fix(resources): prevent circular import (resource -> detector -> resource -> ...) (#4653)

pichlermarc · pichlermarc · commit 307e33a4d2fc · 2024-05-06T16:04:58.000+02:00
* fix(resources): prevent circular import (resource -&gt; detector -&gt; resource -&gt; ...)

* fixup! fix(resources): prevent circular import (resource -&gt; detector -&gt; resource -&gt; ...)
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -29,6 +29,8 @@ For experimental package changes, see the [experimental CHANGELOG](experimental/
 
 * fix(sdk-trace-web): fix invalid timings in span events [#4486](https://github.com/open-telemetry/opentelemetry-js/pull/4486) @Abinet18
 * fix(resources): ensure BrowserDetector does not think Node.js v21 is a browser [#4561](https://github.com/open-telemetry/opentelemetry-js/issues/4561) @trentm
+* fix(resources): prevent circular import (resource -> detector -> resource -> ...) [#4653](https://github.com/open-telemetry/opentelemetry-js/pull/4653) @pichlermarc
+  * fixes a circular import warning which would appear in rollup when bundling `@opentelemetry/resources`
 
 ## 1.23.0
 
diff --git a/packages/opentelemetry-resources/package.json b/packages/opentelemetry-resources/package.json
@@ -9,7 +9,11 @@
     "./src/platform/index.ts": "./src/platform/browser/index.ts",
     "./build/esm/platform/index.js": "./build/esm/platform/browser/index.js",
     "./build/esnext/platform/index.js": "./build/esnext/platform/browser/index.js",
-    "./build/src/platform/index.js": "./build/src/platform/browser/index.js"
+    "./build/src/platform/index.js": "./build/src/platform/browser/index.js",
+    "./src/detectors/platform/index.ts": "./src/detectors/platform/browser/index.ts",
+    "./build/esm/detectors/platform/index.js": "./build/esm/detectors/platform/browser/index.js",
+    "./build/esnext/detectors/platform/index.js": "./build/esnext/detectors/platform/browser/index.js",
+    "./build/src/detectors/platform/index.js": "./build/src/detectors/platform/browser/index.js"
   },
   "types": "build/src/index.d.ts",
   "repository": "open-telemetry/opentelemetry-js",
diff --git a/packages/opentelemetry-resources/src/detectors/BrowserDetector.ts b/packages/opentelemetry-resources/src/detectors/BrowserDetector.ts
@@ -14,12 +14,10 @@
  * limitations under the License.
  */
 
-import {
-  browserDetectorSync,
-  Detector,
-  IResource,
-  ResourceDetectionConfig,
-} from '..';
+import { IResource } from '../IResource';
+import { ResourceDetectionConfig } from '../config';
+import { Detector } from '../types';
+import { browserDetectorSync } from './BrowserDetectorSync';
 
 /**
  * BrowserDetector will be used to detect the resources related to browser.
diff --git a/packages/opentelemetry-resources/src/detectors/BrowserDetectorSync.ts b/packages/opentelemetry-resources/src/detectors/BrowserDetectorSync.ts
@@ -15,9 +15,11 @@
  */
 
 import { SemanticResourceAttributes } from '@opentelemetry/semantic-conventions';
-import { DetectorSync, IResource, Resource, ResourceDetectionConfig } from '..';
-import { ResourceAttributes } from '../types';
+import { DetectorSync, ResourceAttributes } from '../types';
 import { diag } from '@opentelemetry/api';
+import { ResourceDetectionConfig } from '../config';
+import { IResource } from '../IResource';
+import { Resource } from '../Resource';
 
 /**
  * BrowserDetectorSync will be used to detect the resources related to browser.
diff --git a/packages/opentelemetry-resources/src/detectors/index.ts b/packages/opentelemetry-resources/src/detectors/index.ts
@@ -14,7 +14,16 @@
  * limitations under the License.
  */
 
-export * from './BrowserDetector';
-export * from './EnvDetector';
-export * from './BrowserDetectorSync';
-export * from './EnvDetectorSync';
+export {
+  hostDetector,
+  hostDetectorSync,
+  osDetector,
+  osDetectorSync,
+  processDetector,
+  processDetectorSync,
+  serviceInstanceIdDetectorSync,
+} from './platform';
+export { browserDetector } from './BrowserDetector';
+export { envDetector } from './EnvDetector';
+export { browserDetectorSync } from './BrowserDetectorSync';
+export { envDetectorSync } from './EnvDetectorSync';
diff --git a/packages/opentelemetry-resources/src/detectors/platform/browser/HostDetector.ts b/packages/opentelemetry-resources/src/detectors/platform/browser/HostDetector.ts
@@ -14,6 +14,6 @@
  * limitations under the License.
  */
 
-import { noopDetector } from '../../detectors/NoopDetector';
+import { noopDetector } from '../../NoopDetector';
 
 export const hostDetector = noopDetector;
diff --git a/packages/opentelemetry-resources/src/detectors/platform/browser/HostDetectorSync.ts b/packages/opentelemetry-resources/src/detectors/platform/browser/HostDetectorSync.ts
@@ -14,6 +14,6 @@
  * limitations under the License.
  */
 
-import { noopDetectorSync } from '../../detectors/NoopDetectorSync';
+import { noopDetectorSync } from '../../NoopDetectorSync';
 
 export const hostDetectorSync = noopDetectorSync;
diff --git a/packages/opentelemetry-resources/src/detectors/platform/browser/OSDetector.ts b/packages/opentelemetry-resources/src/detectors/platform/browser/OSDetector.ts
@@ -14,6 +14,6 @@
  * limitations under the License.
  */
 
-import { noopDetector } from '../../detectors/NoopDetector';
+import { noopDetector } from '../../NoopDetector';
 
 export const osDetector = noopDetector;
diff --git a/packages/opentelemetry-resources/src/detectors/platform/browser/OSDetectorSync.ts b/packages/opentelemetry-resources/src/detectors/platform/browser/OSDetectorSync.ts
@@ -14,6 +14,6 @@
  * limitations under the License.
  */
 
-import { noopDetectorSync } from '../../detectors/NoopDetectorSync';
+import { noopDetectorSync } from '../../NoopDetectorSync';
 
 export const osDetectorSync = noopDetectorSync;
diff --git a/packages/opentelemetry-resources/src/detectors/platform/browser/ProcessDetector.ts b/packages/opentelemetry-resources/src/detectors/platform/browser/ProcessDetector.ts
@@ -14,6 +14,6 @@
  * limitations under the License.
  */
 
-import { noopDetector } from '../../detectors/NoopDetector';
+import { noopDetector } from '../../NoopDetector';
 
 export const processDetector = noopDetector;
diff --git a/packages/opentelemetry-resources/src/detectors/platform/browser/ProcessDetectorSync.ts b/packages/opentelemetry-resources/src/detectors/platform/browser/ProcessDetectorSync.ts
@@ -14,6 +14,6 @@
  * limitations under the License.
  */
 
-import { noopDetector } from '../../detectors/NoopDetector';
+import { noopDetector } from '../../NoopDetector';
 
 export const processDetectorSync = noopDetector;
diff --git a/packages/opentelemetry-resources/src/detectors/platform/browser/ServiceInstanceIdDetectorSync.ts b/packages/opentelemetry-resources/src/detectors/platform/browser/ServiceInstanceIdDetectorSync.ts
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import { noopDetectorSync } from '../../detectors/NoopDetectorSync';
+import { noopDetectorSync } from '../../NoopDetectorSync';
 
 /**
  * @experimental
diff --git a/packages/opentelemetry-resources/src/detectors/platform/browser/index.ts b/packages/opentelemetry-resources/src/detectors/platform/browser/index.ts
@@ -0,0 +1,23 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export { hostDetector } from './HostDetector';
+export { hostDetectorSync } from './HostDetectorSync';
+export { osDetector } from './OSDetector';
+export { osDetectorSync } from './OSDetectorSync';
+export { processDetector } from './ProcessDetector';
+export { processDetectorSync } from './ProcessDetectorSync';
+export { serviceInstanceIdDetectorSync } from './ServiceInstanceIdDetectorSync';
diff --git a/packages/opentelemetry-resources/src/detectors/platform/index.ts b/packages/opentelemetry-resources/src/detectors/platform/index.ts
@@ -0,0 +1,24 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export {
+  hostDetector,
+  hostDetectorSync,
+  osDetector,
+  osDetectorSync,
+  processDetector,
+  processDetectorSync,
+  serviceInstanceIdDetectorSync,
+} from './node';
diff --git a/packages/opentelemetry-resources/src/detectors/platform/node/HostDetector.ts b/packages/opentelemetry-resources/src/detectors/platform/node/HostDetector.ts
@@ -14,9 +14,9 @@
  * limitations under the License.
  */
 
-import { Detector } from '../../types';
-import { ResourceDetectionConfig } from '../../config';
-import { IResource } from '../../IResource';
+import { Detector } from '../../../types';
+import { ResourceDetectionConfig } from '../../../config';
+import { IResource } from '../../../IResource';
 import { hostDetectorSync } from './HostDetectorSync';
 
 /**
diff --git a/packages/opentelemetry-resources/src/detectors/platform/node/HostDetectorSync.ts b/packages/opentelemetry-resources/src/detectors/platform/node/HostDetectorSync.ts
@@ -15,9 +15,9 @@
  */
 
 import { SemanticResourceAttributes } from '@opentelemetry/semantic-conventions';
-import { Resource } from '../../Resource';
-import { DetectorSync, ResourceAttributes } from '../../types';
-import { ResourceDetectionConfig } from '../../config';
+import { Resource } from '../../../Resource';
+import { DetectorSync, ResourceAttributes } from '../../../types';
+import { ResourceDetectionConfig } from '../../../config';
 import { arch, hostname } from 'os';
 import { normalizeArch } from './utils';
 import { getMachineId } from './machine-id/getMachineId';
diff --git a/packages/opentelemetry-resources/src/detectors/platform/node/OSDetector.ts b/packages/opentelemetry-resources/src/detectors/platform/node/OSDetector.ts
@@ -14,9 +14,9 @@
  * limitations under the License.
  */
 
-import { Detector } from '../../types';
-import { ResourceDetectionConfig } from '../../config';
-import { IResource } from '../../IResource';
+import { Detector } from '../../../types';
+import { ResourceDetectionConfig } from '../../../config';
+import { IResource } from '../../../IResource';
 import { osDetectorSync } from './OSDetectorSync';
 
 /**
diff --git a/packages/opentelemetry-resources/src/detectors/platform/node/OSDetectorSync.ts b/packages/opentelemetry-resources/src/detectors/platform/node/OSDetectorSync.ts
@@ -15,9 +15,9 @@
  */
 
 import { SemanticResourceAttributes } from '@opentelemetry/semantic-conventions';
-import { Resource } from '../../Resource';
-import { DetectorSync, ResourceAttributes } from '../../types';
-import { ResourceDetectionConfig } from '../../config';
+import { Resource } from '../../../Resource';
+import { DetectorSync, ResourceAttributes } from '../../../types';
+import { ResourceDetectionConfig } from '../../../config';
 import { platform, release } from 'os';
 import { normalizeType } from './utils';
 
diff --git a/packages/opentelemetry-resources/src/detectors/platform/node/ProcessDetector.ts b/packages/opentelemetry-resources/src/detectors/platform/node/ProcessDetector.ts
@@ -14,9 +14,9 @@
  * limitations under the License.
  */
 
-import { Detector } from '../../types';
-import { ResourceDetectionConfig } from '../../config';
-import { IResource } from '../../IResource';
+import { Detector } from '../../../types';
+import { ResourceDetectionConfig } from '../../../config';
+import { IResource } from '../../../IResource';
 import { processDetectorSync } from './ProcessDetectorSync';
 
 /**
diff --git a/packages/opentelemetry-resources/src/detectors/platform/node/ProcessDetectorSync.ts b/packages/opentelemetry-resources/src/detectors/platform/node/ProcessDetectorSync.ts
@@ -16,10 +16,10 @@
 
 import { diag } from '@opentelemetry/api';
 import { SemanticResourceAttributes } from '@opentelemetry/semantic-conventions';
-import { Resource } from '../../Resource';
-import { DetectorSync, ResourceAttributes } from '../../types';
-import { ResourceDetectionConfig } from '../../config';
-import { IResource } from '../../IResource';
+import { Resource } from '../../../Resource';
+import { DetectorSync, ResourceAttributes } from '../../../types';
+import { ResourceDetectionConfig } from '../../../config';
+import { IResource } from '../../../IResource';
 import * as os from 'os';
 
 /**
diff --git a/packages/opentelemetry-resources/src/detectors/platform/node/ServiceInstanceIdDetectorSync.ts b/packages/opentelemetry-resources/src/detectors/platform/node/ServiceInstanceIdDetectorSync.ts
@@ -15,9 +15,9 @@
  */
 
 import { SEMRESATTRS_SERVICE_INSTANCE_ID } from '@opentelemetry/semantic-conventions';
-import { Resource } from '../../Resource';
-import { DetectorSync, ResourceAttributes } from '../../types';
-import { ResourceDetectionConfig } from '../../config';
+import { Resource } from '../../../Resource';
+import { DetectorSync, ResourceAttributes } from '../../../types';
+import { ResourceDetectionConfig } from '../../../config';
 import { randomUUID } from 'crypto';
 
 /**
diff --git a/packages/opentelemetry-resources/src/detectors/platform/node/index.ts b/packages/opentelemetry-resources/src/detectors/platform/node/index.ts
@@ -0,0 +1,23 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export { hostDetector } from './HostDetector';
+export { hostDetectorSync } from './HostDetectorSync';
+export { osDetector } from './OSDetector';
+export { osDetectorSync } from './OSDetectorSync';
+export { processDetector } from './ProcessDetector';
+export { processDetectorSync } from './ProcessDetectorSync';
+export { serviceInstanceIdDetectorSync } from './ServiceInstanceIdDetectorSync';
diff --git a/packages/opentelemetry-resources/src/detectors/platform/node/machine-id/execAsync.ts b/packages/opentelemetry-resources/src/detectors/platform/node/machine-id/execAsync.ts
diff --git a/packages/opentelemetry-resources/src/detectors/platform/node/machine-id/getMachineId-bsd.ts b/packages/opentelemetry-resources/src/detectors/platform/node/machine-id/getMachineId-bsd.ts
diff --git a/packages/opentelemetry-resources/src/detectors/platform/node/machine-id/getMachineId-darwin.ts b/packages/opentelemetry-resources/src/detectors/platform/node/machine-id/getMachineId-darwin.ts
diff --git a/packages/opentelemetry-resources/src/detectors/platform/node/machine-id/getMachineId-linux.ts b/packages/opentelemetry-resources/src/detectors/platform/node/machine-id/getMachineId-linux.ts
diff --git a/packages/opentelemetry-resources/src/detectors/platform/node/machine-id/getMachineId-unsupported.ts b/packages/opentelemetry-resources/src/detectors/platform/node/machine-id/getMachineId-unsupported.ts
diff --git a/packages/opentelemetry-resources/src/detectors/platform/node/machine-id/getMachineId-win.ts b/packages/opentelemetry-resources/src/detectors/platform/node/machine-id/getMachineId-win.ts
diff --git a/packages/opentelemetry-resources/src/detectors/platform/node/machine-id/getMachineId.ts b/packages/opentelemetry-resources/src/detectors/platform/node/machine-id/getMachineId.ts
diff --git a/packages/opentelemetry-resources/src/detectors/platform/node/utils.ts b/packages/opentelemetry-resources/src/detectors/platform/node/utils.ts
diff --git a/packages/opentelemetry-resources/src/index.ts b/packages/opentelemetry-resources/src/index.ts
@@ -14,10 +14,22 @@
  * limitations under the License.
  */
 
-export * from './Resource';
-export * from './IResource';
-export * from './platform';
-export * from './types';
-export * from './config';
-export * from './detectors';
-export * from './detect-resources';
+export { Resource } from './Resource';
+export { IResource } from './IResource';
+export { defaultServiceName } from './platform';
+export { DetectorSync, ResourceAttributes, Detector } from './types';
+export { ResourceDetectionConfig } from './config';
+export {
+  browserDetector,
+  browserDetectorSync,
+  envDetector,
+  envDetectorSync,
+  hostDetector,
+  hostDetectorSync,
+  osDetector,
+  osDetectorSync,
+  processDetector,
+  processDetectorSync,
+  serviceInstanceIdDetectorSync,
+} from './detectors';
+export { detectResourcesSync, detectResources } from './detect-resources';
diff --git a/packages/opentelemetry-resources/src/platform/browser/index.ts b/packages/opentelemetry-resources/src/platform/browser/index.ts
@@ -13,12 +13,4 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
-export * from './default-service-name';
-export * from './HostDetector';
-export * from './HostDetectorSync';
-export * from './OSDetector';
-export * from './OSDetectorSync';
-export * from './ProcessDetector';
-export * from './ProcessDetectorSync';
-export * from './ServiceInstanceIdDetectorSync';
+export { defaultServiceName } from './default-service-name';
diff --git a/packages/opentelemetry-resources/src/platform/index.ts b/packages/opentelemetry-resources/src/platform/index.ts
@@ -14,4 +14,4 @@
  * limitations under the License.
  */
 
-export * from './node';
+export { defaultServiceName } from './node';
diff --git a/packages/opentelemetry-resources/src/platform/node/index.ts b/packages/opentelemetry-resources/src/platform/node/index.ts
@@ -13,12 +13,4 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
-export * from './default-service-name';
-export * from './HostDetector';
-export * from './HostDetectorSync';
-export * from './OSDetector';
-export * from './OSDetectorSync';
-export * from './ProcessDetector';
-export * from './ProcessDetectorSync';
-export * from './ServiceInstanceIdDetectorSync';
+export { defaultServiceName } from './default-service-name';
diff --git a/packages/opentelemetry-resources/test/detectors/node/HostDetector.test.ts b/packages/opentelemetry-resources/test/detectors/node/HostDetector.test.ts
@@ -27,7 +27,7 @@ describeNode('hostDetector() on Node.js', () => {
 
   it('should return resource information about the host', async () => {
     const os = require('os');
-    const mid = require('../../../src/platform/node/machine-id/getMachineId');
+    const mid = require('../../../src/detectors/platform/node/machine-id/getMachineId');
 
     const expectedHostId = 'f2c668b579780554f70f72a063dc0864';
 
@@ -67,7 +67,7 @@ describeNode('hostDetector() on Node.js', () => {
 
   it('should handle missing machine id', async () => {
     const os = require('os');
-    const mid = require('../../../src/platform/node/machine-id/getMachineId');
+    const mid = require('../../../src/detectors/platform/node/machine-id/getMachineId');
 
     sinon.stub(os, 'arch').returns('x64');
     sinon.stub(os, 'hostname').returns('opentelemetry-test');
diff --git a/packages/opentelemetry-resources/test/detectors/node/machine-id/getMachineId-bsd.test.ts b/packages/opentelemetry-resources/test/detectors/node/machine-id/getMachineId-bsd.test.ts
@@ -18,8 +18,8 @@ import * as sinon from 'sinon';
 import * as assert from 'assert';
 import { promises as fs } from 'fs';
 import { PromiseWithChild } from 'child_process';
-import * as util from '../../../../src/platform/node/machine-id/execAsync';
-import { getMachineId } from '../../../../src/platform/node/machine-id/getMachineId-bsd';
+import * as util from '../../../../src/detectors/platform/node/machine-id/execAsync';
+import { getMachineId } from '../../../../src/detectors/platform/node/machine-id/getMachineId-bsd';
 
 describe('getMachineId on BSD', () => {
   const expectedMachineId = 'f2c668b579780554f70f72a063dc0864';
diff --git a/packages/opentelemetry-resources/test/detectors/node/machine-id/getMachineId-darwin.test.ts b/packages/opentelemetry-resources/test/detectors/node/machine-id/getMachineId-darwin.test.ts
diff --git a/packages/opentelemetry-resources/test/detectors/node/machine-id/getMachineId-linux.test.ts b/packages/opentelemetry-resources/test/detectors/node/machine-id/getMachineId-linux.test.ts
diff --git a/packages/opentelemetry-resources/test/detectors/node/machine-id/getMachineId-win.test.ts b/packages/opentelemetry-resources/test/detectors/node/machine-id/getMachineId-win.test.ts
