feat: retries only on a specific error (and update tests)

ridedott · Aug 14, 2020 · 7cf6771 · 7cf6771
1 parent 18e4918
commit 7cf6771
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 7 deletions.
diff --git a/src/common/merge.ts b/src/common/merge.ts
@@ -43,6 +43,9 @@ const merge = async (
   await octokit.graphql(mutation, { commitHeadline, pullRequestId });
 };
 
+const shouldRetry = (error: Error): boolean =>
+  error.message.includes('Base branch was modified.');
+
 export const mergeWithRetry = async (
   octokit: ReturnType<typeof getOctokit>,
   details: PullRequestDetails & {
@@ -65,7 +68,7 @@ export const mergeWithRetry = async (
     /* eslint-disable-next-line @typescript-eslint/no-base-to-string */
     logDebug(`Original error: ${(error as Error).toString()}.`);
 
-    if (retryCount <= maximumRetries) {
+    if (shouldRetry(error) && retryCount <= maximumRetries) {
       const nextRetryIn =
         retryCount ** EXPONENTIAL_BACKOFF *
         (minimumWaitTime === undefined ? MINIMUM_WAIT_TIME : minimumWaitTime);

diff --git a/src/eventHandlers/checkSuite/index.spec.ts b/src/eventHandlers/checkSuite/index.spec.ts
@@ -405,7 +405,10 @@ describe('check Suite event handler', (): void => {
       })
       .post('/graphql')
       .times(3)
-      .reply(403, 'Error when merging');
+      .reply(
+        403,
+        '##[error]GraphqlError: Base branch was modified. Review and try the merge again.',
+      );
 
     const mergeWithRetrySpy = jest.spyOn(merge, 'mergeWithRetry');
     const logDebugSpy = jest.spyOn(log, 'logDebug');
@@ -418,7 +421,9 @@ describe('check Suite event handler', (): void => {
       });
     } catch (error) {
       expect(error).toBeInstanceOf(Error);
-      expect(error.message).toStrictEqual('Error when merging');
+      expect(error.message).toStrictEqual(
+        '##[error]GraphqlError: Base branch was modified. Review and try the merge again.',
+      );
       expect(mergeWithRetrySpy).toHaveBeenCalledTimes(3);
       expect(logDebugSpy).toHaveBeenCalledTimes(3);
       expect(logInfoSpy.mock.calls[1][0]).toStrictEqual(

diff --git a/src/eventHandlers/pullRequest/index.spec.ts b/src/eventHandlers/pullRequest/index.spec.ts
@@ -182,7 +182,10 @@ describe('pull request event handler', (): void => {
       })
       .post('/graphql')
       .times(3)
-      .reply(403, 'Error when merging');
+      .reply(
+        403,
+        '##[error]GraphqlError: Base branch was modified. Review and try the merge again.',
+      );
 
     const mergeWithRetrySpy = jest.spyOn(merge, 'mergeWithRetry');
     const logDebugSpy = jest.spyOn(log, 'logDebug');
@@ -195,7 +198,9 @@ describe('pull request event handler', (): void => {
       });
     } catch (error) {
       expect(error).toBeInstanceOf(Error);
-      expect(error.message).toStrictEqual('Error when merging');
+      expect(error.message).toStrictEqual(
+        '##[error]GraphqlError: Base branch was modified. Review and try the merge again.',
+      );
       expect(mergeWithRetrySpy).toHaveBeenCalledTimes(3);
       expect(logDebugSpy).toHaveBeenCalledTimes(3);
       expect(logInfoSpy.mock.calls[1][0]).toStrictEqual(

diff --git a/src/eventHandlers/push/index.spec.ts b/src/eventHandlers/push/index.spec.ts
@@ -313,7 +313,10 @@ describe('push event handler', (): void => {
       })
       .post('/graphql')
       .times(3)
-      .reply(403, 'Error when merging');
+      .reply(
+        403,
+        '##[error]GraphqlError: Base branch was modified. Review and try the merge again.',
+      );
 
     const mergeWithRetrySpy = jest.spyOn(merge, 'mergeWithRetry');
     const logDebugSpy = jest.spyOn(log, 'logDebug');
@@ -326,7 +329,9 @@ describe('push event handler', (): void => {
       });
     } catch (error) {
       expect(error).toBeInstanceOf(Error);
-      expect(error.message).toStrictEqual('Error when merging');
+      expect(error.message).toStrictEqual(
+        '##[error]GraphqlError: Base branch was modified. Review and try the merge again.',
+      );
       expect(mergeWithRetrySpy).toHaveBeenCalledTimes(3);
       expect(logDebugSpy).toHaveBeenCalledTimes(3);
       expect(logInfoSpy.mock.calls[1][0]).toStrictEqual(