@aesop-fables/triginta 0.6.0 → 0.7.1

package/lib/index.d.ts

@@ -4,15 +4,17 @@ export * from './Decorators';
 export * from './http/HttpLambda';
 export * from './http/HttpLambdaServices';
 export { default as RouteRegistry, IRouteRegistry } from './RouteRegistry';
-export * from './SqsLambda';
-export * from './SqsLambdaServices';
-export * from './ISqsMessageHandler';
+export * from './sqs/SqsLambda';
+export * from './sqs/SqsLambdaServices';
+export * from './sqs/ISqsMessageHandler';
+export * from './sqs/RecordMatchers';
+export * from './sqs/ISqsMessage';
 export * from './http/IConfiguredRoute';
 export * from './TrigintaConfig';
 export * as Localization from './localization';
 export * as Validation from './validation';
 import * as httpUtils from './http/invokeHttpHandler';
-import * as sqsUtils from './invokeSqsHandler';
+import * as sqsUtils from './sqs/invokeSqsHandler';
 /**
  * Provides helper functions for invoking lambdas in unit/integration tests.
  */

package/lib/index.js

@@ -37,15 +37,17 @@ __exportStar(require("./http/HttpLambda"), exports);
 __exportStar(require("./http/HttpLambdaServices"), exports);
 var RouteRegistry_1 = require("./RouteRegistry");
 Object.defineProperty(exports, "RouteRegistry", { enumerable: true, get: function () { return __importDefault(RouteRegistry_1).default; } });
-__exportStar(require("./SqsLambda"), exports);
-__exportStar(require("./SqsLambdaServices"), exports);
-__exportStar(require("./ISqsMessageHandler"), exports);
+__exportStar(require("./sqs/SqsLambda"), exports);
+__exportStar(require("./sqs/SqsLambdaServices"), exports);
+__exportStar(require("./sqs/ISqsMessageHandler"), exports);
+__exportStar(require("./sqs/RecordMatchers"), exports);
+__exportStar(require("./sqs/ISqsMessage"), exports);
 __exportStar(require("./http/IConfiguredRoute"), exports);
 __exportStar(require("./TrigintaConfig"), exports);
 exports.Localization = __importStar(require("./localization"));
 exports.Validation = __importStar(require("./validation"));
 const httpUtils = __importStar(require("./http/invokeHttpHandler"));
-const sqsUtils = __importStar(require("./invokeSqsHandler"));
+const sqsUtils = __importStar(require("./sqs/invokeSqsHandler"));
 /**
  * Provides helper functions for invoking lambdas in unit/integration tests.
  */

package/lib/sqs/ISqsMessage.d.ts

@@ -0,0 +1,16 @@
+import { SQSMessageAttributes } from 'aws-lambda';
+export interface ISqsMessage {
+    type: string;
+    getAttributes(): SQSMessageAttributes;
+    getBody(): string;
+}
+export declare const TrigintaMessageHeaders: {
+    MessageType: string;
+};
+export declare abstract class BaseSqsMessage implements ISqsMessage {
+    readonly type: string;
+    constructor(type: string);
+    getAttributes(): SQSMessageAttributes;
+    getData(): any;
+    getBody(): string;
+}

package/lib/sqs/ISqsMessage.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseSqsMessage = exports.TrigintaMessageHeaders = void 0;
+exports.TrigintaMessageHeaders = {
+    MessageType: 'X-Message-Type',
+};
+class BaseSqsMessage {
+    constructor(type) {
+        this.type = type;
+    }
+    getAttributes() {
+        const attributes = {
+            [exports.TrigintaMessageHeaders.MessageType]: {
+                dataType: 'String',
+                stringValue: this.type,
+            },
+        };
+        return attributes;
+    }
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    getData() {
+        return undefined;
+    }
+    getBody() {
+        var _a;
+        const data = (_a = this.getData()) !== null && _a !== void 0 ? _a : {};
+        return JSON.stringify(data);
+    }
+}
+exports.BaseSqsMessage = BaseSqsMessage;

