@yourrentals/cloudevent-receiver-nestjs 0.1.4 → 0.4.2

package/README.md

@@ -0,0 +1,73 @@
+# @yourrentals/cloudevent-receiver-nestjs
+
+This library defines a plugin for NestJS to receive messages from the message bus.
+
+## Installation
+
+```bash
+yarn add @yourrentals/cloudevent-receiver-nestjs @golevelup/nestjs-discovery
+```
+
+## Usage
+
+```ts
+import {CloudEventReceiverModule, CloudEventHandler} from '@yourrentals/cloudevent-receiver-nestjs'
+import {RsaVerifier} from '@yourrentals/message-bus-signature-rsa'
+
+@Injectable()
+class MessagebusHandlerService {
+	@CloudEventHandler('my-queue')
+	async handleMyQueue(event: CloudEvent) {
+		// ...
+	}
+}
+
+@Module({
+	imports: [
+		CloudEventReceiverModule.forRoot({
+			pathPrefix: '/message-bus',
+			verifiers: [new RsaVerifier('signature', 'publicKey')],
+		}),
+	],
+	providers: [MessagebusHandlerService],
+})
+
+```
+
+```ts
+import Axios from 'axios';
+
+const main = async () => {
+  // Queue name defined in the receiver are automatically registered
+  await Axios.post('http://localhost:3000/message-bus/my-queue', {
+    headers: {
+      'ce-specversion': '1.0',
+      'ce-type': 'my-event',
+      'ce-source': 'my-source',
+      'ce-id': 'my-id',
+      'ce-time': '2020-01-01T00:00:00Z',
+      'ce-datacontenttype': 'application/json',
+      'ce-dataschema': 'http://myschema.com',
+      'ce-subject': 'my-subject',
+      'ce-signature': 'my-signature',
+    },
+    body: {
+      foo: 'bar',
+    },
+  });
+};
+```
+
+## Errors
+
+The library defines the following errors:
+
+| Error                  | Description                             | Expected HTTP status code | Retryable |
+| ---------------------- | --------------------------------------- | ------------------------- | --------- |
+| InvalidSignatureError  | The signature of the message is invalid | 401                       | No        |
+| UnparsableMessageError | The message is not a valid CloudEvent   | 400                       | No        |
+| NotFoundError          | The queue name is not registered        | 404                       | Yes       |
+| ConflictError          | The queue name is already registered    | 409                       | Yes       |
+| TooManyRequestsError   | The queue is currently busy             | 429                       | Yes       |
+| ClientError            | Any other client error                  | 400                       | No        |
+| ServerError            | Any other server error                  | 500                       | Yes       |

package/index.cjs.d.ts

@@ -0,0 +1 @@
+export * from "./src/index";

package/index.cjs.js

