fix: revert to working binaries, add binaries error logging (#229)

README.md

@@ -12,7 +12,7 @@ To build native binaries from source files, execute the gulp task corresponding
 'buildMac'
 'buildLinux'
 ```
-Note that the application for a particular platform must be built on a machine with the same platform.
+**Important note**: The application for a particular platform must be built on a machine with the same platform. Since this package can be used on old OS version such as NodeJS 16 docker container, it is important to build binaries on the old OS version for the binaries to contain corresponding dependencies(for example glibc-2.31 for node16 docker image).
 
 The *bin* directory contains pre-built native binaries. Consider using them if your contribution does not affect the native modules.
 

src/api/open.js

@@ -4,19 +4,9 @@ import OS from 'os-family';
 import { exec } from '../utils/exec';
 import exists from '../utils/fs-exists-promised';
 import { BrowserPathNotSetError, UnableToRunBrowsersError } from '../errors';
-import debug from 'debug';
-import { inspect } from 'util';
+import Logger from '../utils/logger';
 
-const LOGGER = debug('testcafe:browser-tools:open');
-
-function log (data) {
-    try {
-        LOGGER(inspect(data, { isTestCafeInspect: true, compact: false }));
-    }
-    catch (e) {
-        LOGGER(e.stack ? e.stack : String(e));
-    }
-}
+const logger = new Logger('testcafe:browser-tools:open');
 
 async function checkBrowserPath (browserInfo) {
     if (!browserInfo.path) {
@@ -84,11 +74,13 @@ export default async function (browserInfo, pageUrl) {
     var command = getOpenCommand(browserInfo, pageUrl);
 
     try {
-        log(command);
+        logger.log(command);
 
         await exec(command);
     }
     catch (err) {
+        logger.log(err);
+
         throw new UnableToRunBrowsersError({ path: browserInfo.path });
     }
 }

src/utils/exec.js

@@ -12,7 +12,9 @@ import BINARIES from '../binaries';
 import flattenWhitespace from './flatten-whitespace';
 import getEnvironmentVariable from './get-environment-variable';
 import { NativeBinaryHasFailedError } from '../errors';
+import Logger from './logger';
 
+const logger = new Logger('testcafe:browser-tools:exec');
 
 const EXIT_CODE_REGEXP = /Exit code: (-?\d+)/;
 
@@ -46,7 +48,6 @@ function getTempPipePath () {
 var execFilePromise = promisify(childProc.execFile);
 var execPromise     = promisify(childProc.exec);
 
-
 function readPipe (pipePath) {
     return new Promise((resolve, reject) => {
         let data     = '';
@@ -98,7 +99,7 @@ async function runWithMacApp (binaryPath, args) {
     try {
         const [data] = await Promise.all([
             readPipe(pipePath),
-            spawnApp(pipePath, binaryPath, args)
+            spawnApp(pipePath, binaryPath, args),
         ]);
 
         const exitCodeMatch = data.match(EXIT_CODE_REGEXP);
@@ -127,6 +128,8 @@ export async function execFile (filePath, args) {
         return await execFilePromise(filePath, args);
     }
     catch (err) {
+        logger.log(err);
+
         if (err instanceof NativeBinaryHasFailedError)
             throw err;
 

src/utils/logger.js

@@ -0,0 +1,17 @@
+import debug from 'debug';
+import { inspect } from 'util';
+
+export default class Logger {
+    constructor (namespace) {
+        this.logger = debug(namespace);
+    }
+
+    log (data) {
+        try {
+            this.logger(inspect(data, { isTestCafeInspect: true, compact: false }));
+        }
+        catch (e) {
+            this.logger(e.stack ? e.stack : String(e));
+        }
+    }
+}