@adobe/helix-deploy 10.3.3 → 10.4.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [10.4.0](https://github.com/adobe/helix-deploy/compare/v10.3.3...v10.4.0) (2024-01-29)
+
+
+### Features
+
+* add support for custom AWS tags which are set on the deployed Lambda. Fixes [#651](https://github.com/adobe/helix-deploy/issues/651) ([#652](https://github.com/adobe/helix-deploy/issues/652)) ([09e2055](https://github.com/adobe/helix-deploy/commit/09e2055928b7f67c70b64034c810a0ff48b5ce59))
+
 ## [10.3.3](https://github.com/adobe/helix-deploy/compare/v10.3.2...v10.3.3) (2024-01-29)
 
 

package/README.md

@@ -132,7 +132,8 @@ AWS Deployment Options
       --aws-log-format            The lambda log format. Can be either "JSON" or "Text". [string]
       --aws-layers                List of layers ARNs to attach to the lambda function.  [array]
       --aws-tracing-mode          The lambda tracing mode. Can be either "Active" or "PassThrough". [string]
-      --aws-extra-permissions     A list fo additional invoke permissions to add to the lambda function in the form <SourceARN>@<Principal>. [array]
+      --aws-extra-permissions     A list of additional invoke permissions to add to the lambda function in the form <SourceARN>@<Principal>. [array]
+      --aws-tags                  A list of additional tags to attach to the lambda function in the form key=value. To remove a tag, use key= (i.e. without a value).[array]
 
 Google Deployment Options
       --google-project-id  the Google Cloud project to deploy to. Optional when the key file is a JSON file  [string] [default: ""]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-deploy",
-  "version": "10.3.3",
+  "version": "10.4.0",
   "description": "Library and Commandline Tools to build and deploy OpenWhisk Actions",
   "license": "Apache-2.0",
   "homepage": "https://github.com/adobe/helix-deploy#readme",

package/src/deploy/AWSConfig.js

@@ -34,6 +34,7 @@ export default class AWSConfig {
       layers: undefined,
       tracingMode: undefined,
       extraPermissions: undefined,
+      tags: undefined,
     });
   }
 
@@ -56,7 +57,8 @@ export default class AWSConfig {
       .withAWSLogFormat(argv.awsLogFormat)
       .withAWSLayers(argv.awsLayers)
       .withAWSTracingMode(argv.awsTracingMode)
-      .withAWSExtraPermissions(argv.awsExtraPermissions);
+      .withAWSExtraPermissions(argv.awsExtraPermissions)
+      .withAWSTags(argv.awsTags);
   }
 
   withAWSRegion(value) {
@@ -152,13 +154,21 @@ export default class AWSConfig {
     return this;
   }
 
+  withAWSTags(value) {
+    if (value && !Array.isArray(value)) {
+      throw new Error('awsTags must be an array');
+    }
+    this.tags = value;
+    return this;
+  }
+
   static yarg(yargs) {
     return yargs
       .group(['aws-region', 'aws-api', 'aws-role', 'aws-cleanup-buckets', 'aws-cleanup-integrations',
         'aws-cleanup-versions', 'aws-create-routes', 'aws-create-authorizer', 'aws-attach-authorizer',
         'aws-lambda-format', 'aws-parameter-manager', 'aws-deploy-template', 'aws-arch', 'aws-update-secrets',
         'aws-deploy-bucket', 'aws-identity-source', 'aws-log-format', 'aws-layers',
-        'aws-tracing-mode', 'aws-extra-permissions'], 'AWS Deployment Options')
+        'aws-tracing-mode', 'aws-extra-permissions', 'aws-tags'], 'AWS Deployment Options')
       .option('aws-region', {
         description: 'the AWS region to deploy lambda functions to',
         type: 'string',
@@ -245,9 +255,14 @@ export default class AWSConfig {
         type: 'string',
       })
       .option('aws-extra-permissions', {
-        description: 'A list fo additional invoke permissions to add to the lambda function in the form <SourceARN>@<Principal>.',
+        description: 'A list of additional invoke permissions to add to the lambda function in the form <SourceARN>@<Principal>.',
         type: 'string',
         array: true,
+      })
+      .option('aws-tags', {
+        description: 'A list of additional tags to attach to the lambda function in the form key=value. To remove a tag, use key= (i.e. without a value).',
+        type: 'array',
+        array: true,
       });
   }
 }

