find-cypress-specs 1.22.0 → 1.24.0

package/README.md

@@ -61,6 +61,19 @@ $ npx find-cypress-specs --branch main --parent --trace-imports cypress
 
 **Note:** the argument is the subfolder name to limit the number of files to inspect when tracing the imports.
 
+You can time how long tracing takes by adding option `--time-trace` to the command line arguments. You can also saved traced dependencies using `--cache-trace` argument. Next time the dependencies will be loaded from the file without recomputing. This is convenient on CI to avoid recomputing them. For example, if you need the number of affected files and their filenames
+
+```
+# get the number of affected specs
+$ npx find-cypress-specs --branch main --parent --trace-imports cypress --cache-trace --count
+# quickly get the affected specs without recomputing the dependencies
+$ npx find-cypress-specs --branch main --parent --trace-imports cypress --cache-trace
+```
+
+The cached trace will be saved in file `deps.json`, you probably want to Git ignore it.
+
+You can limit the number of added traced files using the `--max-added-traced-specs <N>` parameter. This avoids ALL specs added when you change some common utility that many specs import.
+
 ### number of changed files
 
 You can print just the number of changed specs

package/bin/find.js

@@ -37,6 +37,11 @@ const args = arg({
   // to set two named outputs, one for number of changed specs
   // another for actual list of files
   '--set-gha-outputs': Boolean,
+  // save a JSON file with traced dependencies to save time
+  '--cache-trace': Boolean,
+  '--time-trace': Boolean,
+  // do not add more than this number of extra specs after tracing
+  '--max-added-traced-specs': Number,
   // aliases
   '-n': '--names',
   '--name': '--names',
@@ -141,10 +146,41 @@ if (args['--names'] || args['--tags']) {
   debug('comparing against the specs %o', specs)
   if (args['--trace-imports']) {
     debug('tracing dependent changes in folder %s', args['--trace-imports'])
-    const absoluteFolder = path.join(process.cwd(), args['--trace-imports'])
-    const deps = getDependsInFolder(absoluteFolder)
+
+    const saveDependenciesFile = 'deps.json'
+    let deps
+    if (args['--cache-trace']) {
+      if (fs.existsSync(saveDependenciesFile)) {
+        debug(
+          'loading cached traced dependencies from file %s',
+          saveDependenciesFile,
+        )
+        deps = JSON.parse(fs.readFileSync(saveDependenciesFile, 'utf-8')).deps
+      }
+    }
+
+    if (!deps) {
+      const absoluteFolder = path.join(process.cwd(), args['--trace-imports'])
+      const depsOptions = { folder: absoluteFolder, time: args['--time-trace'] }
+      if (args['--cache-trace']) {
+        depsOptions.saveDepsFilename = saveDependenciesFile
+        debug(
+          'will save found dependencies into the file %s',
+          saveDependenciesFile,
+        )
+      }
+      debug('tracing options %o', depsOptions)
+      deps = getDependsInFolder(depsOptions)
+    }
     debug('traced dependencies via imports and require')
     debug(deps)
+
+    // add a sensible limit to the number of extra specs to add
+    // when we trace the dependencies in the changed source files
+    const addedTracedFiles = []
+    const maxAddTracedFiles = args['--max-added-traced-specs'] || 1000
+    debug('maximum traced files to add %d', maxAddTracedFiles)
+
     Object.entries(deps).forEach(([filename, fileDependents]) => {
       const f = path.join(args['--trace-imports'], filename)
       if (changedFiles.includes(f)) {
@@ -156,12 +192,17 @@ if (args['--names'] || args['--tags']) {
         fileDependents.forEach((name) => {
           const nameInCypressFolder = path.join(args['--trace-imports'], name)
           if (!changedFiles.includes(nameInCypressFolder)) {
-            changedFiles.push(nameInCypressFolder)
+            if (addedTracedFiles.length < maxAddTracedFiles) {
+              changedFiles.push(nameInCypressFolder)
+              addedTracedFiles.push(nameInCypressFolder)
+            }
           }
         })
       }
     })
+    debug('added %d traced specs %o', addedTracedFiles.length, addedTracedFiles)
   }
+
   let changedSpecs = specs.filter((file) => changedFiles.includes(file))
   debug('changed %d specs %o', changedSpecs.length, changedSpecs)
   if (args['--set-gha-outputs']) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "find-cypress-specs",
-  "version": "1.22.0",
+  "version": "1.24.0",
   "description": "Find Cypress spec files using the config settings",
   "main": "src",
   "files": [
@@ -26,7 +26,7 @@
     "count-changed-specs": "node ./bin/find --branch main --count",
     "semantic-release": "semantic-release",
     "deps": "spec-change --folder . --mask 'cypress/**/*.{js,ts}'",
-    "deps-changed": "DEBUG=find-cypress-specs node ./bin/find --branch main --parent --trace-imports cypress"
+    "deps-changed": "DEBUG=find-cypress-specs node ./bin/find --branch main --parent --trace-imports cypress --time-trace --cache-trace"
   },
   "repository": {
     "type": "git",
@@ -62,7 +62,7 @@
     "pluralize": "^8.0.0",
     "require-and-forget": "^1.0.0",
     "shelljs": "^0.8.5",
-    "spec-change": "^1.4.0",
+    "spec-change": "^1.6.0",
     "ts-node": "^10.9.1"
   }
 }