@comicrelief/lambda-wrapper 1.10.2 → 2.0.0-beta.10

package/dist/Model/Status.model.js

@@ -1,71 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = exports.STATUS_TYPES = void 0;
-var _Model = _interopRequireDefault(require("./Model.model"));
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-const STATUS_TYPES = {
-  OK: 'OK',
-  ACCEPTABLE_FAILURE: 'ACCEPTABLE_FAILURE',
-  APPLICATION_FAILURE: 'APPLICATION_FAILURE'
-};
-
-/**
- * StatusModel Class
- */
-exports.STATUS_TYPES = STATUS_TYPES;
-class StatusModel extends _Model.default {
-  /**
-   * StatusModel constructor
-   *
-   * @param service
-   * @param status
-   */
-  constructor(service, status) {
-    super();
-    this.setService(service);
-    this.setStatus(status);
-  }
-
-  /**
-   * Get Service
-   *
-   * @returns {*}
-   */
-  getService() {
-    return this.service;
-  }
-
-  /**
-   * Set Service
-   *
-   * @param service
-   */
-  setService(service) {
-    this.service = service;
-  }
-
-  /**
-   * Set the status
-   *
-   * @param status
-   */
-  setStatus(status) {
-    if (typeof STATUS_TYPES[status] === 'undefined') {
-      throw new TypeError(`${StatusModel.name} - ${status} is not a valid status type`);
-    }
-    this.status = status;
-  }
-
-  /**
-   * Get status
-   *
-   * @returns {string|*}
-   */
-  getStatus() {
-    return this.status;
-  }
-}
-exports.default = StatusModel;

package/dist/Service/BaseConfig.service.js

