refactor: changed variable names in splitBatchAndDecryptParameters

Author: dreamorosi

Diff for: packages/parameters/src/ssm/SSMProvider.ts

@@ -76,22 +76,22 @@ class SSMProvider extends BaseProvider {
     // NOTE: We fail early to avoid unintended graceful errors being replaced with their '_errors' param values
     SSMProvider.throwIfErrorsKeyIsPresent(parameters, this.errorsKey, configs.throwOnError);
 
-    const { batch, decrypt } = SSMProvider.splitBatchAndDecryptParameters(parameters, configs);
+    const { parametersToFetchInBatch, parametersToDecrypt } = SSMProvider.splitBatchAndDecryptParameters(parameters, configs);
     // NOTE: We need to find out whether all parameters must be decrypted or not to know which API to use
     // Logic:
     // GetParameters API -> When decrypt is used for all parameters in the the batch
     // GetParameter  API -> When decrypt is used for one or more in the batch
-    if (Object.keys(decrypt).length !== Object.keys(parameters).length) {
-      const { response: decryptResponse, errors: decryptErrors } = await this.getParametersByNameWithDecryptOption(decrypt, configs.throwOnError);
-      const { response: batchResponse, errors: batchErrors } = await this.getParametersBatchByName(batch, configs.throwOnError, false);
+    if (Object.keys(parametersToDecrypt).length !== Object.keys(parameters).length) {
+      const { response: decryptResponse, errors: decryptErrors } = await this.getParametersByNameWithDecryptOption(parametersToDecrypt, configs.throwOnError);
+      const { response: batchResponse, errors: batchErrors } = await this.getParametersBatchByName(parametersToFetchInBatch, configs.throwOnError, false);
 
       response = { ...decryptResponse, ...batchResponse };
       // Fail-fast disabled, let's aggregate errors under "_errors" key so they can handle gracefully
       if (!configs.throwOnError) {
         response[this.errorsKey] = [ ...decryptErrors, ...batchErrors ];
       }
     } else {
-      const { response: batchResponse, errors: batchErrors } = await this.getParametersBatchByName(decrypt, configs.throwOnError, true);
+      const { response: batchResponse, errors: batchErrors } = await this.getParametersBatchByName(parametersToDecrypt, configs.throwOnError, true);
 
       response = batchResponse;
       // Fail-fast disabled, let's aggregate errors under "_errors" key so they can handle gracefully
@@ -296,8 +296,8 @@ class SSMProvider extends BaseProvider {
    */
   protected static splitBatchAndDecryptParameters(parameters: Record<string, SSMGetParametersByNameOptionsInterface>, configs: SSMGetParametersByNameOptionsInterface): SSMSplitBatchAndDecryptParametersOutputType {
     const splitParameters: SSMSplitBatchAndDecryptParametersOutputType = {
-      batch: {},
-      decrypt: {},
+      parametersToFetchInBatch: {},
+      parametersToDecrypt: {},
     };
 
     for (const [ parameterName, parameterOptions ] of Object.entries(parameters)) {
@@ -312,9 +312,9 @@ class SSMProvider extends BaseProvider {
       }
 
       if (overrides.decrypt) {
-        splitParameters.decrypt[parameterName] = overrides;
+        splitParameters.parametersToDecrypt[parameterName] = overrides;
       } else {
-        splitParameters.batch[parameterName] = overrides;
+        splitParameters.parametersToFetchInBatch[parameterName] = overrides;
       }
     }
 

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

@@ -29,8 +29,8 @@ interface SSMGetParametersByNameOptionsInterface {
 }
 
 type SSMSplitBatchAndDecryptParametersOutputType = {
-  batch: Record<string, SSMGetParametersByNameOptionsInterface>
-  decrypt: Record<string, SSMGetParametersByNameOptionsInterface>
+  parametersToFetchInBatch: Record<string, SSMGetParametersByNameOptionsInterface>
+  parametersToDecrypt: Record<string, SSMGetParametersByNameOptionsInterface>
 } & { [key: string]: SSMGetParametersByNameOptionsInterface };
 
 interface SSMGetParametersByNameOutputInterface {

Diff for: packages/parameters/tests/unit/SSMProvider.test.ts

@@ -939,7 +939,10 @@ describe('Class: SSMProvider', () => {
         super();
       }
 
-      public splitBatchAndDecryptParameters(parameters: Record<string, SSMGetParametersByNameOptionsInterface>, configs: SSMGetParametersByNameOptionsInterface): SSMSplitBatchAndDecryptParametersOutputType {
+      public splitBatchAndDecryptParameters(
+        parameters: Record<string, SSMGetParametersByNameOptionsInterface>,
+        configs: SSMGetParametersByNameOptionsInterface
+      ): SSMSplitBatchAndDecryptParametersOutputType {
         return SSMProvider.splitBatchAndDecryptParameters(parameters, configs);
       }
     }
@@ -956,11 +959,14 @@ describe('Class: SSMProvider', () => {
       };
 
       // Act
-      const { batch: notToDecrypt, decrypt } = provider.splitBatchAndDecryptParameters(parameters, {});
+      const {
+        parametersToFetchInBatch,
+        parametersToDecrypt
+      } = provider.splitBatchAndDecryptParameters(parameters, {});
 
       // Assess
-      expect(decrypt).toEqual({});
-      expect(notToDecrypt).toEqual({
+      expect(parametersToDecrypt).toEqual({});
+      expect(parametersToFetchInBatch).toEqual({
         '/foo/bar': {},
         '/foo/baz': {
           maxAge: 1000,
@@ -983,16 +989,19 @@ describe('Class: SSMProvider', () => {
       };
 
       // Act
-      const { batch: notToDecrypt, decrypt } = provider.splitBatchAndDecryptParameters(parameters, {});
+      const {
+        parametersToFetchInBatch,
+        parametersToDecrypt
+      } = provider.splitBatchAndDecryptParameters(parameters, {});
 
       // Assess
-      expect(decrypt).toEqual({
+      expect(parametersToDecrypt).toEqual({
         '/foo/bar': {
           decrypt: true,
           transform: undefined
         },
       });
-      expect(notToDecrypt).toEqual({
+      expect(parametersToFetchInBatch).toEqual({
         '/foo/baz': {
           decrypt: false,
           transform: undefined
@@ -1015,20 +1024,23 @@ describe('Class: SSMProvider', () => {
       };
 
       // Act
-      const { batch: notToDecrypt, decrypt } = provider.splitBatchAndDecryptParameters(parameters, {
+      const {
+        parametersToFetchInBatch,
+        parametersToDecrypt
+      } = provider.splitBatchAndDecryptParameters(parameters, {
         decrypt: false,
         maxAge: 2000,
       });
 
       // Assess
-      expect(decrypt).toEqual({
+      expect(parametersToDecrypt).toEqual({
         '/foo/bar': {
           decrypt: true,
           maxAge: 2000,
           transform: undefined
         },
       });
-      expect(notToDecrypt).toEqual({
+      expect(parametersToFetchInBatch).toEqual({
         '/foo/baz': {
           decrypt: false,
           maxAge: 1000,