feat: add function to wrap SpanContext in NonRecordingSpan #49 (#51)

Author: dyladan

src/api/trace.ts

@@ -14,15 +14,18 @@
  * limitations under the License.
  */
 
-import { ProxyTracerProvider } from '../trace/ProxyTracerProvider';
-import { Tracer } from '../trace/tracer';
-import { TracerProvider } from '../trace/tracer_provider';
-import { isSpanContextValid } from '../trace/spancontext-utils';
 import {
   getGlobal,
   registerGlobal,
   unregisterGlobal,
 } from '../internal/global-utils';
+import { ProxyTracerProvider } from '../trace/ProxyTracerProvider';
+import {
+  isSpanContextValid,
+  wrapSpanContext,
+} from '../trace/spancontext-utils';
+import { Tracer } from '../trace/tracer';
+import { TracerProvider } from '../trace/tracer_provider';
 
 const API_NAME = 'trace';
 
@@ -76,5 +79,7 @@ export class TraceAPI {
     this._proxyTracerProvider = new ProxyTracerProvider();
   }
 
+  public wrapSpanContext = wrapSpanContext;
+
   public isSpanContextValid = isSpanContextValid;
 }

src/trace/spancontext-utils.ts

@@ -13,6 +13,8 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import { NonRecordingSpan } from './NonRecordingSpan';
+import { Span } from './span';
 import { SpanContext } from './span_context';
 import { TraceFlags } from './trace_flags';
 
@@ -43,3 +45,13 @@ export function isSpanContextValid(spanContext: SpanContext): boolean {
     isValidTraceId(spanContext.traceId) && isValidSpanId(spanContext.spanId)
   );
 }
+
+/**
+ * Wrap the given {@link SpanContext} in a new non-recording {@link Span}
+ *
+ * @param spanContext span context to be wrapped
+ * @returns a new non-recording {@link Span} with the provided context
+ */
+export function wrapSpanContext(spanContext: SpanContext): Span {
+  return new NonRecordingSpan(spanContext);
+}

test/trace/spancontext-utils.test.ts

@@ -54,4 +54,17 @@ describe('spancontext-utils', () => {
     };
     assert.ok(!context.isSpanContextValid(spanContext));
   });
+
+  it('should wrap a SpanContext in a non-recording span', () => {
+    const spanContext = {
+      traceId: 'd4cda95b652f4a1592b449d5929fda1b',
+      spanId: '6e0c63257de34c92',
+      traceFlags: TraceFlags.NONE,
+    };
+
+    const span = context.wrapSpanContext(spanContext);
+
+    assert.deepStrictEqual(span.spanContext(), spanContext);
+    assert.strictEqual(span.isRecording(), false);
+  });
 });