use MeasurementUnit (aka Relay's MetricUnit)

Author: Lms24

packages/core/src/attributes.ts

@@ -1,4 +1,5 @@
 import { DEBUG_BUILD } from './debug-build';
+import type { MeasurementUnit } from './types-hoist/measurement';
 import { debug } from './utils/debug-logger';
 
 export type RawAttributes<T> = T & ValidatedAttributes<T>;
@@ -32,18 +33,13 @@ type AttributeUnion = {
   };
 }[keyof AttributeTypeMap];
 
-export type TypedAttributeValue = AttributeUnion & { unit?: Units };
+export type TypedAttributeValue = AttributeUnion & { unit?: MeasurementUnit };
 
 export type AttributeObject = {
   value: unknown;
-  unit?: Units;
+  unit?: MeasurementUnit;
 };
 
-/**
- * Unit of measurement that can be added to an attribute.
- */
-type Units = 'ms' | 's' | 'bytes' | 'count' | 'percent' | string;
-
 /* If an attribute has either a 'value' or 'unit' property, we use the ValidAttributeObject type. */
 export type ValidatedAttributes<T> = {
   // eslint-disable-next-line @typescript-eslint/no-explicit-any

packages/core/test/lib/scope.test.ts

@@ -215,21 +215,30 @@ describe('Scope', () => {
 
       it('accepts an attribute value object with a unit', () => {
         const scope = new Scope();
-        scope.setAttribute('str', { value: 1, unit: 'ms' });
+        scope.setAttribute('str', { value: 1, unit: 'millisecond' });
         expect(scope['_attributes']).toEqual({
-          str: { value: 1, unit: 'ms' },
+          str: { value: 1, unit: 'millisecond' },
+        });
+      });
+
+      it('accepts a custom unit', () => {
+        // mostly there for type checking purposes.
+        const scope = new Scope();
+        scope.setAttribute('str', { value: 3, unit: 'inch' });
+        expect(scope['_attributes']).toEqual({
+          str: { value: 3, unit: 'inch' },
         });
       });
 
       it('accepts an array', () => {
         const scope = new Scope();
 
         scope.setAttribute('strArray', ['a', 'b', 'c']);
-        scope.setAttribute('intArray', { value: [1, 2, 3], unit: 'ms' });
+        scope.setAttribute('intArray', { value: [1, 2, 3], unit: 'millisecond' });
 
         expect(scope['_attributes']).toEqual({
           strArray: ['a', 'b', 'c'],
-          intArray: { value: [1, 2, 3], unit: 'ms' },
+          intArray: { value: [1, 2, 3], unit: 'millisecond' },
         });
       });
 
@@ -266,23 +275,23 @@ describe('Scope', () => {
 
       it('accepts attribute value objects with units', () => {
         const scope = new Scope();
-        scope.setAttributes({ str: { value: 'b', unit: 'ms' }, int: { value: 12, unit: 's' } });
+        scope.setAttributes({ str: { value: 'b', unit: 'millisecond' }, int: { value: 12, unit: 'second' } });
         expect(scope['_attributes']).toEqual({
-          str: { value: 'b', unit: 'ms' },
-          int: { value: 12, unit: 's' },
+          str: { value: 'b', unit: 'millisecond' },
+          int: { value: 12, unit: 'second' },
         });
       });
 
       it('accepts arrays', () => {
         const scope = new Scope();
         scope.setAttributes({
           strArray: ['a', 'b', 'c'],
-          intArray: { value: [1, 2, 3], unit: 'ms' },
+          intArray: { value: [1, 2, 3], unit: 'millisecond' },
         });
 
         expect(scope['_attributes']).toEqual({
           strArray: ['a', 'b', 'c'],
-          intArray: { value: [1, 2, 3], unit: 'ms' },
+          intArray: { value: [1, 2, 3], unit: 'millisecond' },
         });
       });