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

package/dist/models/StatusModel.d.ts

@@ -0,0 +1,40 @@
+export declare const STATUS_TYPES: {
+    OK: string;
+    ACCEPTABLE_FAILURE: string;
+    APPLICATION_FAILURE: string;
+};
+/**
+ * Model for our status check endpoints.
+ */
+export default class StatusModel {
+    /**
+     * Service name.
+     */
+    service: string;
+    /**
+     * One of the `STATUS_TYPES` values.
+     */
+    status: string;
+    constructor(service: string, status: string);
+    /**
+     * Get the service name.
+     */
+    getService(): string;
+    /**
+     * Set the service name.
+     *
+     * @param service
+     */
+    setService(service: string): void;
+    /**
+     * Set the status.
+     *
+     * @param status
+     */
+    setStatus(status: string): void;
+    /**
+     * Get the status.
+     */
+    getStatus(): string;
+}
+//# sourceMappingURL=StatusModel.d.ts.map

package/dist/models/StatusModel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"StatusModel.d.ts","sourceRoot":"","sources":["../../src/models/StatusModel.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,YAAY;;;;CAIxB,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,WAAW;IAC9B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;gBAEH,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;IAK3C;;OAEG;IACH,UAAU,IAAI,MAAM;IAIpB;;;;OAIG;IACH,UAAU,CAAC,OAAO,EAAE,MAAM;IAI1B;;;;OAIG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM;IAQxB;;OAEG;IACH,SAAS,IAAI,MAAM;CAGpB"}

package/dist/models/StatusModel.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.STATUS_TYPES = void 0;
+exports.STATUS_TYPES = {
+    OK: 'OK',
+    ACCEPTABLE_FAILURE: 'ACCEPTABLE_FAILURE',
+    APPLICATION_FAILURE: 'APPLICATION_FAILURE',
+};
+/**
+ * Model for our status check endpoints.
+ */
+class StatusModel {
+    constructor(service, status) {
+        this.service = service;
+        this.status = status;
+    }
+    /**
+     * Get the service name.
+     */
+    getService() {
+        return this.service;
+    }
+    /**
+     * Set the service name.
+     *
+     * @param service
+     */
+    setService(service) {
+        this.service = service;
+    }
+    /**
+     * Set the status.
+     *
+     * @param status
+     */
+    setStatus(status) {
+        if (!(status in exports.STATUS_TYPES)) {
+            throw new TypeError(`${StatusModel.name} - ${status} is not a valid status type`);
+        }
+        this.status = status;
+    }
+    /**
+     * Get the status.
+     */
+    getStatus() {
+        return this.status;
+    }
+}
+exports.default = StatusModel;
+//# sourceMappingURL=StatusModel.js.map

package/dist/models/StatusModel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"StatusModel.js","sourceRoot":"","sources":["../../src/models/StatusModel.ts"],"names":[],"mappings":";;;AAAa,QAAA,YAAY,GAAG;IAC1B,EAAE,EAAE,IAAI;IACR,kBAAkB,EAAE,oBAAoB;IACxC,mBAAmB,EAAE,qBAAqB;CAC3C,CAAC;AAEF;;GAEG;AACH,MAAqB,WAAW;IAW9B,YAAY,OAAe,EAAE,MAAc;QACzC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED;;OAEG;IACH,UAAU;QACR,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED;;;;OAIG;IACH,UAAU,CAAC,OAAe;QACxB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAED;;;;OAIG;IACH,SAAS,CAAC,MAAc;QACtB,IAAI,CAAC,CAAC,MAAM,IAAI,oBAAY,CAAC,EAAE;YAC7B,MAAM,IAAI,SAAS,CAAC,GAAG,WAAW,CAAC,IAAI,MAAM,MAAM,6BAA6B,CAAC,CAAC;SACnF;QAED,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED;;OAEG;IACH,SAAS;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;CACF;AAnDD,8BAmDC"}

package/dist/services/BaseConfigService.d.ts

