@datadog/browser-rum-core - npm Package Compare versions

Comparing version 3.6.3 to 3.6.4

cjs/boot/buildEnv.js

@@ -6,4 +6,4 @@ "use strict";
     buildMode: 'release',
-    sdkVersion: '3.6.3',
+    sdkVersion: '3.6.4',
 };
 //# sourceMappingURL=buildEnv.js.map

cjs/boot/rumPublicApi.d.ts

@@ -34,3 +34,3 @@ import { Context, InitConfiguration, Configuration, InternalMonitoring, DefaultPrivacyLevel } from '@datadog/browser-core';
     addError: (error: unknown, context?: object | undefined) => void;
-    addTiming: (name: string) => void;
+    addTiming: (name: string, time?: number | undefined) => void;
     setUser: (newUser: User) => void;
@@ -37,0 +37,0 @@ removeUser: () => void;

cjs/boot/rumPublicApi.js

@@ -97,4 +97,4 @@ "use strict";
         },
-        addTiming: browser_core_1.monitor(function (name) {
-            addTimingStrategy(name);
+        addTiming: browser_core_1.monitor(function (name, time) {
+            addTimingStrategy(name, time);
         }),
@@ -101,0 +101,0 @@ setUser: browser_core_1.monitor(function (newUser) {

cjs/boot/startRum.d.ts

@@ -10,3 +10,3 @@ import { Configuration, InternalMonitoring, Observable } from '@datadog/browser-core';
     addError: ({ error, handlingStack, startClocks, context: customerContext }: import("../domain/rumEventsCollection/error/errorCollection").ProvidedError, savedCommonContext?: CommonContext | undefined) => void;
-    addTiming: (name: string, time?: import("@datadog/browser-core").TimeStamp) => void;
+    addTiming: (name: string, time?: import("@datadog/browser-core").TimeStamp | import("@datadog/browser-core").RelativeTime) => void;
     startView: (name?: string | undefined, startClocks?: import("@datadog/browser-core").ClocksState | undefined) => void;
@@ -13,0 +13,0 @@ lifeCycle: LifeCycle;

cjs/domain/rumEventsCollection/view/trackViews.d.ts

@@ -1,2 +0,2 @@
-import { Duration, ClocksState, TimeStamp, Observable } from '@datadog/browser-core';
+import { Duration, ClocksState, TimeStamp, Observable, RelativeTime } from '@datadog/browser-core';
 import { ViewLoadingType, ViewCustomTimings } from '../../../rawRumEvent.types';
@@ -33,5 +33,5 @@ import { LifeCycle } from '../../lifeCycle';
 export declare function trackViews(location: Location, lifeCycle: LifeCycle, domMutationObservable: Observable<void>, locationChangeObservable: Observable<LocationChange>, areViewsTrackedAutomatically: boolean, initialViewName?: string): {
-    addTiming: (name: string, time?: TimeStamp) => void;
+    addTiming: (name: string, time?: RelativeTime | TimeStamp) => void;
     startView: (name?: string | undefined, startClocks?: ClocksState | undefined) => void;
     stop: () => void;
 };

cjs/domain/rumEventsCollection/view/trackViews.js

@@ -134,3 +134,4 @@ "use strict";
         addTiming: function (name, time) {
-            customTimings[sanitizeTiming(name)] = browser_core_1.elapsed(startClocks.timeStamp, time);
+            var relativeTime = browser_core_1.looksLikeRelativeTime(time) ? time : browser_core_1.elapsed(startClocks.timeStamp, time);
+            customTimings[sanitizeTiming(name)] = relativeTime;
         },
@@ -137,0 +138,0 @@ };

cjs/domain/rumEventsCollection/view/viewCollection.d.ts

@@ -7,5 +7,5 @@ import { Configuration, Observable } from '@datadog/browser-core';
 export declare function startViewCollection(lifeCycle: LifeCycle, configuration: Configuration, location: Location, domMutationObservable: Observable<void>, locationChangeObservable: Observable<LocationChange>, foregroundContexts: ForegroundContexts, recorderApi: RecorderApi, initialViewName?: string): {
-    addTiming: (name: string, time?: import("@datadog/browser-core").TimeStamp) => void;
+    addTiming: (name: string, time?: import("@datadog/browser-core").TimeStamp | import("@datadog/browser-core").RelativeTime) => void;
     startView: (name?: string | undefined, startClocks?: import("@datadog/browser-core").ClocksState | undefined) => void;
     stop: () => void;
 };

esm/boot/buildEnv.js

 export var buildEnv = {
     buildMode: 'release',
-    sdkVersion: '3.6.3',
+    sdkVersion: '3.6.4',
 };
 //# sourceMappingURL=buildEnv.js.map

esm/boot/rumPublicApi.d.ts

@@ -34,3 +34,3 @@ import { Context, InitConfiguration, Configuration, InternalMonitoring, DefaultPrivacyLevel } from '@datadog/browser-core';
     addError: (error: unknown, context?: object | undefined) => void;
-    addTiming: (name: string) => void;
+    addTiming: (name: string, time?: number | undefined) => void;
     setUser: (newUser: User) => void;
@@ -37,0 +37,0 @@ removeUser: () => void;

esm/boot/rumPublicApi.js

@@ -94,4 +94,4 @@ import { BoundedBuffer, buildCookieOptions, checkCookiesAuthorized, checkIsNotLocalFile, createContextManager, deepClone, isPercentage, makePublicApi, monitor, clocksNow, timeStampNow, display, commonInit, callMonitored, createHandlingStack, } from '@datadog/browser-core';
         },
-        addTiming: monitor(function (name) {
-            addTimingStrategy(name);
+        addTiming: monitor(function (name, time) {
+            addTimingStrategy(name, time);
         }),
@@ -98,0 +98,0 @@ setUser: monitor(function (newUser) {

esm/boot/startRum.d.ts

@@ -10,3 +10,3 @@ import { Configuration, InternalMonitoring, Observable } from '@datadog/browser-core';
     addError: ({ error, handlingStack, startClocks, context: customerContext }: import("../domain/rumEventsCollection/error/errorCollection").ProvidedError, savedCommonContext?: CommonContext | undefined) => void;
-    addTiming: (name: string, time?: import("@datadog/browser-core").TimeStamp) => void;
+    addTiming: (name: string, time?: import("@datadog/browser-core").TimeStamp | import("@datadog/browser-core").RelativeTime) => void;
     startView: (name?: string | undefined, startClocks?: import("@datadog/browser-core").ClocksState | undefined) => void;
@@ -13,0 +13,0 @@ lifeCycle: LifeCycle;

esm/domain/rumEventsCollection/view/trackViews.d.ts

@@ -1,2 +0,2 @@
-import { Duration, ClocksState, TimeStamp, Observable } from '@datadog/browser-core';
+import { Duration, ClocksState, TimeStamp, Observable, RelativeTime } from '@datadog/browser-core';
 import { ViewLoadingType, ViewCustomTimings } from '../../../rawRumEvent.types';
@@ -33,5 +33,5 @@ import { LifeCycle } from '../../lifeCycle';
 export declare function trackViews(location: Location, lifeCycle: LifeCycle, domMutationObservable: Observable<void>, locationChangeObservable: Observable<LocationChange>, areViewsTrackedAutomatically: boolean, initialViewName?: string): {
-    addTiming: (name: string, time?: TimeStamp) => void;
+    addTiming: (name: string, time?: RelativeTime | TimeStamp) => void;
     startView: (name?: string | undefined, startClocks?: ClocksState | undefined) => void;
     stop: () => void;
 };

esm/domain/rumEventsCollection/view/trackViews.js

 import { __assign } from "tslib";
-import { elapsed, generateUUID, monitor, ONE_MINUTE, throttle, clocksNow, clocksOrigin, timeStampNow, display, } from '@datadog/browser-core';
+import { elapsed, generateUUID, monitor, ONE_MINUTE, throttle, clocksNow, clocksOrigin, timeStampNow, display, looksLikeRelativeTime, } from '@datadog/browser-core';
 import { ViewLoadingType } from '../../../rawRumEvent.types';
@@ -130,3 +130,4 @@ import { LifeCycleEventType } from '../../lifeCycle';
         addTiming: function (name, time) {
-            customTimings[sanitizeTiming(name)] = elapsed(startClocks.timeStamp, time);
+            var relativeTime = looksLikeRelativeTime(time) ? time : elapsed(startClocks.timeStamp, time);
+            customTimings[sanitizeTiming(name)] = relativeTime;
         },
@@ -133,0 +134,0 @@ };

esm/domain/rumEventsCollection/view/viewCollection.d.ts

@@ -7,5 +7,5 @@ import { Configuration, Observable } from '@datadog/browser-core';
 export declare function startViewCollection(lifeCycle: LifeCycle, configuration: Configuration, location: Location, domMutationObservable: Observable<void>, locationChangeObservable: Observable<LocationChange>, foregroundContexts: ForegroundContexts, recorderApi: RecorderApi, initialViewName?: string): {
-    addTiming: (name: string, time?: import("@datadog/browser-core").TimeStamp) => void;
+    addTiming: (name: string, time?: import("@datadog/browser-core").TimeStamp | import("@datadog/browser-core").RelativeTime) => void;
     startView: (name?: string | undefined, startClocks?: import("@datadog/browser-core").ClocksState | undefined) => void;
     stop: () => void;
 };

package.json

 {
   "name": "@datadog/browser-rum-core",
-  "version": "3.6.3",
+  "version": "3.6.4",
   "license": "Apache-2.0",
@@ -15,3 +15,3 @@ "main": "cjs/index.js",
   "dependencies": {
-    "@datadog/browser-core": "3.6.3",
+    "@datadog/browser-core": "3.6.4",
     "tslib": "^1.10.0"
@@ -27,3 +27,3 @@ },
   },
-  "gitHead": "b504d87abff702fb64506df02cc17540c1123e93"
+  "gitHead": "8d26165153c9e4e3bf9396ea96947697ff9c752e"
 }

src/boot/rumPublicApi.spec.ts

@@ -478,2 +478,12 @@ import { ONE_SECOND, RelativeTime, getTimeStamp, display, TimeStamp, DefaultPrivacyLevel } from '@datadog/browser-core'
     })
+
+    it('adds custom timing with provided time', () => {
+      rumPublicApi.init(DEFAULT_INIT_CONFIGURATION)
+
+      rumPublicApi.addTiming('foo', 12)
+
+      expect(addTimingSpy.calls.argsFor(0)[0]).toEqual('foo')
+      expect(addTimingSpy.calls.argsFor(0)[1]).toBe(12 as RelativeTime)
+      expect(displaySpy).not.toHaveBeenCalled()
+    })
   })
