feat: delete parameters in ssm store

.tool-versions

@@ -1,2 +1,2 @@
-nodejs 12.14.0
+nodejs 14.15.4
 direnv 2.28.0

lib/commands/configure/make-cleanup.js

@@ -0,0 +1,28 @@
+const get = require('lodash/get');
+const property = require('lodash/property');
+
+const makeCleanup = ({ parameterStore }) => async ({ settings }) => {
+  const configPath = get(settings, 'config.path');
+  const secretPath = get(settings, 'secret.path');
+  const parameters = await Promise.all([
+    parameterStore.getAllParameters({ path: configPath }),
+    parameterStore.getAllParameters({ path: secretPath })
+  ]).then(([configs, secrets]) => [
+    ...Object.values(configs),
+    ...Object.values(secrets)
+  ]);
+
+  const { configParameters = [], secretParameters = [] } = settings;
+  const unusedParameters = parameters.filter(
+    ({ Name }) => ![...configParameters, ...secretParameters].includes(Name)
+  );
+
+  return (
+    unusedParameters.length &&
+    parameterStore.deleteParameters({
+      parameterNames: unusedParameters.map(property('Name'))
+    })
+  );
+};
+
+module.exports = { makeCleanup };

lib/commands/configure/make-populate-config.js

@@ -1,4 +1,4 @@
-const get = require('lodash.get');
+const get = require('lodash/get');
 const chalk = require('chalk');
 
 const { log } = require('../../utils/logger');

lib/commands/configure/make-populate-secret.js

@@ -1,5 +1,5 @@
 const chalk = require('chalk');
-const get = require('lodash.get');
+const get = require('lodash/get');
 
 const { log } = require('../../utils/logger');
 

lib/commands/configure/make-prompt-required-configs.js

@@ -1,5 +1,5 @@
 // TODO: this file needs a lot of tests
-const get = require('lodash.get');
+const get = require('lodash/get');
 const { promptForValues } = require('./prompt-for-values');
 const { validateExistingValues } = require('./validate-existing-values');
 

lib/commands/configure/prompt-for-values.js

@@ -1,4 +1,4 @@
-const get = require('lodash.get');
+const get = require('lodash/get');
 const chalk = require('chalk');
 const prompt = require('prompt');
 

lib/commands/fetch/make-fetch.js

@@ -1,4 +1,4 @@
-const get = require('lodash.get');
+const get = require('lodash/get');
 
 const makeFetch = ({ parameterStore, settingsService }) => ({ keys }) =>
   settingsService

lib/commands/import-export/make-export.js

@@ -1,5 +1,5 @@
 const chalk = require('chalk');
-const get = require('lodash.get');
+const get = require('lodash/get');
 const fs = require('fs');
 
 const { log } = require('../../utils/logger');

lib/commands/import-export/make-import.js

@@ -1,5 +1,5 @@
 const chalk = require('chalk');
-const get = require('lodash.get');
+const get = require('lodash/get');
 const fs = require('fs');
 
 const { log } = require('../../utils/logger');

lib/commands/init/make-init.js

@@ -1,4 +1,4 @@
-const get = require('lodash.get');
+const get = require('lodash/get');
 const chalk = require('chalk');
 const { log } = require('../../utils/logger');
 

lib/commands/list/make-list.js

@@ -1,5 +1,5 @@
 const chalk = require('chalk');
-const get = require('lodash.get');
+const get = require('lodash/get');
 
 const { log } = require('../../utils/logger');
 const { listParameters } = require('./list-parameters');

lib/services/cf/get-outputs.js

@@ -1,4 +1,4 @@
-const get = require('lodash.get');
+const get = require('lodash/get');
 const AWS = require('aws-sdk');
 
 AWS.config.update({ region: 'us-east-1' });

lib/services/parameter-store/make-delete-parameters.js

@@ -0,0 +1,15 @@
+const chalk = require('chalk');
+const { log } = require('../../utils/logger');
+
+const makeDeleteParameters = ({ getProviderStore }) => async ({
+  parameterNames
+}) => {
+  log(chalk.gray(`Deleting unused parameters...`));
+  const providerStore = await getProviderStore();
+
+  return providerStore
+    .deleteParameters({ parameterNames })
+    .then(() => log(chalk.gray('Parameters deleted')));
+};
+
+module.exports = { makeDeleteParameters };

lib/services/parameter-store/make-get-all-parameters.js

@@ -0,0 +1,15 @@
+const { sortParameters } = require('./sort-parameters');
+
+const makeGetAllParameters = ({ getProviderStore }) => async ({ path }) => {
+  if (!path) {
+    throw new Error('Missing path!');
+  }
+
+  const providerStore = await getProviderStore();
+
+  const parameters = await providerStore.getAllParametersByPath({ path });
+
+  return sortParameters(parameters);
+};
+
+module.exports = { makeGetAllParameters };

lib/services/parameter-store/make-get-parameters.js