@@ -0,0 +1,101 @@
+import { S3 } from 'aws-sdk';
+import DependencyAwareClass from '../core/DependencyAwareClass';
+/**
+ * `error.code` for S3 404 errors.
+ */
+export declare const S3_NO_SUCH_KEY_ERROR_CODE = "NoSuchKey";
+/**
+ * Represents the service states.
+ */
+export declare const ServiceStates: {
+    OK: string;
+    TEMPORARILY_PAUSED: string;
+    INDEFINITELY_PAUSED: string;
+};
+/**
+ * Maps service states to HTTP codes.
+ */
+export declare const ServiceStatesHttpCodes: {
+    [x: string]: number;
+};
+/**
+ * This class is to be extended by the implementing services so that
+ * `defaultConfig` and possibly `s3Config` can be overriden / extended.
+ *
+ * Config is typed as `unknown` since you shouldn't trust what's in the bucket.
+ * Override the `get` and `put` methods to pass the results through some
+ * validation to ensure the config is valid and can safely be typed.
+ */
+export default class BaseConfigService extends DependencyAwareClass {
+    /**
+     * 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(): {
+        state: string;
+    };
+    /**
+     * Returns the S3 configuration used to retrieve or update the service
+     * configuration.
+     */
+    static get s3config(): {
+        Bucket: string;
+        Key: string;
+    };
+    /**
+     * Returns an S3 client.
+     */
+    static get client(): S3;
+    /**
+     * Returns an S3 client
+     */
+    get client(): S3;
+    /**
+     * Deletes the configuration stored on S3. Helpful in feature tests.
+     */
+    delete(): Promise<import("aws-sdk/lib/request").PromiseResult<S3.DeleteObjectOutput, import("aws-sdk").AWSError>>;
+    /**
+     * Puts the given configuration on S3.
+     *
+     * @param config
+     */
+    put<T>(config: T): Promise<T>;
+    /**
+     * Gets the service configuration.
+     */
+    get(): Promise<unknown>;
+    /**
+     * Gets or creates the service configuration.
+     *
+     * If the configuration is not found on S3 the default configuration is
+     * uploaded and returned instead.
+     */
+    getOrCreate(): Promise<unknown>;
+    /**
+     * Patches the existing configuration
+     * or the default configuration
+     * with the provided partial configuration
+     *
+     * @param partialConfig
+     */
+    patch(partialConfig: any): Promise<unknown>;
+    /**
+     * Performs a health check given the current config.
+     *
+     * If `currentConfig` is not supplied it uses `getOrCreate` to fetch it.
+     *
+     * @param currentConfig
+     */
+    healthCheck(currentConfig?: any): Promise<number>;
+    /**
+     * Ensures that the application is healthy or throws a `LambdaTermination`.
+     *
+     * @param currentConfig
+     */
+    ensureHealthy(currentConfig?: any): Promise<number>;
+}
+//# sourceMappingURL=BaseConfigService.d.ts.map

package/dist/services/BaseConfigService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseConfigService.d.ts","sourceRoot":"","sources":["../../src/services/BaseConfigService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAE,MAAM,SAAS,CAAC;AAE7B,OAAO,oBAAoB,MAAM,8BAA8B,CAAC;AAGhE;;GAEG;AACH,eAAO,MAAM,yBAAyB,cAAc,CAAC;AAErD;;GAEG;AACH,eAAO,MAAM,aAAa;;;;CAIzB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,sBAAsB;;CAIlC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,CAAC,OAAO,OAAO,iBAAkB,SAAQ,oBAAoB;IACjE;;;;;;;OAOG;IACH,MAAM,KAAK,aAAa;;MAIvB;IAED;;;OAGG;IACH,MAAM,KAAK,QAAQ,IAAI;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAC;KAAE,CAKtD;IAED;;OAEG;IACH,MAAM,KAAK,MAAM,OAIhB;IAED;;OAEG;IACH,IAAI,MAAM,OAET;IAED;;OAEG;IACG,MAAM;IAMZ;;;;OAIG;IACG,GAAG,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IASnC;;OAEG;IACG,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC;IAkB7B;;;;;OAKG;IACG,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC;IAarC;;;;;;OAMG;IACG,KAAK,CAAC,aAAa,EAAE,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC;IAqBjD;;;;;;OAMG;IACG,WAAW,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC;IAMvD;;;;OAIG;IACG,aAAa,CAAC,aAAa,GAAE,GAAU;CAW9C"}

package/dist/services/BaseConfigService.js

