feat!: widen peer dependency range to include zone.js v0.15.0 (#2571)

Co-authored-by: Mend Renovate <[email protected]>
open-telemetry · Dec 6, 2024 · 2e0cbdf · 2e0cbdf
1 parent de679ad
commit 2e0cbdf
Show file tree

Hide file tree

Showing 7 changed files with 27 additions and 28 deletions.
diff --git a/metapackages/auto-instrumentations-web/package.json b/metapackages/auto-instrumentations-web/package.json
@@ -31,7 +31,7 @@
   },
   "peerDependencies": {
     "@opentelemetry/api": "^1.3.0",
-    "zone.js": "^0.11.4 || ^0.13.0 || ^0.14.0"
+    "zone.js": "^0.11.4 || ^0.13.0 || ^0.14.0 || ^0.15.0"
   },
   "devDependencies": {
     "@babel/core": "7.24.6",

diff --git a/package-lock.json b/package-lock.json
diff --git a/plugins/web/opentelemetry-instrumentation-long-task/package.json b/plugins/web/opentelemetry-instrumentation-long-task/package.json
@@ -74,7 +74,7 @@
     "webpack": "5.94.0",
     "webpack-cli": "5.1.4",
     "webpack-merge": "5.10.0",
-    "zone.js": "^0.11.4 || ^0.13.0 || ^0.14.0"
+    "zone.js": "^0.11.4 || ^0.13.0 || ^0.14.0 || ^0.15.0"
   },
   "dependencies": {
     "@opentelemetry/core": "^1.8.0",

diff --git a/plugins/web/opentelemetry-instrumentation-user-interaction/package.json b/plugins/web/opentelemetry-instrumentation-user-interaction/package.json
@@ -76,7 +76,7 @@
     "webpack": "5.94.0",
     "webpack-cli": "5.1.4",
     "webpack-merge": "5.10.0",
-    "zone.js": "^0.11.4 || ^0.13.0 || ^0.14.0"
+    "zone.js": "^0.11.4 || ^0.13.0 || ^0.14.0 || ^0.15.0"
   },
   "dependencies": {
     "@opentelemetry/core": "^1.8.0",
@@ -85,7 +85,7 @@
   },
   "peerDependencies": {
     "@opentelemetry/api": "^1.3.0",
-    "zone.js": "^0.11.4 || ^0.13.0 || ^0.14.0"
+    "zone.js": "^0.11.4 || ^0.13.0 || ^0.14.0 || ^0.15.0"
   },
   "sideEffects": false,
   "homepage": "https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/web/opentelemetry-instrumentation-user-interaction#readme"

diff --git a/plugins/web/opentelemetry-instrumentation-user-interaction/src/instrumentation.ts b/plugins/web/opentelemetry-instrumentation-user-interaction/src/instrumentation.ts
@@ -575,7 +575,7 @@ export class UserInteractionInstrumentation extends InstrumentationBase<UserInte
    * implements enable function
    */
   override enable() {
-    const ZoneWithPrototype = this.getZoneWithPrototype();
+    const ZoneWithPrototype = this._getZoneWithPrototype();
     this._diag.debug(
       'applying patch to',
       this.moduleName,
@@ -645,7 +645,7 @@ export class UserInteractionInstrumentation extends InstrumentationBase<UserInte
    * implements unpatch function
    */
   override disable() {
-    const ZoneWithPrototype = this.getZoneWithPrototype();
+    const ZoneWithPrototype = this._getZoneWithPrototype();
     this._diag.debug(
       'removing patch from',
       this.moduleName,
@@ -680,7 +680,7 @@ export class UserInteractionInstrumentation extends InstrumentationBase<UserInte
   /**
    * returns Zone
    */
-  getZoneWithPrototype(): ZoneTypeWithPrototype | undefined {
+  private _getZoneWithPrototype(): ZoneTypeWithPrototype | undefined {
     const _window: WindowWithZone = window as unknown as WindowWithZone;
     return _window.Zone;
   }

diff --git a/plugins/web/opentelemetry-instrumentation-user-interaction/src/internal-types.ts b/plugins/web/opentelemetry-instrumentation-user-interaction/src/internal-types.ts
@@ -14,6 +14,7 @@
  * limitations under the License.
  */
 
+/// <reference types="zone.js" />
 import { HrTime } from '@opentelemetry/api';
 import { EventName } from './types';
 

diff --git a/...ns/web/opentelemetry-instrumentation-user-interaction/test/userInteraction.nozone.test.ts b/...ns/web/opentelemetry-instrumentation-user-interaction/test/userInteraction.nozone.test.ts
@@ -58,7 +58,9 @@ describe('UserInteractionInstrumentation', () => {
       });
 
       sandbox
-        .stub(userInteractionInstrumentation, 'getZoneWithPrototype')
+        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+        // @ts-ignore this is private, but it exists
+        .stub(userInteractionInstrumentation, '_getZoneWithPrototype')
         .callsFake(() => {
           return false as any;
         });