Skip to content

Commit 99fb3fb

Browse files
pichlermarcpichlermarc
authored
fix(api): re-introduce fallback chain for global utils (#6523)
1 parent b842717 commit 99fb3fb

5 files changed

Lines changed: 161 additions & 1 deletion

File tree

‎.github/workflows/backcompat.yml‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
name: Old Node.js Compatibility
2+
on:
3+
push:
4+
branches:
5+
- main
6+
paths:
7+
- 'api/**'
8+
- '.github/workflows/backcompat.yml'
9+
pull_request:
10+
paths:
11+
- 'api/**'
12+
- '.github/workflows/backcompat.yml'
13+
merge_group:
14+
paths:
15+
- 'api/**'
16+
- '.github/workflows/backcompat.yml'
17+
18+
permissions:
19+
contents: read
20+
21+
jobs:
22+
backcompat:
23+
name: 'backcompat: ${{ matrix.package }} on Node.js ${{ matrix.node-version }}'
24+
strategy:
25+
fail-fast: false
26+
matrix:
27+
include:
28+
- package: api
29+
node-version: '8'
30+
script: test/backcompat/node8-compat.js
31+
runs-on: ubuntu-latest
32+
env:
33+
PACKAGE: ${{ matrix.package }}
34+
NODE_VERSION: ${{ matrix.node-version }}
35+
SCRIPT: ${{ matrix.script }}
36+
steps:
37+
- name: Checkout
38+
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
39+
40+
# Use a modern Node.js to install dependencies and compile TypeScript.
41+
- name: Setup Node.js (compile)
42+
uses: actions/setup-node@53b83947a5a98c8d113130e565377fae1a50d02f # v6
43+
with:
44+
node-version: '22'
45+
cache: 'npm'
46+
cache-dependency-path: package-lock.json
47+
48+
- name: Bootstrap
49+
run: npm ci --ignore-scripts
50+
51+
- name: Compile
52+
run: npm run compile
53+
54+
# Switch to the target old Node.js and run the standalone plain-JS smoke
55+
# test. Package is already compiled and dependencies are already installed.
56+
- name: Setup Node.js ${{ env.NODE_VERSION }} (test)
57+
uses: actions/setup-node@53b83947a5a98c8d113130e565377fae1a50d02f # v6
58+
with:
59+
node-version: ${{ env.NODE_VERSION }}
60+
61+
- name: Run compatibility smoke test
62+
run: node "$SCRIPT"
63+
working-directory: ${{ env.PACKAGE }}

‎api/CHANGELOG.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ All notable changes to this project will be documented in this file.
1515
* fix(api): update diag `consoleLogger` to use original console methods to prevent infinite loop when a console instrumentation is present [#6395](https://github.com/open-telemetry/opentelemetry-js/pull/6395)
1616
* fix(api): use `Attributes` instead of deprecated `SpanAttributes` in `SpanOptions` [#6478](https://github.com/open-telemetry/opentelemetry-js/pull/6478) @overbalance
1717
* fix(diag): change types in `DiagComponentLogger` from `any` to `unknown`[#5478](https://github.com/open-telemetry/opentelemetry-js/pull/5478) @loganrosen
18+
* fix(api): re-introduce fallback chain for global utils [#6523](https://github.com/open-telemetry/opentelemetry-js/pull/6523/) @pichlermarc
1819

1920
### :books: (Refine Doc)
2021

‎api/package.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@
2828
"lint": "eslint . --ext .ts && npm run cycle-check",
2929
"test:browser": "karma start --single-run",
3030
"test": "nyc mocha 'test/**/*.test.ts'",
31+
"test:node8-compat": "node test/backcompat/node8-compat.js",
3132
"test:webworker": "karma start karma.worker.js --single-run",
3233
"cycle-check": "dpdm --exit-code circular:1 src/index.ts",
3334
"version": "node ../scripts/version-update.js",

‎api/src/internal/global-utils.ts‎

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,21 @@ const GLOBAL_OPENTELEMETRY_API_KEY = Symbol.for(
1616
`opentelemetry.js.api.${major}`
1717
);
1818

19-
const _global = globalThis as OTelGlobal;
19+
declare const self: unknown;
20+
declare const window: unknown;
21+
declare const global: unknown;
22+
23+
const _global = (
24+
typeof globalThis === 'object'
25+
? globalThis
26+
: typeof self === 'object'
27+
? self
28+
: typeof window === 'object'
29+
? window
30+
: typeof global === 'object'
31+
? global
32+
: {}
33+
) as OTelGlobal;
2034

2135
export function registerGlobal<Type extends keyof OTelGlobalAPI>(
2236
type: Type,

‎api/test/backcompat/node8-compat.js‎

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
/*
2+
* Copyright The OpenTelemetry Authors
3+
* SPDX-License-Identifier: Apache-2.0
4+
*/
5+
6+
/**
7+
* Simple Node.js v8 compatibility smoke test. Intentionally avoids dependencies
8+
* so that we can keep updating tooling used for unit and integration tests.
9+
*
10+
* Intended to be run directly with node node8-compat.js
11+
*/
12+
13+
const assert = require('assert');
14+
15+
const GLOBAL_API_SYMBOL = Symbol.for('opentelemetry.js.api.1');
16+
17+
function clearGlobal() {
18+
delete global[GLOBAL_API_SYMBOL];
19+
}
20+
21+
function freshApi() {
22+
// Evict every cached module so each call returns a brand-new instance.
23+
Object.keys(require.cache).forEach(function (key) {
24+
delete require.cache[key];
25+
});
26+
return require('../../build/src/index.js');
27+
}
28+
29+
// Test 1: test global registration (the global used must exist)
30+
clearGlobal();
31+
const api = freshApi();
32+
33+
// this will throw or return false if registration fails.
34+
const result = api.diag.setLogger(
35+
new api.DiagConsoleLogger(),
36+
api.DiagLogLevel.ALL
37+
);
38+
assert.strictEqual(
39+
result,
40+
true,
41+
'Test 1 failed: diag.setLogger should return true'
42+
);
43+
44+
// Test 2: test that multiple loads share the same global state (e.g. logger)
45+
clearGlobal();
46+
47+
const api1 = freshApi();
48+
const api2 = freshApi(); // fresh load – different module object, same _global
49+
50+
const infoMessages = [];
51+
const sharedLogger = {
52+
error: function () {},
53+
warn: function () {},
54+
info: function (msg) {
55+
infoMessages.push(msg);
56+
},
57+
debug: function () {},
58+
verbose: function () {},
59+
};
60+
61+
const ok = api1.diag.setLogger(sharedLogger, api1.DiagLogLevel.ALL);
62+
assert.strictEqual(
63+
ok,
64+
true,
65+
'Test 2 setup failed: api1.diag.setLogger should return true'
66+
);
67+
68+
api2.diag.info('shared-state-check');
69+
assert.strictEqual(
70+
infoMessages.length,
71+
1,
72+
'Test 2 failed: api2 should forward logs to the logger registered via api1'
73+
);
74+
assert.strictEqual(
75+
infoMessages[0],
76+
'shared-state-check',
77+
'Test 2 failed: unexpected log message received'
78+
);
79+
80+
// clean-up
81+
clearGlobal();

0 commit comments

Comments
 (0)