@comicrelief/lambda-wrapper 1.10.1 → 2.0.0-beta.2

package/dist/Service/SQS.service.js

@@ -1,420 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = exports.SQS_PUBLISH_FAILURE_MODES = exports.SQS_OFFLINE_MODES = void 0;
-
-var _alai = _interopRequireDefault(require("alai"));
-
-var _each = _interopRequireDefault(require("async/each"));
-
-var _awsSdk = _interopRequireDefault(require("aws-sdk"));
-
-var _uuid = require("uuid");
-
-var _Dependencies = require("../Config/Dependencies");
-
-var _DependencyAware = _interopRequireDefault(require("../DependencyInjection/DependencyAware.class"));
-
-var _DependencyInjection = _interopRequireDefault(require("../DependencyInjection/DependencyInjection.class"));
-
-var _Message = _interopRequireDefault(require("../Model/SQS/Message.model"));
-
-var _Status = _interopRequireWildcard(require("../Model/Status.model"));
-
-function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
-
-function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-/**
- * Allowed values for `process.env.LAMBDA_WRAPPER_OFFLINE_SQS_MODE`.
- */
-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
-   * the default.
-   */
-  DIRECT: 'direct',
-
-  /**
-   * When running offline, send messages to an offline SQS service defined by
-   * `process.env.LAMBDA_WRAPPER_OFFLINE_SQS_HOST`.
-   */
-  LOCAL: 'local',
-
-  /**
-   * When running offline, send messages to AWS as normal.
-   */
-  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
-   *
-   * @param di DependencyInjection
-   */
-  constructor(di) {
-    super(di);
-    const {
-      LAMBDA_WRAPPER_OFFLINE_SQS_HOST: offlineHost = 'localhost',
-      LAMBDA_WRAPPER_OFFLINE_SQS_PORT: offlinePort = '4576',
-      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;
-
-    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 === SQS_OFFLINE_MODES.LOCAL) {
-          // custom URL when using an offline SQS service such as Localstack
-          this.queues[queueDefinition] = `http://${offlineHost}:${offlinePort}/queue/${queues[queueDefinition]}`;
-        } else {
-          // default AWS queue URL
-          this.queues[queueDefinition] = `https://sqs.${REGION}.amazonaws.com/${accountId}/${queues[queueDefinition]}`;
-        }
-      });
-    }
-  }
-  /**
-   * Returns an SQS client instance
-   */
-
-
-  get sqs() {
-    if (!this.$sqs) {
-      this.$sqs = new _awsSdk.default.SQS({
-        region: process.env.REGION,
-        httpOptions: {
-          // longest publish on NOTV took 5 seconds
-          connectTimeout: 8 * 1000,
-          timeout: 8 * 1000
-        },
-        maxRetries: 3 // default is 3, we can change that
-
-      });
-    }
-
-    return this.$sqs;
-  }
-  /**
-   * Returns a Lambda client instance
-   */
-
-
-  get lambda() {
-    if (!this.$lambda) {
-      const endpoint = process.env.SERVICE_LAMBDA_URL;
-
-      if (!endpoint) {
-        throw new Error('process.env.SERVICE_LAMBDA_URL must be defined.');
-      } // move to subprocess
-
-
-      this.$lambda = new _awsSdk.default.Lambda({
-        region: process.env.AWS_REGION,
-        endpoint
-      });
-    }
-
-    return this.$lambda;
-  }
-  /**
-   * Returns the mode to use for offline SQS.
-   *
-   * This is configured by `process.env.LAMBDA_WRAPPER_OFFLINE_SQS_MODE`. The
-   * default is `SQS_OFFLINE_MODES.LAMBDA`.
-   */
-
-
-  static get offlineMode() {
-    return process.env.LAMBDA_WRAPPER_OFFLINE_SQS_MODE || SQS_OFFLINE_MODES.DIRECT;
-  }
-  /**
-   * Batch delete messages
-   *
-   * @param queue strung
-   * @param messageModels [SQSMessageModel]
-   * @returns {Promise<any>}
-   */
-
-
-  batchDelete(queue, messageModels) {
-    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-batch-delete-${(0, _uuid.v4)()} - Queue: '${queueUrl}'`;
-    return new Promise(resolve => {
-      const messagesForDeletion = [];
-      Timer.start(timerId); // assuming openFiles is an array of file names
-
-      (0, _each.default)(messageModels, (messageModel, callback) => {
-        if (messageModel instanceof _Message.default && messageModel.isForDeletion() === true) {
-          messagesForDeletion.push({
-            Id: messageModel.getMessageId(),
-            ReceiptHandle: messageModel.getReceiptHandle()
-          });
-        }
-
-        callback();
-      }, loopError => {
-        if (loopError) {
-          Logger.error(loopError);
-          resolve();
-        }
-
-        this.sqs.deleteMessageBatch({
-          Entries: messagesForDeletion,
-          QueueUrl: queueUrl
-        }, error => {
-          Timer.stop(timerId);
-
-          if (error) {
-            Logger.error(error);
-          }
-
-          resolve();
-        });
-      });
-    });
-  }
-  /**
-   * Check SQS status
-   *
-   * @returns {Promise<any>}
-   */
-
-
-  checkStatus() {
-    const container = this.getContainer();
-    const Logger = container.get(_Dependencies.DEFINITIONS.LOGGER);
-    const Timer = container.get(_Dependencies.DEFINITIONS.TIMER);
-    const timerId = `sqs-list-queues-${(0, _uuid.v4)()}`;
-    return new Promise(resolve => {
-      Timer.start(timerId);
-      this.sqs.listQueues({}, (error, data) => {
-        Timer.stop(timerId);
-        const statusModel = new _Status.default('SQS', _Status.STATUS_TYPES.OK);
-
-        if (error) {
-          Logger.error(error);
-          statusModel.setStatus(_Status.STATUS_TYPES.APPLICATION_FAILURE);
-        }
-
-        if (typeof data.QueueUrls === 'undefined' || data.QueueUrls.length === 0) {
-          statusModel.setStatus(_Status.STATUS_TYPES.APPLICATION_FAILURE);
-        }
-
-        resolve(statusModel);
-      });
-    });
-  }
-  /**
-   * Get number of messages in a queue
-   *
-   * @param queue
-   * @returns {Promise<any>}
-   */
-
-
-  getMessageCount(queue) {
-    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-get-queue-attributes-${(0, _uuid.v4)()} - Queue: '${queueUrl}'`;
-    return new Promise(resolve => {
-      Timer.start(timerId);
-      this.sqs.getQueueAttributes({
-        AttributeNames: ['ApproximateNumberOfMessages'],
-        QueueUrl: queueUrl
-      }, (error, data) => {
-        Timer.stop(timerId);
-
-        if (error) {
-          Logger.error(error);
-          resolve(0);
-        }
-
-        resolve(Number.parseInt(data.Attributes.ApproximateNumberOfMessages, 10));
-      });
-    });
-  }
-  /**
-   * Publish to message queue
-   *
-   * When running within serverless-offline, messages can be published to a
-   * local Lambda or SQS service instead of to AWS, depending on the offline
-   * mode specified by `process.env.LAMBDA_WRAPPER_OFFLINE_SQS_MODE`.
-   *
-   * @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, 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 Timer = container.get(_Dependencies.DEFINITIONS.TIMER);
-    const timerId = `sqs-send-message-${(0, _uuid.v4)()} - Queue: '${queueUrl}'`;
-    Timer.start(timerId);
-    const messageParameters = {
-      MessageBody: JSON.stringify(messageObject),
-      QueueUrl: queueUrl
-    };
-
-    if (queueUrl.includes('.fifo')) {
-      messageParameters.MessageDeduplicationId = (0, _uuid.v4)();
-      messageParameters.MessageGroupId = messageGroupId !== null ? messageGroupId : (0, _uuid.v4)();
-    }
-
-    try {
-      if (container.isOffline && this.constructor.offlineMode === SQS_OFFLINE_MODES.DIRECT) {
-        await this.publishOffline(queue, messageParameters);
-      } else {
-        await this.sqs.sendMessage(messageParameters).promise();
-      }
-    } catch (error) {
-      if (failureMode === SQS_PUBLISH_FAILURE_MODES.CATCH) {
-        container.get(_Dependencies.DEFINITIONS.LOGGER).error(error);
-        return null;
-      }
-
-      throw error;
-    }
-
-    return queue;
-  }
-  /**
-   * Sends a message to a queue consumer running in serverless-offline.
-   *
-   * This method invokes the consumer function directly instead of sending the
-   * message to SQS, which requires a real or emulated SQS service not provided
-   * by serverless-offline. This works very well for local testing.
-   *
-   * @param queue
-   * @param messageParameters
-   */
-
-
-  async publishOffline(queue, messageParameters) {
-    const container = this.getContainer();
-
-    if (!container.isOffline) {
-      throw new Error('Can only publishOffline while running serverless offline.');
-    }
-
-    const consumers = container.getConfiguration('QUEUE_CONSUMERS') || {};
-    const FunctionName = consumers[queue];
-
-    if (!FunctionName) {
-      throw new Error(`Queue consumer for queue ${queue} was not found. Please configure your application's QUEUE_CONSUMERS.`);
-    }
-
-    const InvocationType = 'RequestResponse';
-    const Payload = JSON.stringify({
-      Records: [{
-        body: messageParameters.MessageBody
-      }]
-    });
-    const parameters = {
-      FunctionName,
-      InvocationType,
-      Payload
-    };
-    await this.lambda.invoke(parameters).promise();
-  }
-  /**
-   * Receive from message queue
-   *
-   * @param queue string
-   * @param timeout number
-   * @returns {Promise<any>}
-   */
-
-
-  receive(queue, timeout = 15) {
-    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-receive-message-${(0, _uuid.v4)()} - Queue: '${queueUrl}'`;
-    return new Promise((resolve, reject) => {
-      Timer.start(timerId);
-      this.sqs.receiveMessage({
-        QueueUrl: queueUrl,
-        VisibilityTimeout: timeout,
-        MaxNumberOfMessages: 10
-      }, (error, data) => {
-        Timer.stop(timerId);
-
-        if (error) {
-          Logger.error(error);
-          return reject(error);
-        }
-
-        if (typeof data.Messages === 'undefined') {
-          return resolve([]);
-        }
-
-        return resolve(data.Messages.map(message => new _Message.default(message)));
-      });
-    });
-  }
-
-}
-
-exports.default = SQSService;

package/dist/Service/Timer.service.js

@@ -1,55 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _Dependencies = require("../Config/Dependencies");
-
-var _DependencyAware = _interopRequireDefault(require("../DependencyInjection/DependencyAware.class"));
-
-var _DependencyInjection = _interopRequireDefault(require("../DependencyInjection/DependencyInjection.class"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-/**
- * TimerService class
- */
-class TimerService extends _DependencyAware.default {
-  /**
-   * TimerService constructor
-   *
-   * @param di
-   */
-  constructor(di) {
-    super(di);
-    this.timers = {};
-  }
-  /**
-   * Start timer
-   *
-   * @param identifier
-   */
-
-
-  start(identifier) {
-    this.timers[identifier] = Date.now();
-  }
-  /**
-   * Stop timer
-   *
-   * @param identifier
-   */
-
-
-  stop(identifier) {
-    if (typeof this.timers[identifier] !== 'undefined') {
-      const duration = Date.now() - this.timers[identifier];
-      this.getContainer().get(_Dependencies.DEFINITIONS.LOGGER).info(`Timing - ${identifier} took ${duration}ms to complete`);
-    }
-  }
-
-}
-
-exports.default = TimerService;

package/dist/Wrapper/LambdaTermination.js

@@ -1,39 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-/**
- *
- */
-class LambdaTermination extends Error {
-  /**
-   * Triggers a Lambda Termination.
-   * Offers developer details (that are logged)
-   * an code for the Lambda and a front facing
-   * consumer message.
-   *
-   * @param {object|string} internal
-   * @param {number?} code
-   * @param {object|string?} body
-   * @param details
-   */
-  constructor(internal, code = 500, body = null, details = 'unknown error') {
-    let stringified = internal;
-
-    if (typeof internal !== 'string') {
-      stringified = JSON.stringify(internal);
-    }
-
-    super(stringified);
-    this.internal = internal;
-    this.code = code;
-    this.body = body || 'unknown error';
-    this.details = details;
-  }
-
-}
-
-exports.default = LambdaTermination;

package/dist/Wrapper/LambdaWrapper.js

@@ -1,164 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.handleSuccess = exports.handleError = exports.default = void 0;
-
-var _epsagon = _interopRequireDefault(require("epsagon"));
-
-var _Dependencies = require("../Config/Dependencies");
-
-var _DependencyInjection = _interopRequireDefault(require("../DependencyInjection/DependencyInjection.class"));
-
-var _Response = _interopRequireDefault(require("../Model/Response.model"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-/* eslint-disable sonarjs/cognitive-complexity */
-
-/**
- * Processes the outcome once we have one
- *
- * @param di
- * @param outcome
- */
-const handleSuccess = (di, outcome) => {
-  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;
-};
-/**
- * Gracefully handles an error
- * logging in Epsagon and generating
- * a response reflecting the `code`
- * of the error, if defined.
- *
- * Note about Epsagon:
- * Epsagon generates alerts for logs on level ERROR.
- * This means that logger.error will produce an alert.
- * To avoid not meaningful notifications, most likely
- * coming from tests, we log INFO unless either:
- *
- * 1. `error.raiseOnEpsagon` is defined & truthy
- * 2. `error.code` is defined and `error.code >= 500`.
- *
- * @param {DependencyInjection} di
- * @param {Error} error
- * @param {boolean} [throwError=false]
- */
-
-
-exports.handleSuccess = handleSuccess;
-
-const handleError = (di, error, throwError = false) => {
-  const logger = di.get(_Dependencies.DEFINITIONS.LOGGER);
-  logger.metric('lambda.statusCode', error.code || 500);
-
-  if (error.raiseOnEpsagon || !error.code || error.code >= 500) {
-    logger.error(error);
-  } else {
-    logger.info(error);
-  }
-
-  if (throwError) {
-    if (error instanceof Error) {
-      return error;
-    } // We want to be absolutely sure
-    // that we are returning an error
-    // as Lambda sync handlers will only fail
-    // if the object is instanceof Error
-
-
-    return new Error(error);
-  }
-
-  const responseDetails = {
-    body: error.body || {},
-    code: error.code || 500,
-    details: error.details || 'unknown error'
-  };
-  return _Response.default.generate(responseDetails.body, responseDetails.code, responseDetails.details);
-};
-/**
- * Lambda Wrapper.
- *
- * Wraps a lambda handler, generating a new function
- * that has access to the dependency injection
- * for the service and handles logging and exceptions.
- *
- * @param configuration
- * @param handler
- * @param throwError
- */
-
-
-exports.handleError = handleError;
-
-var _default = (configuration, handler, throwError = false) => {
-  let instance = (event, context, callback) => {
-    const di = new _DependencyInjection.default(configuration, event, context);
-    const request = di.get(_Dependencies.DEFINITIONS.REQUEST);
-    const logger = di.get(_Dependencies.DEFINITIONS.LOGGER);
-    context.callbackWaitsForEmptyEventLoop = false; // If the event is to trigger a warm up, then don't bother returning the function.
-
-    if (di.getEvent().source === 'serverless-plugin-warmup') {
-      return callback(null, 'Lambda is warm!');
-    } // Log the users ip address silently for use in error tracing
-
-
-    if (request.getIp() !== null) {
-      logger.metric('ipAddress', request.getIp(), true);
-    } // Add metrics with user browser information for rapid debugging
-
-
-    const userBrowserAndDevice = request.getUserBrowserAndDevice();
-
-    if (userBrowserAndDevice !== null && typeof userBrowserAndDevice === 'object') {
-      Object.keys(userBrowserAndDevice).forEach(metricKey => {
-        logger.metric(metricKey, userBrowserAndDevice[metricKey], true);
-      });
-    }
-
-    let outcome;
-
-    try {
-      outcome = handler.call(instance, di, request, callback);
-
-      if (outcome instanceof Promise) {
-        outcome = outcome.then(value => handleSuccess(di, value)).catch(error => {
-          const handled = handleError(di, error, throwError);
-
-          if (throwError) {
-            // AWS Lambda with async handler is looking for a rejection
-            // and not an error object directly
-            // and will treat resolved errors as successful
-            // as it will cast the error to JSON, i.e. `{}`
-            throw handled;
-          }
-
-          return handled;
-        });
-      }
-    } catch (error) {
-      outcome = handleError(di, error, throwError);
-    }
-
-    return outcome;
-  }; // If the Epsagon token is enabled, then wrap the instance in the Epsagon wrapper
-
-
-  if (typeof process.env.EPSAGON_TOKEN === 'string' && process.env.EPSAGON_TOKEN !== 'undefined' && typeof process.env.EPSAGON_SERVICE_NAME === 'string' && process.env.EPSAGON_SERVICE_NAME !== 'undefined') {
-    _epsagon.default.init({
-      token: process.env.EPSAGON_TOKEN,
-      appName: process.env.EPSAGON_SERVICE_NAME
-    });
-
-    instance = _epsagon.default.lambdaWrapper(instance);
-  }
-
-  return instance;
-};
-
-exports.default = _default;