isomorphic-git 1.41.5 → 1.41.8

package/managers/index.cjs

@@ -2208,6 +2208,38 @@ class GitRefManager {
     throw new NotFoundError(ref)
   }
 
+  /**
+   * Checks whether a ref names the branch HEAD points at in a repository where
+   * that branch has no commits yet.
+   *
+   * A repository created by `git init` has a HEAD pointing at a branch that
+   * does not exist on disk. Resolving that branch fails the same way resolving
+   * a misspelled ref does, so callers that want to treat the two differently
+   * need this to tell them apart.
+   *
+   * @param {Object} args
+   * @param {FSClient} args.fs - A file system implementation.
+   * @param {string} [args.gitdir=join(dir, '.git')] - [required] The [git directory](dir-vs-gitdir.md) path
+   * @param {string} args.ref - The ref to check.
+   * @returns {Promise<boolean>} - True if the ref names an unborn branch.
+   */
+  static async isUnbornBranch({ fs, gitdir, ref }) {
+    let target;
+    try {
+      // depth 2 stops at the symbolic target instead of following it to an oid.
+      target = await GitRefManager.resolve({
+        fs,
+        gitdir,
+        ref: 'HEAD',
+        depth: 2,
+      });
+    } catch (_) {
+      return false
+    }
+    if (!target.startsWith('refs/heads/')) return false
+    return ref === 'HEAD' || refpaths(ref).includes(target)
+  }
+
   /**
    * Checks if a ref exists.
    *
@@ -4451,6 +4483,10 @@ async function _readObject({
   oid,
   format = 'content',
 }) {
+  if (!['deflated', 'wrapped', 'content'].includes(format)) {
+    throw new InternalError(`invalid requested format "${format}"`)
+  }
+
   // Curry the current read method so that the packfile un-deltification
   // process can acquire external ref-deltas.
   const getExternalRefDelta = oid => _readObject({ fs, cache, gitdir, oid });
@@ -4510,11 +4546,7 @@ async function _readObject({
   result.object = object;
   result.format = 'content';
 
-  if (format === 'content') {
-    return result
-  }
-
-  throw new InternalError(`invalid requested format "${format}"`)
+  return result
 }
 
 async function resolveCommit({ fs, cache, gitdir, oid }) {
@@ -5476,9 +5508,16 @@ class GitWalkerRepo {
       try {
         oid = await GitRefManager.resolve({ fs, gitdir, ref });
       } catch (e) {
-        if (e instanceof NotFoundError) {
-          // Handle fresh branches with no commits
+        // Only a branch that has no commits yet gets the empty tree. Anything
+        // else that fails to resolve is a ref the caller got wrong, and
+        // swallowing it here would walk an empty tree instead of saying so.
+        if (
+          e instanceof NotFoundError &&
+          (await GitRefManager.isUnbornBranch({ fs, gitdir, ref }))
+        ) {
           oid = '4b825dc642cb6eb9a060e54bf8d69288fbee4904';
+        } else {
+          throw e
         }
       }
       const tree = await resolveTree({ fs, cache: this.cache, gitdir, oid });

package/managers/index.d.cts

@@ -582,6 +582,26 @@ export class GitRefManager {
         ref: string;
         depth?: number | undefined;
     }): Promise<string>;
+    /**
+     * Checks whether a ref names the branch HEAD points at in a repository where
+     * that branch has no commits yet.
+     *
+     * A repository created by `git init` has a HEAD pointing at a branch that
+     * does not exist on disk. Resolving that branch fails the same way resolving
+     * a misspelled ref does, so callers that want to treat the two differently
+     * need this to tell them apart.
+     *
+     * @param {Object} args
+     * @param {FSClient} args.fs - A file system implementation.
+     * @param {string} [args.gitdir=join(dir, '.git')] - [required] The [git directory](dir-vs-gitdir.md) path
+     * @param {string} args.ref - The ref to check.
+     * @returns {Promise<boolean>} - True if the ref names an unborn branch.
+     */
+    static isUnbornBranch({ fs, gitdir, ref }: {
+        fs: FSClient;
+        gitdir?: string | undefined;
+        ref: string;
+    }): Promise<boolean>;
     /**
      * Checks if a ref exists.
      *

package/managers/index.d.ts

@@ -581,6 +581,26 @@ export class GitRefManager {
         ref: string;
         depth?: number | undefined;
     }): Promise<string>;
+    /**
+     * Checks whether a ref names the branch HEAD points at in a repository where
+     * that branch has no commits yet.
+     *
+     * A repository created by `git init` has a HEAD pointing at a branch that
+     * does not exist on disk. Resolving that branch fails the same way resolving
+     * a misspelled ref does, so callers that want to treat the two differently
+     * need this to tell them apart.
+     *
+     * @param {Object} args
+     * @param {FSClient} args.fs - A file system implementation.
+     * @param {string} [args.gitdir=join(dir, '.git')] - [required] The [git directory](dir-vs-gitdir.md) path
+     * @param {string} args.ref - The ref to check.
+     * @returns {Promise<boolean>} - True if the ref names an unborn branch.
+     */
+    static isUnbornBranch({ fs, gitdir, ref }: {
+        fs: FSClient;
+        gitdir?: string | undefined;
+        ref: string;
+    }): Promise<boolean>;
     /**
      * Checks if a ref exists.
      *

package/managers/index.js

@@ -2201,6 +2201,38 @@ class GitRefManager {
     throw new NotFoundError(ref)
   }
 
+  /**
+   * Checks whether a ref names the branch HEAD points at in a repository where
+   * that branch has no commits yet.
+   *
+   * A repository created by `git init` has a HEAD pointing at a branch that
+   * does not exist on disk. Resolving that branch fails the same way resolving
+   * a misspelled ref does, so callers that want to treat the two differently
+   * need this to tell them apart.
+   *
+   * @param {Object} args
+   * @param {FSClient} args.fs - A file system implementation.
+   * @param {string} [args.gitdir=join(dir, '.git')] - [required] The [git directory](dir-vs-gitdir.md) path
+   * @param {string} args.ref - The ref to check.
+   * @returns {Promise<boolean>} - True if the ref names an unborn branch.
+   */
+  static async isUnbornBranch({ fs, gitdir, ref }) {
+    let target;
+    try {
+      // depth 2 stops at the symbolic target instead of following it to an oid.
+      target = await GitRefManager.resolve({
+        fs,
+        gitdir,
+        ref: 'HEAD',
+        depth: 2,
+      });
+    } catch (_) {
+      return false
+    }
+    if (!target.startsWith('refs/heads/')) return false
+    return ref === 'HEAD' || refpaths(ref).includes(target)
+  }
+
   /**
    * Checks if a ref exists.
    *
@@ -4438,6 +4470,10 @@ async function _readObject({
   oid,
   format = 'content',
 }) {
+  if (!['deflated', 'wrapped', 'content'].includes(format)) {
+    throw new InternalError(`invalid requested format "${format}"`)
+  }
+
   // Curry the current read method so that the packfile un-deltification
   // process can acquire external ref-deltas.
   const getExternalRefDelta = oid => _readObject({ fs, cache, gitdir, oid });
@@ -4497,11 +4533,7 @@ async function _readObject({
   result.object = object;
   result.format = 'content';
 
-  if (format === 'content') {
-    return result
-  }
-
-  throw new InternalError(`invalid requested format "${format}"`)
+  return result
 }
 
 async function resolveCommit({ fs, cache, gitdir, oid }) {
@@ -5463,9 +5495,16 @@ class GitWalkerRepo {
       try {
         oid = await GitRefManager.resolve({ fs, gitdir, ref });
       } catch (e) {
-        if (e instanceof NotFoundError) {
-          // Handle fresh branches with no commits
+        // Only a branch that has no commits yet gets the empty tree. Anything
+        // else that fails to resolve is a ref the caller got wrong, and
+        // swallowing it here would walk an empty tree instead of saying so.
+        if (
+          e instanceof NotFoundError &&
+          (await GitRefManager.isUnbornBranch({ fs, gitdir, ref }))
+        ) {
           oid = '4b825dc642cb6eb9a060e54bf8d69288fbee4904';
+        } else {
+          throw e
         }
       }
       const tree = await resolveTree({ fs, cache: this.cache, gitdir, oid });