@@ -0,0 +1,163 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var common = require('@nestjs/common');
+var utilReceiverError = require('@yourrentals/util-receiver-error');
+var nestjsDiscovery = require('@golevelup/nestjs-discovery');
+var cloudeventReceiverCore = require('@yourrentals/cloudevent-receiver-core');
+
+/******************************************************************************
+Copyright (c) Microsoft Corporation.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+***************************************************************************** */
+
+function __decorate(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;
+}
+
+function __param(paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+}
+
+function __metadata(metadataKey, metadataValue) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(metadataKey, metadataValue);
+}
+
+function __awaiter(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());
+    });
+}
+
+typeof SuppressedError === "function" ? SuppressedError : function (error, suppressed, message) {
+    var e = new Error(message);
+    return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
+};
+
+const CLOUD_EVENT_HANDLER = Symbol.for('CLOUD_EVENT_HANDLER');
+const CLOUD_EVENT_RECEIVER_OPTIONS = Symbol.for('CLOUD_EVENT_RECEIVER_OPTIONS');
+
+let CloudEventReceiverService = class CloudEventReceiverService {
+    constructor(options, discovery) {
+        this.options = options;
+        this.discovery = discovery;
+    }
+    onModuleInit() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const providers = yield this.discovery.providerMethodsWithMetaAtKey(CLOUD_EVENT_HANDLER);
+            this.receiver = new cloudeventReceiverCore.CloudEventReceiver({
+                queues: providers.map((provider) => ({
+                    name: provider.meta.name,
+                    handler: provider.discoveredMethod.handler.bind(provider.discoveredMethod.parentClass.instance),
+                })),
+                verifiers: this.options.verifiers || [],
+            });
+        });
+    }
+    handle(queueName, headers, body) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.receiver.handle(queueName, headers, body);
+        });
+    }
+};
+CloudEventReceiverService = __decorate([
+    common.Injectable(),
+    __param(0, common.Inject(CLOUD_EVENT_RECEIVER_OPTIONS)),
+    __metadata("design:paramtypes", [Object, nestjsDiscovery.DiscoveryService])
+], CloudEventReceiverService);
+
+const createController = (pathPrefix = '/message-bus') => {
+    let CloudEventReceiverController = class CloudEventReceiverController {
+        constructor(service) {
+            this.service = service;
+        }
+        receiveMessage(request) {
+            return __awaiter(this, void 0, void 0, function* () {
+                try {
+                    const queueName = request.params.queueName;
+                    yield this.service.handle(queueName, request.headers, request.body);
+                }
+                catch (e) {
+                    if (utilReceiverError.isReceiverError(e)) {
+                        throw new common.HttpException(e.message, e.statusCode);
+                    }
+                    throw new common.InternalServerErrorException();
+                }
+            });
+        }
+    };
+    __decorate([
+        common.Post('/:queueName'),
+        common.HttpCode(200),
+        __param(0, common.Req()),
+        __metadata("design:type", Function),
+        __metadata("design:paramtypes", [Object]),
+        __metadata("design:returntype", Promise)
+    ], CloudEventReceiverController.prototype, "receiveMessage", null);
+    CloudEventReceiverController = __decorate([
+        common.Controller(pathPrefix),
+        __param(0, common.Inject(CloudEventReceiverService)),
+        __metadata("design:paramtypes", [CloudEventReceiverService])
+    ], CloudEventReceiverController);
+    return CloudEventReceiverController;
+};
+
+var CloudEventReceiverModule_1;
+exports.CloudEventReceiverModule = CloudEventReceiverModule_1 = class CloudEventReceiverModule {
+    static forRoot(options) {
+        return {
+            module: CloudEventReceiverModule_1,
+            global: true,
+            imports: [nestjsDiscovery.DiscoveryModule],
+            providers: [
+                {
+                    provide: CLOUD_EVENT_RECEIVER_OPTIONS,
+                    useValue: options,
+                },
+                {
+                    provide: CloudEventReceiverService,
+                    useFactory: (options, discovery) => new CloudEventReceiverService(options, discovery),
+                    inject: [CLOUD_EVENT_RECEIVER_OPTIONS, nestjsDiscovery.DiscoveryService],
+                },
+            ],
+            controllers: [createController(options.pathPrefix)],
+        };
+    }
+};
+exports.CloudEventReceiverModule = CloudEventReceiverModule_1 = __decorate([
+    common.Module({})
+], exports.CloudEventReceiverModule);
+
+const CloudEventHandler = (queueName) => common.SetMetadata(CLOUD_EVENT_HANDLER, { name: queueName });
+
+exports.CloudEventHandler = CloudEventHandler;
+Object.keys(utilReceiverError).forEach(function (k) {
+    if (k !== 'default' && !exports.hasOwnProperty(k)) Object.defineProperty(exports, k, {
+        enumerable: true,
+        get: function () { return utilReceiverError[k]; }
+    });
+});
+Object.keys(cloudeventReceiverCore).forEach(function (k) {
+    if (k !== 'default' && !exports.hasOwnProperty(k)) Object.defineProperty(exports, k, {
+        enumerable: true,
+        get: function () { return cloudeventReceiverCore[k]; }
+    });
+});

