packages/test-utils: port logCollector to TS

2020-04-07 17:15:44 +02:00
parent 22d7fe5ac5
commit 742e94a754
2 changed files with 111 additions and 80 deletions
@@ -1,80 +0,0 @@
-/*
- * Copyright 2020 Spotify AB
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-/* eslint-disable no-console */
-/* eslint-disable no-param-reassign */
-
-// If the callback function is async this one will be too.
-export function withLogCollector(logsToCollect, callback) {
-  if (typeof logsToCollect === 'function') {
-    callback = logsToCollect;
-    logsToCollect = ['log', 'warn', 'error'];
-  }
-  const logs = {
-    log: [],
-    warn: [],
-    error: [],
-  };
-
-  const origLog = console.log;
-  const origWarn = console.warn;
-  const origError = console.error;
-
-  if (logsToCollect.includes('log')) {
-    console.log = message => {
-      logs.log.push(message);
-    };
-  }
-  if (logsToCollect.includes('warn')) {
-    console.warn = message => {
-      logs.warn.push(message);
-    };
-  }
-  if (logsToCollect.includes('error')) {
-    console.error = message => {
-      logs.error.push(message);
-    };
-  }
-
-  const restore = () => {
-    console.log = origLog;
-    console.warn = origWarn;
-    console.error = origError;
-  };
-
-  try {
-    const ret = callback();
-
-    if (!ret || !ret.then) {
-      restore();
-      return logs;
-    }
-
-    return ret.then(
-      () => {
-        restore();
-        return logs;
-      },
-      error => {
-        restore();
-        throw error;
-      },
-    );
-  } catch (error) {
-    restore();
-    throw error;
-  }
-}
@@ -0,0 +1,111 @@
+/*
+ * Copyright 2020 Spotify AB
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/* eslint-disable no-console */
+
+export type LogFuncs = 'log' | 'warn' | 'error';
+export type AsyncLogCollector = () => Promise<void>;
+export type SyncLogCollector = () => void;
+export type LogCollector = AsyncLogCollector | SyncLogCollector;
+export type CollectedLogs<T extends LogFuncs> = { [key in T]: string[] };
+
+const allCategories = ['log', 'warn', 'error'];
+
+// Asynchronous log collector with that collects all categories
+export function withLogCollector(
+  callback: AsyncLogCollector,
+): Promise<CollectedLogs<LogFuncs>>;
+
+// Synchronous log collector with that collects all categories
+export function withLogCollector(
+  callback: SyncLogCollector,
+): CollectedLogs<LogFuncs>;
+
+// Asynchronous log collector with that only collects selected categories
+export function withLogCollector<T extends LogFuncs>(
+  logsToCollect: T[],
+  callback: AsyncLogCollector,
+): Promise<CollectedLogs<T>>;
+
+// Synchronous log collector with that only collects selected categories
+export function withLogCollector<T extends LogFuncs>(
+  logsToCollect: T[],
+  callback: SyncLogCollector,
+): CollectedLogs<T>;
+
+export function withLogCollector(
+  logsToCollect: LogFuncs[] | LogCollector,
+  callback?: LogCollector,
+): CollectedLogs<LogFuncs> | Promise<CollectedLogs<LogFuncs>> {
+  const oneArg = !callback;
+  const actualCallback = (oneArg ? logsToCollect : callback) as LogCollector;
+  const categories = (oneArg ? allCategories : logsToCollect) as LogFuncs[];
+
+  const logs = {
+    log: new Array<string>(),
+    warn: new Array<string>(),
+    error: new Array<string>(),
+  };
+
+  const origLog = console.log;
+  const origWarn = console.warn;
+  const origError = console.error;
+
+  if (categories.includes('log')) {
+    console.log = (message: string) => {
+      logs.log.push(message);
+    };
+  }
+  if (categories.includes('warn')) {
+    console.warn = (message: string) => {
+      logs.warn.push(message);
+    };
+  }
+  if (categories.includes('error')) {
+    console.error = (message: string) => {
+      logs.error.push(message);
+    };
+  }
+
+  const restore = () => {
+    console.log = origLog;
+    console.warn = origWarn;
+    console.error = origError;
+  };
+
+  try {
+    const ret = actualCallback();
+
+    if (!ret || !ret.then) {
+      restore();
+      return logs;
+    }
+
+    return ret.then(
+      () => {
+        restore();
+        return logs;
+      },
+      error => {
+        restore();
+        throw error;
+      },
+    );
+  } catch (error) {
+    restore();
+    throw error;
+  }
+}