extract formatTags and its dependencies to a separate module

Author: miriambudayr

packages/shared/src/formatTags.ts

@@ -0,0 +1,42 @@
+import StackUtils from "stack-utils";
+
+const stackUtils = new StackUtils({ cwd: process.cwd(), internals: StackUtils.nodeInternals() });
+
+function anonymizeStackTrace(stack: string): string {
+  return stack
+    .split("\n")
+    .map(line => {
+      const frame = stackUtils.parseLine(line);
+      if (frame && frame.file) {
+        const relativePath = frame.file.includes("node_modules")
+          ? frame.file.substring(frame.file.indexOf("node_modules"))
+          : frame.file;
+        return line.replace(frame.file, relativePath);
+      }
+      return line;
+    })
+    .join("\n");
+}
+
+export type Tags = Record<string, unknown>;
+
+export function formatTags(tags?: Tags) {
+  if (!tags) {
+    return;
+  }
+
+  return Object.entries(tags).reduce((result, [key, value]) => {
+    if (value instanceof Error) {
+      result[key] = {
+        // Intentionally keeping this for any extra properties attached in `Error`
+        ...(value as any),
+        errorName: value.name,
+        errorMessage: value.message,
+        errorStack: anonymizeStackTrace(value.stack ?? ""),
+      };
+    } else {
+      result[key] = value;
+    }
+    return result;
+  }, {} as Record<string, unknown>);
+}

packages/shared/src/logger.ts

@@ -4,55 +4,15 @@ import LokiTransport from "winston-loki";
 import { AuthInfo } from "./graphql/fetchAuthInfoFromGraphQL";
 import { getDeviceId } from "./getDeviceId";
 import { randomUUID } from "crypto";
-import StackUtils from "stack-utils";
+import { formatTags, Tags } from "./formatTags";
 
 const GRAFANA_USER = "909360";
 const GRAFANA_PUBLIC_TOKEN =
   "glc_eyJvIjoiOTEyOTQzIiwibiI6IndyaXRlLW90ZWwtcmVwbGF5LWNsaSIsImsiOiJ0UnFsOXV1a2QyQUI2NzIybDEzSkRuNDkiLCJtIjp7InIiOiJwcm9kLXVzLWVhc3QtMCJ9fQ=="; // write-only permissions.
 const GRAFANA_BASIC_AUTH = `${GRAFANA_USER}:${GRAFANA_PUBLIC_TOKEN}`;
 const HOST = "https://logs-prod-006.grafana.net";
 
-const stackUtils = new StackUtils({ cwd: process.cwd(), internals: StackUtils.nodeInternals() });
-
-function anonymizeStackTrace(stack: string): string {
-  return stack
-    .split("\n")
-    .map(line => {
-      const frame = stackUtils.parseLine(line);
-      if (frame && frame.file) {
-        const relativePath = frame.file.includes("node_modules")
-          ? frame.file.substring(frame.file.indexOf("node_modules"))
-          : frame.file;
-        return line.replace(frame.file, relativePath);
-      }
-      return line;
-    })
-    .join("\n");
-}
-
-export function formatTags(tags?: Tags) {
-  if (!tags) {
-    return;
-  }
-
-  return Object.entries(tags).reduce((result, [key, value]) => {
-    if (value instanceof Error) {
-      result[key] = {
-        // Intentionally keeping this for any extra properties attached in `Error`
-        ...(value as any),
-        errorName: value.name,
-        errorMessage: value.message,
-        errorStack: anonymizeStackTrace(value.stack ?? ""),
-      };
-    } else {
-      result[key] = value;
-    }
-    return result;
-  }, {} as Record<string, unknown>);
-}
-
 type LogLevel = "error" | "warn" | "info" | "debug";
-export type Tags = Record<string, unknown>;
 
 class Logger {
   private deviceId: string;

packages/shared/src/sentry.ts

@@ -3,7 +3,8 @@ const { nodeProfilingIntegration } = require("@sentry/profiling-node");
 import { AuthInfo } from "./graphql/fetchAuthInfoFromGraphQL";
 import { getDeviceId } from "./getDeviceId";
 import { randomUUID } from "crypto";
-import { formatTags, logger, Tags } from "./logger";
+import { logger } from "./logger";
+import { formatTags, Tags } from "./formatTags";
 
 const SENTRY_DSN =
   "https://5c145b72bb502832982243d6584f163d@o437061.ingest.us.sentry.io/4507534763819008"; // write-only permissions