@@ -1,204 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = exports.ServiceStatesHttpCodes = exports.ServiceStates = exports.S3_NO_SUCH_KEY_ERROR_CODE = void 0;
-var _awsSdk = require("aws-sdk");
-var _DependencyAware = _interopRequireDefault(require("../DependencyInjection/DependencyAware.class"));
-var _LambdaTermination = _interopRequireDefault(require("../Wrapper/LambdaTermination"));
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-/**
- * Error.code for S3 404 errors
- */
-const S3_NO_SUCH_KEY_ERROR_CODE = 'NoSuchKey';
-
-/**
- * Represents the service states
- */
-exports.S3_NO_SUCH_KEY_ERROR_CODE = S3_NO_SUCH_KEY_ERROR_CODE;
-const ServiceStates = {
-  OK: 'OK',
-  TEMPORARILY_PAUSED: 'TEMPORARILY_PAUSED',
-  INDEFINITELY_PAUSED: 'INDEFINITELY_PAUSED'
-};
-
-/**
- * Maps service states to HTTP codes
- */
-exports.ServiceStates = ServiceStates;
-const ServiceStatesHttpCodes = {
-  [ServiceStates.OK]: 200,
-  [ServiceStates.TEMPORARILY_PAUSED]: 409,
-  [ServiceStates.INDEFINITELY_PAUSED]: 409
-};
-
-/**
- * BaseConfigService class
- *
- * This class is to be extended by the implementing services
- * so that `defaultConfig` and possibly `s3Config` can be
- * overriden / extended.
- */
-exports.ServiceStatesHttpCodes = ServiceStatesHttpCodes;
-class BaseConfigService extends _DependencyAware.default {
-  /**
-   * Returns the basic config.
-   * This getter is used to set the default config
-   * should the service not find any
-   * on the configured S3 Bucket.
-   *
-   * See `getOrCreate` and `patch` methods.
-   */
-  static get defaultConfig() {
-    return {
-      state: ServiceStates.OK
-    };
-  }
-
-  /**
-   * Returns the S3 configuration
-   * used to retrieve / update the
-   * service configuration.
-   */
-  static get s3config() {
-    return {
-      Bucket: process.env.SERVICE_CONFIG_S3_BUCKET,
-      Key: process.env.SERVICE_CONFIG_S3_KEY
-    };
-  }
-
-  /**
-   * Returns an S3 client
-   *
-   * @returns {S3}
-   */
-  static get client() {
-    return new _awsSdk.S3({
-      region: process.env.REGION
-    });
-  }
-
-  /**
-   * Returns an S3 client
-   *
-   * @returns {S3}
-   */
-  get client() {
-    return this.constructor.client;
-  }
-
-  /**
-   * Deletes the configuration stored on S3.
-   * Helpful in feature tests.
-   */
-  async delete() {
-    return this.client.deleteObject(this.constructor.s3config).promise();
-  }
-
-  /**
-   * Puts the given configuration on S3
-   *
-   * @param config
-   */
-  async put(config) {
-    await this.client.putObject({
-      ...this.constructor.s3config,
-      Body: JSON.stringify(config)
-    }).promise();
-    return config;
-  }
-
-  /**
-   * Gets the service configuration.
-   */
-  async get() {
-    const response = await this.client.getObject(this.constructor.s3config).promise();
-    const body = String(response.Body);
-    if (!body) {
-      // Empty strings are not valid configurations
-      throw new Error('Configuration file is empty');
-    }
-    try {
-      return JSON.parse(body);
-    } catch {
-      throw new Error('Invalid configuration file');
-    }
-  }
-
-  /**
-   * Gets or creates the service configuration.
-   *
-   * If the configuration is not found on S3
-   * the default configuration
-   * is uploaded and returned instead.
-   */
-  async getOrCreate() {
-    try {
-      return await this.get();
-    } catch (error) {
-      if (error.code !== S3_NO_SUCH_KEY_ERROR_CODE) {
-        // Throw directly any other error
-        throw error;
-      }
-      return this.put(this.constructor.defaultConfig);
-    }
-  }
-
-  /**
-   * Patches the existing configuration
-   * or the default configuration
-   * with the provided partial configuration
-   *
-   * @param partialConfig
-   */
-  async patch(partialConfig) {
-    let base = this.constructor.defaultConfig;
-    try {
-      base = await this.get();
-    } catch (error) {
-      if (error.code !== S3_NO_SUCH_KEY_ERROR_CODE) {
-        // Throw directly any other error
-        throw error;
-      }
-
-      // Config doesn't exist
-      // keep using `this.constructor.defaultConfig`
-    }
-
-    return this.put({
-      ...base,
-      ...partialConfig
-    });
-  }
-
-  /**
-   * Performs a health check
-   * given the currentConfig.
-   *
-   * If currentConfig is not supplied
-   * it uses `getOrCreate` to fetch it.
-   *
-   * @param currentConfig
-   */
-  async healthCheck(currentConfig = null) {
-    const config = currentConfig || (await this.getOrCreate());
-    return ServiceStatesHttpCodes[config.state] || 500;
-  }
-
-  /**
-   * Ensures that the application is healthy
-   * or throws a LambdaTermination
-   *
-   * @param currentConfig
-   */
-  async ensureHealthy(currentConfig = null) {
-    const statusCode = await this.healthCheck(currentConfig);
-    if (statusCode < 400) {
-      return statusCode;
-    }
-    const message = 'Application is not healthy.';
-    throw new _LambdaTermination.default(message, statusCode, message, message);
-  }
-}
-exports.default = BaseConfigService;

package/dist/Service/HTTP.service.js