package/lib/{ISqsMessageHandler.d.ts → sqs/ISqsMessageHandler.d.ts}

@@ -1,5 +1,6 @@
 import { SQSBatchResponse, SQSEvent, SQSRecord } from 'aws-lambda';
+import { ISqsMessage } from './ISqsMessage';
 export declare type SqsOutput = SQSBatchResponse | void;
-export interface ISqsMessageHandler<Message, Output extends SqsOutput = void> {
+export interface ISqsMessageHandler<Message extends ISqsMessage, Output extends SqsOutput = void> {
     handle(message: Message, record: SQSRecord, event: SQSEvent): Promise<Output>;
 }

package/lib/sqs/RecordMatchers.d.ts

@@ -0,0 +1,31 @@
+import { SQSMessageAttributes, SQSRecord } from 'aws-lambda';
+import { ISqsMessage } from './ISqsMessage';
+export interface ISqsRecordMatcher {
+    matches(record: SQSRecord): boolean;
+    deserializeMessage<Message extends ISqsMessage>(record: SQSRecord): Promise<Message>;
+}
+export declare function retrieveMessageType(messageAttributes: SQSMessageAttributes): string;
+export declare class DefaultSqsRecordMatcher implements ISqsRecordMatcher {
+    matches(): boolean;
+    deserializeMessage<Message extends ISqsMessage>(record: SQSRecord): Promise<Message>;
+}
+export interface ISqsMessageDeserializer {
+    deserializeMessage<Message extends ISqsMessage>(record: SQSRecord): Promise<Message>;
+}
+export declare class SqsMessageDeserializer implements ISqsMessageDeserializer {
+    private readonly matchers;
+    private readonly defaultMatcher;
+    constructor(matchers: ISqsRecordMatcher[], defaultMatcher: ISqsRecordMatcher);
+    deserializeMessage<Message extends ISqsMessage>(record: SQSRecord): Promise<Message>;
+}
+export declare type MessageConfigAttributes<Message> = {
+    [Property in keyof Message]: string;
+};
+export declare type MessageFactory<Message, Body> = (attributes: Partial<MessageConfigAttributes<Message>>, body: Body) => Promise<Message>;
+export declare type MessageConfig<Message, Options> = {
+    type: string;
+    attributes: Partial<MessageConfigAttributes<Message>>;
+    constructUsing: MessageFactory<Message, Options>;
+};
+export declare type MessageExpression<Message extends ISqsMessage> = Omit<Message, 'getAttributes' | 'getBody' | 'getData'>;
+export declare function createMatcher<Message extends ISqsMessage, Options>(configuration: MessageConfig<MessageExpression<Message>, Options>): ISqsRecordMatcher;

package/lib/sqs/RecordMatchers.js

@@ -0,0 +1,113 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createMatcher = exports.SqsMessageDeserializer = exports.DefaultSqsRecordMatcher = exports.retrieveMessageType = void 0;
+const ISqsMessage_1 = require("./ISqsMessage");
+const SqsLambdaServices_1 = require("./SqsLambdaServices");
+const containr_1 = require("@aesop-fables/containr");
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const jsonSafeParse = (text) => {
+    if (typeof text !== 'string')
+        return text;
+    const firstChar = text[0];
+    if (firstChar !== '{' && firstChar !== '[' && firstChar !== '"')
+        return text;
+    try {
+        return JSON.parse(text);
+    }
+    catch (e) { }
+    return text;
+};
+function retrieveMessageType(messageAttributes) {
+    var _a, _b;
+    return (_b = (_a = messageAttributes[ISqsMessage_1.TrigintaMessageHeaders.MessageType]) === null || _a === void 0 ? void 0 : _a.stringValue) !== null && _b !== void 0 ? _b : '';
+}
+exports.retrieveMessageType = retrieveMessageType;
+class DefaultSqsRecordMatcher {
+    matches() {
+        return true;
+    }
+    deserializeMessage(record) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const body = jsonSafeParse(record.body);
+            if (typeof body === 'string' && body === record.body) {
+                throw new Error(`Invalid JSON body for record ${record.messageId}: ${body}`);
+            }
+            const { messageAttributes = {} } = record;
+            return Object.assign(Object.assign({}, body), { type: retrieveMessageType(messageAttributes) });
+        });
+    }
+}
+exports.DefaultSqsRecordMatcher = DefaultSqsRecordMatcher;
+let SqsMessageDeserializer = class SqsMessageDeserializer {
+    constructor(matchers, defaultMatcher) {
+        this.matchers = matchers;
+        this.defaultMatcher = defaultMatcher;
+    }
+    deserializeMessage(record) {
+        return __awaiter(this, void 0, void 0, function* () {
+            for (let i = 0; i < this.matchers.length; i++) {
+                const matcher = this.matchers[i];
+                if (matcher.matches(record)) {
+                    return matcher.deserializeMessage(record);
+                }
+            }
+            return this.defaultMatcher.deserializeMessage(record);
+        });
+    }
+};
+SqsMessageDeserializer = __decorate([
+    __param(0, (0, containr_1.inject)(SqsLambdaServices_1.SqsLambdaServices.RecordMatchers)),
+    __param(1, (0, containr_1.inject)(SqsLambdaServices_1.SqsLambdaServices.DefaultRecordMatcher)),
+    __metadata("design:paramtypes", [Array, Object])
+], SqsMessageDeserializer);
+exports.SqsMessageDeserializer = SqsMessageDeserializer;
+// Test coverage in SqsLambda.test.ts
+function createMatcher(
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+configuration) {
+    const { attributes: attributeMap, constructUsing, type } = configuration;
+    const defaultMatcher = new DefaultSqsRecordMatcher();
+    return {
+        matches(record) {
+            const { messageAttributes = {} } = record;
+            const messageType = retrieveMessageType(messageAttributes);
+            return messageType === type;
+        },
+        deserializeMessage(record) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const attributes = {};
+                Object.entries(attributeMap).forEach(([key, val]) => {
+                    var _a, _b;
+                    const { messageAttributes = {} } = record;
+                    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                    attributes[key] = (_b = (_a = messageAttributes[val]) === null || _a === void 0 ? void 0 : _a.stringValue) !== null && _b !== void 0 ? _b : '';
+                });
+                const body = yield defaultMatcher.deserializeMessage(record);
+                const result = (yield constructUsing(attributes, body));
+                return result;
+            });
+        },
+    };
+}
+exports.createMatcher = createMatcher;

