Handle edge case with deleted config (#249)

Author: sorenlouv

src/services/github/v4/apiRequestV4.test.ts

@@ -62,7 +62,9 @@ describe('apiRequestV4', () => {
           },
         })
       ).rejects.toThrowError(
-        new HandledError(`some error, some other error (Github v4)`)
+        new HandledError(
+          `some error, some other error (Unhandled Github v4 error)`
+        )
       );
     });
   });

src/services/github/v4/apiRequestV4.ts

@@ -1,5 +1,4 @@
-import axios from 'axios';
-import { AxiosError } from 'axios';
+import axios, { AxiosError } from 'axios';
 import { HandledError } from '../../HandledError';
 import { logger } from '../../logger';
 
@@ -71,15 +70,17 @@ export async function apiRequestV4<DataResponse>({
   }
 }
 
-export function handleGithubV4Error(e: AxiosError<GithubV4Response<null>>) {
-  // not github api error
+export function handleGithubV4Error(e: AxiosError<GithubV4Response<unknown>>) {
+  // re-throw unknown error
   if (!e.response?.data) {
     return e;
   }
 
   const errorMessages = e.response.data.errors?.map((error) => error.message);
   if (errorMessages) {
-    return new HandledError(`${errorMessages.join(', ')} (Github v4)`);
+    return new HandledError(
+      `${errorMessages.join(', ')} (Unhandled Github v4 error)`
+    );
   }
 
   return new HandledError(

src/services/github/v4/enablePullRequestAutoMerge.private.test.ts

@@ -11,6 +11,8 @@ const TEST_REPO_OWNER = 'backport-org';
 const TEST_REPO_NAME = 'repo-with-auto-merge-enabled';
 const TEST_PULL_NUMBER = 1;
 
+const sleep = (ms: number) => new Promise((resolve) => setTimeout(resolve, ms));
+
 let options: ValidConfigOptions;
 
 describe('enablePullRequestAutoMerge', () => {
@@ -35,6 +37,10 @@ describe('enablePullRequestAutoMerge', () => {
       { ...options, autoMergeMethod: 'merge' },
       TEST_PULL_NUMBER
     );
+
+    // ensure Github API reflects the change before querying
+    await sleep(100);
+
     const autoMergeMethod = await fetchPullRequestAutoMergeMethod(
       options,
       TEST_PULL_NUMBER
@@ -47,6 +53,10 @@ describe('enablePullRequestAutoMerge', () => {
       { ...options, autoMergeMethod: 'rebase' },
       TEST_PULL_NUMBER
     );
+
+    // ensure Github API reflects the change before querying
+    await sleep(100);
+
     const autoMergeMethod = await fetchPullRequestAutoMergeMethod(
       options,
       TEST_PULL_NUMBER
@@ -59,6 +69,10 @@ describe('enablePullRequestAutoMerge', () => {
       { ...options, autoMergeMethod: 'squash' },
       TEST_PULL_NUMBER
     );
+
+    // ensure Github API reflects the change before querying
+    await sleep(100);
+
     const autoMergeMethod = await fetchPullRequestAutoMergeMethod(
       options,
       TEST_PULL_NUMBER

src/services/github/v4/fetchCommitByPullNumber.private.test.ts

@@ -61,7 +61,7 @@ describe('fetchCommitByPullNumber', () => {
       } as ValidConfigOptions & { pullNumber: number };
 
       await expect(fetchCommitByPullNumber(options)).rejects.toThrowError(
-        `Could not resolve to a PullRequest with the number of 9999999999999. (Github v4)`
+        `Could not resolve to a PullRequest with the number of 9999999999999. (Unhandled Github v4 error)`
       );
     });
   });

src/services/github/v4/getOptionsFromGithub/index.private.test.ts

@@ -142,4 +142,23 @@ describe('getOptionsFromGithub', () => {
       });
     });
   });
+
+  describe('when a backportrc.json config was deleted from repo', () => {
+    it('does not throw', async () => {
+      const optionsFromConfigFiles = {
+        username: 'sqren',
+        accessToken: devAccessToken,
+        githubApiBaseUrlV4: 'https://api.github.com/graphql',
+        upstream: 'backport-org/repo-with-backportrc-removed',
+      } as OptionsFromConfigFiles;
+      const optionsFromCliArgs = {} as OptionsFromCliArgs;
+
+      const options = await getOptionsFromGithub(
+        optionsFromConfigFiles,
+        optionsFromCliArgs
+      );
+
+      expect(options).toEqual({ sourceBranch: 'main' });
+    });
+  });
 });

src/services/github/v4/getOptionsFromGithub/index.ts

@@ -51,15 +51,30 @@ export async function getOptionsFromGithub(
     spinner.stop();
   } catch (e) {
     spinner.stop();
-    const error = e as AxiosError<GithubV4Response<null>>;
+    const error = e as AxiosError<
+      GithubV4Response<GithubConfigOptionsResponse | null>
+    >;
 
     throwOnInvalidAccessToken({
       error,
       repoName,
       repoOwner,
     });
 
-    throw handleGithubV4Error(error);
+    const configFileNotFound = error.response?.data.errors?.some(
+      (error) =>
+        error.type === 'NOT_FOUND' &&
+        error.path.join('.') ===
+          'repository.defaultBranchRef.target.jsonConfigFile.edges.0.config.file'
+    );
+
+    if (configFileNotFound && error.response?.data.data) {
+      // swallow error if caused by missing config file on Github
+      res = error.response.data.data;
+    } else {
+      // throw generic Github error
+      throw handleGithubV4Error(error);
+    }
   }
 
   // get the original repo (not the fork)

src/services/github/v4/throwOnInvalidAccessToken.test.ts

@@ -50,7 +50,7 @@ describe('throwOnInvalidAccessToken', () => {
             'x-accepted-oauth-scopes': 'a,b,c',
           },
           data: {
-            errors: [{ type: 'NOT_FOUND' }],
+            errors: [{ type: 'NOT_FOUND', path: ['repository'] }],
           },
         },
       } as any;
@@ -73,7 +73,7 @@ describe('throwOnInvalidAccessToken', () => {
             'x-accepted-oauth-scopes': 'a,b,c',
           },
           data: {
-            errors: [{ type: 'NOT_FOUND' }],
+            errors: [{ type: 'NOT_FOUND', path: ['repository'] }],
           },
         },
       } as any;

src/services/github/v4/throwOnInvalidAccessToken.ts

@@ -12,7 +12,7 @@ export function throwOnInvalidAccessToken({
 }: {
   repoOwner: string;
   repoName: string;
-  error: AxiosError<GithubV4Response<null>>;
+  error: AxiosError<GithubV4Response<unknown>>;
 }) {
   type MaybeString = string | undefined;
 
@@ -28,7 +28,8 @@ export function throwOnInvalidAccessToken({
   switch (statusCode) {
     case 200: {
       const repoNotFound = error.response?.data.errors?.some(
-        (error) => error.type === 'NOT_FOUND'
+        (error) =>
+          error.type === 'NOT_FOUND' && error.path.join('.') === 'repository'
       );
 
       const grantedScopes = error.response?.headers['x-oauth-scopes'] || '';