@adobe/helix-deploy 10.3.3 → 11.0.0

package/CHANGELOG.md

@@ -1,3 +1,22 @@
+# [11.0.0](https://github.com/adobe/helix-deploy/compare/v10.4.0...v11.0.0) (2024-01-30)
+
+
+### Features
+
+* move development server to own package ([#659](https://github.com/adobe/helix-deploy/issues/659)) ([43cbb16](https://github.com/adobe/helix-deploy/commit/43cbb16bb74ebfab1759b7b8ae0f842db6ec3ebe)), closes [#654](https://github.com/adobe/helix-deploy/issues/654)
+
+
+### BREAKING CHANGES
+
+* import { DevelopmentServer } from @adobe/helix-universal-devserver
+
+# [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: ""]
@@ -346,38 +347,25 @@ destination filename. eg:
 
 ## Using the development server
 
-Testing an openwhisk action that was _expressified_ using [ActionUtils.expressify()](https://github.com/adobe/openwhisk-action-utils/blob/main/src/expressify.js)
-can be done with the `DevelopmentServer`. Just create a `test/dev.js` file with:
+Testing an universal function can be done with the [development server](https://github.com/adobe/helix-universal-devserver). 
+
+Just create a `test/dev.js` file with:
 
 ```js
-const { DevelopmentServer } = require('@adobe/helix-deploy');
-const App = require('../src/app.js');
+import { DevelopmentServer } from '@adobe/helix-universal-devserver';
+import { main } from '../src/index.js';
 
 async function run() {
-  const devServer = await new DevelopmentServer(App).init();
-  return devServer.start();
+  const devServer = await new DevelopmentServer(main).init();
+  await devServer.start();
 }
 
-// eslint-disable-next-line no-console
-run().catch(console.error);
+run().then(process.stdout).catch(process.stderr);
 ```
 
 and run `node test/dev.js`.
 
-### Using development params with the server
-
-Sometimes it might be useful to specify action params that would be provided during deployment
-but are not available during development. those can be specified by a `dev-params-file` `wsk`
-property. those parameters are loaded an applied to every action call. eg:
-
-```json
-...
-  "wsk": {
-    ...
-    "dev-params-file": ".dev-secrets.env"
-  }
-...
-```
+for more information see https://github.com/adobe/helix-universal-devserver
 
 ## Notes
 

package/index.js

@@ -13,4 +13,3 @@ export { default as ActionBuilder } from './src/ActionBuilder.js';
 export { default as Bundler } from './src/bundler/WebpackBundler.js';
 export { default as BaseConfig } from './src/BaseConfig.js';
 export { default as CLI } from './src/cli.js';
-export { default as DevelopmentServer } from './src/DevelopmentServer.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-deploy",
-  "version": "10.3.3",
+  "version": "11.0.0",
   "description": "Library and Commandline Tools to build and deploy OpenWhisk Actions",
   "license": "Apache-2.0",
   "homepage": "https://github.com/adobe/helix-deploy#readme",
@@ -59,7 +59,6 @@
     "chalk-template": "1.1.0",
     "constants-browserify": "1.0.0",
     "dotenv": "16.4.1",
-    "express": "4.18.2",
     "form-data": "4.0.0",
     "fs-extra": "11.2.0",
     "isomorphic-git": "1.25.3",
@@ -77,7 +76,7 @@
     "@semantic-release/git": "10.0.1",
     "c8": "9.1.0",
     "eslint": "8.56.0",
-    "husky": "8.0.3",
+    "husky": "9.0.7",
     "lint-staged": "15.2.0",
     "mocha": "10.2.0",
     "mocha-junit-reporter": "2.2.1",

package/src/bundler/WebpackBundler.js

@@ -81,7 +81,7 @@ export default class WebpackBundler extends BaseBundler {
         },
         // use fixed conditions to omit the `development` condition.
         // see: https://webpack.js.org/guides/package-exports/#conditions
-        conditionNames: ['node', 'require', 'import'],
+        conditionNames: ['node', 'require', 'import', 'module'],
       },
       node: {
         __dirname: true,

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,

package/src/DevelopmentServer.js

@@ -1,237 +0,0 @@
-/*
- * Copyright 2020 Adobe. All rights reserved.
- * This file is licensed to you under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License. You may obtain a copy
- * of the License at http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software distributed under
- * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
- * OF ANY KIND, either express or implied. See the License for the specific language
- * governing permissions and limitations under the License.
- */
-import crypto from 'crypto';
-import fse from 'fs-extra';
-import path from 'path';
-import express from 'express';
-import { createAdapter } from '@adobe/helix-universal/aws';
-import ActionBuilder from './ActionBuilder.js';
-import BaseConfig from './BaseConfig.js';
-
-function rawBody() {
-  return (req, res, next) => {
-    if (req.method === 'GET' || req.method === 'HEAD') {
-      next();
-      return;
-    }
-    const chunks = [];
-    req.on('data', (chunk) => {
-      chunks.push(chunk);
-    });
-    req.on('end', () => {
-      req.rawBody = Buffer.concat(chunks);
-      next();
-    });
-  };
-}
-
-function addRequestHeader(name, value) {
-  return (req, res, next) => {
-    req.headers[name] = value;
-    next();
-  };
-}
-
-/**
- * Development server for local development.
- *
- * Example:
- *
- * ```
- * // test/dev.js
- *
- * const { DevelopmentServer } = require('@adobe/helix-deploy');
- * const { main } = require('../src/index.js');
- *
- * async function run() {
- *  const devServer = await new DevelopmentServer(main).init();
- *  await devServer.start();
- * }
- *
- * run().then(process.stdout).catch(process.stderr);
- * ```
- *
- * @type {DevelopmentServer}
- */
-export default class DevelopmentServer {
-  /**
-   * Creates a new development server using the given universal function.
-   * @param {UniversalFunction} main - The universal function
-   */
-  constructor(main) {
-    this._main = main;
-    this._cwd = process.cwd();
-    this._port = process.env.WEBSERVER_PORT || 3000;
-    this._headers = {};
-  }
-
-  withPort(value) {
-    this._port = value;
-    return this;
-  }
-
-  withXFH(value) {
-    process.emitWarning('DevelopmentServer.withXFH is deprecated. Use withHeader(\'x-forwarded-host\') instead.', 'DeprecationWarning');
-    this._headers['x-forwarded-host'] = value;
-    return this;
-  }
-
-  withHeader(name, value) {
-    this._headers[name] = value;
-    return this;
-  }
-
-  withDirectory(value) {
-    this._cwd = value;
-    return this;
-  }
-
-  get port() {
-    return this._port;
-  }
-
-  /**
-   * Initializes the development server.
-   * It uses the `wsk.package.params-file` and `wsk.params-file` to read the environment for
-   * the action params.
-   *
-   * @returns this
-   */
-  async init() {
-    // load the action params
-    let pkgJson = {};
-    try {
-      pkgJson = await fse.readJson(path.resolve(this._cwd, 'package.json'));
-    } catch (e) {
-      // ignore
-    }
-    const config = new BaseConfig();
-    if (pkgJson.wsk) {
-      const withParamsFile = async (file) => {
-        if (!file) {
-          return;
-        }
-        // eslint-disable-next-line no-param-reassign
-        const files = (Array.isArray(file) ? file : [file]).map((f) => path.resolve(this._cwd, f));
-        await Promise.all(files.map(async (f) => {
-          if (await fse.exists(f)) {
-            config.withParamsFile(f);
-          }
-        }));
-      };
-
-      await withParamsFile(pkgJson.wsk?.package?.['params-file']);
-      config.withParams(pkgJson.wsk?.package?.params);
-      await withParamsFile(pkgJson.wsk?.['params-file']);
-      config.withParams(pkgJson.wsk?.params);
-      await withParamsFile(pkgJson.wsk?.dev?.['params-file']);
-      config.withParams(pkgJson.wsk?.dev?.params);
-    }
-
-    const builder = new ActionBuilder().withConfig(config);
-    await builder.validate();
-
-    const region = process.env.AWS_REGION ?? 'us-east-1';
-    const accountId = process.env.AWS_ACCOUNT_ID ?? 'no-account';
-
-    const adapter = createAdapter({
-      factory: () => (req, ctx) => {
-        ctx.runtime.name = 'simulate';
-        return this._main(req, ctx);
-      },
-    });
-    this._handler = async (req, res) => {
-      const [rawPath, ...rest] = req.originalUrl.split('?');
-      const rawQueryString = rest.join('?');
-      const method = req.headers['x-http-method'] || req.method;
-      const event = {
-        body: req.rawBody,
-        headers: req.headers,
-        pathParameters: {
-          path: rawPath.substring(1),
-        },
-        requestContext: {
-          domainName: req.hostname,
-          http: {
-            method,
-          },
-        },
-        rawPath,
-        rawQueryString,
-      };
-      const context = {
-        awsRequestId: crypto.randomUUID(),
-        invokedFunctionArn: `arn:aws:lambda:${region}:${accountId}:function:${config.name}:${config.version}`,
-        getRemainingTimeInMillis: () => 60000,
-      };
-
-      const {
-        statusCode,
-        headers,
-        isBase64Encoded,
-        body,
-      } = await adapter(event, context);
-
-      res.status(statusCode);
-      Object.entries(headers).forEach(([name, value]) => res.set(name, value));
-      res.send(isBase64Encoded ? Buffer.from(body, 'base64') : body);
-    };
-    this.params = config.params;
-    return this;
-  }
-
-  /**
-   * Starts the development server
-   * @returns {Promise<void>}
-   */
-  async start() {
-    Object.entries(this.params).forEach(([key, value]) => {
-      if (!(key in process.env)) {
-        process.env[key] = value;
-      }
-    });
-    this.app = express();
-    await new Promise((resolve, reject) => {
-      try {
-        this.server = this.app.listen(this._port, () => {
-          this._port = this.server.address().port;
-          // eslint-disable-next-line no-console
-          console.log(`Started development server at http://localhost:${this._port}/`);
-          resolve();
-        });
-      } catch (e) {
-        reject(e);
-      }
-    });
-    this.app.use(rawBody());
-    Object.entries(this._headers).forEach(([name, value]) => {
-      this.app.use(addRequestHeader(name, value.replace('{port}', this._port)));
-    });
-    this.app.all('*', this._handler);
-  }
-
-  /**
-   * Stops the development server.
-   * @returns {Promise<void>}
-   */
-  async stop() {
-    return new Promise((resolve, reject) => {
-      this.server.close((err) => {
-        if (err) {
-          reject(err);
-        } else {
-          resolve();
-        }
-      });
-    });
-  }
-}