package/lib/sqs/SqsLambda.d.ts

@@ -0,0 +1,29 @@
+import { IServiceContainer, IServiceModule, Newable } from '@aesop-fables/containr';
+import { SQSHandler } from 'aws-lambda';
+import { ISqsMessageHandler, SqsOutput } from './ISqsMessageHandler';
+import { ISqsMessage } from './ISqsMessage';
+import { ISqsRecordMatcher } from './RecordMatchers';
+export interface BootstrappedSqsLambdaContext {
+    container: IServiceContainer;
+    createHandler<Message extends ISqsMessage, Output extends SqsOutput = void>(newable: Newable<ISqsMessageHandler<Message, Output>>): SQSHandler;
+}
+export interface ISqsLambdaFactory {
+    createHandler<Message extends ISqsMessage, Output extends SqsOutput = void>(newable: Newable<ISqsMessageHandler<Message, Output>>): SQSHandler;
+}
+export declare class SqsLambdaFactory implements ISqsLambdaFactory {
+    private readonly container;
+    constructor(container: IServiceContainer);
+    createHandler<Message extends ISqsMessage, Output extends SqsOutput = void>(newable: Newable<ISqsMessageHandler<Message, Output>>): SQSHandler;
+}
+export interface TrigintaSqsOptions {
+    matchers?: ISqsRecordMatcher[];
+}
+export declare const useTrigintaSqs: import("@aesop-fables/containr").ServiceModuleMiddlewareWithOptionsFactory<TrigintaSqsOptions>;
+export interface SqsLambdaBootstrapExpression {
+    matchers?: ISqsRecordMatcher[];
+    modules?: IServiceModule[];
+}
+export declare class SqsLambda {
+    static initialize(expression: SqsLambdaBootstrapExpression): BootstrappedSqsLambdaContext;
+    static getContainer(): IServiceContainer;
+}

