feat(config): add onComplete hook

AriPerkkio · Nov 26, 2020 · d053d2f · d053d2f
1 parent 19373e9
commit d053d2f
Show file tree

Hide file tree

Showing 12 changed files with 186 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -57,6 +57,26 @@ module.exports = {
 
     /** Optional boolean flag used to set CI mode. process.env.CI is used when not set. */
     CI: false,
+
+    /**
+     * Optional callback invoked once scan is complete.
+     *
+     * @param {{
+     *     repository: string,
+     *     repositoryOwner: string,
+     *     rule: string,
+     *     message: string,
+     *     path: string,
+     *     link: string,
+     *     extension: string,
+     *     source: string,
+     *     error: (string|undefined),
+     * }[]} results Results of the scan, if any
+     * @returns {Promise<void>|void}
+     */
+    onComplete: async function onComplete(results) {
+        // Extend the process with custom features, e.g. send results to email, create issues to Github...
+    },
 }
 ```
 

diff --git a/eslint-remote-tester.config.js b/eslint-remote-tester.config.js
@@ -28,4 +28,22 @@ module.exports = {
         },
         extends: ['eslint:recommended'],
     },
+
+    /**
+     * Optional callback invoked once scan is complete.
+     *
+     * @param {{
+     *     repository: string,
+     *     repositoryOwner: string,
+     *     rule: string,
+     *     message: string,
+     *     path: string,
+     *     link: string,
+     *     extension: string,
+     *     source: string,
+     *     error: (string|undefined),
+     * }[]} results Results of the scan, if any
+     * @returns {Promise<void>|void}
+     */
+    onComplete: undefined,
 };
diff --git a/lib/config/config-templates.ts b/lib/config/config-templates.ts
@@ -51,4 +51,24 @@ export const CONFIGURATION_FILE_TEMPLATE =
 
     /** Optional boolean flag used to set CI mode. process.env.CI is used when not set. */
     CI: false,
+
+    /**
+     * Optional callback invoked once scan is complete.
+     *
+     * @param {{
+     *     repository: string,
+     *     repositoryOwner: string,
+     *     rule: string,
+     *     message: string,
+     *     path: string,
+     *     link: string,
+     *     extension: string,
+     *     source: string,
+     *     error: (string|undefined),
+     * }[]} results Results of the scan, if any
+     * @returns {Promise<void>|void}
+     */
+    onComplete: async function onComplete(results) {
+
+    },
 }`;
diff --git a/lib/config/types.d.ts b/lib/config/types.d.ts
@@ -1,5 +1,7 @@
 import { Linter } from 'eslint';
 
+import { ResultTemplateOptions } from '@file-client/result-templates';
+
 export type ResultParser = 'plaintext' | 'markdown';
 
 /** Contents of the `eslint-remote-tester.config.js` */
@@ -12,4 +14,5 @@ export interface Config {
     concurrentTasks: number;
     eslintrc: Linter.Config;
     CI: boolean;
+    onComplete?: (results: ResultTemplateOptions[]) => Promise<void> | void;
 }
diff --git a/lib/config/validator.ts b/lib/config/validator.ts
@@ -19,6 +19,7 @@ export default function constructAndValidateConfiguration(
         concurrentTasks,
         eslintrc,
         CI,
+        onComplete,
     } = configToValidate;
 
     const config = { ...configToValidate };
@@ -79,6 +80,10 @@ export default function constructAndValidateConfiguration(
         config.concurrentTasks = DEFAULT_CONCURRENT_TASKS;
     }
 