@@ -0,0 +1,180 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ServiceStatesHttpCodes = exports.ServiceStates = exports.S3_NO_SUCH_KEY_ERROR_CODE = void 0;
+const aws_sdk_1 = require("aws-sdk");
+const DependencyAwareClass_1 = __importDefault(require("../core/DependencyAwareClass"));
+const LambdaTermination_1 = __importDefault(require("../utils/LambdaTermination"));
+/**
+ * `error.code` for S3 404 errors.
+ */
+exports.S3_NO_SUCH_KEY_ERROR_CODE = 'NoSuchKey';
+/**
+ * Represents the service states.
+ */
+exports.ServiceStates = {
+    OK: 'OK',
+    TEMPORARILY_PAUSED: 'TEMPORARILY_PAUSED',
+    INDEFINITELY_PAUSED: 'INDEFINITELY_PAUSED',
+};
+/**
+ * Maps service states to HTTP codes.
+ */
+exports.ServiceStatesHttpCodes = {
+    [exports.ServiceStates.OK]: 200,
+    [exports.ServiceStates.TEMPORARILY_PAUSED]: 409,
+    [exports.ServiceStates.INDEFINITELY_PAUSED]: 409,
+};
+/**
+ * This class is to be extended by the implementing services so that
+ * `defaultConfig` and possibly `s3Config` can be overriden / extended.
+ *
+ * Config is typed as `unknown` since you shouldn't trust what's in the bucket.
+ * Override the `get` and `put` methods to pass the results through some
+ * validation to ensure the config is valid and can safely be typed.
+ */
+class BaseConfigService extends DependencyAwareClass_1.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: exports.ServiceStates.OK,
+        };
+    }
+    /**
+     * Returns the S3 configuration used to retrieve or 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.
+     */
+    static get client() {
+        return new aws_sdk_1.S3({
+            region: process.env.REGION,
+        });
+    }
+    /**
+     * Returns an S3 client
+     */
+    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 !== exports.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 !== exports.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 current config.
+     *
+     * If `currentConfig` is not supplied it uses `getOrCreate` to fetch it.
+     *
+     * @param currentConfig
+     */
+    async healthCheck(currentConfig) {
+        const config = currentConfig || await this.getOrCreate();
+        return exports.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_1.default(message, statusCode, message, message);
+    }
+}
+exports.default = BaseConfigService;
+//# sourceMappingURL=BaseConfigService.js.map

