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

package/README.md

@@ -4,95 +4,220 @@
 [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
 [![semantic-release](https://badge.fury.io/js/%40comicrelief%2Flambda-wrapper.svg)](https://www.npmjs.com/package/@comicrelief/lambda-wrapper)
 
-When writing Serverless endpoints, we have found ourselves replicating a lot of boiler plate code to do basic actions, such as reading request variables or writing to SQS. The aim of this package is to provide a wrapper for our Lambda functions, to provide some level of dependency and configuration injection and to reduce time spent on project setup.
+When writing Serverless applications, we have found ourselves replicating a lot of boilerplate code to do basic actions, such as reading request data or sending messages to SQS. The aim of this package is to provide a wrapper for our Lambda functions, to provide some level of dependency and configuration injection and to reduce time spent on project setup.
 
-## Installation & usage
+If you're coming from v1 and updating to v2, check out the [v2 migration guide](docs/migration/v2.md).
 
-Install via npm:
+## Getting started
 
-```bash
-npm install --save @comicrelief/lambda-wrapper
-```
-
-Or via yarn:
+Install via npm or Yarn:
 
 ```bash
+npm i @comicrelief/lambda-wrapper
+# or
 yarn add @comicrelief/lambda-wrapper
 ```
 
-You can then wrap your lambdas as follows.
+You can then wrap your Lambda handler functions like this:
 
-```js
-import {
-  LambdaWrapper,
+```ts
+// src/action/Hello.ts
+import lambdaWrapper, {
   ResponseModel,
   RequestService,
 } from '@comicrelief/lambda-wrapper';
 
-export default LambdaWrapper({}, (di, request, done) => {
-  const response = new ResponseModel({}, 200, `hello ${request.get('name', 'nobody')}`);
-  done(null, response.generate());
+export default lambdaWrapper.wrap(async (di) => {
+  const request = di.get(RequestService);
+  return ResponseModel.generate(
+    {},
+    200,
+    `hello ${request.get('name', 'nobody')}`,
+  );
 });
 ```
 
-## Serverless Offline & SQS Emulation
+Here we've used the default export `lambdaWrapper` which is a preconfigured instance that can be used out of the box. You'll likely want to add your own dependencies and service config using the `configure` method:
 
-Serverless Offline only emulates API Gateway and Lambda, so publishing an SQS message would use the real SQS queue and trigger the consumer function (if any) in AWS. When working with offline code, you often want the local functions to be invoked instead.
+```ts
+// src/config/LambdaWrapper.ts
+import lambdaWrapper from '@comicrelief/lambda-wrapper';
 
-Offline SQS behaviour can be configured by setting the `LAMBDA_WRAPPER_OFFLINE_SQS_MODE` environment variable. Available modes are:
+export default lambdaWrapper.configure({
+  // your config goes here
+});
+```
 
-- `direct` (the default): invokes the consumer function directly via an offline Lambda endpoint
-- `local`: send messages to an offline SQS endpoint, such as Localstack
-- `aws`: no special handling of SQS offline; messages will be sent to AWS
+`configure` returns a new Lambda Wrapper instance with the given configuration. You'll want to export it and then use this when wrapping your handler functions.
 
-Details of each mode are documented in the sections below. When you send a message using `SQSService.prototype.publish`, it will check which mode to use and dispatch the message appropriately. These modes take effect only when running offline (as defined by `DependencyInjection.prototype.isOffline`). In a deployed environment, SQS messages will always be sent to AWS SQS.
+Read the next section to see what goes inside the config object!
 
-### Direct Lambda mode
+If you want to start from scratch without the built-in dependencies, you can use the `LambdaWrapper` constructor directly.
 
-This is the default mode if `LAMBDA_WRAPPER_OFFLINE_SQS_MODE` is not set. A Lambda client will be created and the message will be delivered to the offline Lambda endpoint, effectively running the consumer function _immediately_ as part of the original Lambda invocation. This works very well in the offline environment because invoking a Lambda function will trigger its whole (local) execution tree.
+```ts
+// src/config/LambdaWrapper.ts
+import { LambdaWrapper } from '@comicrelief/lambda-wrapper';
 
-To take advantage of SQS emulation, you will need to define the following in the implementing service:
+export default new LambdaWrapper({
+  // your config goes here
+});
+```
 
-**QUEUE_CONSUMERS**
+## Dependencies
 
-In your `src/Config/Configuration` define a `QUEUE_CONSUMERS` object. `QUEUE_CONSUMERS` will map the queue name to the fully qualified `FunctionName` that we want to trigger when messages are published to that queue.
+Lambda Wrapper comes with some commonly used dependencies built in:
 
-You will need to export `QUEUE_CONSUMERS` as part of your default export, alongside `DEFINITIONS`, `DEPENDENCIES`, `QUEUES`, `QUEUE_DEFINITIONS`, etc.
+- [HTTPService](docs/services/HTTPService.md)
+- [LoggerService](docs/services/LoggerService.md)
+- [RequestService](docs/services/RequestService.md)
+- [SQSService](docs/services/SQSService.md)
+- [TimerService](docs/services/TimerService.md)
 
-A `Configuration` example can be found in the `serverless-prize-platform` repository [here](https://github.com/comicrelief/serverless-prize-platform/blob/master/src/Config/Configuration.js).
+Access these via dependency injection. You've already seen an example of this where we got `RequestService`. Pass the dependency class to `di.get()` to get its instance:
 
-**process.env.SERVICE_LAMBDA_URL**
+```ts
+export default lambdaWrapper.wrap(async (di) => {
+  const request = di.get(RequestService);
+  const sqs = di.get(SQSService);
+  // ...
+});
+```
 
-While creating the Lambda client, we need to point it to our offline environment. LambdaWrapper will take care of the specifics, but it will need to know the Lambda endpoint URL. This _can_ and _must_ be specified via the `SERVICE_LAMBDA_URL` environment variable.
+To add your own dependencies, first extend `DependencyAwareClass`.
 
-The URL is likely to be your localhost URL and the next available port from the offline API Gateway. So, if you are running Serverless Offline on `http://localhost:3001`, the Lambda URL is likely to be `http://localhost:3002`. You can check the port in the output during Serverless Offline startup by looking for the following line:
+```ts
+// src/services/MyService.ts
+import { DependencyAwareClass } from '@comicrelief/lambda-wrapper';
 
-    offline: Offline [http for lambda] listening on http://localhost:3002
+export default class MyService extends DependencyAwareClass {
+  doSomething() {
+    // ...
+  }
+}
+```
 
-#### Caveats
+Then add it to your Lambda Wrapper configuration in the `dependencies` key.
 
-1. You will be running the SQS-triggered lambdas in the same Serverless Offline context as your triggering lambda. Expect logs from both lambdas in the Serverless Offline output.
+```ts
+// src/config/LambdaWrapper.ts
+import lambdaWrapper from '@comicrelief/lambda-wrapper';
 
-2. If you await `sqs.publish` you will effectively wait until all SQS-triggered lambdas (and possibly their own SQS-triggered lambdas) have all completed. This is necessary to avoid any pending execution (i.e. the lambda terminating before its async processes are completed).
+import MyService from '@/src/services/MyService';
 
-3. If the triggered lambda incurs an exception, this will be propagated upstream, effectively killing the execution of the calling lambda.
+export default lambdaWrapper.configure({
+  dependencies: {
+    MyService,
+  },
+});
+```
+
+Now you can use it inside your handler functions and other dependencies!
+
+```ts
+// src/action/DoSomething.ts
+import lambdaWrapper from '@/src/config/LambdaWrapper';
+import MyService from '@/src/services/MyService';
+
+export default lambdaWrapper.wrap(async (di) => {
+  di.get(MyService).doSomething();
+});
+```
+
+## Service config
+
+Some dependencies need their own config. This goes in per-service keys within your Lambda Wrapper config. For an example, see [SQSService](docs/services/SQSService.md) which uses the `sqs` key.
+
+```ts
+export default lambdaWrapper.configure({
+  dependencies: {
+    // your dependencies
+  },
+  sqs: {
+    // your SQSService config
+  },
+  // ... other configs ...
+});
+```
+
+To use config with your own dependencies, you need to do three things:
+
+1. Define the key and type of your config object.
+
+   Using `SQSService` as an example, we have the `sqs` key which has the `SQSServiceConfig` type:
+
+   ```ts
+   export interface SQSServiceConfig {
+     queues?: Record<string, string>;
+     queueConsumers?: Record<string, string>;
+   }
+   ```
+
+2. Define a type that can be applied to a Lambda Wrapper config.
+
+   This simply combines the key and type defined in step 1. Conventionally we name these `With...` types.
+
+   ```ts
+   export interface WithSQSServiceConfig {
+     sqs?: SQSServiceConfig;
+   }
+   ```
+
+   In the case of `SQSService`, the `sqs` key is optional because this dependency is included by default and not all applications need it. If your dependency requires config in order to work, you can make this a required key.
+
+3. In your dependency constructor, cast the config to this type.
+
+   ```ts
+   export default class SQSService extends DependencyAwareClass {
+     constructor(di: DependencyInjection) {
+       super(di);
+
+       const config = (this.di.config as WithSQSServiceConfig).sqs;
+       // Bear in mind that because the `sqs` key is optional, the type of
+       // `config` will be `SQSServiceConfig | undefined`. Take care when
+       // accessing its properties! You can use optional chaining:
+       const queues = config?.queues || {};
+       // ...
+     }
+   }
+   ```
+
+When you go to configure your Lambda Wrapper, you can now include your dependency's config type in the generic for `configure` to get IntelliSense completions and type checking for your config keys.
+
+```ts
+lambdaWrapper.configure<WithSQSServiceConfig>({
+  sqs: {
+    queues: 42 // Oops! This will be flaggeed as a type error by TypeScript
+  },
+});
+```
+
+You can combine types for multiple dependencies if needed using `&`:
+
+```ts
+lambdaWrapper.configure<WithSQSServiceConfig & WithOtherServiceConfig>({
+  sqs: {
+    // SQSService config
+  },
+  other: {
+    // OtherService config
+  },
+});
+```
 
-### Local SQS mode
+## Development
 
-Use this mode by setting `LAMBDA_WRAPPER_OFFLINE_SQS_MODE=local`. Messages will still be sent to an SQS queue, but using a locally simulated version instead of AWS. This allows you to test your service using a tool like Localstack.
+### Testing
 
-By default, messages will be sent to a SQS service running on `localhost:4576`. If you need to change the hostname, you can set `process.env.LAMBDA_WRAPPER_OFFLINE_SQS_HOST`.
-Also, if you need to change the port, you can set `process.env.LAMBDA_WRAPPER_OFFLINE_SQS_PORT`.
+Run `yarn test` to run the unit tests.
 
-### AWS SQS mode
+When writing a bugfix, start by writing a test that reproduces the problem. It should fail with the current version of Lambda Wrapper, and pass once you've implemented the fix.
 
-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.
+When adding a feature, ensure it's covered by tests that adequately define its behaviour.
 
-In order for queue URLs to be correctly constructed, you must either:
+### Linting
 
-- 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.
+Run `yarn lint` to check code style complies to our standard. Many problems can be auto-fixed using `yarn lint --fix`.
 
-## Semantic release
+### Releases
 
 Release management is automated using [semantic-release](https://www.npmjs.com/package/semantic-release).

package/dist/core/DependencyAwareClass.d.ts

@@ -0,0 +1,15 @@
+import DependencyInjection from './DependencyInjection';
+/**
+ * Base class for dependencies.
+ */
+export default class DependencyAwareClass {
+    readonly di: DependencyInjection;
+    constructor(di: DependencyInjection);
+    /**
+     * Get dependency injection container.
+     *
+     * @deprecated Use `this.di` instead.
+     */
+    getContainer(): DependencyInjection;
+}
+//# sourceMappingURL=DependencyAwareClass.d.ts.map

package/dist/core/DependencyAwareClass.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DependencyAwareClass.d.ts","sourceRoot":"","sources":["../../src/core/DependencyAwareClass.ts"],"names":[],"mappings":"AAAA,OAAO,mBAAmB,MAAM,uBAAuB,CAAC;AAExD;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,oBAAoB;IAC3B,QAAQ,CAAC,EAAE,EAAE,mBAAmB;gBAAvB,EAAE,EAAE,mBAAmB;IAE5C;;;;OAIG;IACH,YAAY,IAAI,mBAAmB;CAGpC"}

package/dist/core/DependencyAwareClass.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Base class for dependencies.
+ */
+class DependencyAwareClass {
+    constructor(di) {
+        this.di = di;
+    }
+    /**
+     * Get dependency injection container.
+     *
+     * @deprecated Use `this.di` instead.
+     */
+    getContainer() {
+        return this.di;
+    }
+}
+exports.default = DependencyAwareClass;
+//# sourceMappingURL=DependencyAwareClass.js.map

package/dist/core/DependencyAwareClass.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DependencyAwareClass.js","sourceRoot":"","sources":["../../src/core/DependencyAwareClass.ts"],"names":[],"mappings":";;AAEA;;GAEG;AACH,MAAqB,oBAAoB;IACvC,YAAqB,EAAuB;QAAvB,OAAE,GAAF,EAAE,CAAqB;IAAG,CAAC;IAEhD;;;;OAIG;IACH,YAAY;QACV,OAAO,IAAI,CAAC,EAAE,CAAC;IACjB,CAAC;CACF;AAXD,uCAWC"}

package/dist/core/DependencyInjection.d.ts

@@ -0,0 +1,62 @@
+import { Context } from 'aws-lambda';
+import DependencyAwareClass from './DependencyAwareClass';
+import { LambdaWrapperConfig } from './config';
+declare type Class<T> = new (di: DependencyInjection) => T;
+/**
+ * Dependency injection container.
+ *
+ * Dependencies (singleton instances of dependency-aware classes) are provided
+ * to the main Lambda handler and other dependencies via this class.
+ */
+export default class DependencyInjection {
+    readonly config: LambdaWrapperConfig;
+    readonly event: any;
+    readonly context: Context;
+    /**
+     * Instantiated dependencies.
+     */
+    readonly dependencies: Record<string, DependencyAwareClass>;
+    /**
+     * True until all dependencies have been constructed.
+     */
+    private isConstructing;
+    constructor(config: LambdaWrapperConfig, event: any, context: Context);
+    /**
+     * Get the singleton instance of the given dependency.
+     *
+     * @param dependency
+     */
+    get<T extends DependencyAwareClass>(dependency: Class<T>): T;
+    /**
+     * Get the event passed to AWS Lambda.
+     *
+     * @deprecated Use `di.event` instead.
+     */
+    getEvent(): any;
+    /**
+     * Get the AWS Lambda context object.
+     *
+     * @deprecated Use `di.context` instead.
+     */
+    getContext(): Context;
+    /**
+     * Get Lambda Wrapper configuration.
+     *
+     * @deprecated Use `di.config` instead.
+     */
+    getConfiguration(): LambdaWrapperConfig;
+    /**
+     * True if the function is being executed in `serverless-offline`.
+     *
+     * We use the following checks for this:
+     *
+     * - if there is no function ARN, or the ARN includes 'offline'
+     * - if `process.env.USE_SERVERLESS_OFFLINE` is set
+     *
+     * TODO: This is nothing to do with dependency injection and should be moved
+     *   somewhere else! Any ideas?
+     */
+    get isOffline(): boolean;
+}
+export {};
+//# sourceMappingURL=DependencyInjection.d.ts.map

package/dist/core/DependencyInjection.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DependencyInjection.d.ts","sourceRoot":"","sources":["../../src/core/DependencyInjection.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAErC,OAAO,oBAAoB,MAAM,wBAAwB,CAAC;AAC1D,OAAO,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAG/C,aAAK,KAAK,CAAC,CAAC,IAAI,KAAK,EAAE,EAAE,mBAAmB,KAAK,CAAC,CAAC;AAEnD;;;;;GAKG;AACH,MAAM,CAAC,OAAO,OAAO,mBAAmB;IAYpC,QAAQ,CAAC,MAAM,EAAE,mBAAmB;IACpC,QAAQ,CAAC,KAAK,EAAE,GAAG;IACnB,QAAQ,CAAC,OAAO,EAAE,OAAO;IAb3B;;OAEG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAC;IAE5D;;OAEG;IACH,OAAO,CAAC,cAAc,CAAQ;gBAGnB,MAAM,EAAE,mBAAmB,EAC3B,KAAK,EAAE,GAAG,EACV,OAAO,EAAE,OAAO;IAU3B;;;;OAIG;IACH,GAAG,CAAC,CAAC,SAAS,oBAAoB,EAAE,UAAU,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC;IAsB5D;;;;OAIG;IACH,QAAQ;IAIR;;;;OAIG;IACH,UAAU;IAIV;;;;OAIG;IACH,gBAAgB;IAIhB;;;;;;;;;;OAUG;IACH,IAAI,SAAS,IAAI,OAAO,CAIvB;CACF"}

package/dist/core/DependencyInjection.js

@@ -0,0 +1,83 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Dependency injection container.
+ *
+ * Dependencies (singleton instances of dependency-aware classes) are provided
+ * to the main Lambda handler and other dependencies via this class.
+ */
+class DependencyInjection {
+    constructor(config, event, context) {
+        this.config = config;
+        this.event = event;
+        this.context = context;
+        /**
+         * True until all dependencies have been constructed.
+         */
+        this.isConstructing = true;
+        const classes = Object.values(config.dependencies);
+        this.dependencies = Object.fromEntries(classes.map((Constructor) => [Constructor.name, new Constructor(this)]));
+        this.isConstructing = false;
+    }
+    /**
+     * Get the singleton instance of the given dependency.
+     *
+     * @param dependency
+     */
+    get(dependency) {
+        if (this.isConstructing) {
+            throw new Error('Dependencies are not available in dependency class constructors.\n\n'
+                + 'To fix this, call `di.get` in the function where the dependency is'
+                + 'used instead of inside your constructor.');
+        }
+        const name = dependency.name;
+        if (!this.dependencies[name]) {
+            throw new Error(`${name} does not exist in dependency container\n\n`
+                + `Make sure you've included ${name} in the 'dependencies' key of your `
+                + 'Lambda Wrapper config.');
+        }
+        return this.dependencies[name];
+    }
+    /**
+     * Get the event passed to AWS Lambda.
+     *
+     * @deprecated Use `di.event` instead.
+     */
+    getEvent() {
+        return this.event;
+    }
+    /**
+     * Get the AWS Lambda context object.
+     *
+     * @deprecated Use `di.context` instead.
+     */
+    getContext() {
+        return this.context;
+    }
+    /**
+     * Get Lambda Wrapper configuration.
+     *
+     * @deprecated Use `di.config` instead.
+     */
+    getConfiguration() {
+        return this.config;
+    }
+    /**
+     * True if the function is being executed in `serverless-offline`.
+     *
+     * We use the following checks for this:
+     *
+     * - if there is no function ARN, or the ARN includes 'offline'
+     * - if `process.env.USE_SERVERLESS_OFFLINE` is set
+     *
+     * TODO: This is nothing to do with dependency injection and should be moved
+     *   somewhere else! Any ideas?
+     */
+    get isOffline() {
+        return !this.context.invokedFunctionArn
+            || this.context.invokedFunctionArn.includes('offline')
+            || !!process.env.USE_SERVERLESS_OFFLINE;
+    }
+}
+exports.default = DependencyInjection;
+//# sourceMappingURL=DependencyInjection.js.map

package/dist/core/DependencyInjection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DependencyInjection.js","sourceRoot":"","sources":["../../src/core/DependencyInjection.ts"],"names":[],"mappings":";;AAQA;;;;;GAKG;AACH,MAAqB,mBAAmB;IAWtC,YACW,MAA2B,EAC3B,KAAU,EACV,OAAgB;QAFhB,WAAM,GAAN,MAAM,CAAqB;QAC3B,UAAK,GAAL,KAAK,CAAK;QACV,YAAO,GAAP,OAAO,CAAS;QAR3B;;WAEG;QACK,mBAAc,GAAG,IAAI,CAAC;QAO5B,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;QACnD,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,WAAW,CACpC,OAAO,CAAC,GAAG,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CACxE,CAAC;QAEF,IAAI,CAAC,cAAc,GAAG,KAAK,CAAC;IAC9B,CAAC;IAED;;;;OAIG;IACH,GAAG,CAAiC,UAAoB;QACtD,IAAI,IAAI,CAAC,cAAc,EAAE;YACvB,MAAM,IAAI,KAAK,CACb,sEAAsE;kBACpE,oEAAoE;kBACpE,0CAA0C,CAC7C,CAAC;SACH;QAED,MAAM,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC;QAE7B,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE;YAC5B,MAAM,IAAI,KAAK,CACb,GAAG,IAAI,6CAA6C;kBAClD,6BAA6B,IAAI,qCAAqC;kBACtE,wBAAwB,CAC3B,CAAC;SACH;QAED,OAAO,IAAI,CAAC,YAAY,CAAC,IAAI,CAAM,CAAC;IACtC,CAAC;IAED;;;;OAIG;IACH,QAAQ;QACN,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACH,UAAU;QACR,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED;;;;OAIG;IACH,gBAAgB;QACd,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,SAAS;QACX,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,kBAAkB;eAClC,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,QAAQ,CAAC,SAAS,CAAC;eACnD,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,sBAAsB,CAAC;IAC5C,CAAC;CACF;AA9FD,sCA8FC"}

package/dist/core/LambdaWrapper.d.ts

@@ -0,0 +1,61 @@
+import { Context } from '../index';
+import DependencyInjection from './DependencyInjection';
+import { LambdaWrapperConfig } from './config';
+export interface WrapOptions {
+    /**
+     * Whether uncaught errors should be handled to return an HTTP 500 response
+     * instead of causing a function error. (default: `true`)
+     *
+     * This is what you usually want when working on an HTTP endpoint, but in
+     * other contexts (e.g. queue consumers) you may want AWS Lambda to report a
+     * failure so that the event is retried.
+     */
+    handleUncaughtErrors?: boolean;
+}
+export default class LambdaWrapper<TConfig extends LambdaWrapperConfig = LambdaWrapperConfig> {
+    readonly config: TConfig;
+    constructor(config: TConfig);
+    /**
+     * Returns a new Lambda Wrapper with the given configuration applied.
+     *
+     * @param config
+     */
+    configure<TMoreConfig>(config: Partial<TConfig> & TMoreConfig): LambdaWrapper<TConfig & TMoreConfig>;
+    /**
+     * Wrap the given function.
+     */
+    wrap<T>(handler: (di: DependencyInjection) => Promise<T>, options?: WrapOptions): (event: any, context: Context) => Promise<any>;
+    /**
+     * Process the result once we have one.
+     *
+     * @param di
+     * @param result
+     */
+    static handleSuccess(di: DependencyInjection, result: any): any;
+    /**
+     * 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 meaningless 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 di
+     * @param error
+     * @param [throwError=false]
+     */
+    static handleError(di: DependencyInjection, error: Error, throwError?: boolean): {
+        statusCode: any;
+        headers: {
+            'Content-Type': string;
+            'Access-Control-Allow-Origin': string;
+            'Access-Control-Allow-Credentials': boolean;
+        };
+        body: string;
+    } | Error;
+}
+//# sourceMappingURL=LambdaWrapper.d.ts.map

package/dist/core/LambdaWrapper.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"LambdaWrapper.d.ts","sourceRoot":"","sources":["../../src/core/LambdaWrapper.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AAInC,OAAO,mBAAmB,MAAM,uBAAuB,CAAC;AACxD,OAAO,EAAE,mBAAmB,EAAe,MAAM,UAAU,CAAC;AAE5D,MAAM,WAAW,WAAW;IAC1B;;;;;;;OAOG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;CAChC;AAED,MAAM,CAAC,OAAO,OAAO,aAAa,CAAC,OAAO,SAAS,mBAAmB,GAAG,mBAAmB;IAC9E,QAAQ,CAAC,MAAM,EAAE,OAAO;gBAAf,MAAM,EAAE,OAAO;IAEpC;;;;OAIG;IACH,SAAS,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,WAAW,GAAG,aAAa,CAAC,OAAO,GAAG,WAAW,CAAC;IAIpG;;OAEG;IACH,IAAI,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,EAAE,mBAAmB,KAAK,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,WAAW,WAKjD,GAAG,WAAW,OAAO;IAyDnD;;;;;OAKG;IACH,MAAM,CAAC,aAAa,CAAC,EAAE,EAAE,mBAAmB,EAAE,MAAM,EAAE,GAAG;IASzD;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,WAAW,CAAC,EAAE,EAAE,mBAAmB,EAAE,KAAK,EAAE,KAAK,EAAE,UAAU,UAAQ;;;;;;;;;CA8B7E"}

package/dist/core/LambdaWrapper.js

@@ -0,0 +1,126 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const epsagon_1 = __importDefault(require("epsagon"));
+const ResponseModel_1 = __importDefault(require("../models/ResponseModel"));
+const LoggerService_1 = __importDefault(require("../services/LoggerService"));
+const RequestService_1 = __importDefault(require("../services/RequestService"));
+const DependencyInjection_1 = __importDefault(require("./DependencyInjection"));
+const config_1 = require("./config");
+class LambdaWrapper {
+    constructor(config) {
+        this.config = config;
+    }
+    /**
+     * Returns a new Lambda Wrapper with the given configuration applied.
+     *
+     * @param config
+     */
+    configure(config) {
+        return new LambdaWrapper((0, config_1.mergeConfig)(this.config, config));
+    }
+    /**
+     * Wrap the given function.
+     */
+    wrap(handler, options) {
+        const { handleUncaughtErrors = true, } = options || {};
+        let wrapper = async (event, context) => {
+            const di = new DependencyInjection_1.default(this.config, event, context);
+            const request = di.get(RequestService_1.default);
+            const logger = di.get(LoggerService_1.default);
+            context.callbackWaitsForEmptyEventLoop = false;
+            // if the event is a warmup, don't bother running the function
+            if (event.source === 'serverless-plugin-warmup') {
+                return 'Lambda is warm!';
+            }
+            // log the user's IP address silently for use in error tracing
+            const ipAddress = request.getIp();
+            if (ipAddress) {
+                logger.metric('ipAddress', ipAddress, true);
+            }
+            // add metrics with user browser information for rapid debugging
+            const userBrowserAndDevice = request.getUserBrowserAndDevice();
+            if (userBrowserAndDevice) {
+                Object.entries(userBrowserAndDevice).forEach(([key, value]) => {
+                    logger.metric(key, value, true);
+                });
+            }
+            try {
+                const result = await handler.call(wrapper, di);
+                return LambdaWrapper.handleSuccess(di, result);
+            }
+            catch (error) {
+                const handled = LambdaWrapper.handleError(di, error, !handleUncaughtErrors);
+                if (!handleUncaughtErrors) {
+                    // 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;
+            }
+        };
+        // If Epsagon is enabled, wrap the instance in the Epsagon wrapper
+        if (process.env.EPSAGON_TOKEN && process.env.EPSAGON_SERVICE_NAME) {
+            epsagon_1.default.init({
+                token: process.env.EPSAGON_TOKEN,
+                appName: process.env.EPSAGON_SERVICE_NAME,
+            });
+            wrapper = epsagon_1.default.lambdaWrapper(wrapper);
+        }
+        return wrapper;
+    }
+    /**
+     * Process the result once we have one.
+     *
+     * @param di
+     * @param result
+     */
+    static handleSuccess(di, result) {
+        const logger = di.get(LoggerService_1.default);
+        // result may be undefined as not all lambdas have a return value
+        logger.metric('lambda.statusCode', result?.statusCode || 200);
+        return result;
+    }
+    /**
+     * 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 meaningless 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 di
+     * @param error
+     * @param [throwError=false]
+     */
+    static handleError(di, error, throwError = false) {
+        const logger = di.get(LoggerService_1.default);
+        const { code, raiseOnEpsagon, body = {}, details = 'unknown error', } = error;
+        logger.metric('lambda.statusCode', code || 500);
+        if (raiseOnEpsagon || !code || 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);
+        }
+        return ResponseModel_1.default.generate(body, code || 500, details);
+    }
+}
+exports.default = LambdaWrapper;
+//# sourceMappingURL=LambdaWrapper.js.map