feat: allow timestamps to be passed to endSpan (#747)

kjin · web-flow · commit 319642abf51d · 2018-05-14T13:00:59.000-07:00
PR-URL: #747
diff --git a/src/plugin-types.ts b/src/plugin-types.ts
@@ -52,8 +52,10 @@ export interface SpanData {
 
   /**
    * Ends the span. This method should only be called once.
+   * @param timestamp A custom span end time; defaults to the time when endSpan
+   * was called if not provided.
    */
-  endSpan(): void;
+  endSpan(timestamp?: Date): void;
 }
 
 /**
diff --git a/src/span-data.ts b/src/span-data.ts
@@ -103,8 +103,9 @@ export abstract class BaseSpanData implements SpanData {
     this.span.labels[k] = v;
   }
 
-  endSpan() {
-    this.span.endTime = (new Date()).toISOString();
+  endSpan(timestamp?: Date) {
+    timestamp = timestamp || new Date();
+    this.span.endTime = timestamp.toISOString();
   }
 }
 
@@ -131,8 +132,8 @@ export class RootSpanData extends BaseSpanData implements types.RootSpanData {
         skipFrames);      /* # of frames to skip in stack trace */
   }
 
-  endSpan() {
-    super.endSpan();
+  endSpan(timestamp?: Date) {
+    super.endSpan(timestamp);
     traceWriter.get().writeSpan(this.trace);
   }
 }
diff --git a/test/test-span-data.ts b/test/test-span-data.ts
@@ -85,7 +85,6 @@ describe('SpanData', () => {
     });
 
     it('accurately records timestamps', async () => {
-      // Create another span, to determine start time correctness
       const startLowerBound = Date.now();
       const spanData = new CommonSpanData(trace, 'name', '0', 0);
       const startUpperBound = Date.now();
@@ -106,6 +105,16 @@ describe('SpanData', () => {
           expectedTimes.slice().sort(ascending), expectedTimes);
     });
 
+    it('accepts a custom span end time', () => {
+      const spanData = new CommonSpanData(trace, 'name', '0', 0);
+      const startTime = new Date(spanData.span.startTime).getTime();
+      // This input Date is far enough in the future that it's unlikely that the
+      // time this function was called could be close to it.
+      spanData.endSpan(new Date(startTime + 1000000));
+      const endTime = new Date(spanData.span.endTime).getTime();
+      assert.strictEqual(endTime - startTime, 1000000);
+    });
+
     it('truncates large span names to limit', () => {
       const name = 'a'.repeat(200);
       const spanData = new CommonSpanData(trace, name, '0', 0);

Original file line number	Diff line number	Diff line change
`@@ -103,8 +103,9 @@ export abstract class BaseSpanData implements SpanData {`
`103`	`103`	`this.span.labels[k] = v;`
`104`	`104`	`}`
`105`	`105`
`106`		`- endSpan() {`
`107`		`- this.span.endTime = (new Date()).toISOString();`
	`106`	`+ endSpan(timestamp?: Date) {`
	`107`	`+ timestamp = timestamp \|\| new Date();`
	`108`	`+ this.span.endTime = timestamp.toISOString();`
`108`	`109`	`}`
`109`	`110`	`}`
`110`	`111`
`@@ -131,8 +132,8 @@ export class RootSpanData extends BaseSpanData implements types.RootSpanData {`
`131`	`132`	`skipFrames); /* # of frames to skip in stack trace */`
`132`	`133`	`}`
`133`	`134`
`134`		`- endSpan() {`
`135`		`- super.endSpan();`
	`135`	`+ endSpan(timestamp?: Date) {`
	`136`	`+ super.endSpan(timestamp);`
`136`	`137`	`traceWriter.get().writeSpan(this.trace);`
`137`	`138`	`}`
`138`	`139`	`}`