feat(nextjs-component, aws-lambda): support adding tags to lambdas

Author: dphang

packages/e2e-tests/next-app/serverless.yml

@@ -10,3 +10,12 @@ next-app:
       api/*:
         forward:
           headers: [Authorization]
+    tags:
+      defaultLambda:
+        tag1: val1
+      apiLambda:
+        tag2: val2
+      imageLambda:
+        tag3: val3
+      regenerationLambda:
+        tag4: val4

packages/serverless-components/aws-lambda/serverless.js

@@ -39,7 +39,8 @@ const defaults = {
   handler: "handler.hello",
   runtime: "nodejs10.x",
   env: {},
-  region: "us-east-1"
+  region: "us-east-1",
+  tags: {}
 };
 
 class AwsLambda extends Component {

packages/serverless-components/aws-lambda/utils.js

@@ -88,7 +88,8 @@ const createLambda = async ({
   zipPath,
   bucket,
   role,
-  layer
+  layer,
+  tags
 }) => {
   const params = {
     FunctionName: name,
@@ -102,7 +103,8 @@ const createLambda = async ({
     Timeout: timeout,
     Environment: {
       Variables: env
-    }
+    },
+    Tags: tags
   };
 
   if (layer && layer.arn) {
@@ -131,7 +133,8 @@ const updateLambdaConfig = async ({
   env,
   description,
   role,
-  layer
+  layer,
+  tags
 }) => {
   const functionConfigParams = {
     FunctionName: name,
@@ -143,7 +146,8 @@ const updateLambdaConfig = async ({
     Timeout: timeout,
     Environment: {
       Variables: env
-    }
+    },
+    Tags: tags
   };
 
   if (layer && layer.arn) {

packages/serverless-components/nextjs-component/__tests__/custom-inputs.test.ts

@@ -10,7 +10,12 @@ import { mockSQS } from "@sls-next/aws-sqs";
 
 import NextjsComponent, { DeploymentResult } from "../src/component";
 import obtainDomains from "../src/lib/obtainDomains";
-import { DEFAULT_LAMBDA_CODE_DIR, API_LAMBDA_CODE_DIR } from "../src/constants";
+import {
+  DEFAULT_LAMBDA_CODE_DIR,
+  API_LAMBDA_CODE_DIR,
+  IMAGE_LAMBDA_CODE_DIR,
+  REGENERATION_LAMBDA_CODE_DIR
+} from "../src/constants";
 import { cleanupFixtureDirectory } from "../src/lib/test-utils";
 
 // unfortunately can't use __mocks__ because aws-sdk is being mocked in other
@@ -414,6 +419,61 @@ describe("Custom inputs", () => {
     });
   });
 
+  describe.each([
+    {
+      defaultLambda: { tag1: "val1" },
+      apiLambda: { tag2: "val2" },
+      imageLambda: { tag3: "val3" }
+    }
+  ])("Lambda tags input", (tags) => {
+    const fixturePath = path.join(__dirname, "./fixtures/generic-fixture");
+    let tmpCwd: string;
+
+    beforeEach(async () => {
+      tmpCwd = process.cwd();
+      process.chdir(fixturePath);
+
+      mockServerlessComponentDependencies({ expectedDomain: undefined });
+
+      const component = createNextComponent();
+
+      componentOutputs = await component.default({
+        tags: tags
+      });
+    });
+
+    afterEach(() => {
+      process.chdir(tmpCwd);
+      return cleanupFixtureDirectory(fixturePath);
+    });
+
+    it(`sets lambda tags to ${JSON.stringify(tags)}`, () => {
+      // default Lambda
+      expect(mockLambda).toBeCalledWith(
+        expect.objectContaining({
+          code: path.join(fixturePath, DEFAULT_LAMBDA_CODE_DIR),
+          tags: tags.defaultLambda
+        })
+      );
+
+      // api Lambda
+      expect(mockLambda).toBeCalledWith(
+        expect.objectContaining({
+          code: path.join(fixturePath, API_LAMBDA_CODE_DIR),
+          tags: tags.apiLambda
+        })
+      );
+
+      // image lambda
+      expect(mockLambda).toBeCalledWith(
+        expect.objectContaining({
+          code: path.join(fixturePath, IMAGE_LAMBDA_CODE_DIR),
+          tags: tags.imageLambda
+        })
+      );
+    });
+  });
+
   describe.each`
     inputTimeout                            | expectedTimeout
     ${undefined}                            | ${{ defaultTimeout: 10, apiTimeout: 10 }}

packages/serverless-components/nextjs-component/__tests__/deploy.test.ts

@@ -124,6 +124,7 @@ describe.each`
           runtime: "nodejs12.x",
           name: "bucket-xyz",
           region: "us-east-1",
+          tags: {},
           role: {
             service: ["lambda.amazonaws.com"],
             policy: {
@@ -175,6 +176,7 @@ describe.each`
           memory: 512,
           timeout: 10,
           runtime: "nodejs12.x",
+          tags: {},
           role: {
             service: ["lambda.amazonaws.com", "edgelambda.amazonaws.com"],
             policy: {
@@ -221,6 +223,7 @@ describe.each`
           memory: 512,
           timeout: 10,
           runtime: "nodejs12.x",
+          tags: {},
           role: {
             service: ["lambda.amazonaws.com", "edgelambda.amazonaws.com"],
             policy: {
@@ -267,6 +270,7 @@ describe.each`
           memory: 512,
           timeout: 10,
           runtime: "nodejs12.x",
+          tags: {},
           role: {
             service: ["lambda.amazonaws.com", "edgelambda.amazonaws.com"],
             policy: {

packages/serverless-components/nextjs-component/src/component.ts

@@ -451,10 +451,10 @@ class NextjsComponent extends Component {
     );
 
     const readLambdaInputValue = (
-      inputKey: "memory" | "timeout" | "name" | "runtime" | "roleArn",
+      inputKey: "memory" | "timeout" | "name" | "runtime" | "roleArn" | "tags",
       lambdaType: LambdaType,
-      defaultValue: string | number | undefined
-    ): string | number | undefined => {
+      defaultValue: string | number | Record<string, string> | undefined
+    ): string | number | Record<string, string> | undefined => {
       const inputValue = inputs[inputKey];
 
       if (typeof inputValue === "string" || typeof inputValue === "number") {
@@ -571,7 +571,11 @@ class NextjsComponent extends Component {
           "regenerationLambda",
           "nodejs12.x"
         ) as string,
-        name: bucketOutputs.name
+        name: bucketOutputs.name,
+        tags: readLambdaInputValue("tags", "regenerationLambda", {}) as Record<
+          string,
+          string
+        >
       };
 
       const regenerationLambdaResult = await regenerationLambda(
@@ -610,7 +614,11 @@ class NextjsComponent extends Component {
         ) as string,
         name: readLambdaInputValue("name", "apiLambda", undefined) as
           | string
-          | undefined
+          | undefined,
+        tags: readLambdaInputValue("tags", "apiLambda", {}) as Record<
+          string,
+          string
+        >
       };
 
       const apiEdgeLambdaOutputs = await apiEdgeLambda(apiEdgeLambdaInput);
@@ -667,7 +675,11 @@ class NextjsComponent extends Component {
         ) as string,
         name: readLambdaInputValue("name", "imageLambda", undefined) as
           | string
-          | undefined
+          | undefined,
+        tags: readLambdaInputValue("tags", "imageLambda", {}) as Record<
+          string,
+          string
+        >
       };
 
       const imageEdgeLambdaOutputs = await imageEdgeLambda(
@@ -728,7 +740,11 @@ class NextjsComponent extends Component {
       ) as string,
       name: readLambdaInputValue("name", "defaultLambda", undefined) as
         | string
-        | undefined
+        | undefined,
+      tags: readLambdaInputValue("tags", "defaultLambda", {}) as Record<
+        string,
+        string
+      >
     };
 
     const defaultEdgeLambdaOutputs = await defaultEdgeLambda(

packages/serverless-components/nextjs-component/types.d.ts

@@ -49,6 +49,14 @@ export type ServerlessComponentInputs = {
         imageLambda?: string;
         regenerationLambda?: string;
       };
+  tags?:
+    | string
+    | {
+        defaultLambda?: Record<string, string>;
+        apiLambda?: Record<string, string>;
+        imageLambda?: Record<string, string>;
+        regenerationLambda?: Record<string, string>;
+      };
   handler?: string;
   description?: string;
   policy?: string;
@@ -95,4 +103,5 @@ export type LambdaInput = {
   timeout: number;
   runtime: string;
   name?: string;
+  tags: Record<string, string>;
 };