unify attributeValueToTypedAttributeValue with optional fallback logic

Author: Lms24

packages/core/src/attributes.ts

@@ -61,21 +61,47 @@ export function isAttributeObject(maybeObj: unknown): maybeObj is AttributeObjec
   );
 }
 
+export function attributeValueToTypedAttributeValue(rawValue: unknown, useFallback?: true): TypedAttributeValue;
 /**
  * Converts an attribute value to a typed attribute value.
  *
  * Does not allow mixed arrays. In case of a mixed array, the value is stringified and the type is 'string'.
  * All values besides the supported attribute types (see {@link AttributeTypeMap}) are stringified to a string attribute value.
  *
  * @param value - The value of the passed attribute.
+ * @param useFallback - If true, unsupported values will be stringified to a string attribute value.
+ *                      Defaults to false. In this case, `undefined` is returned for unsupported values.
  * @returns The typed attribute.
  */
-export function attributeValueToTypedAttributeValue(rawValue: unknown): TypedAttributeValue | void {
+export function attributeValueToTypedAttributeValue(
+  rawValue: unknown,
+  useFallback = false,
+): TypedAttributeValue | void {
   const { value, unit } = isAttributeObject(rawValue) ? rawValue : { value: rawValue, unit: undefined };
   const attributeValue = getTypedAttributeValue(value);
+  const checkedUnit = unit && typeof unit === 'string' ? { unit } : {};
   if (attributeValue) {
-    return { ...attributeValue, ...(unit && typeof unit === 'string' ? { unit } : {}) };
+    return { ...attributeValue, ...checkedUnit };
   }
+
+  if (!useFallback) {
+    return;
+  }
+
+  // Fallback: stringify the value
+  // TODO(v11): be smarter here and use String constructor if stringify fails
+  // (this is a breaking change for already existing attribute values)
+  let stringValue = '';
+  try {
+    stringValue = JSON.stringify(value) ?? '';
+  } catch {
+    // Do nothing
+  }
+  return {
+    value: stringValue,
+    type: 'string',
+    ...checkedUnit,
+  };
 }
 
 /**

packages/core/src/logs/internal.ts

@@ -17,31 +17,6 @@ import { createLogEnvelope } from './envelope';
 
 const MAX_LOG_BUFFER_SIZE = 100;
 
-/**
- * Converts a log attribute to a serialized log attribute.
- *
- * @param key - The key of the log attribute.
- * @param value - The value of the log attribute.
- * @returns The serialized log attribute.
- */
-export function attributeValueToTypedAttributeValueWithFallback(value: unknown): TypedAttributeValue {
-  const typedAttributeValue = attributeValueToTypedAttributeValue(value);
-  if (typedAttributeValue) {
-    return typedAttributeValue;
-  }
-
-  let stringValue = '';
-  try {
-    stringValue = JSON.stringify(value) ?? '';
-  } catch {
-    // Do nothing
-  }
-  return {
-    value: stringValue,
-    type: 'string',
-  };
-}
-
 /**
  * Sets a log attribute if the value exists and the attribute key is not already present.
  *
@@ -198,7 +173,7 @@ export function _INTERNAL_captureLog(
       ),
       ...Object.keys(logAttributes).reduce(
         (acc, key) => {
-          acc[key] = attributeValueToTypedAttributeValueWithFallback(logAttributes[key]);
+          acc[key] = attributeValueToTypedAttributeValue(logAttributes[key], true);
           return acc;
         },
         {} as Record<string, TypedAttributeValue>,

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

@@ -1,4 +1,4 @@
-import type { TypedAttributes } from '../attributes';
+import type { Attributes } from '../attributes';
 import type { ParameterizedString } from './parameterize';
 
 export type LogSeverityLevel = 'trace' | 'debug' | 'info' | 'warn' | 'error' | 'fatal';
@@ -55,7 +55,7 @@ export interface SerializedLog {
   /**
    * Arbitrary structured data that stores information about the log - e.g., userId: 100.
    */
-  attributes?: TypedAttributes;
+  attributes?: Attributes;
 
   /**
    * The severity number.

packages/core/test/lib/logs/internal.test.ts

@@ -326,9 +326,7 @@ describe('_INTERNAL_captureLog', () => {
       message: 'original message',
       attributes: {
         original: true,
-        // attributes here still have the same form as originally set on the scope or log
-        scope_1: 'attribute_value',
-        scope_2: { value: 38, unit: 'gigabytes' },
+        // scope attributes are not included in beforeSendLog - they're only added during serialization
       },
     });