@@ -1,57 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = exports.DEFAULT_HTTP_TIMEOUT = exports.COMICRELIEF_TEST_METADATA_HEADER = void 0;
-var _axios = _interopRequireWildcard(require("axios"));
-var _DependencyAware = _interopRequireDefault(require("../DependencyInjection/DependencyAware.class"));
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-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; }
-const COMICRELIEF_TEST_METADATA_HEADER = 'x-comicrelief-test-metadata';
-exports.COMICRELIEF_TEST_METADATA_HEADER = COMICRELIEF_TEST_METADATA_HEADER;
-const DEFAULT_HTTP_TIMEOUT = 10 * 1000;
-
-/**
- * HTTPService class
- */
-exports.DEFAULT_HTTP_TIMEOUT = DEFAULT_HTTP_TIMEOUT;
-class HTTPService extends _DependencyAware.default {
-  constructor(di) {
-    super(di);
-    this.config = {
-      timeout: DEFAULT_HTTP_TIMEOUT
-    };
-  }
-
-  /**
-   * Sets the default timeout
-   *
-   * @param {number} ms
-   */
-  setDefaultTimeout(ms) {
-    this.config.timeout = ms;
-  }
-
-  /**
-   * Performs and HTTP Request
-   *
-   * @param config
-   */
-  async request(config) {
-    const mergedConfig = {
-      timeout: this.config.timeout,
-      headers: {},
-      ...config
-    };
-    const lambdaRequest = this.getContainer().get(this.definitions.REQUEST);
-    const testMetadata = lambdaRequest.getHeader(COMICRELIEF_TEST_METADATA_HEADER);
-    if (testMetadata) {
-      mergedConfig.headers = mergedConfig.headers || {};
-      mergedConfig.headers[COMICRELIEF_TEST_METADATA_HEADER] = testMetadata;
-    }
-    return _axios.default.request(mergedConfig);
-  }
-}
-exports.default = HTTPService;

package/dist/Service/Logger.service.js

