Add warning comment for reflog critical section

emmax86 · emmax86 · commit 48bf6fa1ad99 · 2019-02-07T16:20:39.000-07:00
diff --git a/lib/reference.js b/lib/reference.js
@@ -163,9 +163,12 @@ Reference.updateTerminal = function (
     })
     .then(() => NodeGit.Reflog.read(repo, refName))
     .then((reflog) => {
-      // We may want some kind of transactional logic for this
-      // There is a theoretical timing issue that could result in updating
-      // the wrong reflog
+      // Janky, but works. Ideally, we would want to generate the correct reflog
+      // entry in the first place, rather than drop the most recent entry and
+      // write the correct one.
+      // NOTE: There is a theoretical race condition that could happen here.
+      // We may want to consider some kind of transactional logic to make sure
+      // that the reflog on disk isn't modified before we can write back.
       reflog.drop(0, 1);
       reflog.append(oid, signatureToUse, logMessage);
       return reflog.write();
