Include submodule SHA in LoopWorkspace build details (#2399)

Author: marionbarker

Common/Models/BuildDetails.swift

@@ -65,5 +65,20 @@ class BuildDetails {
     var workspaceGitBranch: String? {
         return dict["com-loopkit-LoopWorkspace-git-branch"] as? String
     }
+
+    /// Returns a dictionary of submodule details.
+    /// The keys are the submodule names, and the values are tuples (branch, commitSHA).
+    var submodules: [String: (branch: String, commitSHA: String)] {
+        guard let subs = dict["com-loopkit-Loop-submodules"] as? [String: [String: Any]] else {
+            return [:]
+        }
+        var result = [String: (branch: String, commitSHA: String)]()
+        for (name, info) in subs {
+            let branch = info["branch"] as? String ?? String(localized: "Unknown")
+            let commitSHA = info["commit_sha"] as? String ?? String(localized: "Unknown")
+            result[name] = (branch: branch, commitSHA: commitSHA)
+        }
+        return result
+    }
 }
 

Loop/Managers/DeviceDataManager.swift

@@ -1700,17 +1700,24 @@ extension DeviceDataManager: DeviceSupportDelegate {
                         deviceLogReport = entries.map { "* \($0.timestamp) \($0.managerIdentifier) \($0.deviceIdentifier ?? "") \($0.type) \($0.message)" }.joined(separator: "\n")
                     }
 
+                    let submodulesInfo = BuildDetails.default.submodules
+                        .sorted(by: { $0.key < $1.key })
+                        .map { key, value in
+                            "*   \(key): \(value.branch), \(value.commitSHA)"
+                        }
+                        .joined(separator: "\n")
+
                     let report = [
                         "## Build Details",
                         "* appNameAndVersion: \(Bundle.main.localizedNameAndVersion)",
                         "* profileExpiration: \(BuildDetails.default.profileExpirationString)",
-                        "* gitRevision: \(BuildDetails.default.gitRevision ?? "N/A")",
-                        "* gitBranch: \(BuildDetails.default.gitBranch ?? "N/A")",
-                        "* workspaceGitRevision: \(BuildDetails.default.workspaceGitRevision ?? "N/A")",
-                        "* workspaceGitBranch: \(BuildDetails.default.workspaceGitBranch ?? "N/A")",
                         "* sourceRoot: \(BuildDetails.default.sourceRoot ?? "N/A")",
                         "* buildDateString: \(BuildDetails.default.buildDateString ?? "N/A")",
                         "* xcodeVersion: \(BuildDetails.default.xcodeVersion ?? "N/A")",
+                        "* Workspace branch: \(BuildDetails.default.workspaceGitBranch ?? "N/A")",
+                        "* Workspace SHA: \(BuildDetails.default.workspaceGitRevision ?? "N/A")",
+                        "* Submodule name: branch, SHA",
+                        "\(submodulesInfo)",
                         "",
                         "## FeatureFlags",
                         "\(FeatureFlags)",

Scripts/capture-build-details.sh

@@ -100,3 +100,49 @@ then
     fi
     popd . > /dev/null
 fi
+
+# --- Root repo details ---
+# Retrieve current branch (or tag) and commit SHA.
+git_branch=$(git symbolic-ref --short -q HEAD || echo "")
+git_tag=$(git describe --tags --exact-match 2>/dev/null || echo "")
+git_commit_sha=$(git log -1 --format="%h" --abbrev=7)
+git_branch_or_tag="${git_branch:-${git_tag}}"
+if [ -z "${git_branch_or_tag}" ]; then
+    git_branch_or_tag="detached"
+fi
+
+plutil -replace com-loopkit-Loop-branch -string "${git_branch_or_tag}" "${info_plist_path}"
+plutil -replace com-loopkit-Loop-commit-sha -string "${git_commit_sha}" "${info_plist_path}"
+
+# --- Submodule details ---
+# Remove an existing submodules key if it exists, then create an empty dictionary.
+# (Using PlistBuddy, which is available on macOS)
+submodules_key="com-loopkit-Loop-submodules"
+if /usr/libexec/PlistBuddy -c "Print :${submodules_key}" "${info_plist_path}" 2>/dev/null; then
+    /usr/libexec/PlistBuddy -c "Delete :${submodules_key}" "${info_plist_path}"
+fi
+/usr/libexec/PlistBuddy -c "Add :${submodules_key} dict" "${info_plist_path}"
+
+# Gather submodule details.
+# We use git submodule foreach to output lines in the form:
+#   submodule_name|branch_or_tag|commit_sha
+submodules_info=$(git submodule foreach --quiet '
+  sub_git_branch=$(git symbolic-ref --short -q HEAD || echo "")
+  sub_git_tag=$(git describe --tags --exact-match 2>/dev/null || echo "")
+  sub_git_commit_sha=$(git log -1 --format="%h" --abbrev=7)
+  sub_git_branch_or_tag="${sub_git_branch:-${sub_git_tag}}"
+  if [ -z "${sub_git_branch_or_tag}" ]; then
+    sub_git_branch_or_tag="detached"
+  fi
+  echo "$name|$sub_git_branch_or_tag|$sub_git_commit_sha"
+')
+
+# For each line, add a dictionary entry for that submodule.
+echo "${submodules_info}" | while IFS="|" read -r submodule_name sub_branch sub_sha; do
+    # Create a dictionary for this submodule
+    /usr/libexec/PlistBuddy -c "Add :${submodules_key}:${submodule_name} dict" "${info_plist_path}"
+    /usr/libexec/PlistBuddy -c "Add :${submodules_key}:${submodule_name}:branch string ${sub_branch}" "${info_plist_path}"
+    /usr/libexec/PlistBuddy -c "Add :${submodules_key}:${submodule_name}:commit_sha string ${sub_sha}" "${info_plist_path}"
+done
+
+echo "BuildDetails.plist has been updated at: ${info_plist_path}"