package/src/deploy/AWSDeployer.js

@@ -29,9 +29,9 @@ import {
   CreateAliasCommand,
   CreateFunctionCommand, DeleteAliasCommand, DeleteFunctionCommand, GetAliasCommand,
   GetFunctionCommand,
-  LambdaClient, ListAliasesCommand, ListVersionsByFunctionCommand,
-  PublishVersionCommand, UpdateAliasCommand, UpdateFunctionCodeCommand,
-  UpdateFunctionConfigurationCommand,
+  LambdaClient, ListAliasesCommand, ListTagsCommand, ListVersionsByFunctionCommand,
+  PublishVersionCommand, TagResourceCommand, UntagResourceCommand, UpdateAliasCommand,
+  UpdateFunctionCodeCommand, UpdateFunctionConfigurationCommand,
 } from '@aws-sdk/client-lambda';
 
 import {
@@ -126,6 +126,16 @@ export default class AWSDeployer extends BaseDeployer {
     }`;
   }
 
+  get additionalTags() {
+    return (this._cfg.tags || []).map((tag) => tag.split('=')).reduce((acc, tagSplit) => {
+      if (tagSplit.length >= 2) {
+        const [key, ...value] = tagSplit;
+        acc[key] = value.join('=');
+      }
+      return acc;
+    }, {});
+  }
+
   validate() {
     const req = [];
     if (!this._cfg.role) {
@@ -206,7 +216,7 @@ export default class AWSDeployer extends BaseDeployer {
   }
 
   async createLambda() {
-    const { cfg, functionName } = this;
+    const { cfg, functionName, additionalTags } = this;
     const functionVersion = cfg.version.replace(/\./g, '_');
 
     const functionConfig = {
@@ -243,6 +253,13 @@ export default class AWSDeployer extends BaseDeployer {
       TracingConfig: this._cfg.tracingMode ? { Mode: this._cfg.tracingMode } : undefined,
     };
 
+    // add additional tags which are not empty
+    Object.entries(additionalTags).forEach(([key, value]) => {
+      if (value !== '') {
+        functionConfig.Tags[key] = value;
+      }
+    });
+
     this.log.info(`--: using lambda role "${this._cfg.role}"`);
 
     // check if function already exists
@@ -272,6 +289,28 @@ export default class AWSDeployer extends BaseDeployer {
       this.log.info(chalk`--: updating existing Lambda function configuration {yellow ${functionName}}`);
       await this._lambda.send(new UpdateFunctionConfigurationCommand(functionConfig));
       await this.checkFunctionReady(baseARN);
+      this.log.info(chalk`--: updating existing Lambda function tags {yellow ${functionName}}`);
+      // set all the tags in the current configuration
+      await this._lambda.send(new TagResourceCommand({
+        Resource: baseARN,
+        Tags: functionConfig.Tags,
+      }));
+      // then remove any tags with a blank value in the configuration (and are currently set),
+      // leaving other tags alone
+      const tagsToPotentiallyRemove = Object.entries(additionalTags).filter(([_, value]) => value === '').map(([key]) => key);
+      if (tagsToPotentiallyRemove.length) {
+        const { Tags: currentTags } = await this._lambda.send(new ListTagsCommand({
+          Resource: baseARN,
+        }));
+        const tagsToRemove = tagsToPotentiallyRemove.filter((key) => currentTags[key]);
+        if (tagsToRemove.length) {
+          await this._lambda.send(new UntagResourceCommand({
+            Resource: baseARN,
+            TagKeys: tagsToRemove,
+          }));
+        }
+      }
+      await this.checkFunctionReady(baseARN);
       this.log.info('--: updating Lambda function code...');
       await this._lambda.send(new UpdateFunctionCodeCommand({
         FunctionName: functionName,