Dead Letter Queue with properties. (gmetzker#29)

* Added ability to specify sqs as an object along with properties gmetzker#12

* Updated readme gmetzker#12

Author: gmetzker

README.md

@@ -49,7 +49,19 @@ Use the `deadLetter.sqs` to create a new dead letter queue for the function.
 
 The resulting cloudformation stack will contain an SQS Queue and it's respective QueuePolicy.  
 
+#### Create new dead-letter queue by name
+```YAML
+# 'functions' in serverless.yml
+
+functions:
+  createUser: # Function name
+    handler: handler.createUser # Reference to function 'createUser' in code
+
+    deadLetter:
+      sqs:  createUser-dl-queue  # New Queue with this name
+```
 
+#### Create new dead-letter queue with properties
 ```YAML
 # 'functions' in serverless.yml
 
@@ -58,7 +70,13 @@ functions:
     handler: handler.createUser # Reference to function 'createUser' in code
 
     deadLetter:
-      sqs:  createUser-dl-queue
+      sqs:      # New Queue with these properties
+        queueName: createUser-dl-queue
+        delaySeconds: 60
+        maximumMessageSize: 2048
+        messageRetentionPeriod: 200000
+        receiveMessageWaitTimeSeconds: 15
+        visibilityTimeout: 300
 ```
 
 #### DeadLetter Topic

src/index.js

@@ -262,16 +262,35 @@ class Plugin {
     return `${this.normalizeFunctionName(functionName)}DeadLetterTopic`;
   }
 
+  static capitalizeFirstLetter(string) {
+    return string.charAt(0).toUpperCase() + string.slice(1);
+  }
+
   compileFunctionDeadLetterQueue(functionName, queueConfig) {
 
-    if (typeof queueConfig !== 'string' && queueConfig !== null) {
-      throw new Error(`Function property ${functionName}.deadLetter.sqs is an unexpected type.  This must be a or string.`);
+    const queueProps = { QueueName: '' };
+
+    if (typeof queueConfig === 'string' || queueConfig === null) {
+
+      queueProps.QueueName = (queueConfig || '').trim();
+
+    } else if (typeof queueConfig === 'object') {
+
+      Object.keys(queueConfig).forEach((key) => {
+        if (Object.prototype.hasOwnProperty.call(queueConfig, key)) {
+          queueProps[Plugin.capitalizeFirstLetter(key)] = queueConfig[key];
+        }
+      });
+
+    } else {
+
+      throw new Error(`Function property ${functionName}.deadLetter.sqs is an unexpected type.  This must be an object or a string.`);
+
     }
 
-    const queueName = (queueConfig || '').trim();
 
-    if (queueName.length < 1) {
-      throw new Error(`Function property ${functionName}.deadLetter.sqs must contain one or more characters.`);
+    if (queueProps.QueueName.length < 1) {
+      throw new Error(`Function property ${functionName}.deadLetter.sqs queueName must contain one or more characters.`);
     }
 
     const functionLogicalId = this.provider.naming.getLambdaLogicalId(functionName);
@@ -281,9 +300,7 @@ class Plugin {
 
     const queueResource = {
       Type: 'AWS::SQS::Queue',
-      Properties: {
-        QueueName: queueName
-      }
+      Properties: queueProps
     };
 
     const queuePolicyResource = {

tests/index.test.js

@@ -7,15 +7,28 @@ const BbPromise = require('bluebird');
 
 describe('serverless-plugin-lambda-dead-letter', () => {
 
+  function getNormalizedFunctionName(functionName) {
+
+    // Copied from https://github.com/serverless/serverless/blob/master/lib/plugins/aws/lib/naming.js
+    // See:  serverless/lib/plugins/aws/lib/naming.js/getNormalizedFunctionName
+    let result = functionName
+      .replace(/-/g, 'Dash')
+      .replace(/_/g, 'Underscore');
+
+    if (result !== '') {
+      result = result[0].toUpperCase() + result.substr(1);
+    }
+    return result;
+  }
 
   function createMockServerless(requestFunc) {
 
     const provider = {
       request: requestFunc,
       naming: {
         getStackName: () => 'MyCoolStack',
-        getNormalizedFunctionName: getNormalizedFunctionName,
-        getLambdaLogicalId: (functionName) => `${getNormalizedFunctionName(functionName)}LambdaFunction`
+        getNormalizedFunctionName,
+        getLambdaLogicalId: functionName => `${getNormalizedFunctionName(functionName)}LambdaFunction`
       }
     };
 
@@ -46,20 +59,6 @@ describe('serverless-plugin-lambda-dead-letter', () => {
 
   }
 
-  function getNormalizedFunctionName(functionName) {
-
-    // Copied from https://github.com/serverless/serverless/blob/master/lib/plugins/aws/lib/naming.js
-    // See:  serverless/lib/plugins/aws/lib/naming.js/getNormalizedFunctionName
-    let result = functionName
-      .replace(/-/g, 'Dash')
-      .replace(/_/g, 'Underscore');
-
-    if (result !== '') {
-      result = result[0].toUpperCase() + result.substr(1);
-    }
-    return result;
-  }
-
   function createMockRequest(requestStub) {
 
     return () => {
@@ -1291,7 +1290,7 @@ describe('serverless-plugin-lambda-dead-letter', () => {
   });
 
   describe('compileFunctionDeadLetterQueue', () => {
-    it('throws an error of deadLetter.sqs is not a string', () => {
+    it('throws an error of deadLetter.sqs is not a string or object', () => {
 
       // ARRANGE:
       const stage = 'test1';
@@ -1301,11 +1300,11 @@ describe('serverless-plugin-lambda-dead-letter', () => {
       const plugin = new Plugin(mockServerless, { stage, region });
 
       // ACT:
-      const act = () => plugin.compileFunctionDeadLetterQueue('f1', { });
+      const act = () => plugin.compileFunctionDeadLetterQueue('f1', 123);
 
       // ASSERT:
       expect(act).throwException((e) => {
-        expect(e.message).to.contain('deadLetter.sqs is an unexpected type.  This must be a or string.');
+        expect(e.message).to.contain('deadLetter.sqs is an unexpected type.  This must be an object or a string.');
       });
 
     });
@@ -1328,13 +1327,13 @@ describe('serverless-plugin-lambda-dead-letter', () => {
 
         // ASSERT:
         expect(act).throwException((e) => {
-          expect(e.message).to.contain('deadLetter.sqs must contain one or more characters');
+          expect(e.message).to.contain('deadLetter.sqs queueName must contain one or more characters');
         });
 
       });
 
     });
-    it('assigns SQS resource', () => {
+    it('can compile SQS resource when sqs is a string', () => {
 
       // ARRANGE:
       const stage = 'test1';
@@ -1358,6 +1357,42 @@ describe('serverless-plugin-lambda-dead-letter', () => {
       });
     });
 
+    it('can compile SQS resource when sqs is an object', () => {
+
+      // ARRANGE:
+      const stage = 'test1';
+      const region = 'us-west-42';
+
+      const mockServerless = createMockServerless(createMockRequest(sinon.stub()));
+      const plugin = new Plugin(mockServerless, { stage, region });
+
+      // ACT:
+      plugin.compileFunctionDeadLetterQueue('f1', {
+        queueName: 'MySqs',
+        delaySeconds: 60,
+        maximumMessageSize: 2048,
+        messageRetentionPeriod: 200000,
+        receiveMessageWaitTimeSeconds: 15,
+        visibilityTimeout: 300
+      });
+
+      // ASSERT:
+      const resources = mockServerless.service.provider.compiledCloudFormationTemplate.Resources;
+
+      expect(resources).to.have.key('F1DeadLetterQueue');
+      expect(resources.F1DeadLetterQueue).to.eql({
+        Type: 'AWS::SQS::Queue',
+        Properties: {
+          QueueName: 'MySqs',
+          DelaySeconds: 60,
+          MaximumMessageSize: 2048,
+          MessageRetentionPeriod: 200000,
+          ReceiveMessageWaitTimeSeconds: 15,
+          VisibilityTimeout: 300
+        }
+      });
+    });
+
     it('assigns SQS Policy resource', () => {
 
       // ARRANGE: