feat(repo): spin up .ts daemon when running tests that use daemon

jest.preset.js

@@ -12,4 +12,6 @@ module.exports = {
   coverageReporters: ['html'],
   maxWorkers: 1,
   testEnvironment: 'node',
+  globalSetup: '../../scripts/unit-test-setup.js',
+  globalTeardown: '../../scripts/unit-test-teardown.js',
 };

packages/cypress/src/plugins/plugin.ts

@@ -210,6 +210,7 @@ async function buildCypressTargets(
         ? cypressConfig.e2e.excludeSpecPattern.map((p) => join(projectRoot, p))
         : [join(projectRoot, cypressConfig.e2e.excludeSpecPattern)];
       const specFiles = await globWithWorkspaceContext(
+        context.workspaceRoot,
         specPatterns,
         excludeSpecPatterns
       );

packages/nx/src/daemon/client/client.ts

@@ -4,7 +4,7 @@ import { readFileSync, statSync } from 'fs';
 import { FileHandle, open } from 'fs/promises';
 import { ensureDirSync, ensureFileSync } from 'fs-extra';
 import { connect } from 'net';
-import { join } from 'path';
+import { extname, join } from 'path';
 import { performance } from 'perf_hooks';
 import { output } from '../../utils/output';
 import { getFullOsSocketPath, killSocketOrPath } from '../socket-utils';
@@ -49,9 +49,6 @@ import { NxWorkspaceFiles } from '../../native';
 const DAEMON_ENV_SETTINGS = {
   NX_PROJECT_GLOB_CACHE: 'false',
   NX_CACHE_PROJECTS_CONFIG: 'false',
-
-  // Used to identify that the code is running in the daemon process.
-  NX_ON_DAEMON_PROCESS: 'true',
 };
 
 export type UnregisterCallback = () => void;
@@ -283,14 +280,9 @@ export class DaemonClient {
     return this.sendToDaemonViaQueue(message);
   }
 
-  getWorkspaceContextFileData(
-    globs: string[],
-    exclude?: string[]
-  ): Promise<FileData[]> {
+  getWorkspaceContextFileData(): Promise<FileData[]> {
     const message: HandleContextFileDataMessage = {
       type: GET_CONTEXT_FILE_DATA,
-      globs,
-      exclude,
     };
     return this.sendToDaemonViaQueue(message);
   }
@@ -478,18 +470,35 @@ export class DaemonClient {
     this._out = await open(DAEMON_OUTPUT_LOG_FILE, 'a');
     this._err = await open(DAEMON_OUTPUT_LOG_FILE, 'a');
 
-    const backgroundProcess = spawn(
-      process.execPath,
-      [join(__dirname, '../server/start.js')],
-      {
-        cwd: workspaceRoot,
-        stdio: ['ignore', this._out.fd, this._err.fd],
-        detached: true,
-        windowsHide: true,
-        shell: false,
-        env: { ...process.env, ...DAEMON_ENV_SETTINGS },
-      }
-    );
+    // This stuff is only hit during our unit tests,
+    // as the daemon server is typescript during their execution.
+    const isTypescript = extname(__filename) === '.ts';
+    const workerExt = isTypescript ? 'ts' : 'js';
+
+    const args = [join(__dirname, `../server/start.${workerExt}`)];
+
+    // If the daemon is typescript, we need to add the ts-node/register to support it.
+    if (isTypescript) {
+      args.unshift('-r', 'ts-node/register');
+    }
+
+    const backgroundProcess = spawn(process.execPath, args, {
+      cwd: workspaceRoot,
+      stdio: ['ignore', this._out.fd, this._err.fd],
+      detached: true,
+      windowsHide: true,
+      shell: false,
+      env: {
+        ...process.env,
+        ...DAEMON_ENV_SETTINGS,
+        ...(isTypescript
+          ? {
+              // Ensures that the worker uses the same tsconfig as the main process
+              TS_NODE_PROJECT: join(__dirname, '../../../tsconfig.lib.json'),
+            }
+          : {}),
+      },
+    });
     backgroundProcess.unref();
 
     /**

packages/nx/src/daemon/message-types/get-context-file-data.ts

@@ -2,8 +2,6 @@ export const GET_CONTEXT_FILE_DATA = 'GET_CONTEXT_FILE_DATA' as const;
 
 export type HandleContextFileDataMessage = {
   type: typeof GET_CONTEXT_FILE_DATA;
-  globs: string[];
-  exclude?: string[];
 };
 
 export function isHandleContextFileDataMessage(

packages/nx/src/daemon/server/handle-context-file-data.ts

@@ -3,7 +3,7 @@ import { workspaceRoot } from '../../utils/workspace-root';
 import { HandlerResult } from './server';
 
 export async function handleContextFileData(): Promise<HandlerResult> {
-  const files = getAllFileDataInContext(workspaceRoot);
+  const files = await getAllFileDataInContext(workspaceRoot);
   return {
     response: JSON.stringify(files),
     description: 'handleContextFileData',

packages/nx/src/daemon/server/handle-get-files-in-directory.ts

@@ -5,7 +5,7 @@ import { HandlerResult } from './server';
 export async function handleGetFilesInDirectory(
   dir: string
 ): Promise<HandlerResult> {
-  const files = getFilesInDirectoryUsingContext(workspaceRoot, dir);
+  const files = await getFilesInDirectoryUsingContext(workspaceRoot, dir);
   return {
     response: JSON.stringify(files),
     description: 'handleNxWorkspaceFiles',

packages/nx/src/daemon/server/server.ts

@@ -26,7 +26,6 @@ import {
   handleRecordOutputsHash,
 } from './handle-outputs-tracking';
 import { handleProcessInBackground } from './handle-process-in-background';
-import { handleRequestFileData } from './handle-request-file-data';
 import { handleRequestProjectGraph } from './handle-request-project-graph';
 import { handleRequestShutdown } from './handle-request-shutdown';
 import { serverLogger } from './logger';
@@ -132,11 +131,12 @@ async function handleMessage(socket, data: string) {
     );
   }
 
-  if (daemonIsOutdated()) {
+  const outdated = daemonIsOutdated();
+  if (outdated) {
     await respondWithErrorAndExit(
       socket,
-      `Lock files changed`,
-      new Error('LOCK-FILES-CHANGED')
+      `Daemon outdated`,
+      new Error(outdated)
     );
   }
 
@@ -164,10 +164,6 @@ async function handleMessage(socket, data: string) {
     );
   } else if (payload.type === 'HASH_TASKS') {
     await handleResult(socket, 'HASH_TASKS', () => handleHashTasks(payload));
-  } else if (payload.type === 'REQUEST_FILE_DATA') {
-    await handleResult(socket, 'REQUEST_FILE_DATA', () =>
-      handleRequestFileData()
-    );
   } else if (payload.type === 'PROCESS_IN_BACKGROUND') {
     await handleResult(socket, 'PROCESS_IN_BACKGROUND', () =>
       handleProcessInBackground(payload)
@@ -274,11 +270,19 @@ function registerProcessTerminationListeners() {
 
 let existingLockHash: string | undefined;
 
-function daemonIsOutdated(): boolean {
-  return nxVersionChanged() || lockFileHashChanged();
+function daemonIsOutdated(): string | null {
+  if (nxVersionChanged()) {
+    return 'NX_VERSION_CHANGED';
+  } else if (lockFileHashChanged()) {
+    return 'LOCK_FILES_CHANGED';
+  }
+  return null;
 }
 
 function nxVersionChanged(): boolean {
+  if (process.env.NX_SKIP_NX_VERSION_CHECK === 'true') {
+    return false;
+  }
   return nxVersion !== getInstalledNxVersion();
 }
 
@@ -332,10 +336,11 @@ const handleWorkspaceChanges: FileWatcherCallback = async (
   try {
     resetInactivityTimeout(handleInactivityTimeout);
 
-    if (daemonIsOutdated()) {
+    const outdatedReason = daemonIsOutdated();
+    if (outdatedReason) {
       await handleServerProcessTermination({
         server,
-        reason: 'Lock file changed',
+        reason: outdatedReason,
       });
       return;
     }

packages/nx/src/project-graph/plugins/isolation/plugin-pool.ts

@@ -39,8 +39,6 @@ export function loadRemoteNxPlugin(
       : {}),
   };
 
-  delete env.NX_ON_DAEMON_PROCESS;
-
   const worker = fork(workerPath, [], {
     stdio: ['ignore', 'inherit', 'inherit', 'ipc'],
     env,

packages/nx/src/utils/all-file-data.ts

@@ -1,12 +1,7 @@
 import { FileData } from '../config/project-graph';
-import { daemonClient } from '../daemon/client/client';
 import { getAllFileDataInContext } from './workspace-context';
 import { workspaceRoot } from './workspace-root';
 
 export function allFileData(): Promise<FileData[]> {
-  if (daemonClient.enabled()) {
-    return daemonClient.getAllFileData();
-  } else {
-    return Promise.resolve(getAllFileDataInContext(workspaceRoot));
-  }
+  return getAllFileDataInContext(workspaceRoot);
 }

packages/nx/src/utils/workspace-context.ts

@@ -81,15 +81,15 @@ export function updateFilesInContext(
   return workspaceContext?.incrementalUpdate(updatedFiles, deletedFiles);
 }
 
-export function getAllFileDataInContext(workspaceRoot: string) {
+export async function getAllFileDataInContext(workspaceRoot: string) {
   if (isOnDaemon() || !daemonClient.enabled()) {
     ensureContextAvailable(workspaceRoot);
     return workspaceContext.allFileData();
   }
   return daemonClient.getAllFileData();
 }
 
-export function getFilesInDirectoryUsingContext(
+export async function getFilesInDirectoryUsingContext(
   workspaceRoot: string,
   dir: string
 ) {

packages/playwright/src/plugins/plugin.ts

@@ -163,7 +163,7 @@ async function buildPlaywrightTargets(
     playwrightConfig.testMatch ??= '**/*.@(spec|test).?(c|m)[jt]s?(x)';
 
     const dependsOn: TargetConfiguration['dependsOn'] = [];
-    forEachTestFile(
+    await forEachTestFile(
       (testFile) => {
         const relativeSpecFilePath = normalizePath(
           relative(projectRoot, testFile)
@@ -210,15 +210,15 @@ async function buildPlaywrightTargets(
   return { targets, metadata };
 }
 
-function forEachTestFile(
+async function forEachTestFile(
   cb: (path: string) => void,
   opts: {
     context: CreateNodesContext;
     path: string;
     config: PlaywrightTestConfig;
   }
 ) {
-  const files = getFilesInDirectoryUsingContext(
+  const files = await getFilesInDirectoryUsingContext(
     opts.context.workspaceRoot,
     opts.path
   );

scripts/unit-test-setup.js

@@ -0,0 +1,9 @@
+// Shuts down daemon before running any tests. This ensures that if a
+// test needs the daemon, it will start up fresh and use the `.ts` daemon.
+module.exports = () => {
+  process.env.NX_SKIP_NX_VERSION_CHECK = 'true';
+  require('child_process').execSync('pnpm exec nx daemon --stop', {
+    shell: true,
+    stdio: 'inherit',
+  });
+};

scripts/unit-test-teardown.js

@@ -0,0 +1,6 @@
+// Shuts down daemon after running any tests. This ensures that subsequent
+// commands use the installed Nx version's daemon.
+module.exports = () =>
+  require('child_process').execSync('pnpm exec nx daemon --stop', {
+    shell: true,
+  });

typedoc-theme/jest.config.ts

@@ -14,5 +14,7 @@ export default {
   resolver: '../scripts/patched-jest-resolver.js',
   moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx'],
   coverageDirectory: '../coverage/typedoc-theme',
+  globalSetup: null,
+  globalTeardown: null,
   preset: '../jest.preset.js',
 };