@@ -1,256 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var Sentry = _interopRequireWildcard(require("@sentry/node"));
-var _epsagon = _interopRequireDefault(require("epsagon"));
-var _winston = _interopRequireDefault(require("winston"));
-var _DependencyAware = _interopRequireDefault(require("../DependencyInjection/DependencyAware.class"));
-var _DependencyInjection = _interopRequireDefault(require("../DependencyInjection/DependencyInjection.class"));
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-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; }
-// Instantiate the sentry client
-const sentryIsAvailable = typeof process.env.RAVEN_DSN !== 'undefined' && typeof process.env.RAVEN_DSN === 'string' && process.env.RAVEN_DSN !== 'undefined';
-if (sentryIsAvailable) {
-  Sentry.init({
-    dsn: process.env.RAVEN_DSN,
-    shutdownTimeout: 5,
-    environment: process.env.STAGE
-  });
-}
-
-/**
- * LoggerService class
- */
-class LoggerService extends _DependencyAware.default {
-  constructor(di) {
-    super(di);
-    this.sentry = null;
-    this.winston = null;
-    const container = this.getContainer();
-    const event = container.getEvent();
-    const context = container.getContext();
-
-    // Set sentry client context
-    if (sentryIsAvailable && !container.isOffline) {
-      Sentry.configureScope(scope => {
-        scope.setTags({
-          Event: event,
-          Context: context
-        });
-        scope.setExtras({
-          lambda: context.functionName,
-          memory_size: context.memoryLimitInMB,
-          log_group: context.log_group_name,
-          log_stream: context.log_stream_name,
-          stage: process.env.STAGE,
-          path: event.path,
-          httpMethod: event.httpMethod
-        });
-      });
-      this.sentry = Sentry;
-    }
-  }
-
-  /**
-   * Returns a Winston logger object
-   * configured for our lambdas.
-   *
-   * Note:
-   *
-   * If the lambda is executed
-   * in a `serverless-offline` context
-   * the log output to console will be pretty printed.
-   */
-  getLogger() {
-    const loggerFormats = [_winston.default.format.json({
-      replacer: (key, value) => {
-        if (value instanceof Buffer) {
-          return value.toString('base64');
-        }
-        if (value instanceof Error) {
-          const error = {};
-          Object.getOwnPropertyNames(value).forEach(objectKey => {
-            error[objectKey] = value[objectKey];
-          });
-          return error;
-        }
-        return value;
-      }
-    })];
-    if (this.getContainer().isOffline) {
-      loggerFormats.push(_winston.default.format.prettyPrint());
-    }
-    return _winston.default.createLogger({
-      level: 'info',
-      format: _winston.default.format.combine(...loggerFormats),
-      transports: [new _winston.default.transports.Console()]
-    });
-  }
-
-  /**
-   * Returns the logger.
-   *
-   * Uses a cached `Winston` object
-   * if it has been already generated,
-   * otherwise it generates one.
-   */
-  get logger() {
-    if (!this.winston) {
-      this.winston = this.getLogger();
-    }
-    return this.winston;
-  }
-
-  /**
-   * While handling an error, lambda wrapper should
-   * recognise axios errors and trim down the information.
-   *
-   * Keep the following keys:
-   * - message.config
-   * - message.message
-   * - message.response?.status
-   * - message.response?.data
-   *
-   * @param {object} error
-   */
-  static processAxiosError(error) {
-    const processed = {
-      config: error.config,
-      message: error.message
-    };
-
-    // It's pretty common for axios errors
-    // to not have.response e.g.when there's
-    // a network error or timeout.
-    // These errors will have .request but not .response.
-    if (error.response) {
-      processed.response = {
-        status: error.response.status,
-        data: error.response.data
-      };
-    }
-    return processed;
-  }
-
-  /**
-   * Transform the original message
-   * before it is passed to the winston logger
-   *
-   * @param {string|object} message
-   */
-  processMessage(message = '') {
-    let processed = message;
-    if (processed && processed.isAxiosError) {
-      processed = this.constructor.processAxiosError(processed);
-    }
-    return processed;
-  }
-
-  /**
-   * Log Error Message
-   *
-   * @param error object
-   * @param message string
-   */
-  error(error, message = '') {
-    if (sentryIsAvailable && error instanceof Error) {
-      Sentry.captureException(error);
-    }
-    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' && error instanceof Error) {
-      _epsagon.default.setError(error);
-    }
-    this.logger.log('error', message, {
-      error: this.processMessage(error)
-    });
-    this.label('error', true);
-    this.metric('error', 'error', true);
-  }
-
-  /**
-   * Get sentry client
-   *
-   * @returns {null|*}
-   */
-  getSentry() {
-    return this.sentry;
-  }
-
-  /**
-   * Log Information Message
-   *
-   * @param message string
-   */
-  info(message) {
-    this.logger.log('info', this.processMessage(message));
-  }
-
-  /**
-   * Logs an error, using `LoggerService.error`
-   * or `LoggerService.info` based on
-   * `process.env.LOGGER_SOFT_WARNING`.
-   *
-   * Please note that `LoggerService.error` and `LoggerService.info`
-   * have different signatures. The function uses the shared argument
-   * instead of introducing ambiguity.
-   *
-   * @param error
-   */
-  warning(error) {
-    const softWarningValues = ['true', '1'];
-    if (softWarningValues.includes(process.env.LOGGER_SOFT_WARNING)) {
-      return this.info(error);
-    }
-    return this.error(error);
-  }
-
-  /**
-   * Add a label
-   *
-   * @param descriptor string
-   * @param silent     boolean
-   */
-  label(descriptor, silent = false) {
-    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.label(descriptor, true);
-    }
-    if (silent === false) {
-      this.logger.log('info', `label - ${descriptor}`);
-    }
-  }
-
-  /**
-   * Add a metric
-   *
-   * @param descriptor string
-   * @param stat       integer | string
-   * @param silent     boolean
-   */
-  metric(descriptor, stat, silent = false) {
-    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.label(descriptor, stat);
-    }
-    if (silent === false) {
-      this.logger.log('info', `metric - ${descriptor} - ${stat}`);
-    }
-  }
-
-  /**
-   * Logs an object so that it can be inspected
-   *
-   * @param action - What are we doing with the object, i.e. 'Processing'
-   * @param object - The object to be stored in logs
-   * @param level - 'error', 'warning' or 'info'
-   */
-  object(action, object, level = 'info') {
-    if (!['error', 'warning', 'info'].includes(level)) {
-      throw new Error('Unrecognised log level');
-    }
-    const payload = JSON.stringify(object, null, 4);
-    return this[level](`${action}: '${payload}'`);
-  }
-}
-exports.default = LoggerService;