feat(aws-sqs): support sqs tags/naming (#1543)

Author: dphang

packages/e2e-tests/next-app/next-env.d.ts

@@ -1,2 +1,3 @@
 /// <reference types="next" />
 /// <reference types="next/types/global" />
+/// <reference types="next/image-types/global" />

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

@@ -1,6 +1,9 @@
 next-app:
   component: "../../serverless-components/nextjs-component"
   inputs:
+    sqs:
+      tags:
+        foo: bar
     build:
       postBuildCommands: ["node scripts/post-build-test.js"]
       assetIgnorePatterns:

packages/serverless-components/aws-sqs/__mocks__/aws-sqs-aws-sdk.mock.js

@@ -0,0 +1,71 @@
+const promisifyMock = (mockFn) => {
+  const promise = jest.fn();
+  mockFn.mockImplementation(() => ({
+    promise
+  }));
+
+  return promise;
+};
+
+export const mockGetCallerIdentity = jest.fn();
+export const mockGetCallerIdentityPromise = promisifyMock(
+  mockGetCallerIdentity
+);
+
+export const mockGetQueueAttributes = jest.fn();
+export const mockGetQueueAttributesPromise = promisifyMock(
+  mockGetQueueAttributes
+);
+
+export const mockCreateQueue = jest.fn();
+export const mockCreateQueuePromise = promisifyMock(mockCreateQueue);
+
+export const mockDeleteQueue = jest.fn();
+export const mockDeleteQueuePromise = promisifyMock(mockDeleteQueue);
+
+export const mockListQueueTags = jest.fn();
+export const mockListQueueTagsPromise = promisifyMock(mockListQueueTags);
+
+export const mockTagQueue = jest.fn();
+export const mockTagQueuePromise = promisifyMock(mockTagQueue);
+
+export const mockUntagQueue = jest.fn();
+export const mockUntagQueuePromise = promisifyMock(mockUntagQueue);
+
+export const mockListEventSourceMappings = jest.fn();
+export const mockListEventSourceMappingsPromise = promisifyMock(
+  mockListEventSourceMappings
+);
+
+export const mockCreateEventSourceMapping = jest.fn();
+export const mockCreateEventSourceMappingPromise = promisifyMock(
+  mockCreateEventSourceMapping
+);
+
+module.exports = {
+  SQS: jest.fn(() => ({
+    createQueue: mockCreateQueue,
+    deleteQueue: mockDeleteQueue,
+    getQueueAttributes: mockGetQueueAttributes,
+    listQueueTags: mockListQueueTags,
+    tagQueue: mockTagQueue,
+    untagQueue: mockUntagQueue
+  })),
+  STS: jest.fn(() => ({
+    getCallerIdentity: mockGetCallerIdentity
+  })),
+  SharedIniFileCredentials: jest.fn(),
+  Lambda: jest.fn(() => ({
+    listEventSourceMappings: mockListEventSourceMappings,
+    createEventSourceMapping: mockCreateEventSourceMapping
+  })),
+  mockListEventSourceMappingsPromise,
+  mockCreateEventSourceMappingPromise,
+  mockGetCallerIdentityPromise,
+  mockGetQueueAttributesPromise,
+  mockCreateQueuePromise,
+  mockDeleteQueuePromise,
+  mockListQueueTagsPromise,
+  mockTagQueuePromise,
+  mockUntagQueuePromise
+};

packages/serverless-components/aws-sqs/__tests__/deploy.test.js

@@ -7,14 +7,19 @@ const {
   mockGetCallerIdentityPromise,
   mockGetQueueAttributesPromise,
   mockCreateQueuePromise,
-  mockDeleteQueuePromise
+  mockDeleteQueuePromise,
+  mockListQueueTagsPromise,
+  mockTagQueuePromise,
+  mockUntagQueuePromise
 } = require("aws-sdk");
 
+jest.mock("aws-sdk", () => require("../__mocks__/aws-sqs-aws-sdk.mock"));
+
 describe("sqs component", () => {
   const tmpStateFolder = (initialState) => {
-    const dir = fse.mkdtempSync(path.join(os.tmpdir(), "test-"));
+    const dir = fse.mkdtempSync(path.join(os.tmpdir(), "test-sqs-"));
     if (initialState) {
-      fse.writeJSONSync(path.join(dir, "TestLambda.json"), initialState);
+      fse.writeJSONSync(path.join(dir, "TestSqs.json"), initialState);
     }
     return dir;
   };
@@ -30,7 +35,7 @@ describe("sqs component", () => {
 
   it("creates a new queue", async () => {
     const dir = tmpStateFolder();
-    const component = new AwsSqsQueue("TestLambda", {
+    const component = new AwsSqsQueue("TestSqs", {
       stateRoot: dir
     });
     await component.init();
@@ -43,7 +48,7 @@ describe("sqs component", () => {
     mockGetQueueAttributesPromise.mockResolvedValueOnce({
       Attributes: { not: "empty" }
     });
-    const component = new AwsSqsQueue("TestLambda", {
+    const component = new AwsSqsQueue("TestSqs", {
       stateRoot: tmpStateFolder({
         url: "myQueueUrl"
       })
@@ -58,7 +63,7 @@ describe("sqs component", () => {
     mockGetQueueAttributesPromise.mockResolvedValueOnce({
       Attributes: { not: "empty" }
     });
-    const component = new AwsSqsQueue("TestLambda", {
+    const component = new AwsSqsQueue("TestSqs", {
       stateRoot: tmpStateFolder()
     });
     await component.init();
@@ -71,7 +76,7 @@ describe("sqs component", () => {
     mockListEventSourceMappingsPromise.mockResolvedValueOnce({
       EventSourceMappings: [1]
     });
-    const component = new AwsSqsQueue("TestLambda", {
+    const component = new AwsSqsQueue("TestSqs", {
       stateRoot: tmpStateFolder()
     });
     await component.init();
@@ -83,7 +88,7 @@ describe("sqs component", () => {
     mockListEventSourceMappingsPromise.mockResolvedValueOnce({
       EventSourceMappings: []
     });
-    const component = new AwsSqsQueue("TestLambda", {
+    const component = new AwsSqsQueue("TestSqs", {
       stateRoot: tmpStateFolder()
     });
     await component.init();
@@ -92,11 +97,47 @@ describe("sqs component", () => {
   });
 
   it("calls the delete handler when component is deleted", async () => {
-    const component = new AwsSqsQueue("TestLambda", {
+    const component = new AwsSqsQueue("TestSqs", {
       stateRoot: tmpStateFolder()
     });
     await component.init();
     await component.remove();
     expect(mockDeleteQueuePromise).toBeCalledTimes(1);
   });
+
+  it("configures queue tags when tags are different", async () => {
+    mockListQueueTagsPromise.mockResolvedValueOnce({
+      Tags: {
+        c: "d"
+      }
+    });
+
+    const component = new AwsSqsQueue("TestSqs", {
+      stateRoot: tmpStateFolder()
+    });
+    await component.init();
+    await component.default({ tags: { a: "b" } });
+
+    expect(mockListQueueTagsPromise).toBeCalledTimes(1);
+    expect(mockTagQueuePromise).toBeCalledTimes(1);
+    expect(mockUntagQueuePromise).toBeCalledTimes(1);
+  });
+
+  it("does not configure queue tags when tags are the same", async () => {
+    mockListQueueTagsPromise.mockResolvedValueOnce({
+      Tags: {
+        a: "b"
+      }
+    });
+
+    const component = new AwsSqsQueue("TestSqs", {
+      stateRoot: tmpStateFolder()
+    });
+    await component.init();
+    await component.default({ tags: { a: "b" } });
+
+    expect(mockListQueueTagsPromise).toBeCalledTimes(1);
+    expect(mockTagQueuePromise).not.toBeCalled();
+    expect(mockUntagQueuePromise).not.toBeCalled();
+  });
 });

packages/serverless-components/aws-sqs/package.json

@@ -17,6 +17,10 @@
     "url": "https://github.com/serverless-nextjs/serverless-next.js/issues"
   },
   "homepage": "https://github.com/serverless-nextjs/serverless-next.js#readme",
+  "dependencies": {
+    "@serverless/core": "^1.1.2",
+    "lodash": "^4.17.21"
+  },
   "peerDependencies": {
     "@serverless/core": "^1.1.2",
     "aws-sdk": "^2.920.0"

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

@@ -9,18 +9,28 @@ const {
   getAccountId,
   getArn,
   getUrl,
-  setAttributes
+  setAttributes,
+  configureTags
 } = require("./utils");
 
 const outputsList = ["arn", "url"];
 
 const defaults = {
   name: "serverless",
-  region: "us-east-1"
+  region: "us-east-1",
+  tags: undefined
 };
 
 class AwsSqsQueue extends Component {
-  async default(inputs = {}) {
+  async default(
+    inputs = {
+      name: undefined,
+      region: undefined,
+      arn: undefined,
+      url: undefined,
+      tags: undefined
+    }
+  ) {
     const config = mergeDeepRight(getDefaults({ defaults }), inputs);
     const accountId = await getAccountId(aws);
 
@@ -86,10 +96,19 @@ class AwsSqsQueue extends Component {
       }
     }
 
+    // Synchronize tags if specified
+    if (config.tags) {
+      this.context.debug(
+        "Configuring SQS queue tags since they are specified."
+      );
+      await configureTags(this.context, sqs, queueUrl, config.tags);
+    }
+
     this.state.name = config.name;
     this.state.arn = config.arn;
     this.state.url = config.url;
     this.state.region = config.region;
+    this.state.tags = config.tags;
     await this.save();
 
     const outputs = pick(outputsList, config);

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

@@ -1,4 +1,5 @@
 const { clone } = require("ramda");
+const _ = require("lodash");
 
 const getDefaults = ({ defaults }) => {
   const response = clone(defaults);
@@ -120,6 +121,39 @@ const deleteQueue = async ({ sqs, queueUrl }) => {
   }
 };
 
+const configureTags = async (context, sqs, queueUrl, inputTags) => {
+  const currentTags = {};
+
+  context.debug("Trying to get existing tags.");
+  const data = await sqs.listQueueTags({ QueueUrl: queueUrl }).promise();
+
+  if (data.Tags) {
+    Object.keys(data.Tags).forEach((key) => {
+      currentTags[key] = data.Tags[key];
+    });
+  }
+
+  // Sync tags if different from current tags
+  if (!_.isEqual(inputTags, currentTags)) {
+    context.debug("Tags have changed. Updating tags.");
+    await sqs
+      .untagQueue({
+        QueueUrl: queueUrl,
+        TagKeys: Object.keys(inputTags)
+      })
+      .promise();
+
+    await sqs
+      .tagQueue({
+        QueueUrl: queueUrl,
+        Tags: inputTags
+      })
+      .promise();
+  } else {
+    context.debug("Tags are the same as before, not doing anything.");
+  }
+};
+
 module.exports = {
   createQueue,
   deleteQueue,
@@ -129,5 +163,6 @@ module.exports = {
   getDefaults,
   getQueue,
   getAttributes,
-  setAttributes
+  setAttributes,
+  configureTags
 };