package/index.esm.js

@@ -0,0 +1,149 @@
+import { Injectable, Inject, Post, HttpCode, Req, Controller, HttpException, InternalServerErrorException, Module, SetMetadata } from '@nestjs/common';
+import { isReceiverError } from '@yourrentals/util-receiver-error';
+export * from '@yourrentals/util-receiver-error';
+import { DiscoveryService, DiscoveryModule } from '@golevelup/nestjs-discovery';
+import { CloudEventReceiver } from '@yourrentals/cloudevent-receiver-core';
+export * from '@yourrentals/cloudevent-receiver-core';
+
+/******************************************************************************
+Copyright (c) Microsoft Corporation.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+***************************************************************************** */
+
+function __decorate(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;
+}
+
+function __param(paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+}
+
+function __metadata(metadataKey, metadataValue) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(metadataKey, metadataValue);
+}
+
+function __awaiter(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());
+    });
+}
+
+typeof SuppressedError === "function" ? SuppressedError : function (error, suppressed, message) {
+    var e = new Error(message);
+    return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
+};
+
+const CLOUD_EVENT_HANDLER = Symbol.for('CLOUD_EVENT_HANDLER');
+const CLOUD_EVENT_RECEIVER_OPTIONS = Symbol.for('CLOUD_EVENT_RECEIVER_OPTIONS');
+
+let CloudEventReceiverService = class CloudEventReceiverService {
+    constructor(options, discovery) {
+        this.options = options;
+        this.discovery = discovery;
+    }
+    onModuleInit() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const providers = yield this.discovery.providerMethodsWithMetaAtKey(CLOUD_EVENT_HANDLER);
+            this.receiver = new CloudEventReceiver({
+                queues: providers.map((provider) => ({
+                    name: provider.meta.name,
+                    handler: provider.discoveredMethod.handler.bind(provider.discoveredMethod.parentClass.instance),
+                })),
+                verifiers: this.options.verifiers || [],
+            });
+        });
+    }
+    handle(queueName, headers, body) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.receiver.handle(queueName, headers, body);
+        });
+    }
+};
+CloudEventReceiverService = __decorate([
+    Injectable(),
+    __param(0, Inject(CLOUD_EVENT_RECEIVER_OPTIONS)),
+    __metadata("design:paramtypes", [Object, DiscoveryService])
+], CloudEventReceiverService);
+
+const createController = (pathPrefix = '/message-bus') => {
+    let CloudEventReceiverController = class CloudEventReceiverController {
+        constructor(service) {
+            this.service = service;
+        }
+        receiveMessage(request) {
+            return __awaiter(this, void 0, void 0, function* () {
+                try {
+                    const queueName = request.params.queueName;
+                    yield this.service.handle(queueName, request.headers, request.body);
+                }
+                catch (e) {
+                    if (isReceiverError(e)) {
+                        throw new HttpException(e.message, e.statusCode);
+                    }
+                    throw new InternalServerErrorException();
+                }
+            });
+        }
+    };
+    __decorate([
+        Post('/:queueName'),
+        HttpCode(200),
+        __param(0, Req()),
+        __metadata("design:type", Function),
+        __metadata("design:paramtypes", [Object]),
+        __metadata("design:returntype", Promise)
+    ], CloudEventReceiverController.prototype, "receiveMessage", null);
+    CloudEventReceiverController = __decorate([
+        Controller(pathPrefix),
+        __param(0, Inject(CloudEventReceiverService)),
+        __metadata("design:paramtypes", [CloudEventReceiverService])
+    ], CloudEventReceiverController);
+    return CloudEventReceiverController;
+};
+
+var CloudEventReceiverModule_1;
+let CloudEventReceiverModule = CloudEventReceiverModule_1 = class CloudEventReceiverModule {
+    static forRoot(options) {
+        return {
+            module: CloudEventReceiverModule_1,
+            global: true,
+            imports: [DiscoveryModule],
+            providers: [
+                {
+                    provide: CLOUD_EVENT_RECEIVER_OPTIONS,
+                    useValue: options,
+                },
+                {
+                    provide: CloudEventReceiverService,
+                    useFactory: (options, discovery) => new CloudEventReceiverService(options, discovery),
+                    inject: [CLOUD_EVENT_RECEIVER_OPTIONS, DiscoveryService],
+                },
+            ],
+            controllers: [createController(options.pathPrefix)],
+        };
+    }
+};
+CloudEventReceiverModule = CloudEventReceiverModule_1 = __decorate([
+    Module({})
+], CloudEventReceiverModule);
+
+const CloudEventHandler = (queueName) => SetMetadata(CLOUD_EVENT_HANDLER, { name: queueName });
+
+export { CloudEventHandler, CloudEventReceiverModule };

