fix(core): avoid leaking Node.js types via unrefTimer() util

CHANGELOG.md

@@ -16,6 +16,7 @@ For notes on migrating to 2.x / 0.200.x see [the upgrade guide](doc/upgrade-to-2
 
 ### :bug: Bug Fixes
 
+* fix(core): avoid leaking Node.js types via `unrefTimer()` util [#5986](https://github.com/open-telemetry/opentelemetry-js/pull/5986)
 * fix(core): avoid leaking Node.js types via otperformance [#5987](https://github.com/open-telemetry/opentelemetry-js/pull/5987) @pichlermarc
  * **important:** this bug fix may be breaking for certain uses of `otperformnace`
  * `otperformance.now()` and `otperformance.timeOrigin` are not affected.

experimental/packages/sdk-logs/src/export/BatchLogRecordProcessorBase.ts

@@ -20,7 +20,6 @@ import {
  ExportResultCode,
  getNumberFromEnv,
  globalErrorHandler,
- unrefTimer,
  BindOnceFuture,
  internal,
  callWithTimeout,
@@ -40,7 +39,7 @@ export abstract class BatchLogRecordProcessorBase<T extends BufferConfig>
  private readonly _exportTimeoutMillis: number;
 
  private _finishedLogRecords: SdkLogRecord[] = [];
- private _timer: NodeJS.Timeout | undefined;
+ private _timer: NodeJS.Timeout | number | undefined;
  private _shutdownOnce: BindOnceFuture<void>;
 
  constructor(
@@ -162,7 +161,11 @@ export abstract class BatchLogRecordProcessorBase<T extends BufferConfig>
  globalErrorHandler(e);
  });
  }, this._scheduledDelayMillis);
- unrefTimer(this._timer);
+
+ // depending on runtime, this may be a 'number' or NodeJS.Timeout
+ if (typeof this._timer !== 'number') {
+ this._timer.unref();
+ }
  }
 
  private _clearTimer() {

packages/opentelemetry-core/src/platform/node/timer-util.ts → packages/opentelemetry-core/src/common/timer-util.ts

@@ -13,6 +13,13 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-export function unrefTimer(timer: NodeJS.Timer): void {
- timer.unref();
+
+/**
+ * @deprecated please copy this code to your implementation instead, this function will be removed in the next major version of this package.
+ * @param timer
+ */
+export function unrefTimer(timer: { unref(): unknown } | number): void {
+ if (typeof timer !== 'number') {
+ timer.unref();
+ }
 }

packages/opentelemetry-core/src/index.ts

@@ -37,6 +37,7 @@ export {
  millisToHrTime,
  timeInputToHrTime,
 } from './common/time';
+export { unrefTimer } from './common/timer-util';
 export type { ErrorHandler, InstrumentationScope } from './common/types';
 export { ExportResultCode } from './ExportResult';
 export type { ExportResult } from './ExportResult';
@@ -49,7 +50,6 @@ export {
  getNumberFromEnv,
  getStringListFromEnv,
  otperformance,
- unrefTimer,
 } from './platform';
 export { CompositePropagator } from './propagation/composite';
 export type { CompositePropagatorConfig } from './propagation/composite';

packages/opentelemetry-core/src/platform/browser/index.ts

@@ -23,4 +23,3 @@ export {
 export { _globalThis } from './globalThis';
 export { otperformance } from './performance';
 export { SDK_INFO } from './sdk-info';
-export { unrefTimer } from './timer-util';

packages/opentelemetry-core/src/platform/index.ts

@@ -17,7 +17,6 @@ export {
  SDK_INFO,
  _globalThis,
  otperformance,
- unrefTimer,
  getBooleanFromEnv,
  getStringFromEnv,
  getNumberFromEnv,

packages/opentelemetry-core/src/platform/node/index.ts

@@ -23,4 +23,3 @@ export {
 export { _globalThis } from './globalThis';
 export { otperformance } from './performance';
 export { SDK_INFO } from './sdk-info';
-export { unrefTimer } from './timer-util';

packages/opentelemetry-core/src/platform/browser/timer-util.ts → packages/opentelemetry-core/test/common/utils/timer-util.test.ts

@@ -13,4 +13,18 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-export function unrefTimer(_timer: number): void {}
+
+import { unrefTimer } from '../../../src';
+import * as sinon from 'sinon';
+
+describe('timer-util', function () {
+ it('does not throw on number', function () {
+ unrefTimer(1);
+ });
+
+ it('does call unref', function () {
+ const unrefStub = sinon.stub();
+ unrefTimer({ unref: unrefStub });
+ sinon.assert.calledOnce(unrefStub);
+ });
+});

packages/opentelemetry-sdk-trace-base/src/export/BatchSpanProcessorBase.ts

@@ -21,7 +21,6 @@ import {
  getNumberFromEnv,
  globalErrorHandler,
  suppressTracing,
- unrefTimer,
 } from '@opentelemetry/core';
 import { Span } from '../Span';
 import { SpanProcessor } from '../SpanProcessor';
@@ -43,7 +42,7 @@ export abstract class BatchSpanProcessorBase<T extends BufferConfig>
 
  private _isExporting = false;
  private _finishedSpans: ReadableSpan[] = [];
- private _timer: NodeJS.Timeout | undefined;
+ private _timer: NodeJS.Timeout | number | undefined;
  private _shutdownOnce: BindOnceFuture<void>;
  private _droppedSpansCount: number = 0;
 
@@ -249,7 +248,11 @@ export abstract class BatchSpanProcessorBase<T extends BufferConfig>
  }
  if (this._timer !== undefined) return;
  this._timer = setTimeout(() => flush(), this._scheduledDelayMillis);
- unrefTimer(this._timer);
+
+ // depending on runtime, this may be a 'number' or NodeJS.Timeout
+ if (typeof this._timer !== 'number') {
+ this._timer.unref();
+ }
  }
 
  private _clearTimer() {

packages/sdk-metrics/src/export/PeriodicExportingMetricReader.ts

@@ -19,7 +19,6 @@ import {
  internal,
  ExportResultCode,
  globalErrorHandler,
- unrefTimer,
 } from '@opentelemetry/core';
 import { MetricReader } from './MetricReader';
 import { PushMetricExporter } from './MetricExporter';
@@ -153,7 +152,11 @@ export class PeriodicExportingMetricReader extends MetricReader {
  // this._runOnce never rejects. Using void operator to suppress @typescript-eslint/no-floating-promises.
  void this._runOnce();
  }, this._exportInterval);
- unrefTimer(this._interval);
+
+ // depending on runtime, this may be a 'number' or NodeJS.Timeout
+ if (typeof this._interval !== 'number') {
+ this._interval.unref();
+ }
  }
 
  protected async onForceFlush(): Promise<void> {