Merge pull request #335 from tsedio/feat-detach-logger-from-listr

Feat detach logger from listr
tsedio · Jul 7, 2023 · 67121ef · 67121ef
2 parents f83db81 + cb4e53b
commit 67121ef
Show file tree

Hide file tree

Showing 20 changed files with 146 additions and 48 deletions.
diff --git a/packages/cli-core/jest.config.js b/packages/cli-core/jest.config.js
@@ -9,10 +9,10 @@ module.exports = {
   },
   coverageThreshold: {
     global: {
-      statements: 71.19,
-      branches: 73.06,
+      statements: 71.23,
+      branches: 72.81,
       functions: 48.9,
-      lines: 71.19
+      lines: 71.23
     }
   },
 };
diff --git a/packages/cli-core/src/CliCore.spec.ts b/packages/cli-core/src/CliCore.spec.ts
@@ -1,10 +1,14 @@
 import {CliCore} from "./CliCore";
 import {CliService} from "./services";
 import {normalizePath} from "@tsed/normalize-path";
+import execa from "execa";
 
 jest.mock("./utils/loadPlugins");
-
+jest.mock("execa");
 describe("CliCore", () => {
+  beforeEach(() => {
+    (execa as any as jest.Mock).mockReturnValue({});
+  });
   describe("getProjectRoot()", () => {
     it("should return project root (-r)", () => {
       // eslint-disable-next-line @typescript-eslint/ban-ts-comment

diff --git a/packages/cli-core/src/interfaces/CommandMetadata.ts b/packages/cli-core/src/interfaces/CommandMetadata.ts
@@ -19,4 +19,6 @@ export interface CommandMetadata extends CommandParameters {
   enableFeatures: string[];
 
   disableReadUpPkg: boolean;
+
+  bindLogger: boolean;
 }
diff --git a/packages/cli-core/src/interfaces/Tasks.ts b/packages/cli-core/src/interfaces/Tasks.ts
@@ -3,6 +3,7 @@ import {ListrContext, ListrOptions, ListrTask} from "listr2";
 export interface TaskOptions<Ctx = ListrContext> extends ListrOptions<Ctx> {
   concurrent?: boolean | number;
   verbose?: boolean;
+  bindLogger?: boolean;
 }
 
 export type Task = ListrTask<any, any>;

diff --git a/packages/cli-core/src/services/CliHttpClient.spec.ts b/packages/cli-core/src/services/CliHttpClient.spec.ts
@@ -1,12 +1,30 @@
 import axios from "axios";
 import {DITest} from "@tsed/di";
 import {CliHttpClient} from "./CliHttpClient";
+import {CliProxyAgent} from "./CliProxyAgent";
 
 jest.mock("axios");
 describe("CliHttpClient", () => {
   beforeEach(() => DITest.create());
   afterEach(() => DITest.reset());
 
+  describe("$afterInit()", () => {
+    it("should call $afterInit method", async () => {
+      const cliProxyAgent = {
+        resolveProxySettings: jest.fn()
+      };
+      const client = await DITest.invoke<CliHttpClient>(CliHttpClient, [
+        {
+          token: CliProxyAgent,
+          use: cliProxyAgent
+        }
+      ]);
+
+      await client.$afterInit();
+
+      expect(cliProxyAgent.resolveProxySettings).toHaveBeenCalled();
+    });
+  });
   describe("head()", () => {
     it("should call head method", async () => {
       // GIVEN

diff --git a/packages/cli-core/src/services/CliHttpClient.ts b/packages/cli-core/src/services/CliHttpClient.ts
@@ -22,7 +22,7 @@ export class CliHttpClient extends CliHttpLogClient {
     return stringify(cleanObject(params));
   }
 
-  async $onInit() {
+  async $afterInit() {
     await this.cliProxyAgent.resolveProxySettings();
   }
 

diff --git a/packages/cli-core/src/services/CliPlugins.ts b/packages/cli-core/src/services/CliPlugins.ts
@@ -48,7 +48,9 @@ export class CliPlugins {
     const tasks = plugins.map((plugin) => {
       return {
         title: `Run plugin '${chalk.cyan(plugin)}'`,
-        task: () => this.cliHooks.emit(CommandStoreKeys.ADD, plugin, ctx)
+        task: () => {
+          return this.cliHooks.emit(CommandStoreKeys.ADD, plugin, ctx);
+        }
       };
     });
 

diff --git a/packages/cli-core/src/services/CliProxyAgent.spec.ts b/packages/cli-core/src/services/CliProxyAgent.spec.ts
@@ -110,7 +110,7 @@ describe("CliPlugins", () => {
 
         expect(cliProxyAgent.proxySettings).toEqual({
           url: "https://login:password@host:3000",
-          strictSsl: false
+          strictSsl: true
         });
       });
       it("should get proxy url from (https-proxy)", async () => {
@@ -143,7 +143,7 @@ describe("CliPlugins", () => {
 
         expect(cliProxyAgent.proxySettings).toEqual({
           url: "https://login:password@host:3000",
-          strictSsl: false
+          strictSsl: true
         });
       });
       it("should get proxy url from (https-proxy) without credentials", async () => {
@@ -176,7 +176,7 @@ describe("CliPlugins", () => {
 
         expect(cliProxyAgent.proxySettings).toEqual({
           url: "https://host:3000",
-          strictSsl: false
+          strictSsl: true
         });
       });
     });

diff --git a/packages/cli-core/src/services/CliProxyAgent.ts b/packages/cli-core/src/services/CliProxyAgent.ts
@@ -3,31 +3,13 @@ import {Configuration, Inject, Injectable, Value} from "@tsed/di";
 import {CliExeca} from "./CliExeca";
 import {camelCase} from "change-case";
 import {URL} from "url";
+import {coerce} from "../utils/coerce";
 
 export interface CliProxySettings {
   url: string;
   strictSsl: boolean;
 }
 
-function cast(value: any) {
-  if (["undefined"].includes(value)) {
-    return undefined;
-  }
-  if (["null"].includes(value)) {
-    return null;
-  }
-
-  if (["false"].includes(value)) {
-    return false;
-  }
-
-  if (["true"].includes(value)) {
-    return false;
-  }
-
-  return value;
-}
-
 @Injectable()
 @Configuration({
   proxy: {
@@ -72,7 +54,9 @@ export class CliProxyAgent {
   }
 
   async resolveProxySettings(): Promise<void> {
-    if (this.hasProxy()) {
+    const hasProxy = this.hasProxy();
+
+    if (hasProxy) {
       return;
     }
 
@@ -83,13 +67,13 @@ export class CliProxyAgent {
       this.cliExeca.getAsync("npm", ["config", "get", "strict-ssl"])
     ]);
 
-    const [proxy, httpProxy, httpsProxy, strictSsl] = result.map(cast);
+    const [proxy, httpProxy, httpsProxy, strictSsl] = result.map(coerce);
     const url = httpsProxy || httpProxy || proxy;
 
     if (url) {
       this.proxySettings = {
         url,
-        strictSsl: cast(strictSsl) !== false
+        strictSsl: coerce(strictSsl) !== false
       };
     }
   }

diff --git a/packages/cli-core/src/services/CliService.ts b/packages/cli-core/src/services/CliService.ts
@@ -257,6 +257,8 @@ export class CliService {
       this.injector.logger.level = "info";
     }
 
+    data.bindLogger = $ctx.get("command").bindLogger;
+
     $ctx.set("data", data);
 
     return data;

diff --git a/packages/cli-core/src/utils/coerce.spec.ts b/packages/cli-core/src/utils/coerce.spec.ts
@@ -0,0 +1,11 @@
+import {coerce} from "./coerce";
+
+describe("coerce", () => {
+  it("should coerce given value", () => {
+    expect(coerce("undefined")).toBeUndefined();
+    expect(coerce("null")).toBeNull();
+    expect(coerce("false")).toBe(false);
+    expect(coerce("true")).toBe(true);
+    expect(coerce("")).toBe("");
+  });
+});
diff --git a/packages/cli-core/src/utils/coerce.ts b/packages/cli-core/src/utils/coerce.ts
@@ -0,0 +1,18 @@
+export function coerce(value: any) {
+  if (["undefined"].includes(value)) {
+    return undefined;
+  }
+  if (["null"].includes(value)) {
+    return null;
+  }
+
+  if (["false"].includes(value)) {
+    return false;
+  }
+
+  if (["true"].includes(value)) {
+    return true;
+  }
+
+  return value;
+}
diff --git a/packages/cli-core/src/utils/createTasksRunner.ts b/packages/cli-core/src/utils/createTasksRunner.ts
@@ -37,13 +37,14 @@ class CustomLogger extends Logger {
   }
 }
 
-function getOptions(ctx: TaskOptions): any {
+function getOptions({bindLogger = true, ...ctx}: TaskOptions): any {
   const useRawRenderer = !(!ctx.verbose && !process.env.CI);
-  const rendererOptions = useRawRenderer
-    ? {
-        logger: CustomLogger
-      }
-    : {};
+  const rendererOptions =
+    useRawRenderer && bindLogger
+      ? {
+          logger: CustomLogger
+        }
+      : {};
   return {
     ...ctx,
     rendererSilent: process.env.NODE_ENV === "test",

diff --git a/packages/cli-core/src/utils/getCommandMetadata.spec.ts b/packages/cli-core/src/utils/getCommandMetadata.spec.ts
@@ -8,6 +8,14 @@ import {getCommandMetadata} from "./getCommandMetadata";
 })
 class TestCmd {}
 
+@Command({
+  name: "name",
+  description: "description",
+  alias: "g",
+  bindLogger: false
+})
+class TestCmd2 {}
+
 describe("getCommandMetadata", () => {
   it("should return command metadata", () => {
     expect(getCommandMetadata(TestCmd)).toEqual({
@@ -18,6 +26,19 @@ describe("getCommandMetadata", () => {
       alias: "g",
       disableReadUpPkg: false,
       enableFeatures: [],
+      bindLogger: true,
+      options: {}
+    });
+
+    expect(getCommandMetadata(TestCmd2)).toEqual({
+      args: {},
+      allowUnknownOption: false,
+      description: "description",
+      name: "name",
+      alias: "g",
+      disableReadUpPkg: false,
+      enableFeatures: [],
+      bindLogger: false,
       options: {}
     });
   });

diff --git a/packages/cli-core/src/utils/getCommandMetadata.ts b/packages/cli-core/src/utils/getCommandMetadata.ts
@@ -13,6 +13,7 @@ export function getCommandMetadata(token: Type<any>): CommandMetadata {
     options = {},
     enableFeatures,
     disableReadUpPkg,
+    bindLogger = true,
     ...opts
   } = Store.from(token)?.get(CommandStoreKeys.COMMAND) as CommandParameters;
 
@@ -25,6 +26,7 @@ export function getCommandMetadata(token: Type<any>): CommandMetadata {
     allowUnknownOption: !!allowUnknownOption,
     enableFeatures: enableFeatures || [],
     disableReadUpPkg: !!disableReadUpPkg,
+    bindLogger,
     ...opts
   };
 }
diff --git a/packages/cli-core/test/integrations/command.integration.spec.ts b/packages/cli-core/test/integrations/command.integration.spec.ts
@@ -1,6 +1,12 @@
 import {CliCore, Command, CommandProvider, Tasks} from "../../src";
+import execa from "execa";
+
+jest.mock("execa")
 
 describe("Command", () => {
+  beforeEach(() => {
+    (execa as any as jest.Mock).mockReturnValue({})
+  })
   it("should exec a command with expected parsed argument", async () => {
     @Command({
       name: "test",
@@ -33,6 +39,7 @@ describe("Command", () => {
     })
 
     expect(TestCommand.prototype.$exec).toHaveBeenCalledWith({
+      "bindLogger": true,
       "command": "subcmd",
       "rawArgs": [],
       "rootDir": undefined,

diff --git a/packages/cli/jest.config.js b/packages/cli/jest.config.js
@@ -8,8 +8,8 @@ module.exports = {
   coverageThreshold: {
     global: {
       statements: 91.69,
-      branches: 78.54,
-      functions: 75.94,
+      branches: 78.62,
+      functions: 76.25,
       lines: 91.69
     }
   }

diff --git a/packages/cli/package.json b/packages/cli/package.json
@@ -20,6 +20,7 @@
     "start:version": "cross-env NODE_ENV=development ts-node -r tsconfig-paths/register src/bin/tsed.ts --version",
     "start:init:help": "cross-env NODE_ENV=development ts-node -r tsconfig-paths/register src/bin/tsed.ts init -h",
     "start:init:test": "cross-env NODE_ENV=development cross-env CI=true ts-node -r tsconfig-paths/register src/bin/tsed.ts init -r ./.tmp/init/default --features=oidc --arch=default --convention=conv_default --platform=express --skip-prompt .",
+    "start:init:test:jest": "cross-env NODE_ENV=development cross-env CI=true ts-node -r tsconfig-paths/register src/bin/tsed.ts init -r ./.tmp/init/default --features=jest --arch=default --convention=conv_default --platform=express --skip-prompt .",
     "start:init:run": "cross-env NODE_ENV=development cross-env CI=true ts-node -r tsconfig-paths/register src/bin/tsed.ts init -r ./.tmp/init/default",
     "start:init:params": "cross-env NODE_ENV=development cross-env CI=true ts-node -r tsconfig-paths/register src/bin/tsed.ts init -r ./.tmp/init/default --skip-prompt --features swagger,jest,lintstaged",
     "start:init:run:name": "cross-env NODE_ENV=development ts-node -r tsconfig-paths/register src/bin/tsed.ts init -r ./.tmp/init awesome --verbose",
@@ -88,4 +89,4 @@
     "jest": "29.5.0"
   },
   "peerDependencies": {}
-}
+}
diff --git a/packages/cli/src/commands/init/InitCmd.ts b/packages/cli/src/commands/init/InitCmd.ts
@@ -244,7 +244,7 @@ export class InitCmd implements CommandProvider {
         },
         {
           title: "Install plugins dependencies",
-          task: createSubTasks(this.cliPlugins.addPluginsDependencies(ctx), {...ctx, concurrent: false})
+          task: createSubTasks(() => this.cliPlugins.addPluginsDependencies(ctx), {...ctx, concurrent: false})
         }
       ],
       ctx