fix: catch remote connection errors

readmeio · Dec 7, 2022 · 56f7db1 · 56f7db1
1 parent e7d003b
commit 56f7db1
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 1 deletion.
diff --git a/__tests__/helpers/get-git-mock.ts b/__tests__/helpers/get-git-mock.ts
@@ -19,6 +19,11 @@ export default function getGitRemoteMock(
     }
     // second call (used to grab default branch)
     if (arr.length === 2 && arr[0] === 'show' && arr[1] === remote) {
+      if (remote === 'bad-remote') {
+        return Promise.reject(
+          new Error(`fatal: unable to access '${remoteUrl}': Could not resolve host: ${remoteUrl}`)
+        ) as unknown as Response<string>;
+      }
       if (!defaultBranch) return Promise.reject(new Error('Bad mock uh oh')) as unknown as Response<string>;
       return Promise.resolve(`* remote origin
   Fetch URL: ${remoteUrl}

diff --git a/__tests__/lib/createGHA.test.ts b/__tests__/lib/createGHA.test.ts
@@ -180,6 +180,12 @@ describe('#createGHA', () => {
         return expect(createGHA('success!', cmd, command.args, opts)).resolves.toBe('success!');
       });
 
+      it('should not run if unable to connect to remote', () => {
+        git.remote = getGitRemoteMock('bad-remote', 'http://somebadurl.git');
+
+        return expect(createGHA('success!', cmd, command.args, opts)).resolves.toBe('success!');
+      });
+
       it('should not run if user previously declined to set up GHA for current directory + pkg version', async () => {
         const repoRoot = process.cwd();
 

diff --git a/src/lib/createGHA/index.ts b/src/lib/createGHA/index.ts
@@ -111,7 +111,11 @@ export async function getGitData() {
   if (rawRemotes) {
     const remote = rawRemotes.split('\n')[0];
     debug(`[getGitData] remote result: ${remote}`);
-    const rawRemote = await git.remote(['show', remote]);
+    const rawRemote = await git.remote(['show', remote]).catch(e => {
+      debug(`[getGitData] error accessing remote: ${e.message}`);
+      return '';
+    });
+
     debug(`[getGitData] rawRemote result: ${rawRemote}`);
     // Extract head branch from git output
     const rawHead = headLineRegEx.exec(rawRemote as string)?.[0];