@aesop-fables/triginta 0.8.3 → 0.8.5

package/lib/TrigintaHeaders.d.ts

@@ -0,0 +1,3 @@
+export declare const TrigintaHeaders: {
+    LogLevel: string;
+};

package/lib/TrigintaHeaders.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TrigintaHeaders = void 0;
+exports.TrigintaHeaders = {
+    LogLevel: 'X-Log-Level',
+};

package/lib/http/HttpLambda.js

@@ -32,6 +32,8 @@ const containr_1 = require("@aesop-fables/containr");
 const core_1 = __importDefault(require("@middy/core"));
 const Decorators_1 = require("../Decorators");
 const HttpLambdaServices_1 = require("./HttpLambdaServices");
+const LoggingRegistry_1 = require("../logging/LoggingRegistry");
+const Levels_1 = require("../logging/Levels");
 let HttpResponseGenerator = class HttpResponseGenerator {
     constructor(configuredRoute) {
         this.configuredRoute = configuredRoute;
@@ -137,6 +139,7 @@ exports.HttpLambdaFactory = HttpLambdaFactory;
 exports.useTrigintaHttp = (0, containr_1.createServiceModule)('triginta/http', (services) => {
     services.autoResolve(HttpLambdaServices_1.HttpLambdaServices.HttpResponseGenerator, HttpResponseGenerator, containr_1.Scopes.Transient);
     services.autoResolve(HttpLambdaServices_1.HttpLambdaServices.HttpLambdaFactory, HttpLambdaFactory, containr_1.Scopes.Transient);
+    services.include(new LoggingRegistry_1.LoggingRegistry(Levels_1.CurrentRequestLoggingLevel));
 });
 function validateContainer(container) {
     if (typeof container === 'undefined') {

package/lib/index.d.ts

@@ -17,11 +17,13 @@ export * from './sqs/SqsPublisher';
 export * from './http/IConfiguredRoute';
 export * from './TrigintaConfig';
 export * from './resolveEnvironmentSettings';
+export * from './TrigintaHeaders';
 export * from './s3/IS3RecordHandler';
 export * from './s3/S3Lambda';
 export * from './s3/S3LambdaServices';
 export * as Localization from './localization';
 export * as Validation from './validation';
+export * as Logging from './logging';
 import * as httpUtils from './http/invokeHttpHandler';
 import * as sqsUtils from './sqs/invokeSqsHandler';
 import * as s3Utils from './s3/invokeS3Handler';

package/lib/index.js

@@ -29,7 +29,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TestUtils = exports.Validation = exports.Localization = exports.RouteRegistry = void 0;
+exports.TestUtils = exports.Logging = exports.Validation = exports.Localization = exports.RouteRegistry = void 0;
 __exportStar(require("./Bootstrapping"), exports);
 __exportStar(require("./IHandler"), exports);
 __exportStar(require("./http/IHttpEndpoint"), exports);
@@ -50,11 +50,13 @@ __exportStar(require("./sqs/SqsPublisher"), exports);
 __exportStar(require("./http/IConfiguredRoute"), exports);
 __exportStar(require("./TrigintaConfig"), exports);
 __exportStar(require("./resolveEnvironmentSettings"), exports);
+__exportStar(require("./TrigintaHeaders"), exports);
 __exportStar(require("./s3/IS3RecordHandler"), exports);
 __exportStar(require("./s3/S3Lambda"), exports);
 __exportStar(require("./s3/S3LambdaServices"), exports);
 exports.Localization = __importStar(require("./localization"));
 exports.Validation = __importStar(require("./validation"));
+exports.Logging = __importStar(require("./logging"));
 const httpUtils = __importStar(require("./http/invokeHttpHandler"));
 const sqsUtils = __importStar(require("./sqs/invokeSqsHandler"));
 const s3Utils = __importStar(require("./s3/invokeS3Handler"));

package/lib/logging/ConsoleLogger.d.ts

@@ -0,0 +1,10 @@
+import { ILogger } from './ILogger';
+export declare class ConsoleLogger implements ILogger {
+    private readonly level;
+    constructor(level: string);
+    log(level: string, message: string): void;
+    debug(message: string): void;
+    info(message: string): void;
+    warn(message: string): void;
+    error(message: string): void;
+}

package/lib/logging/ConsoleLogger.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConsoleLogger = void 0;
+const levelMap = {
+    debug: 3,
+    error: 0,
+    info: 2,
+    warn: 1,
+};
+const shouldLog = (level, target) => {
+    var _a, _b;
+    const a = (_a = levelMap[level]) !== null && _a !== void 0 ? _a : 0;
+    const b = (_b = levelMap[target]) !== null && _b !== void 0 ? _b : 0;
+    return a >= b;
+};
+class ConsoleLogger {
+    constructor(level) {
+        this.level = level;
+    }
+    log(level, message) {
+        if (shouldLog(this.level, level)) {
+            console.log(`${level}: ${message}`);
+        }
+    }
+    debug(message) {
+        this.log('debug', message);
+    }
+    info(message) {
+        this.log('info', message);
+    }
+    warn(message) {
+        this.log('warn', message);
+    }
+    error(message) {
+        this.log('error', message);
+    }
+}
+exports.ConsoleLogger = ConsoleLogger;

package/lib/logging/ILogger.d.ts

@@ -0,0 +1,12 @@
+export interface ILogger {
+    debug(message: string): void;
+    info(message: string): void;
+    warn(message: string): void;
+    error(message: string): void;
+}
+export declare class NulloLogger implements ILogger {
+    debug(): void;
+    info(): void;
+    warn(): void;
+    error(): void;
+}

package/lib/logging/ILogger.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NulloLogger = void 0;
+class NulloLogger {
+    debug() {
+        // no-op
+    }
+    info() {
+        // no-op
+    }
+    warn() {
+        // no-op
+    }
+    error() {
+        // no-op
+    }
+}
+exports.NulloLogger = NulloLogger;

package/lib/logging/ILoggerFactory.d.ts

@@ -0,0 +1,7 @@
+import { ILogger } from './ILogger';
+/**
+ * Provides a mechanism for contextually building up a logger
+ */
+export interface ILoggerFactory {
+    createLogger(): ILogger;
+}

package/lib/logging/ILoggerFactory.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/logging/Levels.d.ts

@@ -0,0 +1,14 @@
+import { APIGatewayProxyEventV2, SQSRecord } from 'aws-lambda';
+export interface LoggingLevel {
+    resolveLevel(): string | undefined;
+}
+export declare class CurrentRequestLoggingLevel implements LoggingLevel {
+    private readonly event;
+    constructor(event: APIGatewayProxyEventV2);
+    resolveLevel(): string | undefined;
+}
+export declare class CurrentRecordLoggingLevel implements LoggingLevel {
+    private readonly record;
+    constructor(record: SQSRecord);
+    resolveLevel(): string | undefined;
+}

package/lib/logging/Levels.js

@@ -0,0 +1,46 @@
+"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); }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CurrentRecordLoggingLevel = exports.CurrentRequestLoggingLevel = void 0;
+const containr_1 = require("@aesop-fables/containr");
+const HttpLambdaServices_1 = require("../http/HttpLambdaServices");
+const SqsLambdaServices_1 = require("../sqs/SqsLambdaServices");
+const TrigintaHeaders_1 = require("../TrigintaHeaders");
+let CurrentRequestLoggingLevel = class CurrentRequestLoggingLevel {
+    constructor(event) {
+        this.event = event;
+    }
+    resolveLevel() {
+        return this.event.headers[TrigintaHeaders_1.TrigintaHeaders.LogLevel.toLowerCase()];
+    }
+};
+CurrentRequestLoggingLevel = __decorate([
+    __param(0, (0, containr_1.inject)(HttpLambdaServices_1.HttpLambdaServices.CurrentEvent)),
+    __metadata("design:paramtypes", [Object])
+], CurrentRequestLoggingLevel);
+exports.CurrentRequestLoggingLevel = CurrentRequestLoggingLevel;
+let CurrentRecordLoggingLevel = class CurrentRecordLoggingLevel {
+    constructor(record) {
+        this.record = record;
+    }
+    resolveLevel() {
+        var _a;
+        return (_a = this.record.messageAttributes[TrigintaHeaders_1.TrigintaHeaders.LogLevel]) === null || _a === void 0 ? void 0 : _a.stringValue;
+    }
+};
+CurrentRecordLoggingLevel = __decorate([
+    __param(0, (0, containr_1.inject)(SqsLambdaServices_1.SqsLambdaServices.CurrentRecord)),
+    __metadata("design:paramtypes", [Object])
+], CurrentRecordLoggingLevel);
+exports.CurrentRecordLoggingLevel = CurrentRecordLoggingLevel;

package/lib/logging/LoggerFactory.d.ts

@@ -0,0 +1,8 @@
+import { ILogger } from './ILogger';
+import { ILoggerFactory } from './ILoggerFactory';
+import { LoggingLevel } from './Levels';
+export declare class LoggerFactory implements ILoggerFactory {
+    private readonly levels;
+    constructor(levels: LoggingLevel);
+    createLogger(): ILogger;
+}

package/lib/logging/LoggerFactory.js

@@ -0,0 +1,36 @@
+"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); }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LoggerFactory = void 0;
+const containr_1 = require("@aesop-fables/containr");
+const ILogger_1 = require("./ILogger");
+const LoggingServices_1 = require("./LoggingServices");
+const ConsoleLogger_1 = require("./ConsoleLogger");
+let LoggerFactory = class LoggerFactory {
+    constructor(levels) {
+        this.levels = levels;
+    }
+    createLogger() {
+        const level = this.levels.resolveLevel();
+        if (!level) {
+            return new ILogger_1.NulloLogger();
+        }
+        return new ConsoleLogger_1.ConsoleLogger(level);
+    }
+};
+LoggerFactory = __decorate([
+    __param(0, (0, containr_1.inject)(LoggingServices_1.LoggingServices.Levels)),
+    __metadata("design:paramtypes", [Object])
+], LoggerFactory);
+exports.LoggerFactory = LoggerFactory;

package/lib/logging/LoggingRegistry.d.ts

@@ -0,0 +1,7 @@
+import { IServiceRegistry, Newable, ServiceCollection } from '@aesop-fables/containr';
+import { LoggingLevel } from './Levels';
+export declare class LoggingRegistry implements IServiceRegistry {
+    private readonly levels;
+    constructor(levels: Newable<LoggingLevel>);
+    configureServices(services: ServiceCollection): void;
+}

package/lib/logging/LoggingRegistry.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LoggingRegistry = void 0;
+const containr_1 = require("@aesop-fables/containr");
+const LoggingServices_1 = require("./LoggingServices");
+const LoggerFactory_1 = require("./LoggerFactory");
+class LoggingRegistry {
+    constructor(levels) {
+        this.levels = levels;
+    }
+    configureServices(services) {
+        services.factory(LoggingServices_1.LoggingServices.Levels, (container) => {
+            return container.resolve(this.levels);
+        }, containr_1.Scopes.Transient);
+        services.autoResolve(LoggingServices_1.LoggingServices.Factory, LoggerFactory_1.LoggerFactory, containr_1.Scopes.Transient);
+        services.factory(LoggingServices_1.LoggingServices.Logger, (container) => {
+            const factory = container.get(LoggingServices_1.LoggingServices.Factory);
+            return factory.createLogger();
+        }, containr_1.Scopes.Transient);
+    }
+}
+exports.LoggingRegistry = LoggingRegistry;

package/lib/logging/LoggingServices.d.ts

@@ -0,0 +1,5 @@
+export declare const LoggingServices: {
+    Factory: string;
+    Levels: string;
+    Logger: string;
+};

package/lib/logging/LoggingServices.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LoggingServices = void 0;
+const Utils_1 = require("../Utils");
+const namedService = (0, Utils_1.createServiceNamespacer)('logging');
+exports.LoggingServices = {
+    Factory: namedService('factory'),
+    Levels: namedService('levels'),
+    Logger: namedService('logger'),
+};

package/lib/logging/index.d.ts

@@ -0,0 +1,7 @@
+export * from './ConsoleLogger';
+export * from './ILogger';
+export * from './ILoggerFactory';
+export * from './Levels';
+export * from './LoggerFactory';
+export * from './LoggingServices';
+export * from './LoggingRegistry';

package/lib/logging/index.js

@@ -0,0 +1,23 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./ConsoleLogger"), exports);
+__exportStar(require("./ILogger"), exports);
+__exportStar(require("./ILoggerFactory"), exports);
+__exportStar(require("./Levels"), exports);
+__exportStar(require("./LoggerFactory"), exports);
+__exportStar(require("./LoggingServices"), exports);
+__exportStar(require("./LoggingRegistry"), exports);

package/lib/sqs/MessagePublisher.d.ts

@@ -1,13 +1,17 @@
-import { MessageBodyAttributeMap, SendMessageResult } from 'aws-sdk/clients/sqs';
-import { SqsPublisher } from './SqsPublisher';
+import { MessageBodyAttributeMap, SendMessageRequest, SendMessageResult } from 'aws-sdk/clients/sqs';
+import { ISqsPublisher } from './SqsPublisher';
 import { SQSMessageAttributes } from 'aws-lambda';
 import { ISqsMessage } from './ISqsMessage';
+import { LoggingLevel } from '../logging';
+declare type ConfigureSqsDelegate = (params: SendMessageRequest) => Promise<void>;
 export interface IMessagePublisher {
-    publish(event: ISqsMessage): Promise<SendMessageResult>;
+    publish(event: ISqsMessage, defaultAttributes?: SQSMessageAttributes, configure?: ConfigureSqsDelegate): Promise<SendMessageResult>;
 }
 export declare class MessagePublisher implements IMessagePublisher {
     private readonly sqsPublisher;
-    constructor(sqsPublisher: SqsPublisher);
-    publish(sqsMessage: ISqsMessage): Promise<SendMessageResult>;
+    private readonly levels;
+    constructor(sqsPublisher: ISqsPublisher, levels: LoggingLevel);
+    publish(sqsMessage: ISqsMessage, defaultAttributes?: SQSMessageAttributes, configure?: ConfigureSqsDelegate): Promise<SendMessageResult>;
 }
 export declare function messageTypeConverter(attributes: SQSMessageAttributes): MessageBodyAttributeMap;
+export {};

package/lib/sqs/MessagePublisher.js

@@ -23,27 +23,41 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.messageTypeConverter = exports.MessagePublisher = void 0;
 const containr_1 = require("@aesop-fables/containr");
-const SqsPublisher_1 = require("./SqsPublisher");
 const SqsLambdaServices_1 = require("./SqsLambdaServices");
+const logging_1 = require("../logging");
+const TrigintaHeaders_1 = require("../TrigintaHeaders");
 let MessagePublisher = class MessagePublisher {
     // eslint-disable-next-line prettier/prettier
-    constructor(sqsPublisher) {
+    constructor(sqsPublisher, levels) {
         this.sqsPublisher = sqsPublisher;
+        this.levels = levels;
     }
-    publish(sqsMessage) {
+    publish(sqsMessage, defaultAttributes, configure) {
         return __awaiter(this, void 0, void 0, function* () {
-            const message = {
-                MessageAttributes: messageTypeConverter(sqsMessage.getAttributes()),
+            const attributes = Object.assign(Object.assign({}, messageTypeConverter(defaultAttributes !== null && defaultAttributes !== void 0 ? defaultAttributes : {})), messageTypeConverter(sqsMessage.getAttributes()));
+            const level = this.levels.resolveLevel();
+            if (level) {
+                attributes[TrigintaHeaders_1.TrigintaHeaders.LogLevel] = {
+                    DataType: 'String',
+                    StringValue: level,
+                };
+            }
+            const params = {
+                MessageAttributes: attributes,
                 MessageBody: sqsMessage.getBody(),
                 QueueUrl: sqsMessage.getQueueUrl(),
             };
-            return this.sqsPublisher.sendMessage(message);
+            if (typeof configure === 'function') {
+                yield configure(params);
+            }
+            return this.sqsPublisher.sendMessage(params);
         });
     }
 };
 MessagePublisher = __decorate([
     __param(0, (0, containr_1.inject)(SqsLambdaServices_1.SqsLambdaServices.SqsPublisher)),
-    __metadata("design:paramtypes", [SqsPublisher_1.SqsPublisher])
+    __param(1, (0, containr_1.inject)(logging_1.LoggingServices.Levels)),
+    __metadata("design:paramtypes", [Object, Object])
 ], MessagePublisher);
 exports.MessagePublisher = MessagePublisher;
 function messageTypeConverter(attributes) {

package/lib/sqs/SqsLambda.js

@@ -35,6 +35,7 @@ const SqsLambdaServices_1 = require("./SqsLambdaServices");
 const RecordMatchers_1 = require("./RecordMatchers");
 const SqsPublisher_1 = require("./SqsPublisher");
 const MessagePublisher_1 = require("./MessagePublisher");
+const logging_1 = require("../logging");
 function embedSqsEvent(event) {
     return (0, containr_1.createServiceModule)('@aesop-fables/triginta/sqs/event', (services) => {
         services.singleton(SqsLambdaServices_1.SqsLambdaServices.CurrentEvent, event);
@@ -102,6 +103,7 @@ exports.useTrigintaSqs = (0, containr_1.createServiceModuleWithOptions)('trigint
     services.autoResolve(SqsLambdaServices_1.SqsLambdaServices.MessageDeserializer, RecordMatchers_1.SqsMessageDeserializer, containr_1.Scopes.Transient);
     services.autoResolve(SqsLambdaServices_1.SqsLambdaServices.SqsPublisher, SqsPublisher_1.SqsPublisher, containr_1.Scopes.Transient);
     services.autoResolve(SqsLambdaServices_1.SqsLambdaServices.MessagePublisher, MessagePublisher_1.MessagePublisher, containr_1.Scopes.Transient);
+    services.include(new logging_1.LoggingRegistry(logging_1.CurrentRecordLoggingLevel));
 });
 function createBootstrappedSqsLambdaContext(container) {
     return {

package/lib/sqs/SqsPublisher.d.ts

@@ -1,11 +1,13 @@
 import { SendMessageRequest, SendMessageResult } from 'aws-sdk/clients/sqs';
 import { SqsSettings } from './SqsSettings';
+import { ILogger } from '../logging/ILogger';
 export interface ISqsPublisher {
     sendMessage(message: SendMessageRequest): Promise<SendMessageResult>;
 }
 export declare class SqsPublisher implements ISqsPublisher {
     private readonly settings;
+    private readonly logger;
     private readonly sqs;
-    constructor(settings: SqsSettings);
+    constructor(settings: SqsSettings, logger: ILogger);
     sendMessage(message: SendMessageRequest): Promise<SendMessageResult>;
 }

package/lib/sqs/SqsPublisher.js

@@ -28,13 +28,17 @@ exports.SqsPublisher = void 0;
 const containr_1 = require("@aesop-fables/containr");
 const aws_sdk_1 = __importDefault(require("aws-sdk"));
 const SqsLambdaServices_1 = require("./SqsLambdaServices");
+const logging_1 = require("../logging");
 let SqsPublisher = class SqsPublisher {
-    constructor(settings) {
+    constructor(settings, logger) {
         this.settings = settings;
+        this.logger = logger;
+        this.logger.debug(JSON.stringify(this.settings, null, 2));
         this.sqs = new aws_sdk_1.default.SQS(this.settings);
     }
     sendMessage(message) {
         return __awaiter(this, void 0, void 0, function* () {
+            this.logger.debug(JSON.stringify(message, null, 2));
             const response = this.sqs.sendMessage(message).promise();
             if (!response) {
                 throw new Error(`${response}`);
@@ -45,6 +49,7 @@ let SqsPublisher = class SqsPublisher {
 };
 SqsPublisher = __decorate([
     __param(0, (0, containr_1.inject)(SqsLambdaServices_1.SqsLambdaServices.SqsSettings)),
-    __metadata("design:paramtypes", [Object])
+    __param(1, (0, containr_1.inject)(logging_1.LoggingServices.Logger)),
+    __metadata("design:paramtypes", [Object, Object])
 ], SqsPublisher);
 exports.SqsPublisher = SqsPublisher;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aesop-fables/triginta",
-  "version": "0.8.3",
+  "version": "0.8.5",
   "description": "A lightweight framework that wraps the basic infrastructure usages of AWS Lambda (SQS, Kinesis, etc.).",
   "type": "commonjs",
   "exports": {
@@ -39,7 +39,7 @@
     "esbuild": "^0.17.8",
     "eslint": "8.42.0",
     "eslint-config-prettier": "^8.5.0",
-    "eslint-plugin-jest": "27.2.1",
+    "eslint-plugin-jest": "27.2.2",
     "eslint-plugin-prettier": "^4.2.1",
     "jest": "29.5.0",
     "jest-mock-extended": "^3.0.1",