test: adding fixtures for lockfiles to support --frozen-lockfile (yarn, pnpm) and ci (npm) (#8899)

Sometimes `master` branch (and all subsequent PRs) gets broken simply
due to a fixture dependency's sub-dependency changes/updates/redeploys.

TLDR; Solution:
- Leverage `--frozen-lockfile` and `npm ci` with lockfile fixtures

Implementation:
- This PR introduces a new fixture directory containing lockfiles:
`test/fixtures/lockfiles/<test file name>/<test name>.txt`
- If a test has `isInstallDepsBefore: true`, then we reuse existing
logic flow to check if there's a lockfile fixture already existing, if
so, copy it to the temp `projectDir`. Install deps with arg
`--frozen-lockfile` to use pinned deps specific to each test.
   - npm: `npm ci`
   - yarn: `yarn install --frozen-lockfile`
   - pnpm `pnpm install --frozen-lockfile`
- If a test has no lockfile and deps are installed before running the
test, then write the lockfile at the end of the `npm install` (or yarn,
or pnpm) phase of the process.
- Adds `UPDATE_LOCKFILE_FIXTURES` as a way to re-save the lockfile (such
as when test dependencies are changed)
- Adds `installOptions` containing `cmd`, `installArgs`, and `lockfile` properties
to each Node Module Collector class for easy usage specific to each test

Author: mmaietta

.changeset/wise-seas-bathe.md

@@ -0,0 +1,5 @@
+---
+"app-builder-lib": patch
+---
+
+test: adding fixtures for lockfiles to support `--frozen-lockfile` (yarn, pnpm) and `ci` (npm)

packages/app-builder-lib/src/node-module-collector/index.ts

@@ -12,7 +12,7 @@ async function isPnpmProjectHoisted(rootDir: string) {
   return lines["node-linker"] === "hoisted"
 }
 
-async function getCollectorByPackageManager(rootDir: string) {
+export async function getCollectorByPackageManager(rootDir: string) {
   const manager: PM = await detect({ cwd: rootDir })
   switch (manager) {
     case "pnpm":

packages/app-builder-lib/src/node-module-collector/nodeModulesCollector.ts

@@ -28,6 +28,11 @@ export abstract class NodeModulesCollector<T extends Dependency<T, OptionalsType
     return this.nodeModules
   }
 
+  public abstract readonly installOptions: Promise<{
+    cmd: string
+    args: string[]
+    lockfile: string
+  }>
   protected abstract readonly pmCommand: Lazy<string>
   protected abstract getArgs(): string[]
   protected abstract parseDependenciesTree(jsonBlob: string): T

packages/app-builder-lib/src/node-module-collector/npmNodeModulesCollector.ts

@@ -8,7 +8,8 @@ export class NpmNodeModulesCollector extends NodeModulesCollector<NpmDependency,
     super(rootDir)
   }
 
-  protected readonly pmCommand = new Lazy<string>(() => Promise.resolve(process.platform === "win32" ? "npm.cmd" : "npm"))
+  public readonly pmCommand = new Lazy<string>(() => Promise.resolve(process.platform === "win32" ? "npm.cmd" : "npm"))
+  public readonly installOptions = this.pmCommand.value.then(cmd => ({ cmd, args: ["ci"], lockfile: "package-lock.json" }))
 
   protected getArgs(): string[] {
     return ["list", "-a", "--include", "prod", "--include", "optional", "--omit", "dev", "--json", "--long", "--silent"]

packages/app-builder-lib/src/node-module-collector/pnpmNodeModulesCollector.ts

@@ -22,6 +22,7 @@ export class PnpmNodeModulesCollector extends NodeModulesCollector<PnpmDependenc
   })
 
   protected readonly pmCommand: Lazy<string> = PnpmNodeModulesCollector.pmCommand
+  public readonly installOptions = this.pmCommand.value.then(cmd => ({ cmd, args: ["install", "--frozen-lockfile"], lockfile: "pnpm-lock.yaml" }))
 
   protected getArgs(): string[] {
     return ["list", "--prod", "--json", "--depth", "Infinity"]

packages/app-builder-lib/src/node-module-collector/yarnNodeModulesCollector.ts

@@ -4,4 +4,10 @@ export class YarnNodeModulesCollector extends NpmNodeModulesCollector {
   constructor(rootDir: string) {
     super(rootDir)
   }
+
+  public readonly installOptions = Promise.resolve({
+    cmd: process.platform === "win32" ? "yarn.cmd" : "yarn",
+    args: ["install", "--frozen-lockfile"],
+    lockfile: "yarn.lock",
+  })
 }