Merge pull request #11 from codemagic-ci-cd/hermes

Reduce Hermes log noise during release-react

Author: kmsbernard

script/react-native-utils.ts

@@ -1,5 +1,4 @@
 import * as fs from "fs";
-import * as chalk from "chalk";
 import * as path from "path";
 import * as childProcess from "child_process";
 import { coerce, compare, valid } from "semver";
@@ -12,6 +11,11 @@ export function isValidVersion(version: string): boolean {
   return !!valid(version) || /^\d+\.\d+$/.test(version);
 }
 
+function formatProcessOutput(label: string, output: string): string {
+  const trimmedOutput = output.trim();
+  return trimmedOutput ? `\n${label}:\n${trimmedOutput}` : "";
+}
+
 export async function runHermesEmitBinaryCommand(
   bundleName: string,
   outputFolder: string,
@@ -33,20 +37,21 @@ export async function runHermesEmitBinaryCommand(
     hermesArgs.push("-output-source-map");
   }
 
-  console.log(chalk.cyan("Converting JS bundle to byte code via Hermes, running command:\n"));
   const hermesCommand = await getHermesCommand(gradleFile);
   const hermesProcess = childProcess.spawn(hermesCommand, hermesArgs);
-  console.log(`${hermesCommand} ${hermesArgs.join(" ")}`);
+  const hermesCommandLine = `${hermesCommand} ${hermesArgs.join(" ")}`;
+  let hermesStdout = "";
+  let hermesStderr = "";
 
   return new Promise<void>((resolve, reject) => {
     let hermesProcessError: Error = null;
 
     hermesProcess.stdout.on("data", (data: Buffer) => {
-      console.log(data.toString().trim());
+      hermesStdout += data.toString();
     });
 
     hermesProcess.stderr.on("data", (data: Buffer) => {
-      console.error(data.toString().trim());
+      hermesStderr += data.toString();
     });
 
     hermesProcess.on("error", (err: Error) => {
@@ -60,7 +65,14 @@ export async function runHermesEmitBinaryCommand(
       }
 
       if (exitCode !== 0) {
-        reject(new Error(`"hermes" command failed (exitCode=${exitCode}, signal=${signal}).`));
+        reject(
+          new Error(
+            `"hermes" command failed (exitCode=${exitCode}, signal=${signal}).` +
+              `\nCommand:\n${hermesCommandLine}` +
+              formatProcessOutput("Hermes stdout", hermesStdout) +
+              formatProcessOutput("Hermes stderr", hermesStderr)
+          )
+        );
         return;
       }
 

test/react-native-utils.ts

@@ -7,6 +7,7 @@ import * as fs from "fs";
 import * as os from "os";
 import * as path from "path";
 import * as sinon from "sinon";
+import { EventEmitter } from "events";
 import { getAndroidHermesEnabled, getiOSHermesEnabled, runHermesEmitBinaryCommand } from "../script/react-native-utils";
 
 function getHermesOSBin(): string {
@@ -259,6 +260,83 @@ android {
     assert.equal(fs.readFileSync(path.join(outputFolder, bundleName), "utf-8"), "compiled hermes bundle");
   });
 
+  it("keeps Hermes compiler output quiet when compilation succeeds", async (): Promise<void> => {
+    writeReactNativeProject(projectPath, "0.84.1");
+
+    const hermesCompilerPath = path.join(
+      "node_modules",
+      "hermes-compiler",
+      "hermesc",
+      getHermesOSBin(),
+      getHermesCompilerExe()
+    );
+    writeFile(path.join(projectPath, hermesCompilerPath));
+
+    const outputFolder = path.join(projectPath, "CodePush");
+    const bundleName = "index.android.bundle";
+    writeFile(path.join(outputFolder, bundleName), "plain js bundle");
+
+    const consoleLog = sandbox.stub(console, "log");
+    const consoleError = sandbox.stub(console, "error");
+    sandbox.stub(childProcess, "spawn").callsFake((command: string, args: string[]): any => {
+      const outputIndex = args.indexOf("-out");
+      fs.writeFileSync(args[outputIndex + 1], "compiled hermes bundle");
+
+      const hermesProcess = new EventEmitter() as any;
+      hermesProcess.stdout = new EventEmitter();
+      hermesProcess.stderr = new EventEmitter();
+
+      setImmediate(() => {
+        hermesProcess.stdout.emit("data", Buffer.from("verbose stdout\n"));
+        hermesProcess.stderr.emit("data", Buffer.from("verbose stderr\n"));
+        hermesProcess.emit("close", 0, null);
+      });
+
+      return hermesProcess;
+    });
+
+    await runHermesEmitBinaryCommand(bundleName, outputFolder, null, [], null);
+
+    sinon.assert.notCalled(consoleLog);
+    sinon.assert.notCalled(consoleError);
+  });
+
+  it("includes buffered Hermes compiler output when compilation fails", async (): Promise<void> => {
+    writeReactNativeProject(projectPath, "0.84.1");
+
+    const hermesCompilerPath = path.join(
+      "node_modules",
+      "hermes-compiler",
+      "hermesc",
+      getHermesOSBin(),
+      getHermesCompilerExe()
+    );
+    writeFile(path.join(projectPath, hermesCompilerPath));
+
+    const outputFolder = path.join(projectPath, "CodePush");
+    const bundleName = "index.android.bundle";
+    writeFile(path.join(outputFolder, bundleName), "plain js bundle");
+
+    sandbox.stub(childProcess, "spawn").callsFake((): any => {
+      const hermesProcess = new EventEmitter() as any;
+      hermesProcess.stdout = new EventEmitter();
+      hermesProcess.stderr = new EventEmitter();
+
+      setImmediate(() => {
+        hermesProcess.stdout.emit("data", Buffer.from("useful stdout\n"));
+        hermesProcess.stderr.emit("data", Buffer.from("useful stderr\n"));
+        hermesProcess.emit("close", 1, null);
+      });
+
+      return hermesProcess;
+    });
+
+    await assert.rejects(
+      () => runHermesEmitBinaryCommand(bundleName, outputFolder, null, [], null),
+      /Hermes stdout:\nuseful stdout[\s\S]*Hermes stderr:\nuseful stderr/
+    );
+  });
+
   it("uses explicit Gradle hermesCommand before package autodetection", async (): Promise<void> => {
     writeReactNativeProject(projectPath, "0.84.1");
     const customHermesCommand = path.join("..", "..", "custom-hermes", "%OS-BIN%", getHermesCompilerExe());