chore(maintenance): migrate parameters utility to biome

Author: dreamorosi

packages/parameters/src/appconfig/AppConfigProvider.ts

@@ -292,6 +292,7 @@ class AppConfigProvider extends BaseProvider {
   ): Promise<Uint8Array | undefined> {
     if (
       !this.configurationTokenStore.has(name) ||
+      // biome-ignore lint/style/noNonNullAssertion: we check if the value is in the map before accessing it
       this.configurationTokenStore.get(name)!.expiration <= Date.now()
     ) {
       const sessionOptions: StartConfigurationSessionCommandInput = {
@@ -356,7 +357,7 @@ class AppConfigProvider extends BaseProvider {
   protected async _getMultiple(
     _path: string,
     _sdkOptions?: unknown
-  ): Promise<void> {
+  ): Promise<Record<string, unknown> | undefined> {
     throw new Error('Method not implemented.');
   }
 }

packages/parameters/src/base/BaseProvider.ts

@@ -97,7 +97,7 @@ abstract class BaseProvider implements BaseProviderInterface {
     name: string,
     options?: GetOptionsInterface
   ): Promise<unknown | undefined> {
-    const configs = new GetOptions(options, this.envVarsService);
+    const configs = new GetOptions(this.envVarsService, options);
     const key = [name, configs.transform].toString();
 
     if (!configs.forceFetch && !this.hasKeyExpiredInCache(key)) {
@@ -136,16 +136,15 @@ abstract class BaseProvider implements BaseProviderInterface {
     path: string,
     options?: GetMultipleOptionsInterface
   ): Promise<unknown> {
-    const configs = new GetMultipleOptions(options, this.envVarsService);
+    const configs = new GetMultipleOptions(this.envVarsService, options);
     const key = [path, configs.transform].toString();
 
     if (!configs.forceFetch && !this.hasKeyExpiredInCache(key)) {
-      // If the code enters in this block, then the key must exist & not have been expired
-      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+      // biome-ignore lint/style/noNonNullAssertion: If the code enters in this block, then the key must exist & not have been expired
       return this.store.get(key)!.value as Record<string, unknown>;
     }
 
-    let values;
+    let values: Record<string, unknown> | undefined;
     try {
       values = await this._getMultiple(path, options);
       if (!isRecord(values)) {
@@ -216,7 +215,7 @@ abstract class BaseProvider implements BaseProviderInterface {
   protected abstract _getMultiple(
     path: string,
     options?: unknown
-  ): Promise<Record<string, unknown> | void>;
+  ): Promise<Record<string, unknown> | undefined>;
 }
 
 export { BaseProvider };

packages/parameters/src/base/GetMultipleOptions.ts

@@ -1,5 +1,5 @@
 import { GetOptions } from './GetOptions.js';
-import { EnvironmentVariablesService } from '../config/EnvironmentVariablesService.js';
+import type { EnvironmentVariablesService } from '../config/EnvironmentVariablesService.js';
 import type { GetMultipleOptionsInterface } from '../types/BaseProvider.js';
 
 /**
@@ -14,8 +14,8 @@ class GetMultipleOptions
   public throwOnTransformError = false;
 
   public constructor(
+    envVarsService: EnvironmentVariablesService,
     options: GetMultipleOptionsInterface = {},
-    envVarsService: EnvironmentVariablesService
   ) {
     super(options, envVarsService);
 

packages/parameters/src/base/GetOptions.ts

@@ -1,4 +1,4 @@
-import { EnvironmentVariablesService } from '../config/EnvironmentVariablesService.js';
+import type { EnvironmentVariablesService } from '../config/EnvironmentVariablesService.js';
 import { DEFAULT_MAX_AGE_SECS } from '../constants.js';
 import type {
   GetOptionsInterface,
@@ -17,8 +17,8 @@ class GetOptions implements GetOptionsInterface {
   public transform?: TransformOptions;
 
   public constructor(
+    envVarsService: EnvironmentVariablesService,
     options: GetOptionsInterface = {},
-    envVarsService: EnvironmentVariablesService
   ) {
     Object.assign(this, options);
 

packages/parameters/src/base/transformValue.ts

@@ -66,7 +66,8 @@ const transformValue = (
     if (isJsonTransform || isAutoJsonTransform) {
       return JSON.parse(value) as JSONValue;
       // If the transform is `binary` or `auto` and the key ends with `.binary`, decode the value from base64
-    } else if (isBinaryTransform || isAutoBinaryTransform) {
+    }
+    if (isBinaryTransform || isAutoBinaryTransform) {
       return new TextDecoder('utf-8').decode(fromBase64(value, 'base64'));
     }
   } catch (error) {

packages/parameters/src/config/EnvironmentVariablesService.ts

@@ -1,4 +1,4 @@
-import { ConfigServiceInterface } from '../types/ConfigServiceInterface.js';
+import type { ConfigServiceInterface } from '../types/ConfigServiceInterface.js';
 import { DEFAULT_MAX_AGE_SECS } from '../constants.js';
 import { EnvironmentVariablesService as CommonEnvironmentVariablesService } from '@aws-lambda-powertools/commons';
 
@@ -20,8 +20,8 @@ class EnvironmentVariablesService
 
     if (maxAge.length === 0) return undefined;
 
-    const maxAgeAsNumber = parseInt(maxAge, 10);
-    if (isNaN(maxAgeAsNumber)) {
+    const maxAgeAsNumber = Number.parseInt(maxAge, 10);
+    if (Number.isNaN(maxAgeAsNumber)) {
       console.warn(
         `Invalid value for ${this.parametersMaxAgeVariable} environment variable: [${maxAge}], using default value of ${DEFAULT_MAX_AGE_SECS} seconds`
       );

packages/parameters/src/secrets/SecretsProvider.ts

@@ -245,7 +245,7 @@ class SecretsProvider extends BaseProvider {
   protected async _getMultiple(
     _path: string,
     _options?: unknown
-  ): Promise<void> {
+  ): Promise<Record<string, unknown> | undefined> {
     throw new Error('Method not implemented.');
   }
 }

packages/parameters/src/ssm/SSMProvider.ts

@@ -27,6 +27,7 @@ import type {
   SSMSplitBatchAndDecryptParametersOutputType,
   SSMGetParametersByNameFromCacheOutputType,
 } from '../types/SSMProvider.js';
+import type { JSONValue } from '@aws-lambda-powertools/commons/types';
 
 /**
  * ## Intro
@@ -550,9 +551,7 @@ class SSMProvider extends BaseProvider {
          * The parameter name returned by SSM will contain the full path.
          * However, for readability, we should return only the part after the path.
          **/
-
-        // If the parameter is present in the response, then it has a Name
-        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+        // biome-ignore lint/style/noNonNullAssertion: If the parameter is present in the response, then it has a Name
         let name = parameter.Name!;
         name = name.replace(path, '');
         if (name.startsWith('/')) {
@@ -656,8 +655,7 @@ class SSMProvider extends BaseProvider {
     )) {
       const cacheKey = [parameterName, parameterOptions.transform].toString();
       if (!this.hasKeyExpiredInCache(cacheKey)) {
-        // Since we know the key exists in the cache, we can safely use the non-null assertion operator
-        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+        // biome-ignore lint/style/noNonNullAssertion: Since we know the key exists in the cache, we can safely use the non-null assertion operator
         cached[parameterName] = this.store.get(cacheKey)!.value as Record<
           string,
           string | Record<string, unknown>
@@ -867,13 +865,12 @@ class SSMProvider extends BaseProvider {
     const processedParameters: Record<string, unknown> = {};
 
     for (const parameter of response.Parameters || []) {
-      // If the parameter is present in the response, then it has a Name
-      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+      // biome-ignore lint/style/noNonNullAssertion: If the parameter is present in the response, then it has a Name
       const parameterName = parameter.Name!;
       const parameterValue = parameter.Value;
       const parameterOptions = parameters[parameterName];
 
-      let value;
+      let value: string | JSONValue | Uint8Array | undefined;
       // NOTE: if transform is set, we do it before caching to reduce number of operations
       if (parameterValue && parameterOptions.transform) {
         value = transformValue(

packages/parameters/src/types/BaseProvider.ts

@@ -1,4 +1,4 @@
-import { Transform } from '../constants.js';
+import type { Transform } from '../constants.js';
 
 /**
  * Type for the transform option.
@@ -74,7 +74,7 @@ interface BaseProviderInterface {
   getMultiple(
     path: string,
     options?: GetMultipleOptionsInterface
-  ): Promise<unknown | void>;
+  ): Promise<unknown | unknown>;
   clearCache?(): void;
 }
 

packages/parameters/tests/e2e/appConfigProvider.class.test.functionCode.ts

@@ -1,7 +1,7 @@
 import type { Context } from 'aws-lambda';
 import { Transform } from '../../src/constants.js';
 import { AppConfigProvider } from '../../src/appconfig/AppConfigProvider.js';
-import { AppConfigGetOptions } from '../../src/types/AppConfigProvider.js';
+import type { AppConfigGetOptions } from '../../src/types/AppConfigProvider.js';
 import { TinyLogger } from '../helpers/tinyLogger.js';
 import { middleware } from '../helpers/sdkMiddlewareRequestCounter.js';
 import { AppConfigDataClient } from '@aws-sdk/client-appconfigdata';

packages/parameters/tests/e2e/appConfigProvider.class.test.ts

@@ -71,7 +71,7 @@ import {
  * is created after the previous one. This is necessary because we share the same AppConfig
  * application and environment for all tests.
  */
-describe(`Parameters E2E tests, AppConfig provider`, () => {
+describe('Parameters E2E tests, AppConfig provider', () => {
   const testStack = new TestStack({
     stackNameProps: {
       stackNamePrefix: RESOURCE_NAME_PREFIX,

packages/parameters/tests/e2e/dynamoDBProvider.class.test.functionCode.ts

@@ -1,7 +1,7 @@
 import type { Context } from 'aws-lambda';
 import { Transform } from '../../src/constants.js';
 import { DynamoDBProvider } from '../../src/dynamodb/DynamoDBProvider.js';
-import {
+import type {
   DynamoDBGetOptions,
   DynamoDBGetMultipleOptions,
 } from '../../src/types/DynamoDBProvider.js';

packages/parameters/tests/e2e/dynamoDBProvider.class.test.ts

@@ -95,7 +95,7 @@ import {
  * Test 9
  * Get a cached parameter and force retrieval. This also uses the same custom SDK client that counts the number of calls to DynamoDB.
  */
-describe(`Parameters E2E tests, dynamoDB provider`, () => {
+describe('Parameters E2E tests, dynamoDB provider', () => {
   const testStack = new TestStack({
     stackNameProps: {
       stackNamePrefix: RESOURCE_NAME_PREFIX,

packages/parameters/tests/e2e/secretsProvider.class.test.functionCode.ts

@@ -1,10 +1,10 @@
-import { Context } from 'aws-lambda';
+import type { Context } from 'aws-lambda';
 import { TinyLogger } from '../helpers/tinyLogger.js';
 import { SecretsManagerClient } from '@aws-sdk/client-secrets-manager';
 import { middleware } from '../helpers/sdkMiddlewareRequestCounter.js';
 import { Transform } from '../../src/constants.js';
 import { SecretsProvider } from '../../src/secrets/SecretsProvider.js';
-import { SecretsGetOptions } from '../../src/types/SecretsProvider.js';
+import type { SecretsGetOptions } from '../../src/types/SecretsProvider.js';
 
 const logger = new TinyLogger();
 const defaultProvider = new SecretsProvider();

packages/parameters/tests/e2e/secretsProvider.class.test.ts

@@ -36,7 +36,7 @@ import {
  * Make sure to add the right permissions to the lambda function to access the resources. We use our `ResourceAccessGranter` to add permissions.
  *
  */
-describe(`Parameters E2E tests, Secrets Manager provider`, () => {
+describe('Parameters E2E tests, Secrets Manager provider', () => {
   const testStack = new TestStack({
     stackNameProps: {
       stackNamePrefix: RESOURCE_NAME_PREFIX,

packages/parameters/tests/e2e/ssmProvider.class.test.functionCode.ts

@@ -1,6 +1,6 @@
 import type { Context } from 'aws-lambda';
 import { SSMProvider } from '../../src/ssm/SSMProvider.js';
-import {
+import type {
   SSMGetOptions,
   SSMGetMultipleOptions,
   SSMGetParametersByNameOptions,

packages/parameters/tests/e2e/ssmProvider.class.test.ts

@@ -70,7 +70,7 @@ import {
  * get parameter twice, but force fetch 2nd time, we count number of SDK requests and
  * check that we made two API calls
  */
-describe(`Parameters E2E tests, SSM provider`, () => {
+describe('Parameters E2E tests, SSM provider', () => {
   const testStack = new TestStack({
     stackNameProps: {
       stackNamePrefix: RESOURCE_NAME_PREFIX,

packages/parameters/tests/helpers/resources.ts

@@ -8,7 +8,7 @@ import {
   getRuntimeKey,
   type TestStack,
 } from '@aws-lambda-powertools/testing-utils';
-import { TestNodejsFunction } from '@aws-lambda-powertools/testing-utils/resources/lambda';
+import type { TestNodejsFunction } from '@aws-lambda-powertools/testing-utils/resources/lambda';
 import { TestDynamodbTable } from '@aws-lambda-powertools/testing-utils/resources/dynamodb';
 import { marshall } from '@aws-sdk/util-dynamodb';
 import { CfnOutput, Duration, RemovalPolicy, Stack } from 'aws-cdk-lib';
@@ -18,15 +18,15 @@ import {
   ConfigurationType,
   DeploymentStrategy,
   HostedConfiguration,
-  IEnvironment,
+  type IEnvironment,
   RolloutStrategy,
-  CfnHostedConfigurationVersion,
+  type CfnHostedConfigurationVersion,
 } from 'aws-cdk-lib/aws-appconfig';
 import { Effect, PolicyStatement } from 'aws-cdk-lib/aws-iam';
 import type { SecretProps } from 'aws-cdk-lib/aws-secretsmanager';
 import { Secret } from 'aws-cdk-lib/aws-secretsmanager';
 import type { StringParameterProps } from 'aws-cdk-lib/aws-ssm';
-import { IStringParameter, StringParameter } from 'aws-cdk-lib/aws-ssm';
+import { type IStringParameter, StringParameter } from 'aws-cdk-lib/aws-ssm';
 import {
   AwsCustomResource,
   AwsCustomResourcePolicy,
@@ -266,7 +266,7 @@ class TestAppConfigWithProfiles extends Construct {
       }
     );
 
-    profiles.forEach((profile) => {
+    for (const profile of profiles) {
       const config = new HostedConfiguration(
         testStack.stack,
         `hc-${randomUUID()}`,
@@ -291,7 +291,7 @@ class TestAppConfigWithProfiles extends Construct {
         config.node.defaultChild as CfnHostedConfigurationVersion
       ).applyRemovalPolicy(RemovalPolicy.DESTROY);
       this.profiles.push(config);
-    });
+    };
   }
 
   /**
@@ -300,7 +300,9 @@ class TestAppConfigWithProfiles extends Construct {
    * @param fn The function to add the environment variables to
    */
   public addEnvVariablesToFunction(fn: TestNodejsFunction): void {
+    // biome-ignore lint/style/noNonNullAssertion: we know this is called after the AppConfig resources are created
     fn.addEnvironment('APPLICATION_NAME', this.application.name!);
+    // biome-ignore lint/style/noNonNullAssertion: we know this is called after the AppConfig resources are created
     fn.addEnvironment('ENVIRONMENT_NAME', this.environment.name!);
     fn.addEnvironment(
       'FREEFORM_JSON_NAME',
@@ -326,9 +328,10 @@ class TestAppConfigWithProfiles extends Construct {
    * @param fn The function to grant access to the profiles
    */
   public grantReadData(fn: TestNodejsFunction): void {
-    this.profiles.forEach((profile) => {
+    for (const profile of this.profiles) {
       const appConfigConfigurationArn = Stack.of(fn).formatArn({
         service: 'appconfig',
+        // biome-ignore lint/style/noNonNullAssertion: we know this is called after the AppConfig resources are created
         resource: `application/${profile.application.applicationId}/environment/${profile.deployTo![0].environmentId}/configuration/${profile.configurationProfileId}`,
       });
 
@@ -342,7 +345,7 @@ class TestAppConfigWithProfiles extends Construct {
           resources: [appConfigConfigurationArn],
         })
       );
-    });
+    };
   }
 }
 

packages/parameters/tests/unit/AppConfigProvider.test.ts

@@ -5,7 +5,7 @@
  */
 import { AppConfigProvider } from '../../src/appconfig/index.js';
 import { ExpirableValue } from '../../src/base/ExpirableValue.js';
-import { AppConfigProviderOptions } from '../../src/types/AppConfigProvider.js';
+import type { AppConfigProviderOptions } from '../../src/types/AppConfigProvider.js';
 import {
   AppConfigDataClient,
   GetLatestConfigurationCommand,

packages/parameters/tests/unit/BaseProvider.test.ts

@@ -633,8 +633,7 @@ describe('Class: GetOptions', () => {
       getParametersMaxAge: jest.fn(),
     };
     const options = new GetOptions(
-      undefined,
-      envVarsService as unknown as EnvironmentVariablesService
+      envVarsService as unknown as EnvironmentVariablesService,
     );
 
     // Assess
@@ -649,8 +648,7 @@ describe('Class: GetMultipleOptions', () => {
       getParametersMaxAge: jest.fn(),
     };
     const options = new GetMultipleOptions(
-      undefined,
-      envVarsService as unknown as EnvironmentVariablesService
+      envVarsService as unknown as EnvironmentVariablesService,
     );
 
     // Assess