create function by paramtre type

Author: maryliag

experimental/packages/opentelemetry-configuration/package.json

@@ -49,6 +49,7 @@
     "@types/mocha": "10.0.10",
     "@types/node": "18.6.5",
     "@types/sinon": "17.0.4",
+    "eslint-plugin-n": "^17.23.0",
     "lerna": "6.6.2",
     "mocha": "11.7.2",
     "nyc": "17.1.0",

experimental/packages/opentelemetry-configuration/src/FileConfigProvider.ts

@@ -14,17 +14,19 @@
  * limitations under the License.
  */
 
-import {
-  diagLogLevelFromString,
-  getStringFromEnv,
-} from '@opentelemetry/core';
+import { diagLogLevelFromString, getStringFromEnv } from '@opentelemetry/core';
 import {
   ConfigurationModel,
   initializeDefaultConfiguration,
 } from './configModel';
 import { ConfigProvider } from './IConfigProvider';
 import * as fs from 'fs';
 import * as yaml from 'yaml';
+import {
+  getBooleanFromConfigFile,
+  getNumberFromConfigFile,
+  getStringFromConfigFile,
+} from './utils';
 
 export class FileConfigProvider implements ConfigProvider {
   private _config: ConfigurationModel;
@@ -65,29 +67,26 @@ function parseConfigFile(config: ConfigurationModel) {
     parsedContent['file_format'] &&
     supportedFileVersions.includes(parsedContent['file_format'])
   ) {
-    const disabled = getValue(config.disabled, parsedContent['disabled']);
+    const disabled = getBooleanFromConfigFile(parsedContent['disabled']);
     if (disabled || disabled === false) {
       config.disabled = disabled;
     }
 
-    const logLevel = getValue(
-      config.log_level,
+    const logLevel = getNumberFromConfigFile(
       diagLogLevelFromString(parsedContent['log_level'])
     );
     if (logLevel) {
       config.log_level = logLevel;
     }
 
-    const attrList = getValue(
-      config.resource.attributes_list,
+    const attrList = getStringFromConfigFile(
       parsedContent['resource']?.['attributes_list']
     );
     if (attrList) {
       config.resource.attributes_list = attrList;
     }
 
-    const schemaUrl = getValue(
-      config.resource.schema_url,
+    const schemaUrl = getStringFromConfigFile(
       parsedContent['resource']?.['schema_url']
     );
     if (schemaUrl) {
@@ -102,17 +101,6 @@ function parseConfigFile(config: ConfigurationModel) {
   }
 }
 
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-function getValue(obj: unknown, value: unknown): any {
-  if (typeof obj === 'boolean') {
-    const raw = String(value)?.trim().toLowerCase();
-    if (raw === 'false') {
-      return false;
-    }
-  }
-  return value;
-}
-
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 function setResourceAttributes(config: ConfigurationModel, attributes: any[]) {
   if (attributes) {

experimental/packages/opentelemetry-configuration/src/utils.ts

@@ -0,0 +1,79 @@
+/*
+ * 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.
+ */
+import { diag } from '@opentelemetry/api';
+import { inspect } from 'util';
+
+/**
+ * Retrieves a boolean value from a configuration file parameter.
+ * - Trims leading and trailing whitespace and ignores casing.
+ * - Returns `undefined` if the value is empty, unset, or contains only whitespace.
+ * - Returns `undefined` and a warning for values that cannot be mapped to a boolean.
+ *
+ * @param {unknown} value - The value from the config file.
+ * @returns {boolean} - The boolean value or `false` if the environment variable is unset empty, unset, or contains only whitespace.
+ */
+export function getBooleanFromConfigFile(value: unknown): boolean | undefined {
+  const raw = String(value)?.trim().toLowerCase();
+  if (raw === 'true') {
+    return true;
+  } else if (raw === 'false') {
+    return false;
+  } else if (raw == null || raw === '') {
+    return undefined;
+  } else {
+    diag.warn(`Unknown value ${inspect(raw)}, expected 'true' or 'false'`);
+    return undefined;
+  }
+}
+
+/**
+ * Retrieves a number from a configuration file parameter.
+ * - Returns `undefined` if the environment variable is empty, unset, or contains only whitespace.
+ * - Returns `undefined` and a warning if is not a number.
+ * - Returns a number in all other cases.
+ *
+ * @param {unknown} value - The value from the config file.
+ * @returns {number | undefined} - The number value or `undefined`.
+ */
+export function getNumberFromConfigFile(value: unknown): number | undefined {
+  const raw = String(value)?.trim();
+  if (raw == null || raw.trim() === '') {
+    return undefined;
+  }
+
+  const n = Number(raw);
+  if (isNaN(n)) {
+    diag.warn(`Unknown value ${inspect(raw)}, expected a number`);
+    return undefined;
+  }
+
+  return n;
+}
+
+/**
+ * Retrieves a string from a configuration file parameter.
+ * - Returns `undefined` if the environment variable is empty, unset, or contains only whitespace.
+ *
+ * @param {unknown} value - The value from the config file.
+ * @returns {string | undefined} - The string value or `undefined`.
+ */
+export function getStringFromConfigFile(value: unknown): string | undefined {
+  const raw = String(value)?.trim();
+  if (value == null || raw === '') {
+    return undefined;
+  }
+  return raw;
+}

experimental/packages/opentelemetry-configuration/test/utils.test.ts

@@ -0,0 +1,69 @@
+/*
+ * 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.
+ */
+
+import * as assert from 'assert';
+import * as sinon from 'sinon';
+import { diag } from '@opentelemetry/api';
+import {
+  getBooleanFromConfigFile,
+  getNumberFromConfigFile,
+  getStringFromConfigFile,
+} from '../src/utils';
+
+describe('config utils', function () {
+  afterEach(function () {
+    sinon.restore();
+  });
+
+  it('should return correct values for getBooleanFromConfigFile', function () {
+    assert.strictEqual(getBooleanFromConfigFile(null), undefined);
+    assert.strictEqual(getBooleanFromConfigFile('  '), undefined);
+    assert.strictEqual(getBooleanFromConfigFile(true), true);
+    assert.strictEqual(getBooleanFromConfigFile('true'), true);
+    assert.strictEqual(getBooleanFromConfigFile(false), false);
+    assert.strictEqual(getBooleanFromConfigFile('false'), false);
+
+    const warnStub = sinon.stub(diag, 'warn');
+    assert.strictEqual(getBooleanFromConfigFile('non-boolean'), undefined);
+    sinon.assert.calledOnceWithMatch(
+      warnStub,
+      `Unknown value 'non-boolean', expected 'true' or 'false'`
+    );
+  });
+
+  it('should return correct values for getNumberFromConfigFile', function () {
+    assert.strictEqual(getNumberFromConfigFile(null), undefined);
+    assert.strictEqual(getNumberFromConfigFile(' '), undefined);
+    assert.strictEqual(getNumberFromConfigFile(1), 1);
+    assert.strictEqual(getNumberFromConfigFile(0), 0);
+    assert.strictEqual(getNumberFromConfigFile(100), 100);
+
+    const warnStub = sinon.stub(diag, 'warn');
+    assert.strictEqual(getNumberFromConfigFile('non-number'), undefined);
+    sinon.assert.calledOnceWithMatch(
+      warnStub,
+      `Unknown value 'non-number', expected a number`
+    );
+  });
+
+  it('should return correct values for getStringFromConfigFile', function () {
+    assert.strictEqual(getStringFromConfigFile(null), undefined);
+    assert.strictEqual(getStringFromConfigFile(' '), undefined);
+    assert.strictEqual(getStringFromConfigFile(undefined), undefined);
+    assert.strictEqual(getStringFromConfigFile(1), '1');
+    assert.strictEqual(getStringFromConfigFile('string-value'), 'string-value');
+  });
+});