refactor: getLog(level) -> getLog({ level })

probot · Nov 20, 2020 · f50f68f · f50f68f
1 parent 7c46218
commit f50f68f
Show file tree

Hide file tree

Showing 7 changed files with 15 additions and 9 deletions.
diff --git a/src/application.ts b/src/application.ts
@@ -73,7 +73,9 @@ export class Application {
   private internalRouter: Router;
 
   constructor(options: Options) {
-    this.log = aliasLog(options.log || getLog(process.env.LOG_LEVEL));
+    this.log = aliasLog(
+      options.log || getLog({ level: process.env.LOG_LEVEL })
+    );
 
     this.log.warn(
       `[probot] "import { Application } from 'probot'" is deprecated. Use "import { Probot } from 'probot'" instead, the APIs are the same.`

diff --git a/src/helpers/get-log.ts b/src/helpers/get-log.ts
@@ -18,7 +18,11 @@ import pino from "pino";
 import type { LoggerOptions } from "pino";
 import { getTransformStream } from "@probot/pino";
 
-export function getLog(level: string = "info") {
+type Options = {
+  level?: string;
+};
+
+export function getLog({ level }: Options = { level: "info" }) {
   const pinoOptions: LoggerOptions = { level, name: "probot" };
   const transform = getTransformStream();
   transform.pipe(pino.destination(1));

diff --git a/src/helpers/log-warnings-for-obsolete-environment-variables.ts b/src/helpers/log-warnings-for-obsolete-environment-variables.ts
@@ -1,7 +1,7 @@
 import { getLog } from "./get-log";
 
 export function logWarningsForObsoleteEnvironmentVariables() {
-  const log = getLog(process.env.LOG_LEVEL);
+  const log = getLog({ level: process.env.LOG_LEVEL });
 
   // TODO: remove deprecation warning in v11
   if ("DISABLE_STATS" in process.env) {

diff --git a/src/index.ts b/src/index.ts
@@ -10,7 +10,7 @@ import { ProbotOctokit } from "./octokit/probot-octokit";
 import { run } from "./run";
 
 export const createProbot = (options: Options) => {
-  options.log = options.log || getLog(process.env.LOG_LEVEL);
+  options.log = options.log || getLog({ level: process.env.LOG_LEVEL });
   options.log.warn(
     new Deprecation(
       `[probot] "createProbot(options)" is deprecated, use "new Probot(options)" instead`

diff --git a/src/probot.ts b/src/probot.ts
@@ -35,7 +35,7 @@ const defaultAppFns: ApplicationFunction[] = [defaultApp];
 
 export class Probot {
   public static async run(appFn: ApplicationFunction | string[]) {
-    const log = getLog(process.env.LOG_LEVEL);
+    const log = getLog({ level: process.env.LOG_LEVEL });
     log.warn(
       new Deprecation(
         '[probot] "Probot.run" is deprecate. Import { run } from "probot" instead'
@@ -112,7 +112,7 @@ export class Probot {
       level = process.env.LOG_LEVEL as Options["logLevel"];
     }
 
-    this.log = aliasLog(options.log || getLog(level));
+    this.log = aliasLog(options.log || getLog({ level }));
 
     if (logEnvVariableDeprecation) {
       this.log.warn(logEnvVariableDeprecation);

diff --git a/test/server.test.ts b/test/server.test.ts
@@ -9,7 +9,7 @@ describe("server", () => {
 
   beforeEach(() => {
     webhook = jest.fn((req, res, next) => next());
-    server = createServer({ webhook, logger: getLog("fatal") });
+    server = createServer({ webhook, logger: getLog({ level: "fatal" }) });
 
     // Error handler to avoid printing logs
     server.use(

diff --git a/test/webhook-proxy.test.ts b/test/webhook-proxy.test.ts
@@ -46,7 +46,7 @@ describe("webhook-proxy", () => {
           url,
           port: targetPort,
           path: "/test",
-          logger: getLog("fatal"),
+          logger: getLog({ level: "fatal" }),
         })!;
 
         // Wait for proxy to be ready
@@ -74,7 +74,7 @@ describe("webhook-proxy", () => {
     const url = "http://bad.proxy/events";
     nock("http://bad.proxy").get("/events").reply(404);
 
-    const log = getLog("fatal").child({});
+    const log = getLog({ level: "fatal" }).child({});
     log.error = jest.fn();
 
     proxy = createWebhookProxy({ url, logger: log })!;