chore!: update to JS SDK 2.x (#2738)

Co-authored-by: Marc Pichler <[email protected]>

Author: trentm

.github/workflows/test-all-versions.yml

@@ -46,7 +46,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        node: ["14", "16", "18", "20", "22"]
+        node: ["18", "20", "22"]
     runs-on: ubuntu-latest
     services:
       mongo:
@@ -143,9 +143,6 @@ jobs:
           node-version: ${{ matrix.node }}
       - name: Set MySQL variables
         run: mysql --user=root --password=${MYSQL_ROOT_PASSWORD} --host=${MYSQL_HOST} --port=${MYSQL_PORT} -e "SET GLOBAL log_output='TABLE'; SET GLOBAL general_log = 1;" mysql
-      - name: Update npm to a version that supports workspaces (v7 or later)
-        if: ${{ matrix.node < 16 }}
-        run: npm install -g npm@9 # npm@9 supports node >=14.17.0
       - name: Install
         run: npm ci
       - name: Download Build Artifacts

.github/workflows/unit-test.yml

@@ -37,7 +37,12 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        node: ["14", "16", "18", "20", "22"]
+        node:
+          - "18.19.0"
+          - "18"
+          - "20.6.0"
+          - "20"
+          - "22"
         include:
             - node: 18
               code-coverage: true
@@ -151,9 +156,6 @@ jobs:
           node-version: ${{ matrix.node }}
       - name: Set MySQL variables
         run: mysql --user=root --password=${MYSQL_ROOT_PASSWORD} --host=${MYSQL_HOST} --port=${MYSQL_PORT} -e "SET GLOBAL log_output='TABLE'; SET GLOBAL general_log = 1;" mysql
-      - name: Update npm to a version that supports workspaces (v7 or later)
-        if: ${{ matrix.node < 16 }}
-        run: npm install -g npm@9 # npm@9 supports node >=14.17.0
       - name: Install
         run: npm ci
       - name: Download Build Artifacts

detectors/node/opentelemetry-resource-detector-alibaba-cloud/package.json

@@ -28,7 +28,7 @@
   "author": "OpenTelemetry Authors",
   "license": "Apache-2.0",
   "engines": {
-    "node": ">=14"
+    "node": "^18.19.0 || >=20.6.0"
   },
   "files": [
     "build/src/**/*.js",
@@ -44,21 +44,22 @@
   "devDependencies": {
     "@opentelemetry/api": "^1.0.0",
     "@opentelemetry/contrib-test-utils": "^0.45.1",
+    "@opentelemetry/sdk-trace-base": "^2.0.0",
     "@types/mocha": "10.0.10",
     "@types/node": "18.18.14",
     "@types/sinon": "17.0.4",
     "nock": "13.3.3",
     "nyc": "15.1.0",
     "rimraf": "5.0.10",
     "sinon": "15.2.0",
-    "typescript": "4.4.4"
+    "typescript": "5.0.4"
   },
   "peerDependencies": {
     "@opentelemetry/api": "^1.0.0"
   },
   "dependencies": {
-    "@opentelemetry/core": "^1.26.0",
-    "@opentelemetry/resources": "^1.10.0",
+    "@opentelemetry/core": "^2.0.0",
+    "@opentelemetry/resources": "^2.0.0",
     "@opentelemetry/semantic-conventions": "^1.27.0"
   },
   "homepage": "https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/detectors/node/opentelemetry-resource-detector-alibaba-cloud#readme",

detectors/node/opentelemetry-resource-detector-alibaba-cloud/src/detectors/AlibabaCloudEcsDetector.ts

@@ -14,14 +14,12 @@
  * limitations under the License.
  */
 
-import { context } from '@opentelemetry/api';
+import { context, diag } from '@opentelemetry/api';
 import { suppressTracing } from '@opentelemetry/core';
 import {
-  DetectorSync,
-  IResource,
-  Resource,
-  ResourceAttributes,
-  ResourceDetectionConfig,
+  ResourceDetector,
+  DetectedResource,
+  DetectedResourceAttributes,
 } from '@opentelemetry/resources';
 import {
   CLOUDPLATFORMVALUES_ALIBABA_CLOUD_ECS,
@@ -43,7 +41,7 @@ import * as http from 'http';
  * AlibabaCloud ECS and return a {@link Resource} populated with metadata about
  * the ECS instance. Returns an empty Resource if detection fails.
  */
-class AlibabaCloudEcsDetector implements DetectorSync {
+class AlibabaCloudEcsDetector implements ResourceDetector {
   /**
    * See https://www.alibabacloud.com/help/doc-detail/67254.htm for
    * documentation about the AlibabaCloud instance identity document.
@@ -62,36 +60,59 @@ class AlibabaCloudEcsDetector implements DetectorSync {
    *
    * @param config (unused) The resource detection config
    */
-  detect(_config?: ResourceDetectionConfig): IResource {
-    const attributes = context.with(suppressTracing(context.active()), () =>
-      this._getAttributes()
+  detect(): DetectedResource {
+    const dataPromise = context.with(suppressTracing(context.active()), () =>
+      this._gatherData()
     );
-    return new Resource({}, attributes);
+
+    const attrNames = [
+      SEMRESATTRS_CLOUD_PROVIDER,
+      SEMRESATTRS_CLOUD_PLATFORM,
+      SEMRESATTRS_CLOUD_ACCOUNT_ID,
+      SEMRESATTRS_CLOUD_REGION,
+      SEMRESATTRS_CLOUD_AVAILABILITY_ZONE,
+      SEMRESATTRS_HOST_ID,
+      SEMRESATTRS_HOST_TYPE,
+      SEMRESATTRS_HOST_NAME,
+    ];
+
+    const attributes = {} as DetectedResourceAttributes;
+    attrNames.forEach(name => {
+      // Each resource attribute is determined asynchronously in _gatherData().
+      attributes[name] = dataPromise.then(data => data[name]);
+    });
+
+    return { attributes };
   }
 
   /** Gets identity and host info and returns them as attribs. Empty object if fails */
-  async _getAttributes(
-    _config?: ResourceDetectionConfig
-  ): Promise<ResourceAttributes> {
-    const {
-      'owner-account-id': accountId,
-      'instance-id': instanceId,
-      'instance-type': instanceType,
-      'region-id': region,
-      'zone-id': availabilityZone,
-    } = await this._fetchIdentity();
-    const hostname = await this._fetchHost();
+  async _gatherData(): Promise<DetectedResourceAttributes> {
+    try {
+      const {
+        'owner-account-id': accountId,
+        'instance-id': instanceId,
+        'instance-type': instanceType,
+        'region-id': region,
+        'zone-id': availabilityZone,
+      } = await this._fetchIdentity();
+      const hostname = await this._fetchHost();
 
-    return {
-      [SEMRESATTRS_CLOUD_PROVIDER]: CLOUDPROVIDERVALUES_ALIBABA_CLOUD,
-      [SEMRESATTRS_CLOUD_PLATFORM]: CLOUDPLATFORMVALUES_ALIBABA_CLOUD_ECS,
-      [SEMRESATTRS_CLOUD_ACCOUNT_ID]: accountId,
-      [SEMRESATTRS_CLOUD_REGION]: region,
-      [SEMRESATTRS_CLOUD_AVAILABILITY_ZONE]: availabilityZone,
-      [SEMRESATTRS_HOST_ID]: instanceId,
-      [SEMRESATTRS_HOST_TYPE]: instanceType,
-      [SEMRESATTRS_HOST_NAME]: hostname,
-    };
+      return {
+        [SEMRESATTRS_CLOUD_PROVIDER]: CLOUDPROVIDERVALUES_ALIBABA_CLOUD,
+        [SEMRESATTRS_CLOUD_PLATFORM]: CLOUDPLATFORMVALUES_ALIBABA_CLOUD_ECS,
+        [SEMRESATTRS_CLOUD_ACCOUNT_ID]: accountId,
+        [SEMRESATTRS_CLOUD_REGION]: region,
+        [SEMRESATTRS_CLOUD_AVAILABILITY_ZONE]: availabilityZone,
+        [SEMRESATTRS_HOST_ID]: instanceId,
+        [SEMRESATTRS_HOST_TYPE]: instanceType,
+        [SEMRESATTRS_HOST_NAME]: hostname,
+      };
+    } catch (err: any) {
+      diag.debug(
+        `${this.constructor.name}: did not detect resource: ${err?.message}`
+      );
+      return {};
+    }
   }
 
   /**

detectors/node/opentelemetry-resource-detector-alibaba-cloud/test/detectors/AlibabaCloudEcsDetector.test.ts

@@ -14,9 +14,10 @@
  * limitations under the License.
  */
 
+import { setTimeout as setTimeoutP } from 'timers/promises';
 import * as nock from 'nock';
 import * as assert from 'assert';
-import { Resource } from '@opentelemetry/resources';
+import { detectResources } from '@opentelemetry/resources';
 import { CLOUDPROVIDERVALUES_ALIBABA_CLOUD } from '@opentelemetry/semantic-conventions';
 import {
   assertCloudResource,
@@ -63,7 +64,9 @@ describe('alibabaCloudEcsDetector', () => {
         .get(ALIYUN_HOST_PATH)
         .reply(200, () => mockedHostResponse);
 
-      const resource: Resource = await alibabaCloudEcsDetector.detect();
+      const resource = detectResources({
+        detectors: [alibabaCloudEcsDetector],
+      });
       await resource.waitForAsyncAttributes?.();
 
       scope.done();
@@ -93,7 +96,9 @@ describe('alibabaCloudEcsDetector', () => {
         .get(ALIYUN_HOST_PATH)
         .reply(404, () => new Error());
 
-      const resource = await alibabaCloudEcsDetector.detect();
+      const resource = detectResources({
+        detectors: [alibabaCloudEcsDetector],
+      });
       await resource.waitForAsyncAttributes?.();
 
       assert.deepStrictEqual(resource.attributes, {});
@@ -109,7 +114,9 @@ describe('alibabaCloudEcsDetector', () => {
         .delayConnection(2000)
         .reply(200, () => mockedHostResponse);
 
-      const resource = await alibabaCloudEcsDetector.detect();
+      const resource = detectResources({
+        detectors: [alibabaCloudEcsDetector],
+      });
       await resource.waitForAsyncAttributes?.();
 
       assert.deepStrictEqual(resource.attributes, {});
@@ -122,10 +129,46 @@ describe('alibabaCloudEcsDetector', () => {
         .get(ALIYUN_IDENTITY_PATH)
         .replyWithError('NOT FOUND');
 
-      const resource = await alibabaCloudEcsDetector.detect();
+      const resource = detectResources({
+        detectors: [alibabaCloudEcsDetector],
+      });
+      await resource.waitForAsyncAttributes?.();
+
+      assert.deepStrictEqual(resource.attributes, {});
+
+      scope.done();
+    });
+  });
+
+  describe('with delay in calling .waitForAsyncAttributes()', () => {
+    // Note any `unhandledRejection` process events during the test run.
+    let gotUnhandledRejections: Error[];
+    const unhandleRejectionHandler = (err: any) => {
+      gotUnhandledRejections.push(err);
+    };
+    beforeEach(() => {
+      gotUnhandledRejections = [];
+      process.on('unhandledRejection', unhandleRejectionHandler);
+    });
+    afterEach(() => {
+      process.removeListener('unhandledRejection', unhandleRejectionHandler);
+    });
+
+    it('should return empty resource when receiving error', async () => {
+      const scope = nock(ALIYUN_HOST)
+        .get(ALIYUN_IDENTITY_PATH)
+        .replyWithError('NOT FOUND');
+
+      const resource = detectResources({
+        detectors: [alibabaCloudEcsDetector],
+      });
+      // This pause simulates the delay between `detectResources` and
+      // `waitForAsyncAttributes` typically called later in an exporter.
+      await setTimeoutP(200); // Hope this is enough time to get error response.
       await resource.waitForAsyncAttributes?.();
 
       assert.deepStrictEqual(resource.attributes, {});
+      assert.deepStrictEqual(gotUnhandledRejections, []);
 
       scope.done();
     });

detectors/node/opentelemetry-resource-detector-alibaba-cloud/test/detectors/AlibabaCloudEcsDetectorIntegration.test.ts

@@ -22,7 +22,7 @@ import {
   SimpleSpanProcessor,
 } from '@opentelemetry/sdk-trace-base';
 import { NodeSDK } from '@opentelemetry/sdk-node';
-import { IResource } from '@opentelemetry/resources';
+import { detectResources } from '@opentelemetry/resources';
 
 describe('[Integration] AlibabaCloudEcsDetector', () => {
   it('should not start spans for detector requests', async () => {
@@ -47,7 +47,7 @@ describe('[Integration] AlibabaCloudEcsDetector', () => {
     const {
       alibabaCloudEcsDetector,
     } = require('../../build/src/detectors/AlibabaCloudEcsDetector');
-    const resource = alibabaCloudEcsDetector.detect() as IResource;
+    const resource = detectResources({ detectors: [alibabaCloudEcsDetector] });
     await resource.waitForAsyncAttributes?.();
 
     // Wait for the next loop to let the span close properly

detectors/node/opentelemetry-resource-detector-aws/package.json

@@ -27,7 +27,7 @@
   "author": "OpenTelemetry Authors",
   "license": "Apache-2.0",
   "engines": {
-    "node": ">=14"
+    "node": "^18.19.0 || >=20.6.0"
   },
   "files": [
     "build/src/**/*.js",
@@ -44,22 +44,23 @@
     "@opentelemetry/api": "^1.0.0",
     "@opentelemetry/contrib-test-utils": "^0.45.1",
     "@opentelemetry/instrumentation-fs": "^0.19.1",
-    "@opentelemetry/instrumentation-http": "^0.57.2",
+    "@opentelemetry/instrumentation-http": "^0.200.0",
+    "@opentelemetry/sdk-trace-base": "^2.0.0",
     "@types/mocha": "10.0.10",
     "@types/node": "18.18.14",
     "@types/sinon": "17.0.4",
     "nock": "13.3.3",
     "nyc": "15.1.0",
     "rimraf": "5.0.10",
     "sinon": "15.2.0",
-    "typescript": "4.4.4"
+    "typescript": "5.0.4"
   },
   "peerDependencies": {
     "@opentelemetry/api": "^1.0.0"
   },
   "dependencies": {
-    "@opentelemetry/core": "^1.0.0",
-    "@opentelemetry/resources": "^1.10.0",
+    "@opentelemetry/core": "^2.0.0",
+    "@opentelemetry/resources": "^2.0.0",
     "@opentelemetry/semantic-conventions": "^1.27.0"
   },
   "homepage": "https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/detectors/node/opentelemetry-resource-detector-aws#readme",