feat: allow users to ignore existing pwcs dependency cache (#1229)

Users can pass `--refresh-cache` to ignore existing dependency caches
and rebuild the cache for future runs.

Author: hwartig

packages/cli/src/commands/pw-test.ts

@@ -114,6 +114,10 @@ export default class PwTestCommand extends AuthCommand {
     'install-command': Flags.string({
       description: 'Command to install dependencies before running tests.',
     }),
+    'refresh-cache': Flags.boolean({
+      description: 'Force a fresh install of dependencies and update the cached version.',
+      default: false,
+    }),
   }
 
   async run (): Promise<void> {
@@ -138,6 +142,7 @@ export default class PwTestCommand extends AuthCommand {
       'include': includeFlag,
       'frequency': frequency,
       'install-command': installCommand,
+      'refresh-cache': refreshCache,
     } = flags
     const { configDirectory, configFilenames } = splitConfigFilePath(configFilename)
     const pwPathFlag = this.getConfigPath(playwrightFlags)
@@ -309,6 +314,7 @@ export default class PwTestCommand extends AuthCommand {
       // TODO: ADD PROPER RETRY STRATEGY HANDLING
       null, // testRetryStrategy
       streamLogs,
+      refreshCache,
     )
 
     runner.on(Events.RUN_STARTED,

packages/cli/src/commands/test.ts

@@ -114,6 +114,10 @@ export default class Test extends AuthCommand {
       allowNo: true,
       env: 'CHECKLY_VERIFY_RUNTIME_DEPENDENCIES',
     }),
+    'refresh-cache': Flags.boolean({
+      description: 'Force a fresh install of dependencies and update the cached version.',
+      default: false,
+    }),
   }
 
   static args = {
@@ -148,6 +152,7 @@ export default class Test extends AuthCommand {
       'update-snapshots': updateSnapshots,
       retries,
       'verify-runtime-dependencies': verifyRuntimeDependencies,
+      'refresh-cache': refreshCache,
     } = flags
     const filePatterns = argv as string[]
 
@@ -184,7 +189,7 @@ export default class Test extends AuthCommand {
       availableRuntimes: availableRuntimes.reduce((acc, runtime) => {
         acc[runtime.name] = runtime
         return acc
-      }, <Record<string, Runtime>> {}),
+      }, <Record<string, Runtime>>{}),
       defaultRuntimeId: account.runtimeId,
       verifyRuntimeDependencies,
       checklyConfigConstructs,
@@ -359,6 +364,8 @@ export default class Test extends AuthCommand {
       updateSnapshots,
       configDirectory,
       testRetryStrategy,
+      undefined,
+      refreshCache,
     )
 
     runner.on(Events.RUN_STARTED,

packages/cli/src/commands/trigger.ts

@@ -93,6 +93,10 @@ export default class Trigger extends AuthCommand {
     'retries': Flags.integer({
       description: `[default: 0, max: ${MAX_RETRIES}] How many times to retry a check run.`,
     }),
+    'refresh-cache': Flags.boolean({
+      description: 'Force a fresh install of dependencies and update the cached version.',
+      default: false,
+    }),
   }
 
   async run (): Promise<void> {
@@ -111,6 +115,7 @@ export default class Trigger extends AuthCommand {
       'env-file': envFile,
       'test-session-name': testSessionName,
       retries,
+      'refresh-cache': refreshCache,
     } = flags
     const envVars = await getEnvs(envFile, env)
     const { configDirectory, configFilenames } = splitConfigFilePath(configFilename)
@@ -146,6 +151,7 @@ export default class Trigger extends AuthCommand {
       ciInfo.environment,
       testSessionName,
       testRetryStrategy,
+      refreshCache,
     )
     // TODO: This is essentially the same for `checkly test`. Maybe reuse code.
     runner.on(Events.RUN_STARTED,

packages/cli/src/rest/test-sessions.ts

@@ -15,6 +15,7 @@ type RunTestSessionRequest = {
   environment?: string | null
   shouldRecord: boolean
   streamLogs?: boolean
+  refreshCache?: boolean
 }
 
 type TriggerTestSessionRequest = {
@@ -27,6 +28,7 @@ type TriggerTestSessionRequest = {
   repoInfo: GitInformation | null
   environment: string | null
   testRetryStrategy: RetryStrategy | null
+  refreshCache?: boolean
 }
 
 export type TestResultsShortLinks = {

packages/cli/src/services/test-runner.ts

@@ -21,6 +21,7 @@ export default class TestRunner extends AbstractCheckRunner {
   baseDirectory: string
   testRetryStrategy: RetryStrategy | null
   streamLogs: boolean
+  refreshCache: boolean
 
   constructor (
     accountId: string,
@@ -37,6 +38,7 @@ export default class TestRunner extends AbstractCheckRunner {
     baseDirectory: string,
     testRetryStrategy: RetryStrategy | null,
     streamLogs?: boolean,
+    refreshCache?: boolean,
   ) {
     super(accountId, timeout, verbose)
     this.projectBundle = projectBundle
@@ -50,6 +52,7 @@ export default class TestRunner extends AbstractCheckRunner {
     this.baseDirectory = baseDirectory
     this.testRetryStrategy = testRetryStrategy
     this.streamLogs = streamLogs ?? false
+    this.refreshCache = refreshCache ?? false
   }
 
   async scheduleChecks (
@@ -92,6 +95,7 @@ export default class TestRunner extends AbstractCheckRunner {
       environment: this.environment,
       shouldRecord: this.shouldRecord,
       streamLogs: this.streamLogs,
+      refreshCache: this.refreshCache,
     })
     const { testSessionId, sequenceIds } = data
     const checks = this.checkBundles.map(({ construct: check }) => {

packages/cli/src/services/trigger-runner.ts

@@ -12,6 +12,7 @@ export default class TriggerRunner extends AbstractCheckRunner {
   environment: string | null
   testSessionName: string | undefined
   testRetryStrategy: RetryStrategy | null
+  refreshCache: boolean
 
   constructor (
     accountId: string,
@@ -25,6 +26,7 @@ export default class TriggerRunner extends AbstractCheckRunner {
     environment: string | null,
     testSessionName: string | undefined,
     testRetryStrategy: RetryStrategy | null,
+    refreshCache?: boolean,
   ) {
     super(accountId, timeout, verbose)
     this.shouldRecord = shouldRecord
@@ -35,6 +37,7 @@ export default class TriggerRunner extends AbstractCheckRunner {
     this.environment = environment
     this.testSessionName = testSessionName
     this.testRetryStrategy = testRetryStrategy
+    this.refreshCache = refreshCache ?? false
   }
 
   async scheduleChecks (
@@ -53,6 +56,7 @@ export default class TriggerRunner extends AbstractCheckRunner {
       repoInfo: this.repoInfo,
       environment: this.environment,
       testRetryStrategy: this.testRetryStrategy,
+      refreshCache: this.refreshCache,
     })
     const {
       checks,