@vrplatform/log 1.0.0

package/src/index.ts

@@ -0,0 +1,107 @@
+import { createBaseLog } from './baselog';
+import {
+  AXIOM_AUTH_TOKEN_ENV,
+  AXIOM_DATASET_ENV,
+  AXIOM_ORG_ID_ENV,
+  LOG_ENV,
+  TASK_QUEUE_HEADER,
+  WORKFLOW_ID_HEADER,
+  getCorrelationId,
+  isDev,
+  requestToContext,
+} from './common';
+import type { RequestLike, WorkerLog } from './type';
+
+export * from './common';
+export * from './baselog';
+export * from './type';
+
+export function useLog({
+  name,
+  request,
+  body,
+  env,
+  showStackTrace,
+  correlationId: cid,
+  version,
+  executionContext,
+  dataset: _dataset,
+}: {
+  name: string;
+  request?: RequestLike & { cf?: any };
+  body?: any;
+  showStackTrace?: boolean;
+  correlationId?: string;
+  version?: string;
+  dataset?: string;
+  env?: Record<string, any>;
+  executionContext?: {
+    waitUntil(promise: Promise<any>): void;
+  };
+}): WorkerLog {
+  const colorLogs = env?.[LOG_ENV] === '*';
+  if (showStackTrace === undefined) showStackTrace = isDev(request);
+  const correlationId = cid || getCorrelationId(request); //const logger = nodeColorLog;
+
+  const axiomToken = env?.[AXIOM_AUTH_TOKEN_ENV];
+
+  const axiom = createBaseLog(
+    {
+      token: axiomToken,
+      orgId: env?.[AXIOM_ORG_ID_ENV],
+      dataset: _dataset || env?.[AXIOM_DATASET_ENV] || 'default',
+      consoleLog: colorLogs ? 'color' : false,
+    },
+    {
+      environment: isDev(request) ? 'development' : 'production',
+      type: 'worker',
+      executionContext,
+      workerId: env?.MACHINE_NAME || name || 'default',
+      app: name || 'default',
+      version: version || 'default',
+      correlationId,
+      context: {
+        rootCorrelationId: correlationId,
+        correlationId,
+        taskQueue: request?.headers?.get(TASK_QUEUE_HEADER) || undefined,
+        workflowId: request?.headers?.get(WORKFLOW_ID_HEADER) || undefined,
+        child: undefined as any as string,
+      },
+    }
+  ) as WorkerLog;
+
+  axiom.info('Request', {
+    request: requestToContext(request, body),
+  });
+
+  axiom.respond = async (res) => {
+    const temp = await (typeof res === 'function' ? res() : res);
+
+    const { response, ...arg } =
+      temp instanceof Response
+        ? {
+            body: undefined,
+            response: temp,
+            status: temp.status,
+            statusText: temp.statusText,
+            headers: temp.headers,
+          }
+        : temp;
+    const resp =
+      response ||
+      new Response(
+        typeof arg.body === 'object' ? JSON.stringify(arg.body) : arg.body,
+        {
+          status: arg.status,
+          statusText: arg.statusText,
+          headers: arg.headers,
+        }
+      );
+    axiom?.info('Response', {
+      response,
+    });
+    await axiom?.flush();
+    return resp;
+  };
+  return axiom;
+}

package/src/type.ts

@@ -0,0 +1,43 @@
+export type LogFn = (message: any, ...args: any[]) => void;
+export type Log = {
+  error: LogFn;
+  info: LogFn;
+  debug: LogFn;
+  warn: LogFn;
+  child: (data: ChildLogOptions) => Log;
+  addContext: (data: Record<string, any>) => void;
+};
+
+export type ChildLogOptions = {
+  correlationId?: string;
+  name?: string;
+  request?: any;
+  context?: Record<string, any>;
+};
+
+type Res =
+  | Response
+  | {
+      status: number;
+      statusText?: string;
+      headers?: Record<string, string>;
+      body?: any;
+      response?: Response;
+    };
+export type BaseLog = Log & {
+  flush(): Promise<void> | void;
+};
+export type WorkerLog = BaseLog & {
+  respond(
+    response: Res | Promise<Res> | (() => Res | Promise<Res>)
+  ): Promise<Response>;
+};
+
+export type RequestLike = {
+  headers: {
+    get: (key: string) => string | null;
+  };
+  method: string;
+  url: string;
+  json: () => Promise<any>;
+};