Merge pull request #3283 from OpenNeuroOrg/cli/remote-configuration

fix(cli): Configure and enable a git-annex remote when downloading datasets

Author: nellh

cli/src/commands/download.ts

@@ -44,10 +44,16 @@ export async function downloadAction(
 
   console.log("Downloading...")
 
+  // Clone main/master and git-annex branches
   worker.postMessage({
     "command": "clone",
   })
 
+  // Setup any git-annex remotes required for downloads
+  worker.postMessage({
+    "command": "remote-setup",
+  })
+
   // Close after all tasks are queued
   worker.postMessage({ command: "done" })
 

cli/src/worker/git.ts

@@ -181,6 +181,14 @@ async function createAnnexBranch() {
   })
 }
 
+/**
+ * Generate a commit for remote.log updates if needed
+ */
+async function remoteSetup() {
+  const noAnnexKeys: Record<string, string> = {}
+  await commitAnnexBranch(noAnnexKeys)
+}
+
 /**
  * Generate one commit for all pending git-annex branch changes
  */
@@ -225,7 +233,10 @@ async function commitAnnexBranch(annexKeys: Record<string, string>) {
           { encoding: "utf8" },
         )
       } catch (_err) {
-        if (_err instanceof Error && _err.name !== "NotFound") {
+        // Continue if the error is remote.log is not found, otherwise throw it here
+        if (
+          !(_err instanceof Error && "code" in _err && _err.code === "ENOENT")
+        ) {
           throw _err
         }
       } finally {
@@ -269,11 +280,23 @@ async function commitAnnexBranch(annexKeys: Record<string, string>) {
           await git.add({ ...context.config(), filepath: annexBranchPath })
         }
       }
-      await git.commit({
-        ...context.config(),
-        message: "[OpenNeuro CLI] Added annexed objects",
-        author: context.author,
-      })
+      // Show a better commit message for when only the remote is updated
+      if (Object.keys(annexKeys).length === 0) {
+        // Only generate a commit if needed
+        if (!remoteLog.includes(uuid)) {
+          await git.commit({
+            ...context.config(),
+            message: "[OpenNeuro CLI] Configured remote",
+            author: context.author,
+          })
+        }
+      } else {
+        await git.commit({
+          ...context.config(),
+          message: "[OpenNeuro CLI] Added annexed objects",
+          author: context.author,
+        })
+      }
     }
   } finally {
     try {
@@ -437,6 +460,8 @@ self.onmessage = (event: GitWorkerEvent) => {
     workQueue.enqueue(commit)
   } else if (event.data.command === "push") {
     workQueue.enqueue(push)
+  } else if (event.data.command === "remote-setup") {
+    workQueue.enqueue(remoteSetup)
   } else if (event.data.command === "done") {
     workQueue.enqueue(done)
   }