fix: enhanced typescript support for currentSpan().span (#1370)

- typing showed an error when accessing `instana.currentSpan().span` - defined the inner span attribute via TS - more TS & SDK improvements are coming soon
instana · Oct 9, 2024 · 762af17 · 762af17
1 parent 8df5f48
commit 762af17
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 12 deletions.
diff --git a/packages/collector/src/types/shared.d.ts b/packages/collector/src/types/shared.d.ts
@@ -2,7 +2,7 @@ import { CollectorConfig } from './collector';
 import { GenericLogger, InstanaBaseSpan } from '@instana/core/src/core';
 
 export interface Init {
-  currentSpan(): InstanaBaseSpan;
+  currentSpan(): { span: InstanaBaseSpan };
   isTracing(): boolean;
   isConnected(): boolean;
   setLogger(logger: GenericLogger): void;
@@ -15,13 +15,13 @@ export interface Init {
 
 export type InitFunction = {
   (config?: CollectorConfig): Init;
-  sdk: any;
+  currentSpan(): { span: InstanaBaseSpan };
+  isTracing(): boolean;
+  isConnected(): boolean;
+  setLogger(logger: GenericLogger): void;
   core: any;
-  currentSpan: any;
-  isTracing: any;
-  isConnected: any;
-  setLogger: any;
   sharedMetrics: any;
   experimental: any;
   opentracing: any;
+  sdk: any;
 };
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
@@ -28,7 +28,7 @@ app.get('/', async (req, res) => {
 app.get('/request', async (req, res) => {
   const currentSpan = instana.currentSpan();
 
-  if (!currentSpan) {
+  if (!currentSpan || !currentSpan.span || !currentSpan.span.t) {
     throw new Error('No current span available.');
   }
 

diff --git a/packages/collector/test/tracing/misc/typescript/ts_cjs/src/app_2.ts b/packages/collector/test/tracing/misc/typescript/ts_cjs/src/app_2.ts
@@ -28,7 +28,7 @@ app.get('/', async (req, res) => {
 app.get('/request', async (req, res) => {
   const currentSpan = instana.currentSpan();
 
-  if (!currentSpan) {
+  if (!currentSpan || !currentSpan.span || !currentSpan.span.t) {
     throw new Error('No current span available.');
   }
 

diff --git a/packages/collector/test/tracing/misc/typescript/ts_esm/src/app_1.ts b/packages/collector/test/tracing/misc/typescript/ts_esm/src/app_1.ts
@@ -28,7 +28,7 @@ app.get('/', async (req, res) => {
 app.get('/request', async (req, res) => {
   const currentSpan = instana.currentSpan();
 
-  if (!currentSpan) {
+  if (!currentSpan || !currentSpan.span || !currentSpan.span.t) {
     throw new Error('No current span available.');
   }
 

diff --git a/packages/collector/test/tracing/misc/typescript/ts_esm/src/app_2.ts b/packages/collector/test/tracing/misc/typescript/ts_esm/src/app_2.ts
@@ -28,7 +28,7 @@ app.get('/', async (req, res) => {
 app.get('/request', async (req, res) => {
   const currentSpan = instana.default.currentSpan();
 
-  if (!currentSpan) {
+  if (!currentSpan || !currentSpan.span || !currentSpan.span.t) {
     throw new Error('No current span available.');
   }
 

diff --git a/packages/collector/test/tracing/misc/typescript/ts_esm/ts_esm_test.js b/packages/collector/test/tracing/misc/typescript/ts_esm/ts_esm_test.js
@@ -25,7 +25,7 @@ const loaderPath = isLatestEsmSupportedVersion(process.versions.node)
 mochaSuiteFn('Typescript TS->ESM', function () {
   this.timeout(config.getTestTimeout() * 5);
 
-  mochaSuiteFn('[CASE 1]', () => {
+  describe('[CASE 1]', () => {
     globalAgent.setUpCleanUpHooks();
     const agentControls = globalAgent.instance;
 
@@ -68,7 +68,7 @@ mochaSuiteFn('Typescript TS->ESM', function () {
     });
   });
 
-  mochaSuiteFn('[CASE 2]', () => {
+  describe('[CASE 2]', () => {
     globalAgent.setUpCleanUpHooks();
     const agentControls = globalAgent.instance;