[DDW-1081] Really find child processes on Linux – LC_ALL interference

michalrus · michalrus · commit 123b17eda814 · 2022-04-29T12:10:19.000+02:00
diff --git a/source/main/cardano/CardanoNode.ts b/source/main/cardano/CardanoNode.ts
@@ -324,7 +324,7 @@ export class CardanoNode {
             path: this._config.logFilePath,
             maxFiles: 4,
           }
-        )
+        );
       };
 
       const nodeLogFile = mkLogFile('node.log');
@@ -334,7 +334,9 @@ export class CardanoNode {
 
       if (isSelfnode) {
         try {
-          const mockTokenMetadataServerLogFile = mkLogFile('mock-token-metadata-server.log');
+          const mockTokenMetadataServerLogFile = mkLogFile(
+            'mock-token-metadata-server.log'
+          );
           this._mockTokenMetadataServerLogFile = mockTokenMetadataServerLogFile;
 
           const { selfnodeBin, mockTokenMetadataServerBin } = launcherConfig;
@@ -859,7 +861,8 @@ export class CardanoNode {
   _reset = () => {
     if (this._cardanoNodeLogFile) this._cardanoNodeLogFile.end();
     if (this._cardanoWalletLogFile) this._cardanoWalletLogFile.end();
-    if (this._mockTokenMetadataServerLogFile) this._mockTokenMetadataServerLogFile.end();
+    if (this._mockTokenMetadataServerLogFile)
+      this._mockTokenMetadataServerLogFile.end();
     if (this._node) this._node = null;
     this._tlsConfig = null;
   };
diff --git a/source/main/cardano/CardanoSelfnodeLauncher.ts b/source/main/cardano/CardanoSelfnodeLauncher.ts
@@ -1,7 +1,7 @@
 import { spawn } from 'child_process';
 import find from 'find-process';
 import path from 'path';
-import fs, {WriteStream} from 'fs';
+import fs, { WriteStream } from 'fs';
 import which from 'which';
 import tcpPortUsed from 'tcp-port-used';
 import type { ChildProcess } from 'child_process';
@@ -33,10 +33,9 @@ const CARDANO_WALLET_START_CHECK_INTERVAL = 500; // 500 ms | unit: milliseconds
 
 const TOKEN_METADATA_SERVER_PORT = 65432;
 const TOKEN_METADATA_SERVER = `http://localhost:${TOKEN_METADATA_SERVER_PORT}/`;
-const TOKEN_METADATA_SERVER_PROCESS_NAME =
-  environment.isWindows
-    ? 'mock-token-metadata-server.exe'
-    : 'mock-token-metadata-server';
+const TOKEN_METADATA_SERVER_PROCESS_NAME = environment.isWindows
+  ? 'mock-token-metadata-server.exe'
+  : 'mock-token-metadata-server';
 export async function CardanoSelfnodeLauncher(
   selfnodeOptions: SelfnodeOptions
 ): Promise<{
@@ -57,13 +56,18 @@ export async function CardanoSelfnodeLauncher(
       const binDir = path.dirname(which.sync(selfnodeBin));
       return firstExisting('SHELLEY_TEST_DATA', [
         path.resolve(path.join(binDir, 'data', 'cardano-node-shelley')), // Windows installer
-        path.resolve(path.join(binDir, '..', 'Resources', 'data', 'cardano-node-shelley')), // Darwin installer
+        path.resolve(
+          path.join(binDir, '..', 'Resources', 'data', 'cardano-node-shelley')
+        ), // Darwin installer
         // Linux installer substitutes SHELLEY_TEST_DATA in the local-cluster Bash wrapper
-        '../../utils/cardano/selfnode' // nix-shell? but nix-shell has the substitute ↑ as well… Some other scenario?
-      ])
+        '../../utils/cardano/selfnode', // nix-shell? but nix-shell has the substitute ↑ as well… Some other scenario?
+      ]);
     })();
 
-    setupMockTokenMetadataServer(mockTokenMetadataServerBin, mockTokenMetadataServerLogFile);
+    setupMockTokenMetadataServer(
+      mockTokenMetadataServerBin,
+      mockTokenMetadataServerLogFile
+    );
     // @ts-ignore ts-migrate(2322) FIXME: Type '{ pid: number; ppid?: number; uid?: number; ... Remove this comment to see the full error message
     const processList: Array<Process> = await find('port', CARDANO_WALLET_PORT);
     const isSelfnodeRunning =
@@ -113,11 +117,16 @@ export async function CardanoSelfnodeLauncher(
       if (environment.isDev) {
         nodeProcess.unref(); // allows Daedalus to exit independently of selfnode (3/3)
       }
-      if (!environment.isDev && nodeProcess.stdout && nodeProcess.stderr && walletLogFile) {
-        nodeProcess.stdout.on('data', data => {
+      if (
+        !environment.isDev &&
+        nodeProcess.stdout &&
+        nodeProcess.stderr &&
+        walletLogFile
+      ) {
+        nodeProcess.stdout.on('data', (data) => {
           walletLogFile.write(data);
         });
-        nodeProcess.stderr.on('data', data => {
+        nodeProcess.stderr.on('data', (data) => {
           walletLogFile.write(data);
         });
       }
@@ -151,11 +160,18 @@ export async function CardanoSelfnodeLauncher(
 /**
  * Return the first existing file path among candidates. If none exist, return the last one, and log a warning an identifier.
  */
-const firstExisting = (identifier: string, candidates: Array<string>): string => {
+const firstExisting = (
+  identifier: string,
+  candidates: Array<string>
+): string => {
   const existing = candidates.filter(fs.existsSync);
   if (existing.length > 0) return existing[0];
   const fallback = candidates[candidates.length - 1];
-  logger.warn(`${identifier} candidates don’t exist, will use fallback`, { identifier, candidates, fallback });
+  logger.warn(`${identifier} candidates don’t exist, will use fallback`, {
+    identifier,
+    candidates,
+    fallback,
+  });
   return fallback;
 };
 
@@ -195,7 +211,7 @@ const setupMockTokenMetadataServer = async (
     return firstExisting('TOKEN_METADATA_REGISTRY', [
       path.resolve(path.join(binDir, 'token-metadata.json')), // Windows and Linux installers
       path.resolve(path.join(binDir, '..', 'Resources', 'token-metadata.json')), // Darwin installer
-      './utils/cardano/selfnode/token-metadata.json' // nix-shell
+      './utils/cardano/selfnode/token-metadata.json', // nix-shell
     ]);
   })();
 
@@ -239,12 +255,17 @@ const setupMockTokenMetadataServer = async (
     if (environment.isDev) {
       mockTokenMetadataServerProcess.unref();
     }
-    if (!environment.isDev && mockTokenMetadataServerProcess.stdout && mockTokenMetadataServerProcess.stderr && mockTokenMetadataServerLogFile) {
-      mockTokenMetadataServerProcess.stdout.on('data', data => {
+    if (
+      !environment.isDev &&
+      mockTokenMetadataServerProcess.stdout &&
+      mockTokenMetadataServerProcess.stderr &&
+      mockTokenMetadataServerLogFile
+    ) {
+      mockTokenMetadataServerProcess.stdout.on('data', (data) => {
         mockTokenMetadataServerLogFile.write(data);
       });
-      mockTokenMetadataServerProcess.stderr.on('data', data => {
-        mockTokenMetadataServerLogFile.write(data)
+      mockTokenMetadataServerProcess.stderr.on('data', (data) => {
+        mockTokenMetadataServerLogFile.write(data);
       });
     }
     mockTokenMetadataServer = mockTokenMetadataServerProcess;
diff --git a/source/main/utils/processes.ts b/source/main/utils/processes.ts
@@ -14,7 +14,7 @@ export type Process = {
 export const getProcessById = async (processId: number): Promise<Process> => {
   // finds running processes matching PID
   // @ts-ignore ts-migrate(2322) FIXME: Type '{ pid: number; ppid?: number; uid?: number; ... Remove this comment to see the full error message
-  const matchingProcesses: Array<Process> = await find('pid', processId);
+  const matchingProcesses: Array<Process> = await wrappedFind('pid', processId);
   return matchingProcesses.length > 0 ? matchingProcesses[0] : Promise.reject();
 };
 export const getProcessName = async (processId: number) =>
@@ -24,7 +24,10 @@ export const getProcessesByName = async (
 ): Promise<Array<Process>> => {
   // finds running processes matching name
   // @ts-ignore ts-migrate(2322) FIXME: Type '{ pid: number; ppid?: number; uid?: number; ... Remove this comment to see the full error message
-  const matchingProcesses: Array<Process> = await find('name', processName);
+  const matchingProcesses: Array<Process> = await wrappedFind(
+    'name',
+    processName
+  );
   return matchingProcesses;
 };
 export const getProcess = async (
@@ -34,15 +37,21 @@ export const getProcess = async (
   try {
     // finds running processes matching PID
     // @ts-ignore ts-migrate(2322) FIXME: Type '{ pid: number; ppid?: number; uid?: number; ... Remove this comment to see the full error message
-    const matchingProcesses: Array<Process> = await find('pid', processId);
+    const matchingProcesses: Array<Process> = await wrappedFind(
+      'pid',
+      processId
+    );
     // no processes exist with a matching PID
     if (!matchingProcesses.length) return null;
     // Return first matching process if names match
     const previousProcess: Process = matchingProcesses[0];
 
     if (isObject(previousProcess)) {
       const binPathSegments = previousProcess.bin.split(path.sep);
-      const exeName = binPathSegments.length > 0 ? binPathSegments[binPathSegments.length - 1] : previousProcess.bin;
+      const exeName =
+        binPathSegments.length > 0
+          ? binPathSegments[binPathSegments.length - 1]
+          : previousProcess.bin;
       if (exeName === processName || previousProcess.name === processName) {
         return previousProcess;
       }
@@ -54,3 +63,39 @@ export const getProcess = async (
     return null;
   }
 };
+
+/**
+ * Like `find from 'find-process'`, but wraps the execution into setting locale to C (available anywhere).
+ *
+ * Inside Nix chroot for Linux installation, it is possible there will not be locale definitions for user’s LC_ALL,
+ * which variable is inherited by the chroot from user’s regular system.
+ *
+ * Unfortunately, `/bin/sh` inside the Nix chroot outputs warnings to `stderr` about missing locales then.
+ *
+ * Then, `find-process` interprets non-empty stderr as some error, and throws.
+ *
+ * Another solution would be to patch `find-process` to construct the `ps` invocation itself, not using `/bin/sh`
+ * for that (i.e. `exec('ps', 'aux')` instead of `exec('ps aux')` which is really `exec('/bin/sh', '-c', 'ps aux')`.
+ */
+const wrappedFind = async (
+  type: 'name' | 'pid' | 'port',
+  value: string | number | RegExp,
+  strict?: boolean
+): Promise<
+  {
+    pid: number;
+    ppid?: number;
+    uid?: number;
+    gid?: number;
+    name: string;
+    cmd: string;
+  }[]
+> => {
+  const previousLocale = process.env.LC_ALL;
+  process.env.LC_ALL = 'C';
+  const rv = await find(type, value, strict);
+  if (typeof previousLocale !== 'undefined')
+    process.env.LC_ALL = previousLocale;
+  else delete process.env.LC_ALL;
+  return rv;
+};
