refactor(otlp-exporter-base): remove unnecessary isNaN() checks (#5374

)
open-telemetry · Jan 27, 2025 · 3e013cf · 3e013cf
1 parent f927e82
commit 3e013cf
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 10 deletions.
diff --git a/experimental/CHANGELOG.md b/experimental/CHANGELOG.md
@@ -29,6 +29,8 @@ All notable changes to experimental packages in this project will be documented
 
 ### :house: (Internal)
 
+* refactor(otlp-exporter-base): remove unnecessary isNaN() checks [#5374](https://github.com/open-telemetry/opentelemetry-js/pull/5374) @cjihrig
+
 ## 0.57.0
 
 ### :rocket: (Enhancement)

diff --git a/experimental/packages/otlp-exporter-base/src/configuration/shared-configuration.ts b/experimental/packages/otlp-exporter-base/src/configuration/shared-configuration.ts
@@ -29,11 +29,7 @@ export interface OtlpSharedConfiguration {
 }
 
 export function validateTimeoutMillis(timeoutMillis: number) {
-  if (
-    !Number.isNaN(timeoutMillis) &&
-    Number.isFinite(timeoutMillis) &&
-    timeoutMillis > 0
-  ) {
+  if (Number.isFinite(timeoutMillis) && timeoutMillis > 0) {
     return timeoutMillis;
   }
   throw new Error(

diff --git a/experimental/packages/otlp-exporter-base/src/configuration/shared-env-configuration.ts b/experimental/packages/otlp-exporter-base/src/configuration/shared-env-configuration.ts
@@ -22,11 +22,7 @@ function parseAndValidateTimeoutFromEnv(
   const envTimeout = process.env[timeoutEnvVar]?.trim();
   if (envTimeout != null && envTimeout !== '') {
     const definedTimeout = Number(envTimeout);
-    if (
-      !Number.isNaN(definedTimeout) &&
-      Number.isFinite(definedTimeout) &&
-      definedTimeout > 0
-    ) {
+    if (Number.isFinite(definedTimeout) && definedTimeout > 0) {
       return definedTimeout;
     }
     diag.warn(

diff --git a/...mental/packages/otlp-exporter-base/test/common/configuration/shared-configuration.test.ts b/...mental/packages/otlp-exporter-base/test/common/configuration/shared-configuration.test.ts
@@ -19,6 +19,7 @@ import {
   mergeOtlpSharedConfigurationWithDefaults,
   OtlpSharedConfiguration,
 } from '../../../src';
+import { validateTimeoutMillis } from '../../../src/configuration/shared-configuration';
 
 export function testSharedConfigBehavior<T extends OtlpSharedConfiguration>(
   sut: (
@@ -134,3 +135,15 @@ describe('mergeOtlpSharedConfigurationWithDefaults', function () {
     concurrencyLimit: 2,
   });
 });
+
+describe('validateTimeoutMillis', function () {
+  it('throws if timeout is not a positive number', () => {
+    const values = [null, '1', true, NaN, Infinity, -Infinity, -1, 0];
+
+    for (let i = 0; i < values.length; ++i) {
+      assert.throws(() => {
+        validateTimeoutMillis(values[i] as any);
+      }, /Configuration: timeoutMillis is invalid/);
+    }
+  });
+});