Make adjustPerfTimeOrigin take nav timing (#20)

Author: draffensperger

packages/opencensus-web-core/src/common/time-util.ts

@@ -43,15 +43,15 @@ export function getPerfTimeOrigin(): number {
  *     the client in a <script> in the rendered HTML.
  * @param serverNavFetchDuration The server's measurement of the request
  *     duration in milliseconds. This would also be sent to the client.
+ * @param perfNavTiming The performance navigation timing, which can be
+ *     retrieved by `performance.getEntriesByType('navigation')[0]`, provided
+ *     that the browser supports it.
  */
 export function adjustPerfTimeOrigin(
-    serverNavFetchStartTime: number, serverNavFetchDuration: number) {
-  // If there is no performance timing info, we don't have the client's
-  // start/end times for the navigation fetch, so we can't accurately use the
-  // server times to adjust the client time origin.
-  if (!performance.timing) return;
-  const clientStart = performance.timing.requestStart;
-  const clientEnd = performance.timing.responseStart;
+    serverNavFetchStartTime: number, serverNavFetchDuration: number,
+    perfNavTiming: PerformanceNavigationTiming) {
+  const clientStart = perfNavTiming.requestStart;
+  const clientEnd = perfNavTiming.responseStart;
   const clientNavFetchDuration = clientEnd - clientStart;
 
   // Server time is more than client time, which we don't expect, so don't try

packages/opencensus-web-core/test/test-time-util.ts

@@ -40,6 +40,47 @@ describe('time utils', () => {
   });
 
   describe('adjustPerfTimeOrigin', () => {
+    function createNavTiming({requestStart, responseStart}:
+                                 {requestStart: number, responseStart: number}):
+        PerformanceNavigationTiming {
+      return {
+        // This are used by the time adjustment function below.
+        requestStart,   // Client start time in performance clock millis.
+        responseStart,  // Client end time in performance clock millis.
+        // These are needed to satisfy the interface.
+        connectEnd: 0,
+        connectStart: 0,
+        decodedBodySize: 0,
+        domComplete: 0,
+        domContentLoadedEventEnd: 0,
+        domContentLoadedEventStart: 0,
+        domInteractive: 0,
+        domainLookupEnd: 0,
+        domainLookupStart: 0,
+        duration: 0,
+        encodedBodySize: 0,
+        entryType: '',
+        fetchStart: 0,
+        initiatorType: '',
+        loadEventEnd: 0,
+        loadEventStart: 0,
+        name: '',
+        nextHopProtocol: '',
+        redirectCount: 0,
+        redirectEnd: 0,
+        redirectStart: 0,
+        responseEnd: 0,
+        secureConnectionStart: 0,
+        startTime: 0,
+        toJSON: () => ({}),
+        transferSize: 0,
+        type: 'navigate',
+        unloadEventEnd: 0,
+        unloadEventStart: 0,
+        workerStart: 0,
+      };
+    }
+
     const CLIENT_TIME_ORIGIN = 1548000000000;
     beforeEach(() => {
       mockGetterOrValue(performance, 'timeOrigin', CLIENT_TIME_ORIGIN);
@@ -48,35 +89,31 @@ describe('time utils', () => {
       TEST_ONLY.clearAdjustedPerfTime();
     });
 
-    it('keeps client time origin if performance timing missing', () => {
-      spyOnProperty(performance, 'timing').and.returnValue(undefined);
-      adjustPerfTimeOrigin(1548000001000.2, 5.1);
-      expect(getPerfTimeOrigin()).toBe(CLIENT_TIME_ORIGIN);
-    });
-
     it('keeps client time origin if server time longer than client', () => {
       // Client nav fetch duration is 5ms
-      spyOnProperty(performance.timing, 'requestStart').and.returnValue(10.1);
-      spyOnProperty(performance.timing, 'responseStart').and.returnValue(15.1);
+      const perfNavTiming =
+          createNavTiming({requestStart: 10.1, responseStart: 15.1});
 
       // Server nav fetch duration is 10ms
-      adjustPerfTimeOrigin(1548000001000.2, /* serverNavFetchDuration */ 10);
+      adjustPerfTimeOrigin(
+          1548000001000.2, /* serverNavFetchDuration */ 10, perfNavTiming);
 
       expect(getPerfTimeOrigin()).toBe(CLIENT_TIME_ORIGIN);
     });
 
     it('adjusts origin to center server span in client span', () => {
-      const clientNavFetchStartInPerfTime = 10;  // Performance clock millis.
-      spyOnProperty(performance.timing, 'requestStart')
-          .and.returnValue(clientNavFetchStartInPerfTime);
-      const clientNavFetchEndInPerfTime = 18;  // Performance clock millis.
-      spyOnProperty(performance.timing, 'responseStart')
-          .and.returnValue(clientNavFetchEndInPerfTime);
-
+      const clientNavFetchStartInPerfTime = 10;
+      const clientNavFetchEndInPerfTime = 18;
+      const perfNavTiming = createNavTiming({
+        requestStart: clientNavFetchStartInPerfTime,
+        responseStart: clientNavFetchEndInPerfTime,
+      });
       const serverNavFetchStartEpochMillis = 1500000001000;  // Epoch millis.
       const serverNavFetchDuration = 6;                      // Duration millis
+
       adjustPerfTimeOrigin(
-          serverNavFetchStartEpochMillis, serverNavFetchDuration);
+          serverNavFetchStartEpochMillis, serverNavFetchDuration,
+          perfNavTiming);
 
       // Calculations to make the expectation clearer:
       const clientNavFetchDuration =

packages/opencensus-web-instrumentation-perf/src/perf-types.ts

@@ -91,6 +91,7 @@ export declare interface PerformanceNavigationTimingExtended extends
   readonly type: NavigationType;
   readonly unloadEventEnd: number;
   readonly unloadEventStart: number;
+  readonly redirectCount: number;
 }
 
 /**
@@ -158,12 +159,8 @@ export declare interface PerformanceLongTaskTiming extends PerformanceEntry {
   readonly attribution: TaskAttributionTiming[];
 }
 
-/** Enables casting `window` to have optional `PerformanceObserver` field. */
-export declare type WindowWithPerformanceObserver = Window & {
-  readonly PerformanceObserver?: PerformanceObserver;
-};
-
 /** Type for the `window` object with a field to track LongTask timings. */
-export declare type WindowWithLongTasks = WindowWithPerformanceObserver & {
+export declare interface WindowWithLongTasks extends Window {
+  readonly PerformanceObserver?: PerformanceObserver;
   ocwLt?: PerformanceLongTaskTiming[];
-};
+}

packages/opencensus-web-instrumentation-perf/test/test-perf-grouper.ts

@@ -91,6 +91,7 @@ const RESOURCE_ENTRY: PerformanceResourceTimingExtended = {
   nextHopProtocol: 'h2',
   redirectEnd: 0,
   redirectStart: 0,
+  redirectCount: 0,
   requestStart: 0,
   responseEnd: 280.1000000035856,
   responseStart: 0,

packages/opencensus-web-instrumentation-perf/test/test-resource-span.ts

@@ -47,6 +47,7 @@ describe('getResourceSpan', () => {
       nextHopProtocol: 'h2',
       redirectEnd: 0,
       redirectStart: 0,
+      redirectCount: 0,
       requestStart: 0,
       responseEnd: 280.1,
       responseStart: 0,