Merge pull request #214 from Workiva/fix-new-root

Fix trace and traceSync not creating root spans when newRoot is true

Author: btr-rmconsole-1[bot]

lib/src/api/open_telemetry.dart

@@ -6,6 +6,7 @@ import 'dart:async';
 import 'package:meta/meta.dart';
 
 import '../../api.dart' as api;
+import '../../src/sdk/trace/tracer.dart' as sdk show Tracer;
 import '../experimental_api.dart';
 import 'propagation/noop_text_map_propagator.dart';
 import 'trace/noop_tracer_provider.dart';
@@ -102,12 +103,23 @@ Future<T> trace<T>(String name, Future<T> Function() fn,
   context ??= api.Context.current;
   tracer ??= _tracerProvider.getTracer('opentelemetry-dart');
 
-  final span = tracer.startSpan(name,
-      // TODO: use start span option `newRoot` instead
-      context: newRoot ? api.Context.root : context,
-      attributes: spanAttributes,
-      kind: spanKind,
-      links: spanLinks);
+  // TODO: use start span option `newRoot` instead
+  var span;
+  if (tracer is sdk.Tracer) {
+    span = tracer.startSpan(name,
+        context: context,
+        attributes: spanAttributes,
+        kind: spanKind,
+        links: spanLinks,
+        newRoot: newRoot);
+  } else {
+    span = tracer.startSpan(name,
+        context: newRoot ? api.Context.root : context,
+        attributes: spanAttributes,
+        kind: spanKind,
+        links: spanLinks);
+  }
+
   try {
     return await Zone.current.fork().run(() {
       final token = api.Context.attach(api.contextWithSpan(context!, span));
@@ -139,12 +151,23 @@ T traceSync<T>(String name, T Function() fn,
   context ??= api.Context.current;
   tracer ??= _tracerProvider.getTracer('opentelemetry-dart');
 
-  final span = tracer.startSpan(name,
-      // TODO: use start span option `newRoot` instead
-      context: newRoot ? api.Context.root : context,
-      attributes: spanAttributes,
-      kind: spanKind,
-      links: spanLinks);
+  // TODO: use start span option `newRoot` instead
+  var span;
+  if (tracer is sdk.Tracer) {
+    span = tracer.startSpan(name,
+        context: context,
+        attributes: spanAttributes,
+        kind: spanKind,
+        links: spanLinks,
+        newRoot: newRoot);
+  } else {
+    span = tracer.startSpan(name,
+        context: newRoot ? api.Context.root : context,
+        attributes: spanAttributes,
+        kind: spanKind,
+        links: spanLinks);
+  }
+
   try {
     return Zone.current.fork().run(() {
       final token = api.Context.attach(api.contextWithSpan(context!, span));

test/api/open_telemetry_test.dart

@@ -58,6 +58,32 @@ void main() {
     }, tracer: tracer, context: contextWithSpan(Context.current, parent));
   });
 
+  test('trace creates a root span', () async {
+    final parent = tracer.startSpan('parent')..end();
+    final context = contextWithSpan(Context.current, parent);
+    final token = Context.attach(context);
+
+    await trace('child', () async {
+      final child = spanFromContext(Context.current);
+      expect(child.parentSpanId.isValid, isFalse);
+    }, tracer: tracer, context: context, newRoot: true);
+
+    Context.detach(token);
+  });
+
+  test('traceSync creates a root span', () {
+    final parent = tracer.startSpan('parent')..end();
+    final context = contextWithSpan(Context.current, parent);
+    final token = Context.attach(context);
+
+    traceSync('child', () {
+      final child = spanFromContext(Context.current);
+      expect(child.parentSpanId.isValid, isFalse);
+    }, tracer: tracer, context: context, newRoot: true);
+
+    Context.detach(token);
+  });
+
   test('trace catches, records, and rethrows exception', () async {
     late sdk.Span span;
     var caught = false;