feat(sdk): added SpanHandle & NoopSpanHandle types (#1374)

- added support for TS e.g. `instana.currentSpan().getTraceId()`
instana · Oct 10, 2024 · 5e762a3 · 5e762a3
1 parent b618268
commit 5e762a3
Show file tree

Hide file tree

Showing 3 changed files with 70 additions and 3 deletions.
diff --git a/packages/collector/src/types/shared.d.ts b/packages/collector/src/types/shared.d.ts
@@ -1,8 +1,8 @@
 import { CollectorConfig } from './collector';
-import { GenericLogger, InstanaBaseSpan } from '@instana/core/src/core';
+import { GenericLogger, SpanHandle, NoopSpanHandle } from '@instana/core/src/core';
 
 export interface Init {
-  currentSpan(): { span: InstanaBaseSpan };
+  currentSpan(): SpanHandle | NoopSpanHandle;
   isTracing(): boolean;
   isConnected(): boolean;
   setLogger(logger: GenericLogger): void;
@@ -15,7 +15,7 @@ export interface Init {
 
 export type InitFunction = {
   (config?: CollectorConfig): Init;
-  currentSpan(): { span: InstanaBaseSpan };
+  currentSpan(): SpanHandle | NoopSpanHandle;
   isTracing(): boolean;
   isConnected(): boolean;
   setLogger(logger: GenericLogger): void;

diff --git a/packages/collector/test/tracing/misc/typescript/ts_cjs/src/app_1.ts b/packages/collector/test/tracing/misc/typescript/ts_cjs/src/app_1.ts
@@ -32,6 +32,10 @@ app.get('/request', async (req, res) => {
     throw new Error('No current span available.');
   }
 
+  if (!currentSpan.getTraceId()) {
+    throw new Error('getTraceId fn not available.');
+  }
+
   await fetch(`http://127.0.0.1:${agentPort}`);
   res.json({ success: true });
 });

diff --git a/packages/core/src/core.d.ts b/packages/core/src/core.d.ts
@@ -79,3 +79,66 @@ export interface InstanaBaseSpan {
   /** function to perform cleanup */
   cleanup?: () => void;
 }
+
+export interface SpanHandle {
+  span: InstanaBaseSpan;
+
+  getTraceId(): string | null;
+  getSpanId(): string | null;
+  getParentSpanId(): string | null;
+  getName(): string | null;
+
+  isEntrySpan(): boolean;
+  isExitSpan(): boolean;
+  isIntermediateSpan(): boolean;
+
+  getTimestamp(): number;
+  getDuration(): number;
+  getErrorCount(): number;
+
+  getCorrelationId(): string | null;
+  setCorrelationId(correlationId: string): void;
+
+  getCorrelationType(): string | null;
+  setCorrelationType(correlationType: string): void;
+
+  annotate(path: string | string[], value: any): void;
+
+  markAsErroneous(errorMessage?: string, errorMessagePath?: string | string[]): void;
+  markAsNonErroneous(errorMessagePath?: string | string[]): void;
+
+  disableAutoEnd(): void;
+  end(errorCount?: boolean | number): void;
+  cancel(): void;
+}
+
+export interface NoopSpanHandle {
+  span: undefined;
+  getTraceId(): null;
+  getSpanId(): null;
+  getParentSpanId(): null;
+  getName(): null;
+
+  isEntrySpan(): boolean;
+  isExitSpan(): boolean;
+  isIntermediateSpan(): boolean;
+
+  getTimestamp(): number;
+  getDuration(): number;
+  getErrorCount(): number;
+
+  getCorrelationId(): null;
+  setCorrelationId(correlationId: string): void;
+
+  getCorrelationType(): null;
+  setCorrelationType(correlationType: string): void;
+
+  annotate(path: string | string[], value: any): void;
+
+  markAsErroneous(errorMessage?: string, errorMessagePath?: string | string[]): void;
+  markAsNonErroneous(errorMessagePath?: string | string[]): void;
+
+  disableAutoEnd(): void;
+  end(errorCount?: boolean | number): void;
+  cancel(): void;
+}