@comicrelief/lambda-wrapper 1.8.0 → 1.9.0

package/README.md

@@ -85,7 +85,12 @@ By default, messages will be sent to a SQS service running on `localhost:4576`.
 
 ### AWS SQS mode
 
-Use this mode by setting `LAMBDA_WRAPPER_OFFLINE_SQS_MODE=aws`. Messages will be sent to the real queue in AWS. This is useful for running end-to-end tests where a message is sent to a queue and eventually appears in an external data store.
+Use this mode by setting `LAMBDA_WRAPPER_OFFLINE_SQS_MODE=aws`. Messages will be sent to the real queue in AWS. This mode is useful when a queue is consumed by an external service, rather than another function in the service under test.
+
+In order for queue URLs to be correctly constructed, you must either:
+
+- set `AWS_ACCOUNT_ID` to the account ID that hosts your queue; or
+- invoke offline functions via the Lambda API, passing a context that contains a realistic `invokedFunctionArn` including the account ID.
 
 ## Semantic release
 

package/dist/Service/SQS.service.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.default = void 0;
+exports.default = exports.SQS_PUBLISH_FAILURE_MODES = exports.SQS_OFFLINE_MODES = void 0;
 
 var _alai = _interopRequireDefault(require("alai"));
 
@@ -32,7 +32,7 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 /**
  * Allowed values for `process.env.LAMBDA_WRAPPER_OFFLINE_SQS_MODE`.
  */