package/dist/services/BaseConfigService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseConfigService.js","sourceRoot":"","sources":["../../src/services/BaseConfigService.ts"],"names":[],"mappings":";;;;;;AAAA,qCAA6B;AAE7B,wFAAgE;AAChE,mFAA2D;AAE3D;;GAEG;AACU,QAAA,yBAAyB,GAAG,WAAW,CAAC;AAErD;;GAEG;AACU,QAAA,aAAa,GAAG;IAC3B,EAAE,EAAE,IAAI;IACR,kBAAkB,EAAE,oBAAoB;IACxC,mBAAmB,EAAE,qBAAqB;CAC3C,CAAC;AAEF;;GAEG;AACU,QAAA,sBAAsB,GAAG;IACpC,CAAC,qBAAa,CAAC,EAAE,CAAC,EAAE,GAAG;IACvB,CAAC,qBAAa,CAAC,kBAAkB,CAAC,EAAE,GAAG;IACvC,CAAC,qBAAa,CAAC,mBAAmB,CAAC,EAAE,GAAG;CACzC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAqB,iBAAkB,SAAQ,8BAAoB;IACjE;;;;;;;OAOG;IACH,MAAM,KAAK,aAAa;QACtB,OAAO;YACL,KAAK,EAAE,qBAAa,CAAC,EAAE;SACxB,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,MAAM,KAAK,QAAQ;QACjB,OAAO;YACL,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,wBAAwB,IAAI,EAAE;YAClD,GAAG,EAAE,OAAO,CAAC,GAAG,CAAC,qBAAqB,IAAI,EAAE;SAC7C,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,MAAM,KAAK,MAAM;QACf,OAAO,IAAI,YAAE,CAAC;YACZ,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,MAAM;SAC3B,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,IAAI,MAAM;QACR,OAAQ,IAAI,CAAC,WAAwC,CAAC,MAAM,CAAC;IAC/D,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM;QACV,OAAO,IAAI,CAAC,MAAM,CAAC,YAAY,CAC5B,IAAI,CAAC,WAAwC,CAAC,QAAQ,CACxD,CAAC,OAAO,EAAE,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,GAAG,CAAI,MAAS;QACpB,MAAM,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC;YAC1B,GAAI,IAAI,CAAC,WAAwC,CAAC,QAAQ;YAC1D,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC;SAC7B,CAAC,CAAC,OAAO,EAAE,CAAC;QAEb,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,GAAG;QACP,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,SAAS,CACzC,IAAI,CAAC,WAAwC,CAAC,QAAQ,CACxD,CAAC,OAAO,EAAE,CAAC;QACZ,MAAM,IAAI,GAAG,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAEnC,IAAI,CAAC,IAAI,EAAE;YACT,6CAA6C;YAC7C,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;SAChD;QAED,IAAI;YACF,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;SACzB;QAAC,MAAM;YACN,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;SAC/C;IACH,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,WAAW;QACf,IAAI;YACF,OAAO,MAAM,IAAI,CAAC,GAAG,EAAE,CAAC;SACzB;QAAC,OAAO,KAAU,EAAE;YACnB,IAAI,KAAK,CAAC,IAAI,KAAK,iCAAyB,EAAE;gBAC5C,iCAAiC;gBACjC,MAAM,KAAK,CAAC;aACb;YAED,OAAO,IAAI,CAAC,GAAG,CAAE,IAAI,CAAC,WAAwC,CAAC,aAAa,CAAC,CAAC;SAC/E;IACH,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,KAAK,CAAC,aAAkB;QAC5B,IAAI,IAAI,GAAS,IAAI,CAAC,WAAwC,CAAC,aAAa,CAAC;QAE7E,IAAI;YACF,IAAI,GAAG,MAAM,IAAI,CAAC,GAAG,EAAE,CAAC;SACzB;QAAC,OAAO,KAAU,EAAE;YACnB,IAAI,KAAK,CAAC,IAAI,KAAK,iCAAyB,EAAE;gBAC5C,iCAAiC;gBACjC,MAAM,KAAK,CAAC;aACb;YAED,uBAAuB;YACvB,8CAA8C;SAC/C;QAED,OAAO,IAAI,CAAC,GAAG,CAAC;YACd,GAAG,IAAI;YACP,GAAG,aAAa;SACjB,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,WAAW,CAAC,aAAmB;QACnC,MAAM,MAAM,GAAG,aAAa,IAAI,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;QAEzD,OAAO,8BAAsB,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,GAAG,CAAC;IACrD,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,aAAa,CAAC,gBAAqB,IAAI;QAC3C,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC;QAEzD,IAAI,UAAU,GAAG,GAAG,EAAE;YACpB,OAAO,UAAU,CAAC;SACnB;QAED,MAAM,OAAO,GAAG,6BAA6B,CAAC;QAE9C,MAAM,IAAI,2BAAiB,CAAC,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IACrE,CAAC;CACF;AAlKD,oCAkKC"}

package/dist/services/HTTPService.d.ts

@@ -0,0 +1,29 @@
+import { AxiosRequestConfig, AxiosResponse } from 'axios';
+import DependencyAwareClass from '../core/DependencyAwareClass';
+import DependencyInjection from '../core/DependencyInjection';
+export declare const COMICRELIEF_TEST_METADATA_HEADER = "x-comicrelief-test-metadata";
+export declare const DEFAULT_HTTP_TIMEOUT: number;
+/**
+ * Wrapper for `axios.request` that:
+ *
+ * - sets a default timeout of 10 seconds
+ * - forwards a `x-comicrelief-test-metadata` header if one was provided in
+ *   the request from upstream
+ */
+export default class HTTPService extends DependencyAwareClass {
+    config: AxiosRequestConfig;
+    constructor(di: DependencyInjection);
+    /**
+     * Set the default timeout.
+     *
+     * @param ms
+     */
+    setDefaultTimeout(ms: number): void;
+    /**
+     * Perform an HTTP request.
+     *
+     * @param config
+     */
+    request(config: AxiosRequestConfig): Promise<AxiosResponse>;
+}
+//# sourceMappingURL=HTTPService.d.ts.map

package/dist/services/HTTPService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"HTTPService.d.ts","sourceRoot":"","sources":["../../src/services/HTTPService.ts"],"names":[],"mappings":"AAAA,OAAc,EAAE,kBAAkB,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAEjE,OAAO,oBAAoB,MAAM,8BAA8B,CAAC;AAChE,OAAO,mBAAmB,MAAM,6BAA6B,CAAC;AAG9D,eAAO,MAAM,gCAAgC,gCAAgC,CAAC;AAC9E,eAAO,MAAM,oBAAoB,QAAY,CAAC;AAE9C;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,OAAO,WAAY,SAAQ,oBAAoB;IAC3D,MAAM,EAAE,kBAAkB,CAAC;gBAEf,EAAE,EAAE,mBAAmB;IAQnC;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,EAAE,MAAM;IAI5B;;;;OAIG;IACG,OAAO,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,aAAa,CAAC;CAiBlE"}

