feat(config): add cache flag

AriPerkkio · Nov 28, 2020 · 5d8d21d · 5d8d21d
1 parent 36587e8
commit 5d8d21d
Show file tree

Hide file tree

Showing 9 changed files with 36 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -58,6 +58,9 @@ module.exports = {
     /** Optional boolean flag used to set CI mode. process.env.CI is used when not set. */
     CI: false,
 
+    /** Optional boolean flag used to enable caching of cloned repositories. For CI's it's ideal to disable caching. Defauls to true. */
+    cache: true,
+
     /**
      * Optional callback invoked once scan is complete.
      *

diff --git a/eslint-remote-tester.config.js b/eslint-remote-tester.config.js
@@ -29,6 +29,8 @@ module.exports = {
         extends: ['eslint:recommended'],
     },
 
+    cache: true,
+
     /**
      * Optional callback invoked once scan is complete.
      *

diff --git a/lib/config/config-templates.ts b/lib/config/config-templates.ts
@@ -52,6 +52,9 @@ export const CONFIGURATION_FILE_TEMPLATE =
     /** Optional boolean flag used to set CI mode. process.env.CI is used when not set. */
     CI: false,
 
+    /** Optional boolean flag used to enable caching of cloned repositories. For CI's it's ideal to disable caching. Defauls to true. */
+    cache: true,
+
     /**
      * Optional callback invoked once scan is complete.
      *

diff --git a/lib/config/types.d.ts b/lib/config/types.d.ts
@@ -14,5 +14,6 @@ export interface Config {
     concurrentTasks: number;
     eslintrc: Linter.Config;
     CI: boolean;
+    cache: 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,
+        cache,
         onComplete,
     } = configToValidate;
 
@@ -62,6 +63,12 @@ export default function constructAndValidateConfiguration(
         config.CI = CI == null ? process.env.CI === 'true' : CI;
     }
 
+    if (cache != null && typeof cache !== 'boolean') {
+        errors.push(`cache (${cache}) should be a boolean.`);
+    } else if (cache == null) {
+        config.cache = true;
+    }
+
     if (resultParser && !RESULT_PARSERS.includes(resultParser)) {
         errors.push(
             `resultParser (${resultParser}) is not valid value. Known values are ${RESULT_PARSERS.join(

diff --git a/lib/engine/worker-task.ts b/lib/engine/worker-task.ts
@@ -3,7 +3,7 @@ import { ESLint, Linter } from 'eslint';
 
 import { LintMessage, WorkerData } from './types';
 import config from '@config';
-import { getFiles, SourceFile } from '@file-client';
+import { getFiles, removeCachedRepository, SourceFile } from '@file-client';
 
 export type WorkerMessage =
     | { type: 'START' }
@@ -216,5 +216,9 @@ export default async function workerTask(): Promise<void> {
         postMessage({ type: 'FILE_LINT_END', payload: index + 1 });
     }
 
+    if (!config.cache) {
+        await removeCachedRepository(repository);
+    }
+
     postMessage({ type: 'LINT_END', payload: results });
 }
diff --git a/lib/file-client/index.ts b/lib/file-client/index.ts
@@ -5,6 +5,6 @@ export {
     RESULTS_LOCATION,
     RESULT_TEMPLATE,
 } from './results-writer';
-export { CACHE_LOCATION } from './repository-client';
+export { CACHE_LOCATION, removeCachedRepository } from './repository-client';
 export { default as ResultsStore } from './results-store';
 export { RESULTS_TEMPLATE_CI_BASE } from './result-templates';
diff --git a/lib/file-client/repository-client.ts b/lib/file-client/repository-client.ts
@@ -49,3 +49,16 @@ export async function cloneRepository({
         }
     }
 }
+
+/**
+ * Remove repository from the cache
+ */
+export async function removeCachedRepository(
+    repository: string
+): Promise<void> {
+    const repoLocation = `${CACHE_LOCATION}/${repository}`;
+
+    if (fs.existsSync(repoLocation)) {
+        fs.rmdirSync(repoLocation, { recursive: true });
+    }
+}
diff --git a/test/validator.test.ts b/test/validator.test.ts
@@ -11,6 +11,7 @@ const DEFAULT_CONFIGURATION: Config = {
     concurrentTasks: undefined as any,
     eslintrc: {},
     CI: undefined as any,
+    cache: undefined as any,
 };
 
 describe('Config validator', () => {