linting, etc

Author: colin-sentry

packages/core/src/exports.ts

@@ -1,5 +1,6 @@
 import { getClient, getCurrentScope, getIsolationScope, withIsolationScope } from './currentScopes';
 import { DEBUG_BUILD } from './debug-build';
+import { captureLog } from './ourlogs';
 import type { CaptureContext } from './scope';
 import { closeSession, makeSession, updateSession } from './session';
 import type {
@@ -24,7 +25,6 @@ import { timestampInSeconds } from './utils-hoist/time';
 import { GLOBAL_OBJ } from './utils-hoist/worldwide';
 import type { ExclusiveEventHintOrCaptureContext } from './utils/prepareEvent';
 import { parseEventHintOrCaptureContext } from './utils/prepareEvent';
-import { captureLog } from './ourlogs';
 
 /**
  * Captures an exception event and sends it to Sentry.
@@ -336,7 +336,6 @@ export function captureSession(end: boolean = false): void {
   _sendSessionUpdate();
 }
 
-
 /**
  * A utility to record a log with level 'INFO' and send it to sentry.
  *

packages/core/src/index.ts

@@ -31,7 +31,7 @@ export {
   addEventProcessor,
   _experimentalLogError,
   _experimentalLogInfo,
-  _experimentalLogWarning
+  _experimentalLogWarning,
 } from './exports';
 export {
   getCurrentScope,

packages/core/src/ourlogs.ts

@@ -29,9 +29,9 @@ function addLog(log: Log): void {
     return;
   }
 
-  // if (!client.getOptions()._experiments?.logSupport) {
-  //   return;
-  // }
+  if (!client.getOptions()._experiments?.logSupport) {
+    return;
+  }
 
   const globalScope = getGlobalScope();
   const dsn = client.getDsn();
@@ -41,74 +41,86 @@ function addLog(log: Log): void {
       trace_id: globalScope.getPropagationContext().traceId,
       public_key: dsn?.publicKey,
     },
-    ...(dsn ? {dsn: dsnToString(dsn)} : {}),
-  }
-  if(!log.traceId) {
+    ...(dsn ? { dsn: dsnToString(dsn) } : {}),
+  };
+  if (!log.traceId) {
     log.traceId = globalScope.getPropagationContext().traceId || '00000000-0000-0000-0000-000000000000';
   }
-  if(!log.timeUnixNano) {
-    log.timeUnixNano = `${(new Date()).getTime().toString()}000000`;
+  if (!log.timeUnixNano) {
+    log.timeUnixNano = `${new Date().getTime().toString()}000000`;
   }
 
   const envelope = createEnvelope<LogEnvelope>(headers, [createLogEnvelopeItem(log)]);
 
-  client.sendEnvelope(envelope).then(null, ex => console.error(ex));
+  // sendEnvelope should not throw
+  // eslint-disable-next-line @typescript-eslint/no-floating-promises
+  client.sendEnvelope(envelope);
 }
 
 function valueToAttribute(key: string, value: unknown): LogAttribute {
   if (typeof value === 'number') {
-    if(Number.isInteger(value)) {
+    if (Number.isInteger(value)) {
       return {
         key,
         value: {
-          intValue: value
-        }
-      }
+          intValue: value,
+        },
+      };
     }
     return {
       key,
       value: {
-        doubleValue: value
-      }
-    }
+        doubleValue: value,
+      },
+    };
   } else if (typeof value === 'boolean') {
     return {
       key,
       value: {
-        boolValue: value
-      }
-    }
+        boolValue: value,
+      },
+    };
   } else if (typeof value === 'string') {
     return {
       key,
       value: {
-        stringValue: value
-      }
-    }
+        stringValue: value,
+      },
+    };
   } else {
     return {
       key,
       value: {
-        stringValue: JSON.stringify(value)
-      }
-    }
+        stringValue: JSON.stringify(value),
+      },
+    };
   }
 }
 
 /**
  * A utility function to be able to create methods like Sentry.info`...`
  *
  * The first parameter is bound with, e.g., const info = captureLog.bind(null, 'info')
- * The other parameters are in the format to be passed a template, Sentry.info`hello ${world}`
+ * The other parameters are in the format to be passed a tagged template, Sentry.info`hello ${world}`
  */
 export function captureLog(level: LogSeverityLevel, messages: string[] | string, ...values: unknown[]): void {
-  const message = Array.isArray(messages) ? messages.reduce((acc, str, i) => acc + str + (values[i] ?? ''), '') : messages;
-
+  const message = Array.isArray(messages)
+    ? messages.reduce((acc, str, i) => acc + str + (values[i] ?? ''), '')
+    : messages;
+  const attributes = values.map<LogAttribute>((value, index) => valueToAttribute(`param${index}`, value));
+  if (Array.isArray(messages)) {
+    attributes.push({
+      key: 'sentry.template',
+      value: {
+        stringValue: messages.map((s, i) => s + (i < messages.length - 1 ? `$param${i}` : '')).join(''),
+      },
+    });
+  }
   addLog({
     severityText: level,
     body: {
       stringValue: message,
     },
-    attributes: values.map<LogAttribute>((value, index) => valueToAttribute(`param${index}`, value)),
-  })
+    attributes: attributes,
+  });
 }

packages/core/src/types-hoist/envelope.ts

@@ -5,12 +5,12 @@ import type { LegacyCSPReport } from './csp';
 import type { DsnComponents } from './dsn';
 import type { Event } from './event';
 import type { FeedbackEvent, UserFeedback } from './feedback';
+import type { Log } from './ourlogs';
 import type { Profile, ProfileChunk } from './profiling';
 import type { ReplayEvent, ReplayRecordingData } from './replay';
 import type { SdkInfo } from './sdkinfo';
 import type { SerializedSession, SessionAggregates } from './session';
 import type { SpanJSON } from './span';
-import { Log } from './ourlogs';
 
 // Based on: https://develop.sentry.dev/sdk/envelopes/
 

packages/core/src/types-hoist/index.ts

@@ -117,7 +117,7 @@ export type {
   Log,
   LogAttribute,
   LogSeverityLevel,
-  LogAttributeValueType
+  LogAttributeValueType,
 } from './ourlogs';
 export type { SpanStatus } from './spanStatus';
 export type { TimedEvent } from './timedEvent';

packages/core/src/types-hoist/ourlogs.ts

@@ -2,19 +2,23 @@ import type { SeverityLevel } from './severity';
 
 export type LogSeverityLevel = SeverityLevel | 'critical' | 'trace';
 
-export type LogAttributeValueType = {
-  stringValue: string
-} | {
-  intValue: number
-} | {
-  boolValue: boolean
-} | {
-  doubleValue: number
-}
+export type LogAttributeValueType =
+  | {
+      stringValue: string;
+    }
+  | {
+      intValue: number;
+    }
+  | {
+      boolValue: boolean;
+    }
+  | {
+      doubleValue: number;
+    };
 
 export type LogAttribute = {
-  key: string,
-  value: LogAttributeValueType
+  key: string;
+  value: LogAttributeValueType;
 };
 
 export interface Log {
@@ -48,7 +52,7 @@ export interface Log {
    * The message to be logged - for example, 'hello world' would become a log like '[INFO] hello world'
    */
   body: {
-    stringValue: string,
+    stringValue: string;
   };
 
   /**