package/dist/services/HTTPService.js

@@ -0,0 +1,55 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_HTTP_TIMEOUT = exports.COMICRELIEF_TEST_METADATA_HEADER = void 0;
+const axios_1 = __importDefault(require("axios"));
+const DependencyAwareClass_1 = __importDefault(require("../core/DependencyAwareClass"));
+const RequestService_1 = __importDefault(require("./RequestService"));
+exports.COMICRELIEF_TEST_METADATA_HEADER = 'x-comicrelief-test-metadata';
+exports.DEFAULT_HTTP_TIMEOUT = 10 * 1000;
+/**
+ * Wrapper for `axios.request` that:
+ *
+ * - sets a default timeout of 10 seconds
+ * - forwards a `x-comicrelief-test-metadata` header if one was provided in
+ *   the request from upstream
+ */
+class HTTPService extends DependencyAwareClass_1.default {
+    constructor(di) {
+        super(di);
+        this.config = {
+            timeout: exports.DEFAULT_HTTP_TIMEOUT,
+        };
+    }
+    /**
+     * Set the default timeout.
+     *
+     * @param ms
+     */
+    setDefaultTimeout(ms) {
+        this.config.timeout = ms;
+    }
+    /**
+     * Perform an HTTP request.
+     *
+     * @param config
+     */
+    async request(config) {
+        const mergedConfig = {
+            timeout: this.config.timeout,
+            headers: {},
+            ...config,
+        };
+        const request = this.di.get(RequestService_1.default);
+        const testMetadata = request.getHeader(exports.COMICRELIEF_TEST_METADATA_HEADER);
+        if (testMetadata) {
+            mergedConfig.headers = mergedConfig.headers || {};
+            mergedConfig.headers[exports.COMICRELIEF_TEST_METADATA_HEADER] = testMetadata;
+        }
+        return axios_1.default.request(mergedConfig);
+    }
+}
+exports.default = HTTPService;
+//# sourceMappingURL=HTTPService.js.map

package/dist/services/HTTPService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"HTTPService.js","sourceRoot":"","sources":["../../src/services/HTTPService.ts"],"names":[],"mappings":";;;;;;AAAA,kDAAiE;AAEjE,wFAAgE;AAEhE,sEAA8C;AAEjC,QAAA,gCAAgC,GAAG,6BAA6B,CAAC;AACjE,QAAA,oBAAoB,GAAG,EAAE,GAAG,IAAI,CAAC;AAE9C;;;;;;GAMG;AACH,MAAqB,WAAY,SAAQ,8BAAoB;IAG3D,YAAY,EAAuB;QACjC,KAAK,CAAC,EAAE,CAAC,CAAC;QAEV,IAAI,CAAC,MAAM,GAAG;YACZ,OAAO,EAAE,4BAAoB;SAC9B,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,iBAAiB,CAAC,EAAU;QAC1B,IAAI,CAAC,MAAM,CAAC,OAAO,GAAG,EAAE,CAAC;IAC3B,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,OAAO,CAAC,MAA0B;QACtC,MAAM,YAAY,GAAG;YACnB,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,OAAO;YAC5B,OAAO,EAAE,EAAE;YACX,GAAG,MAAM;SACV,CAAC;QAEF,MAAM,OAAO,GAAG,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,wBAAc,CAAC,CAAC;QAC5C,MAAM,YAAY,GAAG,OAAO,CAAC,SAAS,CAAC,wCAAgC,CAAC,CAAC;QAEzE,IAAI,YAAY,EAAE;YAChB,YAAY,CAAC,OAAO,GAAG,YAAY,CAAC,OAAO,IAAI,EAAE,CAAC;YAClD,YAAY,CAAC,OAAO,CAAC,wCAAgC,CAAC,GAAG,YAAY,CAAC;SACvE;QAED,OAAO,eAAK,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;IACrC,CAAC;CACF;AA1CD,8BA0CC"}

package/dist/services/LoggerService.d.ts