@@ -8,7 +8,9 @@ const makeGetParameters = ({ getProviderStore }) => ({
   }
 
   return getProviderStore()
-    .then(providerStore => providerStore.getAllParameters({ parameterNames }))
+    .then(providerStore =>
+      providerStore.getAllParametersByNames({ parameterNames })
+    )
     .then(sortParameters);
 };
 

lib/services/parameter-store/make-get-parameters.test.js

@@ -10,7 +10,7 @@ const { makeGetParameters } = require('./make-get-parameters');
 const getParameters = makeGetParameters({
   getProviderStore: () =>
     Promise.resolve({
-      getAllParameters: mockGetAllParameters
+      getAllParametersByNames: mockGetAllParameters
     })
 });
 describe('getParameters', () => {

lib/services/parameter-store/make-get-provider-store.js

@@ -1,4 +1,4 @@
-const get = require('lodash.get');
+const get = require('lodash/get');
 const { makeSsmStore } = require('./stores/ssm/make-ssm-store');
 
 const makeGetProviderStore = ({ settingsService }) => () =>

lib/services/parameter-store/make-parameter-store.js

@@ -2,17 +2,23 @@ const { makeGetProviderStore } = require('./make-get-provider-store');
 const { makeUpdateSecrets } = require('./make-update-secrets');
 const { makeUpdateConfigs } = require('./make-update-configs');
 const { makeGetParameters } = require('./make-get-parameters');
+const { makeGetAllParameters } = require('./make-get-all-parameters');
+const { makeDeleteParameters } = require('./make-delete-parameters');
 
 const makeParameterStore = ({ settingsService }) => {
   const getProviderStore = makeGetProviderStore({ settingsService });
   const updateSecrets = makeUpdateSecrets({ getProviderStore });
   const updateConfigs = makeUpdateConfigs({ getProviderStore });
   const getParameters = makeGetParameters({ getProviderStore });
+  const getAllParameters = makeGetAllParameters({ getProviderStore });
+  const deleteParameters = makeDeleteParameters({ getProviderStore });
 
   return {
     updateConfigs,
     updateSecrets,
-    getParameters
+    getParameters,
+    getAllParameters,
+    deleteParameters
   };
 };
 

lib/services/parameter-store/stores/ssm/delete-parameters.js

@@ -0,0 +1,18 @@
+const chunk = require('lodash/chunk');
+const { getSsmClient } = require('./get-ssm-client');
+
+const deleteParameters = ({ parameterNames }) => {
+  const ssm = getSsmClient();
+
+  const chunks = chunk(parameterNames, 10);
+  const promises = chunks.map(chunkedParameterNames =>
+    ssm
+      .deleteParameters({
+        Names: chunkedParameterNames
+      })
+      .promise()
+  );
+  return Promise.all(promises);
+};
+
+module.exports = { deleteParameters };

lib/services/parameter-store/stores/ssm/delete-parameters.test.js

@@ -0,0 +1,23 @@
+const mockDeleteParameters = jest.fn().mockImplementation(() => ({
+  promise: () => Promise.resolve({})
+}));
+
+const AWS = require('aws-sdk');
+
+AWS.SSM.mockImplementation(() => ({
+  deleteParameters: mockDeleteParameters
+}));
+
+const { makeSsmStore } = require('./make-ssm-store');
+
+describe('deleteParameters', () => {
+  it('should delete parameters in batches', async () => {
+    const parameterNames = [...Array(35).keys()].map(key => `/test/${key}`);
+
+    const ssm = makeSsmStore();
+
+    await ssm.deleteParameters({ parameterNames });
+
+    expect(mockDeleteParameters.mock.calls.length).toEqual(4);
+  });
+});

lib/services/parameter-store/stores/ssm/get-all-parameters-by-path.js

@@ -0,0 +1,30 @@
+const { getSsmClient } = require('./get-ssm-client');
+
+const ssm = getSsmClient();
+
+const getParametersByPathRecursively = async params => {
+  const data = await ssm.getParametersByPath(params).promise();
+
+  let parameters = data.Parameters || [];
+
+  if (data.NextToken) {
+    const nextParameters = await getParametersByPathRecursively({
+      ...params,
+      NextToken: data.NextToken
+    });
+    parameters = parameters.concat(nextParameters);
+  }
+
+  return parameters;
+};
+
+const getAllParametersByPath = async ({ path }) => {
+  const allParameters = await getParametersByPathRecursively({
+    Path: path,
+    Recursive: true
+  });
+
+  return allParameters;
+};
+
+module.exports = { getAllParametersByPath };

lib/services/parameter-store/stores/ssm/get-all-parameters-by-path.test.js

@@ -0,0 +1,66 @@
+const mockGetParametersByPath = jest
+  .fn()
+  .mockImplementationOnce(() => ({
+    promise: () =>
+      Promise.resolve({
+        Parameters: [
+          {
+            Name: 'TEST/ONE',
+            Value: '1'
+          }
+        ],
+        NextToken: 'first-token'
+      })
+  }))
+  .mockImplementationOnce(() => ({
+    promise: () =>
+      Promise.resolve({
+        Parameters: [
+          {
+            Name: 'TEST/TWO',
+            Value: '2'
+          }
+        ],
+        NextToken: 'second-token'
+      })
+  }))
+  .mockImplementationOnce(() => ({
+    promise: () =>
+      Promise.resolve({
+        Parameters: [
+          {
+            Name: 'TEST/THREE',
+            Value: '1'
+          }
+        ]
+      })
+  }));
+
+const AWS = require('aws-sdk');
+
+AWS.SSM.mockImplementation(() => ({
+  getParametersByPath: mockGetParametersByPath
+}));
+
+const { makeSsmStore } = require('./make-ssm-store');
+
+describe('getAllParameterByPath', () => {
+  it('should get parameters recursively', async () => {
+    const ssm = makeSsmStore();
+    const parameters = await ssm.getAllParametersByPath({ path: 'TEST' });
+    expect(parameters).toEqual([
+      {
+        Name: 'TEST/ONE',
+        Value: '1'
+      },
+      {
+        Name: 'TEST/TWO',
+        Value: '2'
+      },
+      {
+        Name: 'TEST/THREE',
+        Value: '1'
+      }
+    ]);
+  });
+});

lib/services/parameter-store/stores/ssm/get-batch-parameters.js

@@ -1,4 +1,4 @@
-const get = require('lodash.get');
+const get = require('lodash/get');
 const { getSsmClient } = require('./get-ssm-client');
 
 const getParametersFromSSM = ({ parameterNames }) => {

lib/services/parameter-store/stores/ssm/make-get-all-parameters.js → lib/services/parameter-store/stores/ssm/make-get-all-parameters-by-names.js

@@ -1,6 +1,6 @@
-const get = require('lodash.get');
+const get = require('lodash/get');
 
-const makeGetAllParameters = ({ loader }) => ({ parameterNames }) =>
+const makeGetAllParametersByNames = ({ loader }) => ({ parameterNames }) =>
   loader.loadMany(parameterNames).then(parameters =>
     parameters.reduce((acc, parameter, index) => {
       const parameterPath = get(parameterNames, index) || '';
@@ -18,5 +18,5 @@ const makeGetAllParameters = ({ loader }) => ({ parameterNames }) =>
   );
 
 module.exports = {
-  makeGetAllParameters
+  makeGetAllParametersByNames
 };

lib/services/parameter-store/stores/ssm/make-get-all-parameters.test.js → lib/services/parameter-store/stores/ssm/make-get-all-parameters-by-names.test.js

@@ -67,13 +67,13 @@ AWS.SSM.mockImplementation(() => ({
 
 const { makeSsmStore } = require('./make-ssm-store');
 
-describe('getAllParameters', () => {
+describe('getAllParametersByNames', () => {
   let resultPromise;
 
   beforeAll(() => {
     const ssmStore = makeSsmStore();
-    const { getAllParameters } = ssmStore;
-    resultPromise = getAllParameters({
+    const { getAllParametersByNames } = ssmStore;
+    resultPromise = getAllParametersByNames({
       parameterNames: [
         'TEST/ONE',
         'TEST/TWO',

lib/services/parameter-store/stores/ssm/make-ssm-store.js

@@ -2,19 +2,33 @@ const DataLoader = require('dataloader');
 const { makeUpdateConfigs } = require('./make-update-configs');
 const { makeUpdateSecrets } = require('./make-update-secrets');
 const { getBatchParameters } = require('./get-batch-parameters');
-const { makeGetAllParameters } = require('./make-get-all-parameters');
+const {
+  makeGetAllParametersByNames
+} = require('./make-get-all-parameters-by-names');
+const { getAllParametersByPath } = require('./get-all-parameters-by-path');
+const { deleteParameters } = require('./delete-parameters');
 
 const makeSsmStore = () => {
   const ssmLoader = new DataLoader(keys =>
     getBatchParameters({ parameterNames: keys })
   );
-  const getAllParameters = makeGetAllParameters({ loader: ssmLoader });
+  const getAllParametersByNames = makeGetAllParametersByNames({
+    loader: ssmLoader
+  });
   const getLatestVersion = key => ssmLoader.load(key);
 
   return {
-    getAllParameters,
-    updateConfigs: makeUpdateConfigs({ getAllParameters, getLatestVersion }),
-    updateSecrets: makeUpdateSecrets({ getAllParameters, getLatestVersion })
+    getAllParametersByPath,
+    getAllParametersByNames,
+    updateConfigs: makeUpdateConfigs({
+      getAllParametersByNames,
+      getLatestVersion
+    }),
+    updateSecrets: makeUpdateSecrets({
+      getAllParametersByNames,
+      getLatestVersion
+    }),
+    deleteParameters
   };
 };