perf: skip node_modules when finding app module (#1190)

Author: Jason Kuhrt

package.json

@@ -44,6 +44,7 @@
     "cross-fetch": "^3.0.4",
     "dotenv": "^8.2.0",
     "express": "^4.17.1",
+    "fast-glob": "^3.2.4",
     "fp-ts": "^2.5.4",
     "fs-jetpack": "^2.4.0",
     "get-port": "^5.1.0",

src/lib/fs/index.spec.ts

@@ -0,0 +1,16 @@
+import * as Path from 'path'
+import * as FS from './'
+
+describe('findFile', () => {
+  it('ignores and does not even walk node_modules', () => {
+    const startTime = Date.now()
+    const result = FS.findFile('package.json', { cwd: Path.join(__dirname, '../../..') })!
+    const endTime = Date.now()
+    const duration = endTime - startTime
+    // Should be extremely fast. Takes ~4ms on MBP for example.
+    // 50 accounts for slow runs, often CI, etc.
+    // This test is how we know we didn't walk node_modules, which if we did, we would get a much larger number
+    expect(duration).toBeLessThan(50)
+    expect(Path.basename(result)).toEqual('package.json')
+  })
+})

src/lib/fs.ts renamed to src/lib/fs/index.ts

@@ -1,8 +1,9 @@
+import * as Glob from 'fast-glob'
 import * as NodeFS from 'fs'
 import * as FS from 'fs-jetpack'
 import * as OS from 'os'
 import * as Path from 'path'
-import { log } from './nexus-logger'
+import { log } from '../nexus-logger'
 
 /**
  * Write a file after forcefully removing it, so that VSC will observe the
@@ -168,24 +169,18 @@ export function sourceFilePathFromTranspiledPath({
   return Path.join(rootDir, maybeAppFolders, tsFileName)
 }
 
-export function findFile(
-  fileNames: string | string[],
-  config: { ignore?: string[]; projectRoot: string }
-): null | string {
-  const paths = Array.isArray(fileNames) ? fileNames : [fileNames]
-  const projectRoot = config.projectRoot
-  const localFs = FS.cwd(projectRoot)
-
-  const foundFiles = localFs.find({
-    matching: [...paths, '!node_modules/**/*', '!.yalc/**/*', ...(config?.ignore?.map((i) => `!${i}`) ?? [])],
-  })
+/**
+ * Find the given file within the directory tree under the given root path (cwd).
+ *
+ * Dot-folders, dot-files, node_modules are all always ignored
+ */
+export function findFile(pattern: string, config: { ignore?: string[]; cwd: string }): null | string {
+  const cwd = config.cwd
+  const ignore = ['node_modules/**', ...(config.ignore ?? [])]
+  const foundFiles = Glob.sync(pattern, { cwd, ignore, absolute: true, dot: false })
 
   // TODO: What if several files were found?
-  if (foundFiles.length > 0) {
-    return Path.join(projectRoot, foundFiles[0])
-  }
-
-  return null
+  return foundFiles[0] ?? null
 }
 
 export async function findFiles(

src/lib/layout/index.spec.ts

@@ -5,9 +5,8 @@ import * as Path from 'path'
 import { TsConfigJson } from 'type-fest'
 import * as Layout from '.'
 import { FSSpec, writeFSSpec } from '../../lib/testing-utils'
-import { leftOrThrow, rightOrThrow } from '../utils'
 import * as TC from '../test-context'
-import { normalizePathsInData, repalceInObject, replaceEvery } from '../utils'
+import { leftOrThrow, normalizePathsInData, repalceInObject, replaceEvery, rightOrThrow } from '../utils'
 import { NEXUS_TS_LSP_IMPORT_ID } from './tsconfig'
 
 let logs: string = ''

src/lib/layout/layout.ts

@@ -279,9 +279,8 @@ const noAppOrNexusModules = exceptionType<'no_app_or_schema_modules', {}>(
  */
 export function findAppModule(opts: { projectRoot: string }): string | null {
   log.trace('looking for app module')
-  const path = findFile(CONVENTIONAL_ENTRYPOINT_FILE_NAME, opts)
+  const path = findFile(`./**/${CONVENTIONAL_ENTRYPOINT_FILE_NAME}`, { cwd: opts.projectRoot })
   log.trace('done looking for app module', { path })
-
   return path
 }
 

yarn.lock

@@ -2626,6 +2626,18 @@ fast-glob@^3.0.3, fast-glob@^3.2.2:
     micromatch "^4.0.2"
     picomatch "^2.2.1"
 
+fast-glob@^3.2.4:
+  version "3.2.4"
+  resolved "https://registry.yarnpkg.com/fast-glob/-/fast-glob-3.2.4.tgz#d20aefbf99579383e7f3cc66529158c9b98554d3"
+  integrity sha512-kr/Oo6PX51265qeuCYsyGypiO5uJFgBS0jksyG7FUeCyQzNwYnzrNIMR1NXfkZXsMYXYLRAHgISHBz8gQcxKHQ==
+  dependencies:
+    "@nodelib/fs.stat" "^2.0.2"
+    "@nodelib/fs.walk" "^1.2.3"
+    glob-parent "^5.1.0"
+    merge2 "^1.3.0"
+    micromatch "^4.0.2"
+    picomatch "^2.2.1"
+
 [email protected], fast-json-stable-stringify@^2.0.0:
   version "2.1.0"
   resolved "https://registry.yarnpkg.com/fast-json-stable-stringify/-/fast-json-stable-stringify-2.1.0.tgz#874bf69c6f404c2b5d99c481341399fd55892633"