@@ -0,0 +1,102 @@
+import * as Sentry from '@sentry/node';
+import { AxiosError } from 'axios';
+import Winston from 'winston';
+import DependencyAwareClass from '../core/DependencyAwareClass';
+import DependencyInjection from '../core/DependencyInjection';
+/**
+ * Provides logging and integrations with our monitoring tools.
+ *
+ * For logging we use [Winston](https://github.com/winstonjs/winston).
+ * Errors will also be sent to [Sentry](https://sentry.io/) and
+ * [Epsagon](https://epsagon.com/) if those are available.
+ */
+export default class LoggerService extends DependencyAwareClass {
+    private sentry;
+    private winston;
+    constructor(di: DependencyInjection);
+    /**
+     * Returns a Winston logger 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(): Winston.Logger;
+    /**
+     * Returns the logger.
+     *
+     * Uses a cached Winston logger if it has been already created, otherwise it
+     * creates one.
+     */
+    get logger(): Winston.Logger;
+    /**
+     * Get Sentry client.
+     */
+    getSentry(): typeof Sentry | null;
+    /**
+     * While logging an error, we should recognise axios errors and trim down the
+     * information to only what is useful for debugging.
+     *
+     * Keep the following keys:
+     * - message.config
+     * - message.message
+     * - message.response?.status
+     * - message.response?.data
+     *
+     * @param {object} error
+     */
+    static processAxiosError(error: AxiosError): any;
+    /**
+     * Transform the original message before it is passed to the logger.
+     *
+     * @param message
+     */
+    static processMessage(message: any): any;
+    /**
+     * Log Error Message
+     *
+     * @param error object
+     * @param message string
+     */
+    error(error: any, message?: string): void;
+    /**
+     * Log an informational message.
+     *
+     * @param message
+     */
+    info(message: any): void;
+    /**
+     * Log 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: any): void;
+    /**
+     * Add a label to the function's Epsagon trace.
+     *
+     * @param descriptor
+     * @param silent If `false`, the label will also be logged. (default: false)
+     */
+    label(descriptor: string, silent?: boolean): void;
+    /**
+     * Add a metric to the function's Epsagon trace.
+     *
+     * @param descriptor
+     * @param stat
+     * @param silent If `false`, the metric will also be logged. (default: false)
+     */
+    metric(descriptor: string, stat: number | string, silent?: boolean): void;
+    /**
+     * Log an object so that it can be inspected.
+     *
+     * @param action What are we doing with the object, e.g. 'Processing'
+     * @param object The object to be stored in logs
+     * @param level 'error', 'warning' or 'info'
+     */
+    object(action: string, object: any, level?: 'error' | 'warning' | 'info'): void;
+}
+//# sourceMappingURL=LoggerService.d.ts.map

package/dist/services/LoggerService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"LoggerService.d.ts","sourceRoot":"","sources":["../../src/services/LoggerService.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,UAAU,EAAE,MAAM,OAAO,CAAC;AAEnC,OAAO,OAAO,MAAM,SAAS,CAAC;AAE9B,OAAO,oBAAoB,MAAM,8BAA8B,CAAC;AAChE,OAAO,mBAAmB,MAAM,6BAA6B,CAAC;AAa9D;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,OAAO,aAAc,SAAQ,oBAAoB;IAC7D,OAAO,CAAC,MAAM,CAAuB;IAErC,OAAO,CAAC,OAAO,CAAwB;gBAE3B,EAAE,EAAE,mBAAmB;IA6BnC;;;;;OAKG;IACH,SAAS;IA6BT;;;;;OAKG;IACH,IAAI,MAAM,mBAMT;IAED;;OAEG;IACH,SAAS;IAIT;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,iBAAiB,CAAC,KAAK,EAAE,UAAU;IAkB1C;;;;OAIG;IACH,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE,GAAG;IAUlC;;;;;OAKG;IACH,KAAK,CAAC,KAAK,EAAE,GAAG,EAAE,OAAO,SAAK;IAoB9B;;;;OAIG;IACH,IAAI,CAAC,OAAO,EAAE,GAAG;IAIjB;;;;;;;;;OASG;IACH,OAAO,CAAC,KAAK,EAAE,GAAG;IAUlB;;;;;OAKG;IACH,KAAK,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,UAAQ;IAexC;;;;;;OAMG;IACH,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,MAAM,UAAQ;IAehE;;;;;;OAMG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,KAAK,GAAE,OAAO,GAAG,SAAS,GAAG,MAAe;CASjF"}