package/lib/{SqsLambda.js → sqs/SqsLambda.js}

@@ -18,20 +18,9 @@ exports.SqsLambda = exports.useTrigintaSqs = exports.SqsLambdaFactory = void 0;
 /* eslint-disable @typescript-eslint/no-unused-vars */
 const containr_1 = require("@aesop-fables/containr");
 const core_1 = __importDefault(require("@middy/core"));
-const Decorators_1 = require("./Decorators");
+const Decorators_1 = require("../Decorators");
 const SqsLambdaServices_1 = require("./SqsLambdaServices");
-const jsonSafeParse = (text) => {
-    if (typeof text !== 'string')
-        return text;
-    const firstChar = text[0];
-    if (firstChar !== '{' && firstChar !== '[' && firstChar !== '"')
-        return text;
-    try {
-        return JSON.parse(text);
-    }
-    catch (e) { }
-    return text;
-};
+const RecordMatchers_1 = require("./RecordMatchers");
 class SqsLambdaFactory {
     constructor(container) {
         this.container = container;
@@ -40,10 +29,11 @@ class SqsLambdaFactory {
         const handler = (event) => __awaiter(this, void 0, void 0, function* () {
             const childContainer = this.container.createChildContainer('sqsLambda');
             try {
-                const handler = this.container.resolve(newable);
+                const handler = childContainer.resolve(newable);
+                const deserializer = childContainer.get(SqsLambdaServices_1.SqsLambdaServices.MessageDeserializer);
                 for (let i = 0; i < event.Records.length; i++) {
                     const record = event.Records[i];
-                    const message = jsonSafeParse(record.body);
+                    const message = yield deserializer.deserializeMessage(record);
                     yield handler.handle(message, record, event);
                 }
             }
@@ -70,15 +60,36 @@ class SqsLambdaFactory {
     }
 }
 exports.SqsLambdaFactory = SqsLambdaFactory;
-exports.useTrigintaSqs = (0, containr_1.createServiceModule)('triginta/sqs', (services) => {
+// Here until we fix containr's array stuff
+// I think we might want to just use a different inject call for arrays
+class NoOpMatcher {
+    matches() {
+        return false;
+    }
+    deserializeMessage() {
+        throw new Error('Method not implemented.');
+    }
+}
+exports.useTrigintaSqs = (0, containr_1.createServiceModuleWithOptions)('triginta/sqs', (services, options) => {
     services.register(SqsLambdaServices_1.SqsLambdaServices.SqsLambdaFactory, (container) => new SqsLambdaFactory(container));
+    const { matchers = [] } = options;
+    if (matchers.length === 0) {
+        matchers.push(new NoOpMatcher());
+    }
+    matchers.forEach((matcher) => {
+        services.addDependency(SqsLambdaServices_1.SqsLambdaServices.RecordMatchers, matcher);
+    });
+    services.use(SqsLambdaServices_1.SqsLambdaServices.DefaultRecordMatcher, RecordMatchers_1.DefaultSqsRecordMatcher);
+    services.use(SqsLambdaServices_1.SqsLambdaServices.MessageDeserializer, RecordMatchers_1.SqsMessageDeserializer);
 });
 let _currentContainer;
 class SqsLambda {
-    static initialize(modules = []) {
-        const container = (0, containr_1.createContainer)([exports.useTrigintaSqs, ...modules]);
+    static initialize(expression) {
+        const { matchers, modules = [] } = expression;
+        const container = (0, containr_1.createContainer)([(0, exports.useTrigintaSqs)({ matchers }), ...modules]);
         _currentContainer = container;
         return {
+            container,
             createHandler(newable) {
                 const factory = container.get(SqsLambdaServices_1.SqsLambdaServices.SqsLambdaFactory);
                 return factory.createHandler(newable);

package/lib/sqs/SqsLambdaServices.d.ts

@@ -0,0 +1,6 @@
+export declare const SqsLambdaServices: {
+    SqsLambdaFactory: string;
+    DefaultRecordMatcher: string;
+    MessageDeserializer: string;
+    RecordMatchers: string;
+};

package/lib/{SqsLambdaServices.js → sqs/SqsLambdaServices.js}

@@ -3,4 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.SqsLambdaServices = void 0;
 exports.SqsLambdaServices = {
     SqsLambdaFactory: 'SqsLambdaFactory',
+    DefaultRecordMatcher: 'DefaultRecordMatcher',
+    MessageDeserializer: 'MessageDeserializer',
+    RecordMatchers: 'RecordMatchers',
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aesop-fables/triginta",
-  "version": "0.6.0",
+  "version": "0.7.1",
   "description": "A lightweight framework that wraps the basic infrastructure usages of AWS Lambda (SQS, Kinesis, etc.).",
   "type": "commonjs",
   "exports": {
@@ -33,9 +33,10 @@
     "@types/jest": "^29.5.0",
     "@types/node": "^18.11.11",
     "@typescript-eslint/eslint-plugin": "^5.45.1",
-    "@typescript-eslint/parser": "5.59.1",
+    "@typescript-eslint/parser": "5.59.2",
+    "aws-sdk": "^2.1363.0",
     "esbuild": "^0.17.8",
-    "eslint": "8.38.0",
+    "eslint": "8.39.0",
     "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-jest": "27.2.1",
     "eslint-plugin-prettier": "^4.2.1",
@@ -43,7 +44,7 @@
     "jest-mock-extended": "^3.0.1",
     "prettier": "^2.8.1",
     "reflect-metadata": "^0.1.13",
-    "ts-jest": "29.0.5",
+    "ts-jest": "29.1.0",
     "typescript": "4.9.5"
   },
   "files": [
@@ -54,6 +55,7 @@
     "@middy/core": "4.x",
     "@middy/http-error-handler": "4.x",
     "@middy/http-json-body-parser": "4.x",
+    "aws-sdk": "2.x",
     "reflect-metadata": "0.1.x"
   },
   "repository": {

package/lib/SqsLambda.d.ts

@@ -1,19 +0,0 @@
-import { IServiceContainer, IServiceModule, Newable } from '@aesop-fables/containr';
-import { SQSHandler } from 'aws-lambda';
-import { ISqsMessageHandler, SqsOutput } from './ISqsMessageHandler';
-export interface BootstrappedSqsLambdaContext {
-    createHandler<Message, Output extends SqsOutput = void>(newable: Newable<ISqsMessageHandler<Message, Output>>): SQSHandler;
-}
-export interface ISqsLambdaFactory {
-    createHandler<Message, Output extends SqsOutput = void>(newable: Newable<ISqsMessageHandler<Message, Output>>): SQSHandler;
-}
-export declare class SqsLambdaFactory implements ISqsLambdaFactory {
-    private readonly container;
-    constructor(container: IServiceContainer);
-    createHandler<Message, Output extends SqsOutput = void>(newable: Newable<ISqsMessageHandler<Message, Output>>): SQSHandler;
-}
-export declare const useTrigintaSqs: IServiceModule;
-export declare class SqsLambda {
-    static initialize(modules?: IServiceModule[]): BootstrappedSqsLambdaContext;
-    static getContainer(): IServiceContainer;
-}

package/lib/SqsLambdaServices.d.ts

@@ -1,3 +0,0 @@
-export declare const SqsLambdaServices: {
-    SqsLambdaFactory: string;
-};