chore(commons): simplify config service interface

Author: dreamorosi

Diff for: packages/commons/src/config/EnvironmentVariablesService.ts

@@ -1,4 +1,4 @@
-import { ConfigService } from './ConfigService.js';
+import type { ConfigServiceInterface } from '../types/ConfigServiceInterface.js';
 
 /**
  * Class EnvironmentVariablesService
@@ -13,7 +13,7 @@ import { ConfigService } from './ConfigService.js';
  * @see https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-runtime
  * @see https://docs.powertools.aws.dev/lambda/typescript/latest/#environment-variables
  */
-class EnvironmentVariablesService implements ConfigService {
+class EnvironmentVariablesService implements ConfigServiceInterface {
   /**
    * @see https://docs.powertools.aws.dev/lambda/typescript/latest/#environment-variables
    * @protected

Diff for: packages/commons/src/config/ConfigService.ts renamed to packages/commons/src/types/ConfigServiceInterface.ts

@@ -3,25 +3,22 @@
  *
  * This class defines common methods and variables that can be set by the developer
  * in the runtime.
- *
- * @class
- * @abstract
  */
-abstract class ConfigService {
+interface ConfigServiceInterface {
   /**
    * It returns the value of an environment variable that has given name.
    *
    * @param {string} name
    * @returns {string}
    */
-  public abstract get(name: string): string;
+  get(name: string): string;
 
   /**
    * It returns the value of the POWERTOOLS_SERVICE_NAME environment variable.
    *
    * @returns {string}
    */
-  public abstract getServiceName(): string;
+  getServiceName(): string;
 
   /**
    * It returns the value of the _X_AMZN_TRACE_ID environment variable.
@@ -33,22 +30,22 @@ abstract class ConfigService {
    *
    * @returns {string|undefined}
    */
-  public abstract getXrayTraceId(): string | undefined;
+  getXrayTraceId(): string | undefined;
 
   /**
    * It returns true if the `POWERTOOLS_DEV` environment variable is set to truthy value.
    *
    * @returns {boolean}
    */
-  public abstract isDevMode(): boolean;
+  isDevMode(): boolean;
 
   /**
    * It returns true if the string value represents a boolean true value.
    *
    * @param {string} value
    * @returns boolean
    */
-  public abstract isValueTrue(value: string): boolean;
+  isValueTrue(value: string): boolean;
 }
 
-export { ConfigService };
+export type { ConfigServiceInterface };

Diff for: packages/commons/src/types/index.ts

@@ -16,3 +16,4 @@ export type {
   LambdaInterface,
   HandlerMethodDecorator,
 } from './LambdaInterface.js';
+export type { ConfigServiceInterface } from './ConfigServiceInterface.js';

Diff for: packages/idempotency/src/types/ConfigServiceInterface.ts

@@ -1,10 +1,27 @@
-interface ConfigServiceInterface {
-  get(name: string): string;
-
-  getServiceName(): string;
+import type { ConfigServiceInterface as ConfigServiceBaseInterface } from '@aws-lambda-powertools/commons/types';
 
+/**
+ * Interface ConfigServiceInterface
+ *
+ * @interface
+ * @see https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-runtime
+ * @see https://docs.powertools.aws.dev/lambda-typescript/latest/#environment-variables
+ */
+interface ConfigServiceInterface extends ConfigServiceBaseInterface {
+  /**
+   * It returns the value of the AWS_LAMBDA_FUNCTION_NAME environment variable.
+   *
+   * @returns {string}
+   */
   getFunctionName(): string;
 
+  /**
+   * It returns whether the idempotency feature is enabled or not.
+   *
+   * Reads the value of the POWERTOOLS_IDEMPOTENCY_DISABLED environment variable.
+   *
+   * @returns {boolean}
+   */
   getIdempotencyEnabled(): boolean;
 }
 

Diff for: packages/logger/src/types/ConfigServiceInterface.ts

@@ -1,19 +1,13 @@
+import type { ConfigServiceInterface as ConfigServiceBaseInterface } from '@aws-lambda-powertools/commons/types';
+
 /**
  * Interface ConfigServiceInterface
  *
  * @interface
  * @see https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-runtime
  * @see https://docs.powertools.aws.dev/lambda/typescript/latest/#environment-variables
  */
-interface ConfigServiceInterface {
-  /**
-   * It returns the value of an environment variable that has given name.
-   *
-   * @param {string} name
-   * @returns {string}
-   */
-  get(name: string): string;
-
+interface ConfigServiceInterface extends ConfigServiceBaseInterface {
   /**
    * It returns the value of the `AWS_LAMBDA_LOG_LEVEL` environment variable.
    *
@@ -58,21 +52,6 @@ interface ConfigServiceInterface {
    * @returns {string|undefined}
    */
   getSampleRateValue(): number | undefined;
-
-  /**
-   * It returns the value of the POWERTOOLS_SERVICE_NAME environment variable.
-   *
-   * @returns {string}
-   */
-  getServiceName(): string;
-
-  /**
-   * It returns true if the string value represents a boolean true value.
-   *
-   * @param {string} value
-   * @returns boolean
-   */
-  isValueTrue(value: string): boolean;
 }
 
 export type { ConfigServiceInterface };

Diff for: packages/logger/tests/unit/Logger.test.ts

@@ -369,6 +369,9 @@ describe('Class: Logger', () => {
         getServiceName(): string {
           return 'my-backend-service';
         },
+        getXrayTraceId(): string | undefined {
+          return undefined;
+        },
         isDevMode(): boolean {
           return false;
         },

Diff for: packages/logger/tests/unit/middleware/middy.test.ts

@@ -292,6 +292,9 @@ describe('Middy middleware', () => {
         getServiceName(): string {
           return 'my-backend-service';
         },
+        getXrayTraceId(): string | undefined {
+          return undefined;
+        },
         isDevMode(): boolean {
           return false;
         },

Diff for: packages/metrics/src/config/EnvironmentVariablesService.ts

@@ -7,6 +7,11 @@ class EnvironmentVariablesService
 {
   private namespaceVariable = 'POWERTOOLS_METRICS_NAMESPACE';
 
+  /**
+   * It returns the value of the POWERTOOLS_METRICS_NAMESPACE environment variable.
+   *
+   * @returns {string}
+   */
   public getNamespace(): string {
     return this.get(this.namespaceVariable);
   }

Diff for: packages/metrics/src/types/ConfigServiceInterface.ts

@@ -1,13 +1,19 @@
-interface ConfigServiceInterface {
-  get?(name: string): string;
-  getNamespace(): string;
-  getServiceName(): string;
+import type { ConfigServiceInterface as ConfigServiceBaseInterface } from '@aws-lambda-powertools/commons/types';
+
+/**
+ * Interface ConfigServiceInterface
+ *
+ * @interface
+ * @see https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-runtime
+ * @see https://docs.powertools.aws.dev/lambda-typescript/latest/#environment-variables
+ */
+interface ConfigServiceInterface extends ConfigServiceBaseInterface {
   /**
-   * It returns the value of the POWERTOOLS_DEV environment variable.
+   * It returns the value of the POWERTOOLS_METRICS_NAMESPACE environment variable.
    *
-   * @returns {boolean}
+   * @returns {string}
    */
-  isDevMode(): boolean;
+  getNamespace(): string;
 }
 
 export type { ConfigServiceInterface };

Diff for: packages/metrics/tests/unit/Metrics.test.ts

@@ -242,9 +242,15 @@ describe('Class: Metrics', () => {
         getServiceName(): string {
           return 'test-service';
         },
+        getXrayTraceId(): string | undefined {
+          return 'test-trace-id';
+        },
         isDevMode(): boolean {
           return false;
         },
+        isValueTrue(value: string): boolean {
+          return value === 'true';
+        },
       };
       const metricsOptions: MetricsOptions = {
         customConfigService: configService,

Diff for: packages/parameters/src/config/EnvironmentVariablesService.ts

@@ -10,6 +10,11 @@ class EnvironmentVariablesService
   private parametersMaxAgeVariable = 'POWERTOOLS_PARAMETERS_MAX_AGE';
   private ssmDecryptVariable = 'POWERTOOLS_PARAMETERS_SSM_DECRYPT';
 
+  /**
+   * It returns the value of the POWERTOOLS_PARAMETERS_MAX_AGE environment variable.
+   *
+   * @returns {number|undefined}
+   */
   public getParametersMaxAge(): number | undefined {
     const maxAge = this.get(this.parametersMaxAgeVariable);
 
@@ -25,6 +30,11 @@ class EnvironmentVariablesService
     }
   }
 
+  /**
+   * It returns the value of the POWERTOOLS_PARAMETERS_SSM_DECRYPT environment variable.
+   *
+   * @returns {string}
+   */
   public getSSMDecrypt(): string {
     return this.get(this.ssmDecryptVariable);
   }

Diff for: packages/parameters/src/types/ConfigServiceInterface.ts

@@ -1,10 +1,24 @@
-interface ConfigServiceInterface {
-  get?(name: string): string;
-
-  getServiceName(): string;
+import type { ConfigServiceInterface as ConfigServiceBaseInterface } from '@aws-lambda-powertools/commons/types';
 
+/**
+ * Interface ConfigServiceInterface
+ *
+ * @interface
+ * @see https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-runtime
+ * @see https://docs.powertools.aws.dev/lambda-typescript/latest/#environment-variables
+ */
+interface ConfigServiceInterface extends ConfigServiceBaseInterface {
+  /**
+   * It returns the value of the POWERTOOLS_PARAMETERS_MAX_AGE environment variable.
+   *
+   * @returns {number|undefined}
+   */
   getParametersMaxAge(): number | undefined;
-
+  /**
+   * It returns the value of the POWERTOOLS_PARAMETERS_SSM_DECRYPT environment variable.
+   *
+   * @returns {string}
+   */
   getSSMDecrypt(): string;
 }
 

Diff for: packages/tracer/src/config/EnvironmentVariablesService.ts

@@ -14,26 +14,56 @@ class EnvironmentVariablesService
   private tracerCaptureResponseVariable = 'POWERTOOLS_TRACER_CAPTURE_RESPONSE';
   private tracingEnabledVariable = 'POWERTOOLS_TRACE_ENABLED';
 
+  /**
+   * It returns the value of the AWS_EXECUTION_ENV environment variable.
+   *
+   * @returns {string}
+   */
   public getAwsExecutionEnv(): string {
     return this.get(this.awsExecutionEnv);
   }
 
+  /**
+   * It returns the value of the POWERTOOLS_TRACER_CAPTURE_HTTPS_REQUESTS environment variable.
+   *
+   * @returns {string}
+   */
   public getCaptureHTTPsRequests(): string {
     return this.get(this.tracerCaptureHTTPsRequestsVariable);
   }
 
+  /**
+   * It returns the value of the AWS_SAM_LOCAL environment variable.
+   *
+   * @returns {string}
+   */
   public getSamLocal(): string {
     return this.get(this.samLocalVariable);
   }
 
+  /**
+   * It returns the value of the POWERTOOLS_TRACER_CAPTURE_ERROR environment variable.
+   *
+   * @returns {string}
+   */
   public getTracingCaptureError(): string {
     return this.get(this.tracerCaptureErrorVariable);
   }
 
+  /**
+   * It returns the value of the POWERTOOLS_TRACER_CAPTURE_RESPONSE environment variable.
+   *
+   * @returns {string}
+   */
   public getTracingCaptureResponse(): string {
     return this.get(this.tracerCaptureResponseVariable);
   }
 
+  /**
+   * It returns the value of the POWERTOOLS_TRACE_ENABLED environment variable.
+   *
+   * @returns {string}
+   */
   public getTracingEnabled(): string {
     return this.get(this.tracingEnabledVariable);
   }

Diff for: packages/tracer/src/types/ConfigServiceInterface.ts

@@ -1,14 +1,53 @@
-interface ConfigServiceInterface {
-  get(name: string): string;
+import type { ConfigServiceInterface as ConfigServiceBaseInterface } from '@aws-lambda-powertools/commons/types';
 
+/**
+ * Interface ConfigServiceInterface
+ *
+ * @interface
+ * @see https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-runtime
+ * @see https://docs.powertools.aws.dev/lambda-typescript/latest/#environment-variables
+ */
+interface ConfigServiceInterface extends ConfigServiceBaseInterface {
+  /**
+   * It returns the value of the AWS_EXECUTION_ENV environment variable.
+   *
+   * @returns {string}
+   */
+  getAwsExecutionEnv(): string;
+
+  /**
+   * It returns the value of the POWERTOOLS_TRACER_CAPTURE_HTTPS_REQUESTS environment variable.
+   *
+   * @returns {string}
+   */
   getCaptureHTTPsRequests(): string;
 
-  getTracingEnabled(): string;
+  /**
+   * It returns the value of the AWS_SAM_LOCAL environment variable.
+   *
+   * @returns {string}
+   */
+  getSamLocal(): string;
 
-  getServiceName(): string;
+  /**
+   * It returns the value of the POWERTOOLS_TRACE_ENABLED environment variable.
+   *
+   * @returns {string}
+   */
+  getTracingEnabled(): string;
 
+  /**
+   * It returns the value of the POWERTOOLS_TRACER_CAPTURE_RESPONSE environment variable.
+   *
+   * @returns {string}
+   */
   getTracingCaptureResponse(): string;
 
+  /**
+   * It returns the value of the POWERTOOLS_TRACER_CAPTURE_ERROR environment variable.
+   *
+   * @returns {string}
+   */
   getTracingCaptureError(): string;
 }