@@ -480,0 +490,0 @@

src/boot/rumPublicApi.ts

@@ -22,2 +22,4 @@ import {
   DefaultPrivacyLevel,
+  TimeStamp,
+  RelativeTime,
 } from '@datadog/browser-core'
@@ -196,4 +198,4 @@ import { LifeCycle } from '../domain/lifeCycle'
 
-    addTiming: monitor((name: string) => {
-      addTimingStrategy(name)
+    addTiming: monitor((name: string, time?: number) => {
+      addTimingStrategy(name, time as RelativeTime | TimeStamp | undefined)
     }),
@@ -200,0 +202,0 @@

src/domain/rumEventsCollection/view/trackViews.spec.ts

@@ -1,2 +0,2 @@
-import { Duration, RelativeTime, timeStampNow, display, relativeToClocks } from '@datadog/browser-core'
+import { Duration, RelativeTime, timeStampNow, display, relativeToClocks, relativeNow } from '@datadog/browser-core'
 import { setup, TestSetupBuilder, setupViewTest, ViewTest } from '../../../../test/specHelper'
@@ -450,3 +450,3 @@ import {
 
-  it('should add custom timing with a specific time', () => {
+  it('should add custom timing with a specific timestamp', () => {
     const { clock } = setupBuilder.build()
@@ -463,2 +463,14 @@ const { getViewUpdate, addTiming } = viewTest
 
+  it('should add custom timing with a specific relative time', () => {
+    const { clock } = setupBuilder.build()
+    const { getViewUpdate, addTiming } = viewTest
+
+    clock.tick(1234)
+    addTiming('foo', relativeNow())
+
+    expect(getViewUpdate(1).customTimings).toEqual({
+      foo: 1234 as Duration,
+    })
+  })
+
   it('should sanitized timing name', () => {
@@ -465,0 +477,0 @@ const { clock } = setupBuilder.build()

src/domain/rumEventsCollection/view/trackViews.ts

@@ -16,2 +16,4 @@ import {
   Subscription,
+  RelativeTime,
+  looksLikeRelativeTime,
 } from '@datadog/browser-core'
@@ -134,3 +136,3 @@ import { ViewLoadingType, ViewCustomTimings } from '../../../rawRumEvent.types'
   return {
-    addTiming: (name: string, time = timeStampNow()) => {
+    addTiming: (name: string, time: RelativeTime | TimeStamp = timeStampNow()) => {
       currentView.addTiming(name, time)
@@ -227,4 +229,5 @@ currentView.triggerUpdate()
     },
-    addTiming(name: string, time: TimeStamp) {
-      customTimings[sanitizeTiming(name)] = elapsed(startClocks.timeStamp, time)
+    addTiming(name: string, time: RelativeTime | TimeStamp) {
+      const relativeTime = looksLikeRelativeTime(time) ? time : elapsed(startClocks.timeStamp, time)
+      customTimings[sanitizeTiming(name)] = relativeTime
     },
@@ -231,0 +234,0 @@ }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

972016

increased by0.17%

Lines of code

19886

increased by0.12%

Dependency changes

• + Added@datadog/browser-core@3.6.4(transitive)

• - Removed@datadog/browser-core@3.6.3(transitive)

• Updated@datadog/browser-core@3.6.4