+    if (onComplete && typeof onComplete !== 'function') {
+        errors.push(`onComplete (${onComplete}) should be a function`);
+    }
+
     if (errors.length) {
         console.log(
             chalk.red(

diff --git a/lib/file-client/result-templates.ts b/lib/file-client/result-templates.ts
@@ -1,6 +1,7 @@
 import { ResultParser } from '@config/types';
 import { LintMessage } from '@engine/types';
 
+// Note that this is part of public API
 export interface ResultTemplateOptions {
     repository: string;
     repositoryOwner: string;

diff --git a/lib/progress-logger/progress-logger.ts b/lib/progress-logger/progress-logger.ts
@@ -3,6 +3,7 @@ import chalk from 'chalk';
 import * as Templates from './log-templates';
 import { LogMessage, Task, Listeners, Listener, ListenerType } from './types';
 import config from '@config';
+import { ResultsStore } from '@file-client';
 
 const CI_KEEP_ALIVE_INTERVAL_MS = 4.5 * 60 * 1000;
 const DEFAULT_COLOR = (text: string) => text;
@@ -101,7 +102,35 @@ class ProgressLogger {
             clearInterval(this.ciKeepAliveIntervalHandle);
         }
 
-        this.listeners.exit.forEach(listener => listener());
+        const onError = (error: Error) =>
+            console.error(
+                [
+                    `Error occured while calling onComplete callback`,
+                    error.stack,
+                ].join('\n')
+            );
+        const notifyListeners = () =>
+            this.listeners.exit.forEach(listener => listener());
+
+        let exitPromise = Promise.resolve();
+
+        if (config.onComplete) {
+            const results = ResultsStore.getResults();
+            try {
+                const onCompletePromise = config.onComplete(results);
+
+                if (onCompletePromise instanceof Promise) {
+                    exitPromise = onCompletePromise;
+                }
+            } catch (e) {
+                onError(e);
+            }
+        }
+
+        exitPromise.then(notifyListeners).catch(error => {
+            onError(error);
+            notifyListeners();
+        });
     }
 
     /**

diff --git a/test/integration/eslint-remote-tester.integration.config.js b/test/integration/eslint-remote-tester.integration.config.js
@@ -19,4 +19,7 @@ module.exports = {
             'local-rules/some-unstable-rule': 'error',
         },
     },
+    onComplete: function onComplete(results) {
+        global.onComplete(results);
+    },
 };
diff --git a/test/integration/integration.ci.test.ts b/test/integration/integration.ci.test.ts
@@ -6,6 +6,7 @@ import {
     INTEGRATION_REPO_NAME,
     getStdoutWriteCalls,
     sanitizeStackTrace,
+    getOnCompleteCalls,
 } from '../utils';
 import { CACHE_LOCATION } from '@file-client';
 
@@ -159,4 +160,34 @@ describe('CI mode', () => {
     test('exits process with error code', async () => {
         expect(process.exit).toHaveBeenCalledWith(1);
     });
+
+    test('calls onComplete hook with the results', async () => {
+        const [onCompleteCalls] = getOnCompleteCalls();
+        const [result] = onCompleteCalls;
+
+        expect(result.extension).toBe('js');
+        expect(result.link).toBe(
+            `https://github.com/${INTEGRATION_REPO_OWNER}/${INTEGRATION_REPO_NAME}/blob/HEAD/expected-to-crash-linter.js#L2`
+        );
+        expect(result.rule).toBe('unable-to-parse-rule-id');
+        expect(result.message).toBe(
+            "Cannot read property 'someAttribute' of undefined\nOccurred while linting <text>:2"
+        );
+        expect(result.path).toBe(
+            `${INTEGRATION_REPO_OWNER}/${INTEGRATION_REPO_NAME}/expected-to-crash-linter.js`
+        );
+        expect(result.error).toBeTruthy();
+
+        // Each result should have attributes defined
+        onCompleteCalls.forEach(result => {
+            expect(result.repository).toBeTruthy();
+            expect(result.repositoryOwner).toBeTruthy();
+            expect(result.rule).toBeTruthy();
+            expect(result.message).toBeTruthy();
+            expect(result.path).toBeTruthy();
+            expect(result.link).toBeTruthy();
+            expect(result.extension).toBeTruthy();
+            expect(result.source).toBeTruthy();
+        });
+    });
 });
diff --git a/test/integration/integration.cli.test.ts b/test/integration/integration.cli.test.ts
@@ -6,6 +6,7 @@ import {
     INTEGRATION_REPO_OWNER,
     getStdoutWriteCalls,
     sanitizeStackTrace,
+    getOnCompleteCalls,
 } from '../utils';
 import { RESULTS_LOCATION, CACHE_LOCATION } from '@file-client';
 
@@ -158,4 +159,34 @@ describe('CLI', () => {
         expect(secondRunWrites.some(call => /PULLING/.test(call))).toBe(true);
         expect(fs.existsSync(cachedRepository)).toBe(true);
     });
+
+    test('calls onComplete hook with the results', async () => {
+        const [onCompleteCalls] = getOnCompleteCalls();
+        const [result] = onCompleteCalls;
+
+        expect(result.extension).toBe('js');
+        expect(result.link).toBe(
+            `https://github.com/${INTEGRATION_REPO_OWNER}/${INTEGRATION_REPO_NAME}/blob/HEAD/expected-to-crash-linter.js#L2`
+        );
+        expect(result.rule).toBe('unable-to-parse-rule-id');
+        expect(result.message).toBe(
+            "Cannot read property 'someAttribute' of undefined\nOccurred while linting <text>:2"
+        );
+        expect(result.path).toBe(
+            `${INTEGRATION_REPO_OWNER}/${INTEGRATION_REPO_NAME}/expected-to-crash-linter.js`
+        );
+        expect(result.error).toBeTruthy();
+
+        // Each result should have attributes defined
+        onCompleteCalls.forEach(result => {
+            expect(result.repository).toBeTruthy();
+            expect(result.repositoryOwner).toBeTruthy();
+            expect(result.rule).toBeTruthy();
+            expect(result.message).toBeTruthy();
+            expect(result.path).toBeTruthy();
+            expect(result.link).toBeTruthy();
+            expect(result.extension).toBeTruthy();
+            expect(result.source).toBeTruthy();
+        });
+    });
 });
diff --git a/test/jest.setup.ts b/test/jest.setup.ts
@@ -6,6 +6,8 @@ const actualWrite = process.stdout.write;
 const mockedExit = (jest.fn() as any) as typeof actualExit;
 const mockedWrite = jest.fn();
 
+(global as any).onComplete = jest.fn();
+
 beforeEach(() => {
     global.console.log = mockedLog;
     global.process.exit = mockedExit;
@@ -18,7 +20,7 @@ beforeEach(() => {
     global.process.stdout.rows = 9999;
 });
 
-afterEach(async () => {
+afterEach(() => {
     global.console.log = actualLog;
     global.process.exit = actualExit;
     global.process.stdout.write = actualWrite;

diff --git a/test/utils.ts b/test/utils.ts
@@ -1,9 +1,13 @@
+import { ResultTemplateOptions } from '@file-client/result-templates';
+
 export const INTEGRARION_CONFIGURATION_LOCATION =
     'test/integration/eslint-remote-tester.integration.config.js';
 export const INTEGRATION_REPO_OWNER = 'AriPerkkio';
 export const INTEGRATION_REPO_NAME =
     'eslint-remote-tester-integration-test-target';
 
+declare const global: { onComplete: jest.Mock };
+
 /**
  * Import the actual production build and run it
  */
@@ -12,6 +16,7 @@ export async function runProductionBuild(): Promise<void> {
         // Clear possible previous runs results
         resetStdoutMethodCalls();
         resetExitCalls();
+        resetOnCompleteCalls();
         jest.resetModules();
 
         const { __handleForTests } = require('../dist/index');
@@ -105,6 +110,22 @@ export function resetExitCalls(): void {
     ((process.exit as any) as jest.Mock).mockClear();
 }
 
+/**
+ * Get call arguments of `global.onComplete`
+ */
+export function getOnCompleteCalls(): ResultTemplateOptions[][] {
+    const calls: ResultTemplateOptions[][][] = global.onComplete.mock.calls;
+
+    return calls.map(argumentArray => argumentArray[0]);
+}
+
+/**
+ * Reset captured calls of `global.onComplete`
+ */
+export function resetOnCompleteCalls(): void {
+    global.onComplete.mockClear();
+}
+
 /**
  * Sanitize possible stack traces for sensitive paths
  * - Removes absolute root path from stack traces, e.g.