-const OFFLINE_MODES = {
+const SQS_OFFLINE_MODES = {
   /**
    * When running offline, messages will trigger the consumer function directly
    * via a Lambda endpoint, set using `process.env.SERVICE_LAMBDA_URL`. This is
@@ -51,10 +51,34 @@ const OFFLINE_MODES = {
    */
   AWS: 'aws'
 };
+/**
+ * Defines the preferred behaviour
+ * for SQSService.prototype.publish
+ * should AWS SQS fail.
+ */
+
+exports.SQS_OFFLINE_MODES = SQS_OFFLINE_MODES;
+const SQS_PUBLISH_FAILURE_MODES = {
+  /**
+   * Catches the exception and logs it.
+   * This is the default behaviour
+   * for LambdaWrapper 1.8.0 and below
+   * and for LambdaWrapper 1.8.2 and above
+   */
+  CATCH: 'catch',
+
+  /**
+   * Throws the exception so that the caller
+   * can handle it directly.
+   */
+  THROW: 'throw'
+};
 /**
  * SQSService class
  */
 
+exports.SQS_PUBLISH_FAILURE_MODES = SQS_PUBLISH_FAILURE_MODES;
+
 class SQSService extends _DependencyAware.default {
   /**
    * SQSService constructor
@@ -63,31 +87,33 @@ class SQSService extends _DependencyAware.default {
    */
   constructor(di) {
     super(di);
+    const {
+      LAMBDA_WRAPPER_OFFLINE_SQS_HOST: offlineHost = 'localhost',
+      LAMBDA_WRAPPER_OFFLINE_SQS_MODE: offlineMode = SQS_OFFLINE_MODES.DIRECT,
+      AWS_ACCOUNT_ID,
+      REGION
+    } = process.env;
     const container = this.getContainer();
     const context = container.getContext();
     const queues = container.getConfiguration('QUEUES');
+    const accountId = context && context.invokedFunctionArn && _alai.default.parse(context) || AWS_ACCOUNT_ID;
     this.queues = {};
     this.$lambda = null;
     this.$sqs = null;
-    const {
-      LAMBDA_WRAPPER_OFFLINE_SQS_HOST: offlineHost = 'localhost',
-      LAMBDA_WRAPPER_OFFLINE_SQS_MODE: offlineMode = OFFLINE_MODES.DIRECT,
-      REGION
-    } = process.env;
 
-    if (container.isOffline && !Object.values(OFFLINE_MODES).includes(offlineMode)) {
-      throw new Error(`Invalid LAMBDA_WRAPPER_OFFLINE_SQS_MODE: ${offlineMode}\n` + `Please use one of: ${Object.values(OFFLINE_MODES).join(', ')}`);
+    if (container.isOffline && !Object.values(SQS_OFFLINE_MODES).includes(offlineMode)) {
+      throw new Error(`Invalid LAMBDA_WRAPPER_OFFLINE_SQS_MODE: ${offlineMode}\n` + `Please use one of: ${Object.values(SQS_OFFLINE_MODES).join(', ')}`);
     } // Add the queues from configuration
 
 
     if (queues !== null && Object.keys(queues).length > 0) {
       Object.keys(queues).forEach(queueDefinition => {
-        if (container.isOffline && offlineMode === OFFLINE_MODES.LOCAL) {
+        if (container.isOffline && offlineMode === SQS_OFFLINE_MODES.LOCAL) {
           // custom URL when using an offline SQS service such as Localstack
           this.queues[queueDefinition] = `http://${offlineHost}:4576/queue/${queues[queueDefinition]}`;
         } else {
           // default AWS queue URL
-          this.queues[queueDefinition] = `https://sqs.${REGION}.amazonaws.com/${_alai.default.parse(context)}/${queues[queueDefinition]}`;
+          this.queues[queueDefinition] = `https://sqs.${REGION}.amazonaws.com/${accountId}/${queues[queueDefinition]}`;
         }
       });
     }
@@ -139,12 +165,12 @@ class SQSService extends _DependencyAware.default {
    * Returns the mode to use for offline SQS.
    *
    * This is configured by `process.env.LAMBDA_WRAPPER_OFFLINE_SQS_MODE`. The
-   * default is `OFFLINE_MODES.LAMBDA`.
+   * default is `SQS_OFFLINE_MODES.LAMBDA`.
    */
 
 
   static get offlineMode() {
-    return process.env.LAMBDA_WRAPPER_OFFLINE_SQS_MODE || OFFLINE_MODES.DIRECT;
+    return process.env.LAMBDA_WRAPPER_OFFLINE_SQS_MODE || SQS_OFFLINE_MODES.DIRECT;
   }
   /**
    * Batch delete messages
@@ -267,14 +293,20 @@ class SQSService extends _DependencyAware.default {
    * @param queue          string
    * @param messageObject  object
    * @param messageGroupId string
+   * @param {'catch' | 'throw'} failureMode Choose how failures are handled:
+   *   - `catch`: errors will be caught and logged. This is the default.
+   *   - `throw`: errors will be thrown, causing promise to reject.
    * @returns {Promise<any>}
    */
 
 
-  async publish(queue, messageObject, messageGroupId = null) {
+  async publish(queue, messageObject, messageGroupId = null, failureMode = SQS_PUBLISH_FAILURE_MODES.CATCH) {
+    if (!Object.values(SQS_PUBLISH_FAILURE_MODES).includes(failureMode)) {
+      throw new Error(`Invalid value for 'failureMode': ${failureMode}`);
+    }
+
     const container = this.getContainer();
     const queueUrl = this.queues[queue];
-    const Logger = container.get(_Dependencies.DEFINITIONS.LOGGER);
     const Timer = container.get(_Dependencies.DEFINITIONS.TIMER);
     const timerId = `sqs-send-message-${(0, _uuid.v4)()} - Queue: '${queueUrl}'`;
     Timer.start(timerId);
@@ -289,13 +321,21 @@ class SQSService extends _DependencyAware.default {
     }
 
     try {
-      if (container.isOffline && this.constructor.offlineMode === OFFLINE_MODES.DIRECT) {
+      if (container.isOffline && this.constructor.offlineMode === SQS_OFFLINE_MODES.DIRECT) {
         await this.publishOffline(queue, messageParameters);
       } else {
         await this.sqs.sendMessage(messageParameters).promise();
       }
     } catch (error) {
-      Logger.error(error);
+      switch (failureMode) {
+        case SQS_PUBLISH_FAILURE_MODES.CATCH:
+          container.get(_Dependencies.DEFINITIONS.LOGGER).error(error);
+          return null;
+
+        case SQS_PUBLISH_FAILURE_MODES.THROW:
+        default:
+          throw error;
+      }
     }
 
     return queue;

package/dist/Wrapper/LambdaWrapper.js

@@ -24,8 +24,9 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  * @param outcome
  */
 const handleSuccess = (di, outcome) => {
-  const logger = di.get(_Dependencies.DEFINITIONS.LOGGER);
-  logger.metric('lambda.statusCode', outcome.statusCode || 200);
+  const logger = di.get(_Dependencies.DEFINITIONS.LOGGER); // Outcome may be undefined as not all lambdas have a return value.
+
+  logger.metric('lambda.statusCode', outcome && outcome.statusCode || 200);
   return outcome;
 };
 /**

package/dist/index.js

@@ -93,6 +93,18 @@ Object.defineProperty(exports, "SQSService", {
     return _SQS.default;
   }
 });
+Object.defineProperty(exports, "SQS_OFFLINE_MODES", {
+  enumerable: true,
+  get: function () {
+    return _SQS.SQS_OFFLINE_MODES;
+  }
+});
+Object.defineProperty(exports, "SQS_PUBLISH_FAILURE_MODES", {
+  enumerable: true,
+  get: function () {
+    return _SQS.SQS_PUBLISH_FAILURE_MODES;
+  }
+});
 Object.defineProperty(exports, "LambdaTermination", {
   enumerable: true,
   get: function () {
@@ -136,7 +148,7 @@ var _Logger = _interopRequireDefault(require("./Service/Logger.service"));
 
 var _Request = _interopRequireDefault(require("./Service/Request.service"));
 
-var _SQS = _interopRequireDefault(require("./Service/SQS.service"));
+var _SQS = _interopRequireWildcard(require("./Service/SQS.service"));
 
 var _LambdaTermination = _interopRequireDefault(require("./Wrapper/LambdaTermination"));
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@comicrelief/lambda-wrapper",
-  "version": "1.8.0",
+  "version": "1.9.0",
   "description": "Lambda wrapper for all Comic Relief Serverless Projects",
   "main": "dist/index.js",
   "scripts": {