@webda/aws 4.0.0-beta.2 → 4.0.0-beta.3

package/README.md

@@ -13,13 +13,70 @@ This module is part of Webda Application Framework that allows you to quickly de
 
 <!-- README_HEADER -->
 
-## Summary
-
-This module allows you to use DynamoDB Store, SQS, CloudWatchLogger and SecretsManager
-
-## Lambda Entrypoint
-
-You can add the request id to the http header response by specifying `parameters.lambdaRequestHeader`
+# @webda/aws
+
+> AWS integration bundle for Webda — DynamoDB Store, S3 Binary, SQS Queue, CloudWatch Logger, Secrets Manager, Lambda server, Route53, and Lambda/CloudFormation deployers in one package.
+
+## When to use it
+
+- You are deploying a Webda application on AWS (Lambda or EC2/ECS) and need cloud-native backing services.
+- You want to swap out `MemoryStore` / `MemoryQueue` / `FileBinary` with AWS-managed equivalents for production.
+- You need to deploy your application as a Lambda function or manage infrastructure via CloudFormation.
+
+## Install
+
+```bash
+pnpm add @webda/aws
+```
+
+## What's inside
+
+### Runtime services
+
+- `DynamoStore` — DynamoDB-backed Store for any Webda model ([source](./src/services/dynamodb.ts))
+- `S3Binary` — S3-backed Binary service for file uploads and downloads ([source](./src/services/s3binary.ts))
+- `SQSQueue` — SQS-backed Queue for durable task queuing ([source](./src/services/sqsqueue.ts))
+- `CloudWatchLogger` — Streams application logs to CloudWatch Logs ([source](./src/services/cloudwatchlogger.ts))
+- `SecretsManager` — Resolves configuration parameters from AWS Secrets Manager ([source](./src/services/secretsmanager.ts))
+- `Route53` — DNS record management via Route53 ([source](./src/services/route53.ts))
+- `LambdaServer` — Adapts incoming Lambda events to Webda's HTTP context ([source](./src/services/lambdaserver.ts))
+- `LambdaCaller` — Invokes other Lambda functions as service calls ([source](./src/services/lambdacaller.ts))
+
+### Deployers (shell/build-time)
+
+- `LambdaDeployer` — Packages and deploys the application as an AWS Lambda function ([source](./src/deployers/lambda-entrypoint.ts))
+- `CloudFormationDeployer` — Full infrastructure deployment via AWS CloudFormation ([source](./src/deployers/cloudformation.ts))
+- `LambdaPackager` — Bundles the application for Lambda deployment ([source](./src/deployers/lambdapackager.ts))
+
+## Quick config example
+
+```json
+{
+  "services": {
+    "userStore": {
+      "type": "DynamoStore",
+      "model": "MyApp/User",
+      "table": "my-app-users",
+      "region": "us-east-1"
+    },
+    "uploadBucket": {
+      "type": "S3Binary",
+      "bucket": "my-app-uploads",
+      "region": "us-east-1"
+    },
+    "taskQueue": {
+      "type": "SQSQueue",
+      "queue": "https://sqs.us-east-1.amazonaws.com/123456789/my-tasks"
+    }
+  }
+}
+```
+
+## Reference
+
+- API reference: see the auto-generated typedoc at `docs/pages/Modules/aws/`.
+- Source: [`packages/aws`](https://github.com/loopingz/webda.io/tree/main/packages/aws)
+- Related: [`@webda/core`](../core) for Store, Queue, and Binary base classes; [`@webda/async`](../async) for job orchestration using SQSQueue.
 
 <!-- README_FOOTER -->
 ## Sponsors

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC"}

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC"}

package/lib/services/aws-parameters.d.ts

@@ -0,0 +1,33 @@
+/**
+ * AWS client parameters shared by the AWS services
+ *
+ * Each service parameters class declares these fields and calls
+ * {@link loadAWSParameters} from its `load()` override
+ */
+export interface AWSServiceParameters {
+    /**
+     * Custom endpoint (localstack, minio, ...)
+     */
+    endpoint?: string;
+    /**
+     * Static credentials, default to the AWS environment variables
+     */
+    credentials?: {
+        accessKeyId: string;
+        secretAccessKey: string;
+        sessionToken?: string;
+    };
+    /**
+     * AWS region
+     * @default "us-east-1"
+     */
+    region?: string;
+}
+/**
+ * Default the region and credentials from the AWS environment variables
+ *
+ * @param params - the parameters to complete
+ * @returns the parameters
+ */
+export declare function loadAWSParameters<T extends AWSServiceParameters>(params: T): T;
+//# sourceMappingURL=aws-parameters.d.ts.map

package/lib/services/aws-parameters.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"aws-parameters.d.ts","sourceRoot":"","sources":["../../src/services/aws-parameters.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,WAAW,CAAC,EAAE;QACZ,WAAW,EAAE,MAAM,CAAC;QACpB,eAAe,EAAE,MAAM,CAAC;QACxB,YAAY,CAAC,EAAE,MAAM,CAAC;KACvB,CAAC;IACF;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,SAAS,oBAAoB,EAAE,MAAM,EAAE,CAAC,GAAG,CAAC,CAU9E"}

package/lib/services/aws-parameters.js

@@ -0,0 +1,18 @@
+/**
+ * Default the region and credentials from the AWS environment variables
+ *
+ * @param params - the parameters to complete
+ * @returns the parameters
+ */
+export function loadAWSParameters(params) {
+    params.region ?? (params.region = process.env["AWS_DEFAULT_REGION"] || "us-east-1");
+    if (process.env["AWS_ACCESS_KEY_ID"] && process.env["AWS_SECRET_ACCESS_KEY"] && !process.env["ECS_CLUSTER"]) {
+        params.credentials ?? (params.credentials = {
+            accessKeyId: process.env["AWS_ACCESS_KEY_ID"],
+            secretAccessKey: process.env["AWS_SECRET_ACCESS_KEY"],
+            sessionToken: process.env["AWS_SESSION_TOKEN"]
+        });
+    }
+    return params;
+}
+//# sourceMappingURL=aws-parameters.js.map

package/lib/services/aws-parameters.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"aws-parameters.js","sourceRoot":"","sources":["../../src/services/aws-parameters.ts"],"names":[],"mappings":"AA0BA;;;;;GAKG;AACH,MAAM,UAAU,iBAAiB,CAAiC,MAAS;IACzE,MAAM,CAAC,MAAM,KAAb,MAAM,CAAC,MAAM,GAAK,OAAO,CAAC,GAAG,CAAC,oBAAoB,CAAC,IAAI,WAAW,EAAC;IACnE,IAAI,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC,IAAI,OAAO,CAAC,GAAG,CAAC,uBAAuB,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,EAAE,CAAC;QAC5G,MAAM,CAAC,WAAW,KAAlB,MAAM,CAAC,WAAW,GAAK;YACrB,WAAW,EAAE,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC;YAC7C,eAAe,EAAE,OAAO,CAAC,GAAG,CAAC,uBAAuB,CAAC;YACrD,YAAY,EAAE,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC;SAC/C,EAAC;IACJ,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/lib/services/awscommands.service.d.ts

@@ -0,0 +1,39 @@
+import { Service } from "@webda/core";
+/**
+ * AWS command line utilities
+ *
+ * Exposes the `webda aws route53 export|import|sync` and `webda aws copyTable` commands
+ *
+ * @WebdaModda
+ */
+export declare class AWSCommands extends Service {
+    /**
+     * Export a Route53 domain to a file
+     *
+     * @param domain - the domain to export
+     * @param file - the file to export to (.json or .yml)
+     */
+    route53Export(domain: string, file: string): Promise<void>;
+    /**
+     * Import a Route53 exported file to Route53
+     *
+     * @param file - the exported file
+     */
+    route53Import(file: string): Promise<void>;
+    /**
+     * Sync a Route53 exported file to Route53, removing any other entries
+     *
+     * @param file - the exported file
+     * @param pretend - only display the entries that would be removed
+     */
+    route53Sync(file: string, pretend?: boolean): Promise<void>;
+    /**
+     * Copy all items of a DynamoDB table into another one
+     *
+     * @param sourceTable - the table to copy from
+     * @param targetTable - the table to copy to
+     */
+    copyTable(sourceTable: string, targetTable: string): Promise<void>;
+}
+export default AWSCommands;
+//# sourceMappingURL=awscommands.service.d.ts.map

package/lib/services/awscommands.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"awscommands.service.d.ts","sourceRoot":"","sources":["../../src/services/awscommands.service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAW,OAAO,EAAE,MAAM,aAAa,CAAC;AAK/C;;;;;;GAMG;AACH,qBAAa,WAAY,SAAQ,OAAO;IACtC;;;;;OAKG;IAMG,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAE/D;IAED;;;;OAIG;IAMG,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAE/C;IAED;;;;;OAKG;IAMG,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE,OAAe,GAAG,OAAO,CAAC,IAAI,CAAC,CAEvE;IAED;;;;;OAKG;IAMG,SAAS,CAAC,WAAW,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAEvE;CACF;eAEc,WAAW"}

package/lib/services/awscommands.service.js

@@ -0,0 +1,127 @@
+var __runInitializers = (this && this.__runInitializers) || function (thisArg, initializers, value) {
+    var useValue = arguments.length > 2;
+    for (var i = 0; i < initializers.length; i++) {
+        value = useValue ? initializers[i].call(thisArg, value) : initializers[i].call(thisArg);
+    }
+    return useValue ? value : void 0;
+};
+var __esDecorate = (this && this.__esDecorate) || function (ctor, descriptorIn, decorators, contextIn, initializers, extraInitializers) {
+    function accept(f) { if (f !== void 0 && typeof f !== "function") throw new TypeError("Function expected"); return f; }
+    var kind = contextIn.kind, key = kind === "getter" ? "get" : kind === "setter" ? "set" : "value";
+    var target = !descriptorIn && ctor ? contextIn["static"] ? ctor : ctor.prototype : null;
+    var descriptor = descriptorIn || (target ? Object.getOwnPropertyDescriptor(target, contextIn.name) : {});
+    var _, done = false;
+    for (var i = decorators.length - 1; i >= 0; i--) {
+        var context = {};
+        for (var p in contextIn) context[p] = p === "access" ? {} : contextIn[p];
+        for (var p in contextIn.access) context.access[p] = contextIn.access[p];
+        context.addInitializer = function (f) { if (done) throw new TypeError("Cannot add initializers after decoration has completed"); extraInitializers.push(accept(f || null)); };
+        var result = (0, decorators[i])(kind === "accessor" ? { get: descriptor.get, set: descriptor.set } : descriptor[key], context);
+        if (kind === "accessor") {
+            if (result === void 0) continue;
+            if (result === null || typeof result !== "object") throw new TypeError("Object expected");
+            if (_ = accept(result.get)) descriptor.get = _;
+            if (_ = accept(result.set)) descriptor.set = _;
+            if (_ = accept(result.init)) initializers.unshift(_);
+        }
+        else if (_ = accept(result)) {
+            if (kind === "field") initializers.unshift(_);
+            else descriptor[key] = _;
+        }
+    }
+    if (target) Object.defineProperty(target, contextIn.name, descriptor);
+    done = true;
+};
+import { Command, Service } from "@webda/core";
+import { useWorkerOutput } from "@webda/workout";
+import { DynamoStore } from "./dynamodb.service.js";
+import { Route53Service } from "./route53.service.js";
+/**
+ * AWS command line utilities
+ *
+ * Exposes the `webda aws route53 export|import|sync` and `webda aws copyTable` commands
+ *
+ * @WebdaModda
+ */
+let AWSCommands = (() => {
+    var _a;
+    let _classSuper = Service;
+    let _instanceExtraInitializers = [];
+    let _route53Export_decorators;
+    let _route53Import_decorators;
+    let _route53Sync_decorators;
+    let _copyTable_decorators;
+    return _a = class AWSCommands extends _classSuper {
+            /**
+             * Export a Route53 domain to a file
+             *
+             * @param domain - the domain to export
+             * @param file - the file to export to (.json or .yml)
+             */
+            async route53Export(domain, file) {
+                await Route53Service.export(domain, file);
+            }
+            /**
+             * Import a Route53 exported file to Route53
+             *
+             * @param file - the exported file
+             */
+            async route53Import(file) {
+                await Route53Service.import({ file }, this.log.bind(this));
+            }
+            /**
+             * Sync a Route53 exported file to Route53, removing any other entries
+             *
+             * @param file - the exported file
+             * @param pretend - only display the entries that would be removed
+             */
+            async route53Sync(file, pretend = false) {
+                await Route53Service.import({ file, pretend, sync: true }, this.log.bind(this));
+            }
+            /**
+             * Copy all items of a DynamoDB table into another one
+             *
+             * @param sourceTable - the table to copy from
+             * @param targetTable - the table to copy to
+             */
+            async copyTable(sourceTable, targetTable) {
+                await DynamoStore.copyTable(useWorkerOutput(), sourceTable, targetTable);
+            }
+            constructor() {
+                super(...arguments);
+                __runInitializers(this, _instanceExtraInitializers);
+            }
+        },
+        (() => {
+            const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(_classSuper[Symbol.metadata] ?? null) : void 0;
+            _route53Export_decorators = [Command("aws route53 export", {
+                    description: "Export a Route53 domain to a json file",
+                    requires: ["aws-commands"],
+                    phase: "resolved"
+                })];
+            _route53Import_decorators = [Command("aws route53 import", {
+                    description: "Import a Route53 exported format to Route53",
+                    requires: ["aws-commands"],
+                    phase: "resolved"
+                })];
+            _route53Sync_decorators = [Command("aws route53 sync", {
+                    description: "Sync a Route53 exported format to Route53 (remove all others entries)",
+                    requires: ["aws-commands"],
+                    phase: "resolved"
+                })];
+            _copyTable_decorators = [Command("aws copyTable", {
+                    description: "Copy a DynamoDB table content to another table",
+                    requires: ["aws-commands"],
+                    phase: "resolved"
+                })];
+            __esDecorate(_a, null, _route53Export_decorators, { kind: "method", name: "route53Export", static: false, private: false, access: { has: obj => "route53Export" in obj, get: obj => obj.route53Export }, metadata: _metadata }, null, _instanceExtraInitializers);
+            __esDecorate(_a, null, _route53Import_decorators, { kind: "method", name: "route53Import", static: false, private: false, access: { has: obj => "route53Import" in obj, get: obj => obj.route53Import }, metadata: _metadata }, null, _instanceExtraInitializers);
+            __esDecorate(_a, null, _route53Sync_decorators, { kind: "method", name: "route53Sync", static: false, private: false, access: { has: obj => "route53Sync" in obj, get: obj => obj.route53Sync }, metadata: _metadata }, null, _instanceExtraInitializers);
+            __esDecorate(_a, null, _copyTable_decorators, { kind: "method", name: "copyTable", static: false, private: false, access: { has: obj => "copyTable" in obj, get: obj => obj.copyTable }, metadata: _metadata }, null, _instanceExtraInitializers);
+            if (_metadata) Object.defineProperty(_a, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
+        })(),
+        _a;
+})();
+export { AWSCommands };
+export default AWSCommands;
+//# sourceMappingURL=awscommands.service.js.map

package/lib/services/awscommands.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"awscommands.service.js","sourceRoot":"","sources":["../../src/services/awscommands.service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAC/C,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAEtD;;;;;;GAMG;IACU,WAAW;;sBAAS,OAAO;;;;;;sBAA3B,WAAY,SAAQ,WAAO;YACtC;;;;;eAKG;YAMH,KAAK,CAAC,aAAa,CAAC,MAAc,EAAE,IAAY;gBAC9C,MAAM,cAAc,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;YAC5C,CAAC;YAED;;;;eAIG;YAMH,KAAK,CAAC,aAAa,CAAC,IAAY;gBAC9B,MAAM,cAAc,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,EAAE,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;YAC7D,CAAC;YAED;;;;;eAKG;YAMH,KAAK,CAAC,WAAW,CAAC,IAAY,EAAE,OAAO,GAAY,KAAK;gBACtD,MAAM,cAAc,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;YAClF,CAAC;YAED;;;;;eAKG;YAMH,KAAK,CAAC,SAAS,CAAC,WAAmB,EAAE,WAAmB;gBACtD,MAAM,WAAW,CAAC,SAAS,CAAC,eAAe,EAAE,EAAE,WAAW,EAAE,WAAW,CAAC,CAAC;YAC3E,CAAC;;;gBA1DU,mDAAW;;;;;yCAOrB,OAAO,CAAC,oBAAoB,EAAE;oBAC7B,WAAW,EAAE,wCAAwC;oBACrD,QAAQ,EAAE,CAAC,cAAc,CAAC;oBAC1B,KAAK,EAAE,UAAU;iBAClB,CAAC;yCAUD,OAAO,CAAC,oBAAoB,EAAE;oBAC7B,WAAW,EAAE,6CAA6C;oBAC1D,QAAQ,EAAE,CAAC,cAAc,CAAC;oBAC1B,KAAK,EAAE,UAAU;iBAClB,CAAC;uCAWD,OAAO,CAAC,kBAAkB,EAAE;oBAC3B,WAAW,EAAE,uEAAuE;oBACpF,QAAQ,EAAE,CAAC,cAAc,CAAC;oBAC1B,KAAK,EAAE,UAAU;iBAClB,CAAC;qCAWD,OAAO,CAAC,eAAe,EAAE;oBACxB,WAAW,EAAE,gDAAgD;oBAC7D,QAAQ,EAAE,CAAC,cAAc,CAAC;oBAC1B,KAAK,EAAE,UAAU;iBAClB,CAAC;YA3CF,wLAAM,aAAa,6DAElB;YAYD,wLAAM,aAAa,6DAElB;YAaD,kLAAM,WAAW,6DAEhB;YAaD,4KAAM,SAAS,6DAEd;;;;;SA1DU,WAAW;AA6DxB,eAAe,WAAW,CAAC"}

package/lib/services/cloudwatchlogger.service.d.ts

@@ -0,0 +1,131 @@
+import { CloudWatchLogs } from "@aws-sdk/client-cloudwatch-logs";
+import { Service, ServiceParameters } from "@webda/core";
+import { WorkerLogLevel, WorkerMessage } from "@webda/workout";
+import { AWSServiceParameters } from "./aws-parameters.js";
+import type { CloudFormationContributor } from "./contributors.js";
+/**
+ * Send webda log to CloudWatch
+ */
+export declare class CloudWatchLoggerParameters extends ServiceParameters implements AWSServiceParameters {
+    /**
+     * Custom endpoint (localstack, minio, ...)
+     */
+    endpoint?: string;
+    /**
+     * Static credentials, default to the AWS environment variables
+     */
+    credentials?: {
+        accessKeyId: string;
+        secretAccessKey: string;
+        sessionToken?: string;
+    };
+    /**
+     * AWS region
+     * @default "us-east-1"
+     */
+    region?: string;
+    /**
+     * logGroupName to send logStream to
+     */
+    logGroupName: string;
+    /**
+     * Prefix of the log stream name, a random uuid is appended
+     */
+    logStreamNamePrefix?: string;
+    /**
+     * KMS key to use when creating the log group
+     */
+    kmsKeyId?: string;
+    /**
+     * Tags to add when creating the log group
+     */
+    tags?: any;
+    /**
+     * Minimum level of logs to send
+     * @default "INFO"
+     */
+    logLevel?: WorkerLogLevel;
+    /**
+     * Send each log line as soon as it is produced
+     */
+    singlePush?: boolean;
+    /**
+     * CloudFormation customization
+     */
+    CloudFormation?: any;
+    /**
+     * Skip CloudFormation on deploy
+     */
+    CloudFormationSkip?: boolean;
+    /**
+     * @override
+     * @param params - raw parameters
+     * @returns this
+     */
+    load(params?: any): this;
+}
+/**
+ * Output log to a CloudWatch Stream
+ *
+ * @WebdaModda
+ */
+export declare class CloudWatchLogger<T extends CloudWatchLoggerParameters = CloudWatchLoggerParameters> extends Service<T> implements CloudFormationContributor {
+    _logGroupName: string;
+    _logStreamName: string;
+    _seqToken: string;
+    _logStream: any;
+    _cloudwatch: CloudWatchLogs;
+    _bufferedLogs: any[];
+    /**
+     * Listener on the worker output
+     */
+    protected messageListener: (msg: WorkerMessage) => void;
+    /**
+     * Unsubscribe from the Webda.Result core event
+     */
+    protected resultListenerOff: () => void;
+    /**
+     * Create the log group and stream, then forward the logs
+     * @returns this
+     */
+    init(): Promise<this>;
+    /**
+     * Remove the log and result listeners
+     */
+    protected removeListeners(): void;
+    /**
+     * Flush the logs and stop forwarding
+     * @override
+     */
+    stop(): Promise<void>;
+    /**
+     * Send logs to CloudWatch
+     *
+     * @param copy - send a copy of the buffer and reset it before sending
+     */
+    sendLogs(copy?: boolean): Promise<void>;
+    /**
+     * Buffer a log line
+     * @param level - log level
+     * @param args - log arguments
+     */
+    _log(level: WorkerLogLevel, ...args: any[]): void;
+    /**
+     * IAM policy required by the service
+     * @param accountId - AWS account id
+     * @returns the policy statement
+     */
+    getARNPolicy(accountId: string): {
+        Sid: string;
+        Effect: string;
+        Action: string[];
+        Resource: string[];
+    };
+    /**
+     * CloudFormation resources for the log group
+     * @returns the resources
+     */
+    getCloudFormation(): {};
+}
+export default CloudWatchLogger;
+//# sourceMappingURL=cloudwatchlogger.service.d.ts.map

package/lib/services/cloudwatchlogger.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cloudwatchlogger.service.d.ts","sourceRoot":"","sources":["../../src/services/cloudwatchlogger.service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,iCAAiC,CAAC;AACjE,OAAO,EAAE,OAAO,EAAE,iBAAiB,EAAiB,MAAM,aAAa,CAAC;AACxE,OAAO,EAA8B,cAAc,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAE3F,OAAO,EAAE,oBAAoB,EAAqB,MAAM,qBAAqB,CAAC;AAC9E,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,mBAAmB,CAAC;AAEnE;;GAEG;AACH,qBAAa,0BAA2B,SAAQ,iBAAkB,YAAW,oBAAoB;IAC/F;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,WAAW,CAAC,EAAE;QAAE,WAAW,EAAE,MAAM,CAAC;QAAC,eAAe,EAAE,MAAM,CAAC;QAAC,YAAY,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IACtF;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,IAAI,CAAC,EAAE,GAAG,CAAC;IACX;;;OAGG;IACH,QAAQ,CAAC,EAAE,cAAc,CAAC;IAC1B;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;OAEG;IACH,cAAc,CAAC,EAAE,GAAG,CAAC;IACrB;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAE7B;;;;OAIG;IACH,IAAI,CAAC,MAAM,GAAE,GAAQ,GAAG,IAAI,CAK3B;CACF;AAED;;;;GAIG;AACH,qBAAa,gBAAgB,CAAC,CAAC,SAAS,0BAA0B,GAAG,0BAA0B,CAC7F,SAAQ,OAAO,CAAC,CAAC,CACjB,YAAW,yBAAyB;IAEpC,aAAa,EAAE,MAAM,CAAC;IACtB,cAAc,EAAE,MAAM,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,GAAG,CAAC;IAChB,WAAW,EAAE,cAAc,CAAC;IAC5B,aAAa,EAAE,GAAG,EAAE,CAAM;IAC1B;;OAEG;IACH,SAAS,CAAC,eAAe,EAAE,CAAC,GAAG,EAAE,aAAa,KAAK,IAAI,CAAC;IACxD;;OAEG;IACH,SAAS,CAAC,iBAAiB,EAAE,MAAM,IAAI,CAAC;IAExC;;;OAGG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAkC1B;IAED;;OAEG;IACH,SAAS,CAAC,eAAe,SAOxB;IAED;;;OAGG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAI1B;IAED;;;;OAIG;IACG,QAAQ,CAAC,IAAI,GAAE,OAAe,GAAG,OAAO,CAAC,IAAI,CAAC,CAsBnD;IAED;;;;OAIG;IACH,IAAI,CAAC,KAAK,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI,CAUhD;IAED;;;;OAIG;IACH,YAAY,CAAC,SAAS,EAAE,MAAM;QAG1B,GAAG;QACH,MAAM;QACN,MAAM;QACN,QAAQ;MAKX;IAED;;;OAGG;IACH,iBAAiB,OAehB;CACF;eAEc,gBAAgB"}

package/lib/services/{cloudwatchlogger.js → cloudwatchlogger.service.js}

@@ -1,33 +1,37 @@
 import { CloudWatchLogs } from "@aws-sdk/client-cloudwatch-logs";
-import { Service, ServiceParameters } from "@webda/core";
-import { LogFilter } from "@webda/workout";
-import { AWSServiceParameters } from "./aws-mixin.js";
-import { randomUUID } from "crypto";
+import { Service, ServiceParameters, useCoreEvents } from "@webda/core";
+import { LogFilter, useWorkerOutput } from "@webda/workout";
+import { randomUUID } from "node:crypto";
+import { loadAWSParameters } from "./aws-parameters.js";
 /**
  * Send webda log to CloudWatch
  */
-export class CloudWatchLoggerParameters extends AWSServiceParameters(ServiceParameters) {
+export class CloudWatchLoggerParameters extends ServiceParameters {
+    /**
+     * @override
+     * @param params - raw parameters
+     * @returns this
+     */
+    load(params = {}) {
+        super.load(params);
+        loadAWSParameters(this);
+        this.logLevel ?? (this.logLevel = "INFO");
+        return this;
+    }
 }
 /**
  * Output log to a CloudWatch Stream
  *
  * @WebdaModda
  */
-export default class CloudWatchLogger extends Service {
+export class CloudWatchLogger extends Service {
     constructor() {
         super(...arguments);
         this._bufferedLogs = [];
     }
     /**
-     * Load the parameters
-     *
-     * @param params
-     */
-    loadParameters(params) {
-        return new CloudWatchLoggerParameters(params);
-    }
-    /**
-     * @inheritdoc
+     * Create the log group and stream, then forward the logs
+     * @returns this
      */
     async init() {
         await super.init();
@@ -51,22 +55,43 @@ export default class CloudWatchLogger extends Service {
             logGroupName: this._logGroupName,
             logStreamName: this._logStreamName
         });
-        this._webda.getWorkerOutput().on("message", (msg) => {
+        this.removeListeners();
+        this.messageListener = (msg) => {
             if (msg.type !== "log") {
                 return;
             }
             if (LogFilter(msg.log.level, this.parameters.logLevel)) {
                 this._log(msg.log.level, ...msg.log.args);
             }
-        });
-        this._webda.on("Webda.Result", this.sendLogs.bind(this));
+        };
+        useWorkerOutput().on("message", this.messageListener);
+        this.resultListenerOff = useCoreEvents("Webda.Result", () => this.sendLogs());
         return this;
     }
+    /**
+     * Remove the log and result listeners
+     */
+    removeListeners() {
+        if (this.messageListener) {
+            useWorkerOutput().off("message", this.messageListener);
+            this.messageListener = undefined;
+        }
+        this.resultListenerOff?.();
+        this.resultListenerOff = undefined;
+    }
+    /**
+     * Flush the logs and stop forwarding
+     * @override
+     */
+    async stop() {
+        this.removeListeners();
+        await this.sendLogs();
+        await super.stop();
+    }
     /**
      * Send logs to CloudWatch
      *
-     * @param copy
-     * @returns
+     * @param copy - send a copy of the buffer and reset it before sending
      */
     async sendLogs(copy = false) {
         if (!this._bufferedLogs.length) {
@@ -93,7 +118,9 @@ export default class CloudWatchLogger extends Service {
         }
     }
     /**
-     * @inheritdoc
+     * Buffer a log line
+     * @param level - log level
+     * @param args - log arguments
      */
     _log(level, ...args) {
         this._bufferedLogs.push({
@@ -101,16 +128,20 @@ export default class CloudWatchLogger extends Service {
             timestamp: new Date().getTime()
         });
         if (this.parameters.singlePush) {
-            this.sendLogs(true);
+            this.sendLogs(true).catch(() => {
+                // Ignore send errors to avoid logging loops
+            });
         }
     }
     /**
-     * @inheritdoc
+     * IAM policy required by the service
+     * @param accountId - AWS account id
+     * @returns the policy statement
      */
     getARNPolicy(accountId) {
         const region = this.parameters.region || "us-east-1";
         return {
-            Sid: this.constructor.name + this._name,
+            Sid: this.constructor.name + this.getName(),
             Effect: "Allow",
             Action: ["logs:*"],
             Resource: [
@@ -120,7 +151,8 @@ export default class CloudWatchLogger extends Service {
         };
     }
     /**
-     * @inheritdoc
+     * CloudFormation resources for the log group
+     * @returns the resources
      */
     getCloudFormation() {
         if (this.parameters.CloudFormationSkip) {
@@ -128,7 +160,7 @@ export default class CloudWatchLogger extends Service {
         }
         const resources = {};
         this.parameters.CloudFormation = this.parameters.CloudFormation || {};
-        resources[this._name + "LogGroup"] = {
+        resources[this.getName() + "LogGroup"] = {
             Type: "AWS::Logs::LogGroup",
             Properties: {
                 ...this.parameters.CloudFormation.LogGroup,
@@ -139,5 +171,5 @@ export default class CloudWatchLogger extends Service {
         return resources;
     }
 }
-export { CloudWatchLogger };
-//# sourceMappingURL=cloudwatchlogger.js.map
+export default CloudWatchLogger;
+//# sourceMappingURL=cloudwatchlogger.service.js.map

package/lib/services/cloudwatchlogger.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cloudwatchlogger.service.js","sourceRoot":"","sources":["../../src/services/cloudwatchlogger.service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,iCAAiC,CAAC;AACjE,OAAO,EAAE,OAAO,EAAE,iBAAiB,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AACxE,OAAO,EAAE,SAAS,EAAE,eAAe,EAAiC,MAAM,gBAAgB,CAAC;AAC3F,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAwB,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAG9E;;GAEG;AACH,MAAM,OAAO,0BAA2B,SAAQ,iBAAiB;IAiD/D;;;;OAIG;IACH,IAAI,CAAC,MAAM,GAAQ,EAAE;QACnB,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACnB,iBAAiB,CAAC,IAAI,CAAC,CAAC;QACxB,IAAI,CAAC,QAAQ,KAAb,IAAI,CAAC,QAAQ,GAAK,MAAM,EAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,OAAO,gBACX,SAAQ,OAAU;IADpB;;QASE,kBAAa,GAAU,EAAE,CAAC;IA4J5B,CAAC;IAlJC;;;OAGG;IACH,KAAK,CAAC,IAAI;QACR,MAAM,KAAK,CAAC,IAAI,EAAE,CAAC;QACnB,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC;QAClD,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;YACxB,MAAM,KAAK,CAAC,8CAA8C,CAAC,CAAC;QAC9D,CAAC;QACD,IAAI,CAAC,cAAc,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,mBAAmB,IAAI,EAAE,CAAC,GAAG,UAAU,EAAE,CAAC;QACjF,IAAI,CAAC,WAAW,GAAG,IAAI,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACvD,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,iBAAiB,CAAC;YACnD,kBAAkB,EAAE,IAAI,CAAC,aAAa;SACvC,CAAC,CAAC;QACH,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC;YAC1B,MAAM,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC;gBACpC,YAAY,EAAE,IAAI,CAAC,aAAa;gBAChC,QAAQ,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ;gBAClC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,IAAI;aAC3B,CAAC,CAAC;QACL,CAAC;QACD,IAAI,CAAC,UAAU,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,eAAe,CAAC;YACvD,YAAY,EAAE,IAAI,CAAC,aAAa;YAChC,aAAa,EAAE,IAAI,CAAC,cAAc;SACnC,CAAC,CAAC;QACH,IAAI,CAAC,eAAe,EAAE,CAAC;QACvB,IAAI,CAAC,eAAe,GAAG,CAAC,GAAkB,EAAE,EAAE;YAC5C,IAAI,GAAG,CAAC,IAAI,KAAK,KAAK,EAAE,CAAC;gBACvB,OAAO;YACT,CAAC;YACD,IAAI,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;gBACvD,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YAC5C,CAAC;QACH,CAAC,CAAC;QACF,eAAe,EAAE,CAAC,EAAE,CAAC,SAAS,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;QACtD,IAAI,CAAC,iBAAiB,GAAG,aAAa,CAAC,cAAc,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;QAC9E,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACO,eAAe;QACvB,IAAI,IAAI,CAAC,eAAe,EAAE,CAAC;YACzB,eAAe,EAAE,CAAC,GAAG,CAAC,SAAS,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;YACvD,IAAI,CAAC,eAAe,GAAG,SAAS,CAAC;QACnC,CAAC;QACD,IAAI,CAAC,iBAAiB,EAAE,EAAE,CAAC;QAC3B,IAAI,CAAC,iBAAiB,GAAG,SAAS,CAAC;IACrC,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,IAAI;QACR,IAAI,CAAC,eAAe,EAAE,CAAC;QACvB,MAAM,IAAI,CAAC,QAAQ,EAAE,CAAC;QACtB,MAAM,KAAK,CAAC,IAAI,EAAE,CAAC;IACrB,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,QAAQ,CAAC,IAAI,GAAY,KAAK;QAClC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,CAAC;YAC/B,OAAO;QACT,CAAC;QACD,IAAI,MAAM,CAAC;QACX,IAAI,IAAI,EAAE,CAAC;YACT,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;YACxC,IAAI,CAAC,aAAa,GAAG,EAAE,CAAC;QAC1B,CAAC;aAAM,CAAC;YACN,MAAM,GAAG,IAAI,CAAC,aAAa,CAAC;QAC9B,CAAC;QACD,MAAM,MAAM,GAAG;YACb,SAAS,EAAE,MAAM;YACjB,YAAY,EAAE,IAAI,CAAC,aAAa;YAChC,aAAa,EAAE,IAAI,CAAC,cAAc;YAClC,aAAa,EAAE,IAAI,CAAC,SAAS;SAC9B,CAAC;QACF,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;QACxD,IAAI,CAAC,SAAS,GAAG,GAAG,CAAC,iBAAiB,CAAC;QACvC,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,IAAI,CAAC,aAAa,GAAG,EAAE,CAAC;QAC1B,CAAC;IACH,CAAC;IAED;;;;OAIG;IACH,IAAI,CAAC,KAAqB,EAAE,GAAG,IAAW;QACxC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC;YACtB,OAAO,EAAE,IAAI,KAAK,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;YAClF,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE;SAChC,CAAC,CAAC;QACH,IAAI,IAAI,CAAC,UAAU,CAAC,UAAU,EAAE,CAAC;YAC/B,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE;gBAC7B,4CAA4C;YAC9C,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED;;;;OAIG;IACH,YAAY,CAAC,SAAiB;QAC5B,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,IAAI,WAAW,CAAC;QACrD,OAAO;YACL,GAAG,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,GAAG,IAAI,CAAC,OAAO,EAAE;YAC3C,MAAM,EAAE,OAAO;YACf,MAAM,EAAE,CAAC,QAAQ,CAAC;YAClB,QAAQ,EAAE;gBACR,eAAe,GAAG,MAAM,GAAG,GAAG,GAAG,SAAS,GAAG,aAAa,GAAG,IAAI,CAAC,UAAU,CAAC,YAAY;gBACzF,eAAe,GAAG,MAAM,GAAG,GAAG,GAAG,SAAS,GAAG,aAAa,GAAG,IAAI,CAAC,UAAU,CAAC,YAAY,GAAG,MAAM;aACnG;SACF,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,iBAAiB;QACf,IAAI,IAAI,CAAC,UAAU,CAAC,kBAAkB,EAAE,CAAC;YACvC,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,MAAM,SAAS,GAAG,EAAE,CAAC;QACrB,IAAI,CAAC,UAAU,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,cAAc,IAAI,EAAE,CAAC;QACtE,SAAS,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,UAAU,CAAC,GAAG;YACvC,IAAI,EAAE,qBAAqB;YAC3B,UAAU,EAAE;gBACV,GAAG,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,QAAQ;gBAC1C,YAAY,EAAE,IAAI,CAAC,UAAU,CAAC,YAAY;aAC3C;SACF,CAAC;QACF,qDAAqD;QACrD,OAAO,SAAS,CAAC;IACnB,CAAC;CACF;AAED,eAAe,gBAAgB,CAAC"}