package/package.json

@@ -1,10 +1,15 @@
 {
   "name": "@yourrentals/cloudevent-receiver-nestjs",
-  "version": "0.1.4",
+  "version": "0.4.2",
   "dependencies": {
-    "@golevelup/nestjs-discovery": "^4.0.0"
+    "@yourrentals/cloudevent-receiver-core": "0.4.2",
+    "@yourrentals/util-receiver-error": "0.4.2"
   },
   "peerDependencies": {
-    "@nestjs/common": "^6.0.0 || ^7.0.0 || ^8.0.0 || ^9.0.0 || ^10.0.0"
-  }
+    "@nestjs/common": "^6.0.0 || ^7.0.0 || ^8.0.0 || ^9.0.0 || ^10.0.0",
+    "@golevelup/nestjs-discovery": "^3.0.0 || ^4.0.0"
+  },
+  "type": "commonjs",
+  "main": "./index.cjs.js",
+  "module": "./index.esm.js"
 }

package/{index.d.ts → src/index.d.ts}

@@ -1,4 +1,4 @@
 export * from './lib/cloud-event-receiver.module';
 export * from './lib/cloud-event-receiver.decorators';
-export * from '@message-bus/cloudevent-receiver-core';
-export * from '@message-bus/util-receiver-error';
+export * from '@yourrentals/cloudevent-receiver-core';
+export * from '@yourrentals/util-receiver-error';

package/src/lib/cloud-event-receiver.controller.d.ts

@@ -0,0 +1,7 @@
+import { CloudEventReceiverService } from './cloud-event-receiver.service';
+export declare const createController: (pathPrefix?: string) => {
+    new (service: CloudEventReceiverService): {
+        readonly service: CloudEventReceiverService;
+        receiveMessage(request: any): Promise<void>;
+    };
+};

package/src/lib/cloud-event-receiver.service.d.ts

@@ -0,0 +1,12 @@
+import { OnModuleInit } from '@nestjs/common';
+import { DiscoveryService } from '@golevelup/nestjs-discovery';
+import { CloudEventReceiver } from '@yourrentals/cloudevent-receiver-core';
+import { CloudEventReceiverModuleOptions } from './cloud-event-receiver.types';
+export declare class CloudEventReceiverService implements OnModuleInit {
+    readonly options: CloudEventReceiverModuleOptions;
+    readonly discovery: DiscoveryService;
+    receiver: CloudEventReceiver;
+    constructor(options: CloudEventReceiverModuleOptions, discovery: DiscoveryService);
+    onModuleInit(): Promise<void>;
+    handle(queueName: string, headers: any, body: any): Promise<void>;
+}

package/src/lib/cloud-event-receiver.types.d.ts

@@ -0,0 +1,5 @@
+import type { CloudEventReceiverOptions } from '@yourrentals/cloudevent-receiver-core';
+export type CloudEventReceiverModuleOptions = {
+    pathPrefix?: string;
+    verifiers?: CloudEventReceiverOptions['verifiers'];
+};