feat: improve cli output when building project [fixes DXJ-406] (#317)

* feat: improve cli output when building project [fixes DXJ-406] * fix review * fix review * remove --sk replacement * add variable for exit code message * remove additional instanceof check * use instance of for errors * restore chmod
fluencelabs · Jul 4, 2023 · 1da1fb0 · 1da1fb0
1 parent 8decf46
commit 1da1fb0
Show file tree

Hide file tree

Showing 12 changed files with 93 additions and 68 deletions.
diff --git a/package.json b/package.json
@@ -164,6 +164,9 @@
       "unused-imports"
     ],
     "rules": {
+      "no-console": [
+        "error"
+      ],
       "arrow-body-style": [
         "error",
         "always"

diff --git a/src/beforeBuild.ts b/src/beforeBuild.ts
@@ -132,7 +132,7 @@ const compileInstallationSpellAqua = async (tracing = false) => {
   );
 };
 
-(async () => {
+void (async () => {
   await rm(VERSIONS_DIR_PATH, { recursive: true, force: true });
   await mkdir(VERSIONS_DIR_PATH, { recursive: true });
   await cp("package.json", join(VERSIONS_DIR_PATH, "cli.package.json"));
@@ -151,6 +151,4 @@ const compileInstallationSpellAqua = async (tracing = false) => {
 
   await compileInstallationSpellAqua();
   await compileInstallationSpellAqua(true);
-})().catch((e) => {
-  return console.error(e);
-});
+})();
diff --git a/src/commands/run.ts b/src/commands/run.ts
@@ -220,6 +220,9 @@ export default class Run extends BaseCommand<typeof Run> {
       typeof result === "string" ? result : jsonStringify(result);
 
     if (stringResult !== undefined) {
+      // If `--quite` flag is used then commandObj.log does nothing
+      // So we use console.log here instead
+      // eslint-disable-next-line no-console
       console.log(stringResult);
     }
 

diff --git a/src/countlyInterceptor.js b/src/countlyInterceptor.js
@@ -53,8 +53,10 @@ const ERROR_HANDLED_BY_OCLIF_KEY = "errorHandledByOclif";
  */
 export const createErrorPromise = (error) => {
   if (error instanceof CLIError) {
+    // eslint-disable-next-line no-console
     console.error(`Error: ${error.message}`);
   } else {
+    // eslint-disable-next-line no-console
     console.error(error);
   }
 
@@ -81,6 +83,7 @@ export const createErrorPromise = (error) => {
 
   return new Promise(() => {
     setTimeout(() => {
+      // eslint-disable-next-line no-console
       console.log(
         "\nWasn't able to report this crash to Fluence Team. Please report it manually to https://github.com/fluencelabs/fluence-cli/issues"
       );

diff --git a/src/genConfigDocs.ts b/src/genConfigDocs.ts
@@ -104,4 +104,4 @@ ${schemas
   );
 };
 
-main().catch(console.error);
+void main();
diff --git a/src/lib/execPromise.ts b/src/lib/execPromise.ts
@@ -17,16 +17,20 @@
 import { spawn } from "node:child_process";
 
 import oclifColor from "@oclif/color";
-import { CLIError } from "@oclif/core/lib/errors/index.js";
-
 const color = oclifColor.default;
+import { CLIError } from "@oclif/core/lib/errors/index.js";
 
-import { IS_DEVELOPMENT, MARINE_CARGO_DEPENDENCY } from "./const.js";
+import { isInteractive } from "./commandObj.js";
+import { MARINE_CARGO_DEPENDENCY } from "./const.js";
 import { type Flags, flagsToArgs } from "./helpers/flagsToArgs.js";
 import { startSpinner, stopSpinner } from "./helpers/spinner.js";
 
 type SpawnParams = Parameters<typeof spawn>;
 
+const getErrorMessage = (printOutput: boolean, stderr: string) => {
+  return printOutput ? "" : `. Reason:\n${stderr}`;
+};
+
 export type ExecPromiseArg = {
   command: SpawnParams[0];
   args?: SpawnParams[1] | undefined;
@@ -37,33 +41,32 @@ export type ExecPromiseArg = {
   printOutput?: boolean | undefined;
 };
 
-export const execPromise = ({
+export const execPromise = async ({
   command,
   args,
   flags,
   options,
   spinnerMessage,
   timeout,
-  printOutput = false,
+  printOutput: printOutputArg = false,
 }: ExecPromiseArg): Promise<string> => {
+  const printOutput = isInteractive ? printOutputArg : false;
   const flagArgs = flags === undefined ? [] : flagsToArgs(flags);
   const allArgs = [...(args ?? []), ...flagArgs];
   const fullCommand = [command, ...allArgs].join(" ");
 
-  const commandToDisplay = IS_DEVELOPMENT
-    ? fullCommand
-    : fullCommand.replace(
-        /([\S\s]*--sk ).*([\S\s]*)/,
-        "$1<SECRET_KEY_IS_HIDDEN>$2"
-      );
+  const getCommandFailedMessage = (code: number | null = null) => {
+    const exitCodeMessage =
+      code === null ? "failed" : `exited with code ${code}`;
+
+    return `Command: ${color.yellow(fullCommand)} ${exitCodeMessage}`;
+  };
 
   if (typeof spinnerMessage === "string") {
     startSpinner(spinnerMessage);
   }
 
-  const debugInfo = `Debug info:\n${commandToDisplay}\n`;
-
-  return new Promise<string>((res, rej): void => {
+  const result = await new Promise<CLIError | Error | string>((res): void => {
     const execTimeout =
       timeout !== undefined &&
       setTimeout((): void => {
@@ -72,12 +75,13 @@ export const execPromise = ({
         }
 
         childProcess.kill();
+        const commandFailedMessage = getCommandFailedMessage();
 
-        rej(
+        res(
           new Error(
-            `Execution timed out: command didn't yield any result in ${color.yellow(
+            `${commandFailedMessage}. Reason: Execution timed out: command didn't yield any result in ${color.yellow(
               `${timeout}ms`
-            )}\n${debugInfo}`
+            )}`
           )
         );
       }, timeout);
@@ -111,7 +115,9 @@ export const execPromise = ({
         stopSpinner(color.red("failed"));
       }
 
-      rej(new Error(`${printOutput ? "" : stderr}${error}\n${debugInfo}`));
+      const commandFailedMessage = getCommandFailedMessage();
+      const errorMessage = getErrorMessage(printOutput, stderr);
+      res(new Error(`${commandFailedMessage}${errorMessage}${error}`));
     });
 
     childProcess.on("close", (code): void => {
@@ -126,32 +132,31 @@ export const execPromise = ({
       }
 
       if (stderr.includes("linker `cc` not found")) {
-        rej(
-          new CLIError(
-            `\n${color.yellow(MARINE_CARGO_DEPENDENCY)} requires ${color.yellow(
-              "build-essential"
-            )} to be installed. Please install it and try again.\nOn debian-based systems (e.g. Ubuntu) you can install it using this command:\n\n${color.yellow(
-              "sudo apt install build-essential"
-            )}\n`
-          )
-        );
-
+        const expectedErrorMessage = `\n${color.yellow(
+          MARINE_CARGO_DEPENDENCY
+        )} requires ${color.yellow(
+          "build-essential"
+        )} to be installed. Please install it and try again.\nOn debian-based systems (e.g. Ubuntu) you can install it using this command:\n\n${color.yellow(
+          "sudo apt install build-essential"
+        )}\n`;
+
+        res(new CLIError(expectedErrorMessage));
         return;
       }
 
       if (code !== 0) {
-        rej(
-          new Error(
-            `${printOutput ? "" : stderr}\nprocess exited${
-              code === null ? "" : ` with code ${code}`
-            }\n${debugInfo}`
-          )
-        );
-
-        return;
+        const commandFailedMessage = getCommandFailedMessage(code);
+        const errorMessage = getErrorMessage(printOutput, stderr);
+        res(new Error(`${commandFailedMessage}${errorMessage}`));
       }
 
       res(stdout);
     });
   });
+
+  if (result instanceof Error) {
+    throw result;
+  }
+
+  return result;
 };
diff --git a/src/lib/helpers/logAndFail.ts b/src/lib/helpers/logAndFail.ts
@@ -15,6 +15,7 @@
  */
 
 export const logAndFail = (unknown: unknown): never => {
+  // eslint-disable-next-line no-console
   console.log(unknown);
   throw new Error("Failed after console.log");
 };
diff --git a/src/lib/marineCli.ts b/src/lib/marineCli.ts
@@ -16,12 +16,13 @@
 
 import { join } from "node:path";
 
+import { commandObj } from "./commandObj.js";
 import type { FluenceConfig } from "./configs/project/fluence.js";
 import { BIN_DIR_NAME, MARINE_CARGO_DEPENDENCY } from "./const.js";
 import { execPromise } from "./execPromise.js";
 import { getMessageWithKeyValuePairs } from "./helpers/getMessageWithKeyValuePairs.js";
 import { ensureCargoDependency } from "./rust.js";
-import type { Flags } from "./typeHelpers.js";
+import { type Flags } from "./typeHelpers.js";
 
 type MarineCliInput =
   | {
@@ -62,16 +63,26 @@ export const initMarineCli = async (
     cwd,
     printOutput = true,
   }): Promise<string> => {
-    return execPromise({
-      command: marineCLIPath,
-      args,
-      flags,
-      spinnerMessage:
+    try {
+      const spinnerMessage =
         message === undefined
           ? undefined
-          : getMessageWithKeyValuePairs(message, keyValuePairs),
-      options: { cwd },
-      printOutput,
-    });
+          : getMessageWithKeyValuePairs(message, keyValuePairs);
+
+      return await execPromise({
+        command: marineCLIPath,
+        args,
+        flags,
+        spinnerMessage,
+        options: { cwd },
+        printOutput,
+      });
+    } catch (e) {
+      if (e instanceof Error) {
+        return commandObj.error(e.message);
+      }
+
+      throw e;
+    }
   };
 };
diff --git a/src/lib/rust.ts b/src/lib/rust.ts
@@ -33,6 +33,7 @@ import {
 import { addCountlyLog } from "./countly.js";
 import { execPromise } from "./execPromise.js";
 import { downloadFile } from "./helpers/downloadFile.js";
+import { jsonStringify } from "./helpers/jsonStringify.js";
 import {
   handleInstallation,
   resolveDependencies,
@@ -43,7 +44,6 @@ import {
 } from "./helpers/package.js";
 import { replaceHomeDir } from "./helpers/replaceHomeDir.js";
 import { startSpinner, stopSpinner } from "./helpers/spinner.js";
-import { hasKey, isObject } from "./typeHelpers.js";
 
 const CARGO = "cargo";
 const RUSTUP = "rustup";
@@ -285,10 +285,19 @@ const tryDownloadingBinary = async ({
 
   const url = `https://github.com/fluencelabs/marine/releases/download/${name}-v${version}/${name}-${platformToUse}-x86_64`;
 
+  startSpinner(
+    `Downloading ${name}@${version} binary to ${replaceHomeDir(
+      dependencyDirPath
+    )}`
+  );
+
   try {
     await downloadFile(binaryPath, url);
-  } catch {
-    return `Failed to download ${name}@${version} from ${url}`;
+    stopSpinner();
+  } catch (e) {
+    stopSpinner("failed");
+    const error = e instanceof Error ? e.message : jsonStringify(e);
+    return `Failed to download ${name}@${version} from ${url}. Error: ${error}`;
   }
 
   try {
@@ -311,12 +320,7 @@ const tryDownloadingBinary = async ({
       return `Downloaded ${name}@${version} binary at ${binaryPath} --help message does not contain the ${version} version it is supposed to contain:\n result of --help execution is: ${helpText}`;
     }
   } catch (e) {
-    if (
-      isObject(e) &&
-      hasKey("message", e) &&
-      typeof e["message"] === "string" &&
-      e["message"].includes(version)
-    ) {
+    if (e instanceof Error && e.message.includes(version)) {
       return true;
     }
 
@@ -369,10 +373,6 @@ export const ensureCargoDependency = async ({
       version,
     });
 
-  startSpinner(
-    `Installing ${name}@${version} to ${replaceHomeDir(dependencyDirPath)}`
-  );
-
   const maybeErrorMessage = await tryDownloadingBinary({
     name,
     version,
@@ -404,8 +404,6 @@ export const ensureCargoDependency = async ({
     });
   }
 
-  stopSpinner();
-
   await updateConfigsIfVersionChanged({
     maybeFluenceConfig,
     name,

diff --git a/test/helpers.ts b/test/helpers.ts
@@ -103,8 +103,8 @@ export const initFirstTime = async (template: Template) => {
     }
   }
 
+  // eslint-disable-next-line no-console
   console.log(`Initialized template "${template}"`);
-
   return templatePath;
 };
 

diff --git a/test/integration.test.ts b/test/integration.test.ts
@@ -47,6 +47,7 @@ describe("integration tests", () => {
       // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
       {
         log(msg: string) {
+          // eslint-disable-next-line no-console
           console.log(msg);
         },
         error(msg: string) {

diff --git a/test/setupTests.ts b/test/setupTests.ts
@@ -20,6 +20,7 @@ import "../src/lib/setupEnvironment.js";
 import { fluence, initFirstTime } from "./helpers.js";
 
 (async (): Promise<void> => {
+  // eslint-disable-next-line no-console
   console.log("Setting up tests...");
 
   await fluence({
@@ -32,6 +33,7 @@ import { fluence, initFirstTime } from "./helpers.js";
     })
   );
 
+  // eslint-disable-next-line no-console
   console.log("Tests are ready to run!");
 })().catch((error) => {
   throw error;