@rsdk/nats.producer 5.3.0-next.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md ADDED
@@ -0,0 +1,10 @@
1
+ # Change Log
2
+
3
+ All notable changes to this project will be documented in this file.
4
+ See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5
+
6
+ ## [5.3.0-next.4](https://github.com/R-Vision/rsdk/compare/v5.3.0-next.3...v5.3.0-next.4) (2024-11-05)
7
+
8
+ ### Features
9
+
10
+ * **nats.producer:** direct nats producer alpha implementation ([#301](https://github.com/R-Vision/rsdk/issues/301)) ([d173b51](https://github.com/R-Vision/rsdk/commit/d173b51c664c718a214cdc695708cfdd40fc4dcb))
@@ -0,0 +1,15 @@
1
+ import type { EventPayload, EventType } from '@rsdk/nats.common';
2
+ import type { MsgHdrs, Payload } from 'nats';
3
+ import type { EventMetadata, ProducerOptions, PublishOptions } from './interfaces';
4
+ export declare abstract class EventsFactory<T extends EventType, K extends Uint8Array | string> {
5
+ protected readonly eventType: T;
6
+ private readonly payloadFormat;
7
+ constructor(eventType: T, config: ProducerOptions);
8
+ getPartitionKey<P extends Record<string, any>>(payload: P, options?: PublishOptions): string | undefined;
9
+ protected getMetadata(type: string, metadata: EventMetadata | undefined | null): Record<string, string>;
10
+ protected serializePayload<P extends EventPayload<T>>(payload: P): Payload;
11
+ abstract create(payload: EventPayload<T>, options?: PublishOptions): {
12
+ headers: MsgHdrs;
13
+ payload: K;
14
+ };
15
+ }
@@ -0,0 +1,60 @@
1
+ "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.EventsFactory = void 0;
7
+ const nats_common_1 = require("@rsdk/nats.common");
8
+ const camelCase_1 = __importDefault(require("lodash/camelCase"));
9
+ const get_1 = __importDefault(require("lodash/get"));
10
+ class EventsFactory {
11
+ eventType;
12
+ payloadFormat;
13
+ constructor(eventType, config) {
14
+ this.eventType = eventType;
15
+ this.payloadFormat = config.payloadFormat ?? nats_common_1.DEFAULT_PAYLOAD_FORMAT;
16
+ }
17
+ getPartitionKey(payload, options) {
18
+ /**
19
+ * Если ключ партиционирования передаётся
20
+ * в опциях явно - берём его
21
+ */
22
+ if (options?.partitionKey) {
23
+ return String(options.partitionKey);
24
+ }
25
+ /**
26
+ * Если в типе события определено имя ключевого поля,
27
+ * извлекаем его значение и используем
28
+ */
29
+ const { $partitionKeyField } = this.eventType;
30
+ if ($partitionKeyField && typeof $partitionKeyField === 'string') {
31
+ // TODO: Может быть лучше ошибку кидать?
32
+ return ((0, get_1.default)(payload, $partitionKeyField) ??
33
+ (0, get_1.default)(payload, (0, camelCase_1.default)($partitionKeyField)));
34
+ }
35
+ /**
36
+ * Ищем последовательно поля id, uuid, guid,
37
+ * если ничего не найдено, используем генерируем
38
+ * ключ случайным образом
39
+ */
40
+ return (0, get_1.default)(payload, 'id') ?? (0, get_1.default)(payload, 'uuid') ?? (0, get_1.default)(payload, 'guid');
41
+ }
42
+ getMetadata(type, metadata) {
43
+ return {
44
+ ...metadata,
45
+ [nats_common_1.X_TYPE_HEADER]: type,
46
+ ...(this.payloadFormat &&
47
+ this.payloadFormat !== nats_common_1.DEFAULT_PAYLOAD_FORMAT && {
48
+ [nats_common_1.X_FORMAT_HEADER]: this.payloadFormat,
49
+ }),
50
+ };
51
+ }
52
+ serializePayload(payload) {
53
+ const codec = this.payloadFormat === nats_common_1.PayloadFormat.JSON
54
+ ? new nats_common_1.JSONEventCodec()
55
+ : new nats_common_1.ProtoEventCodec(this.eventType);
56
+ return codec.encode(payload);
57
+ }
58
+ }
59
+ exports.EventsFactory = EventsFactory;
60
+ //# sourceMappingURL=event-factory.abstract.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"event-factory.abstract.js","sourceRoot":"","sources":["../src/event-factory.abstract.ts"],"names":[],"mappings":";;;;;;AACA,mDAO2B;AAC3B,iEAAyC;AACzC,qDAA6B;AAS7B,MAAsB,aAAa;IAOZ;IAHJ,aAAa,CAAgB;IAE9C,YACqB,SAAY,EAC/B,MAAuB;QADJ,cAAS,GAAT,SAAS,CAAG;QAG/B,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,aAAa,IAAI,oCAAsB,CAAC;IACtE,CAAC;IAEM,eAAe,CACpB,OAAU,EACV,OAAwB;QAExB;;;WAGG;QACH,IAAI,OAAO,EAAE,YAAY,EAAE,CAAC;YAC1B,OAAO,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;QACtC,CAAC;QAED;;;WAGG;QACH,MAAM,EAAE,kBAAkB,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC;QAC9C,IAAI,kBAAkB,IAAI,OAAO,kBAAkB,KAAK,QAAQ,EAAE,CAAC;YACjE,wCAAwC;YACxC,OAAO,CACL,IAAA,aAAG,EAAC,OAAO,EAAE,kBAAkB,CAAC;gBAChC,IAAA,aAAG,EAAC,OAAO,EAAE,IAAA,mBAAS,EAAC,kBAAkB,CAAC,CAAC,CAC5C,CAAC;QACJ,CAAC;QAED;;;;WAIG;QACH,OAAO,IAAA,aAAG,EAAC,OAAO,EAAE,IAAI,CAAC,IAAI,IAAA,aAAG,EAAC,OAAO,EAAE,MAAM,CAAC,IAAI,IAAA,aAAG,EAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IAC5E,CAAC;IAES,WAAW,CACnB,IAAY,EACZ,QAA0C;QAE1C,OAAO;YACL,GAAG,QAAQ;YACX,CAAC,2BAAa,CAAC,EAAE,IAAI;YACrB,GAAG,CAAC,IAAI,CAAC,aAAa;gBACpB,IAAI,CAAC,aAAa,KAAK,oCAAsB,IAAI;gBAC/C,CAAC,6BAAe,CAAC,EAAE,IAAI,CAAC,aAAa;aACtC,CAAC;SACL,CAAC;IACJ,CAAC;IAES,gBAAgB,CAA4B,OAAU;QAC9D,MAAM,KAAK,GACT,IAAI,CAAC,aAAa,KAAK,2BAAa,CAAC,IAAI;YACvC,CAAC,CAAC,IAAI,4BAAc,EAAK;YACzB,CAAC,CAAC,IAAI,6BAAe,CAAI,IAAI,CAAC,SAAS,CAAC,CAAC;QAE7C,OAAO,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAC/B,CAAC;CAMF;AAzED,sCAyEC"}
@@ -0,0 +1,3 @@
1
+ export { EventsFactory } from './event-factory.abstract';
2
+ export { NatsProducer, PublishOptions, ProducerOptions, EventMetadata, } from './interfaces';
3
+ export { ProducerConfig } from './producer.config';
package/dist/index.js ADDED
@@ -0,0 +1,8 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.ProducerConfig = exports.EventsFactory = void 0;
4
+ var event_factory_abstract_1 = require("./event-factory.abstract");
5
+ Object.defineProperty(exports, "EventsFactory", { enumerable: true, get: function () { return event_factory_abstract_1.EventsFactory; } });
6
+ var producer_config_1 = require("./producer.config");
7
+ Object.defineProperty(exports, "ProducerConfig", { enumerable: true, get: function () { return producer_config_1.ProducerConfig; } });
8
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,mEAAyD;AAAhD,uHAAA,aAAa,OAAA;AAQtB,qDAAmD;AAA1C,iHAAA,cAAc,OAAA"}
@@ -0,0 +1,14 @@
1
+ import type { EventPayload, EventType, PayloadFormat } from '@rsdk/nats.common';
2
+ export interface ProducerOptions {
3
+ payloadFormat?: PayloadFormat;
4
+ }
5
+ export type EventMetadata = Record<string, unknown>;
6
+ export interface PublishOptions {
7
+ /** Metadata must be a plain object. Object will be stringified */
8
+ metadata?: EventMetadata;
9
+ /** Override partition key */
10
+ partitionKey?: string | number;
11
+ }
12
+ export interface NatsProducer<E extends EventType> {
13
+ publish<P extends EventPayload<E>>(payload: P, options?: PublishOptions): Promise<void>;
14
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=interfaces.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":""}
@@ -0,0 +1,6 @@
1
+ import { Config } from '@rsdk/core';
2
+ import { PayloadFormat } from '@rsdk/nats.common';
3
+ import type { ProducerOptions } from './interfaces';
4
+ export declare class ProducerConfig extends Config implements ProducerOptions {
5
+ payloadFormat: PayloadFormat;
6
+ }
@@ -0,0 +1,32 @@
1
+ "use strict";
2
+ var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
3
+ var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
4
+ if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
5
+ 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;
6
+ return c > 3 && r && Object.defineProperty(target, key, r), r;
7
+ };
8
+ var __metadata = (this && this.__metadata) || function (k, v) {
9
+ if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
10
+ };
11
+ Object.defineProperty(exports, "__esModule", { value: true });
12
+ exports.ProducerConfig = void 0;
13
+ const core_1 = require("@rsdk/core");
14
+ const nats_common_1 = require("@rsdk/nats.common");
15
+ let ProducerConfig = class ProducerConfig extends core_1.Config {
16
+ payloadFormat;
17
+ };
18
+ exports.ProducerConfig = ProducerConfig;
19
+ __decorate([
20
+ (0, core_1.Property)('NATS_PAYLOAD_FORMAT', new core_1.EnumParser(nats_common_1.PayloadFormat), {
21
+ description: 'Option for producer payload serializer',
22
+ defaultValue: nats_common_1.DEFAULT_PAYLOAD_FORMAT,
23
+ }),
24
+ __metadata("design:type", String)
25
+ ], ProducerConfig.prototype, "payloadFormat", void 0);
26
+ exports.ProducerConfig = ProducerConfig = __decorate([
27
+ (0, core_1.ConfigSection)({
28
+ name: 'Nats producer config',
29
+ tags: [core_1.ConfigTag.infrastructure, core_1.ConfigTag.storage],
30
+ })
31
+ ], ProducerConfig);
32
+ //# sourceMappingURL=producer.config.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"producer.config.js","sourceRoot":"","sources":["../src/producer.config.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,qCAMoB;AACpB,mDAA0E;AAQnE,IAAM,cAAc,GAApB,MAAM,cAAe,SAAQ,aAAM;IAKxC,aAAa,CAAiB;CAC/B,CAAA;AANY,wCAAc;AAKzB;IAJC,IAAA,eAAQ,EAAC,qBAAqB,EAAE,IAAI,iBAAU,CAAC,2BAAa,CAAC,EAAE;QAC9D,WAAW,EAAE,wCAAwC;QACrD,YAAY,EAAE,oCAAsB;KACrC,CAAC;;qDAC4B;yBALnB,cAAc;IAJ1B,IAAA,oBAAa,EAAC;QACb,IAAI,EAAE,sBAAsB;QAC5B,IAAI,EAAE,CAAC,gBAAS,CAAC,cAAc,EAAE,gBAAS,CAAC,OAAO,CAAC;KACpD,CAAC;GACW,cAAc,CAM1B"}
package/package.json ADDED
@@ -0,0 +1,27 @@
1
+ {
2
+ "name": "@rsdk/nats.producer",
3
+ "version": "5.3.0-next.4",
4
+ "description": "Publishers for Nats",
5
+ "license": "Apache License 2.0",
6
+ "publishConfig": {
7
+ "access": "public"
8
+ },
9
+ "repository": {
10
+ "url": "https://github.com/R-Vision/rsdk"
11
+ },
12
+ "main": "dist/index.js",
13
+ "peerDependencies": {
14
+ "@nestjs/common": "^10.0.0",
15
+ "@nestjs/core": "^10.0.0",
16
+ "@nestjs/microservices": "^10.0.0",
17
+ "@rsdk/common": "*",
18
+ "@rsdk/core": "*",
19
+ "@rsdk/logging": "*",
20
+ "@rsdk/nats.common": "*",
21
+ "lodash": "^4.17.21",
22
+ "nats": "^2.28.2",
23
+ "reflect-metadata": "^0.1.12 || ^0.2.0",
24
+ "rxjs": "^7.8.1"
25
+ },
26
+ "gitHead": "6d80aacd87b9cc36cfcff8c0c050e4fe31810276"
27
+ }
@@ -0,0 +1,93 @@
1
+ import type { EventPayload, EventType } from '@rsdk/nats.common';
2
+ import {
3
+ DEFAULT_PAYLOAD_FORMAT,
4
+ JSONEventCodec,
5
+ PayloadFormat,
6
+ ProtoEventCodec,
7
+ X_FORMAT_HEADER,
8
+ X_TYPE_HEADER,
9
+ } from '@rsdk/nats.common';
10
+ import camelCase from 'lodash/camelCase';
11
+ import get from 'lodash/get';
12
+ import type { MsgHdrs, Payload } from 'nats';
13
+
14
+ import type {
15
+ EventMetadata,
16
+ ProducerOptions,
17
+ PublishOptions,
18
+ } from './interfaces';
19
+
20
+ export abstract class EventsFactory<
21
+ T extends EventType,
22
+ K extends Uint8Array | string,
23
+ > {
24
+ private readonly payloadFormat: PayloadFormat;
25
+
26
+ constructor(
27
+ protected readonly eventType: T,
28
+ config: ProducerOptions,
29
+ ) {
30
+ this.payloadFormat = config.payloadFormat ?? DEFAULT_PAYLOAD_FORMAT;
31
+ }
32
+
33
+ public getPartitionKey<P extends Record<string, any>>(
34
+ payload: P,
35
+ options?: PublishOptions,
36
+ ): string | undefined {
37
+ /**
38
+ * Если ключ партиционирования передаётся
39
+ * в опциях явно - берём его
40
+ */
41
+ if (options?.partitionKey) {
42
+ return String(options.partitionKey);
43
+ }
44
+
45
+ /**
46
+ * Если в типе события определено имя ключевого поля,
47
+ * извлекаем его значение и используем
48
+ */
49
+ const { $partitionKeyField } = this.eventType;
50
+ if ($partitionKeyField && typeof $partitionKeyField === 'string') {
51
+ // TODO: Может быть лучше ошибку кидать?
52
+ return (
53
+ get(payload, $partitionKeyField) ??
54
+ get(payload, camelCase($partitionKeyField))
55
+ );
56
+ }
57
+
58
+ /**
59
+ * Ищем последовательно поля id, uuid, guid,
60
+ * если ничего не найдено, используем генерируем
61
+ * ключ случайным образом
62
+ */
63
+ return get(payload, 'id') ?? get(payload, 'uuid') ?? get(payload, 'guid');
64
+ }
65
+
66
+ protected getMetadata(
67
+ type: string,
68
+ metadata: EventMetadata | undefined | null,
69
+ ): Record<string, string> {
70
+ return {
71
+ ...metadata,
72
+ [X_TYPE_HEADER]: type,
73
+ ...(this.payloadFormat &&
74
+ this.payloadFormat !== DEFAULT_PAYLOAD_FORMAT && {
75
+ [X_FORMAT_HEADER]: this.payloadFormat,
76
+ }),
77
+ };
78
+ }
79
+
80
+ protected serializePayload<P extends EventPayload<T>>(payload: P): Payload {
81
+ const codec =
82
+ this.payloadFormat === PayloadFormat.JSON
83
+ ? new JSONEventCodec<T>()
84
+ : new ProtoEventCodec<T>(this.eventType);
85
+
86
+ return codec.encode(payload);
87
+ }
88
+
89
+ abstract create(
90
+ payload: EventPayload<T>,
91
+ options?: PublishOptions,
92
+ ): { headers: MsgHdrs; payload: K };
93
+ }
package/src/index.ts ADDED
@@ -0,0 +1,9 @@
1
+ export { EventsFactory } from './event-factory.abstract';
2
+
3
+ export {
4
+ NatsProducer,
5
+ PublishOptions,
6
+ ProducerOptions,
7
+ EventMetadata,
8
+ } from './interfaces';
9
+ export { ProducerConfig } from './producer.config';
@@ -0,0 +1,22 @@
1
+ import type { EventPayload, EventType, PayloadFormat } from '@rsdk/nats.common';
2
+
3
+ export interface ProducerOptions {
4
+ payloadFormat?: PayloadFormat;
5
+ }
6
+
7
+ export type EventMetadata = Record<string, unknown>;
8
+
9
+ export interface PublishOptions {
10
+ /** Metadata must be a plain object. Object will be stringified */
11
+ metadata?: EventMetadata;
12
+
13
+ /** Override partition key */
14
+ partitionKey?: string | number;
15
+ }
16
+
17
+ export interface NatsProducer<E extends EventType> {
18
+ publish<P extends EventPayload<E>>(
19
+ payload: P,
20
+ options?: PublishOptions,
21
+ ): Promise<void>;
22
+ }
@@ -0,0 +1,22 @@
1
+ import {
2
+ Config,
3
+ ConfigSection,
4
+ ConfigTag,
5
+ EnumParser,
6
+ Property,
7
+ } from '@rsdk/core';
8
+ import { DEFAULT_PAYLOAD_FORMAT, PayloadFormat } from '@rsdk/nats.common';
9
+
10
+ import type { ProducerOptions } from './interfaces';
11
+
12
+ @ConfigSection({
13
+ name: 'Nats producer config',
14
+ tags: [ConfigTag.infrastructure, ConfigTag.storage],
15
+ })
16
+ export class ProducerConfig extends Config implements ProducerOptions {
17
+ @Property('NATS_PAYLOAD_FORMAT', new EnumParser(PayloadFormat), {
18
+ description: 'Option for producer payload serializer',
19
+ defaultValue: DEFAULT_PAYLOAD_FORMAT,
20
+ })
21
+ payloadFormat!: PayloadFormat;
22
+ }
@@ -0,0 +1,12 @@
1
+ {
2
+ "extends": "./tsconfig.json",
3
+ "exclude": [
4
+ "node_modules",
5
+ "dist",
6
+ "test",
7
+ "**/*.spec.ts",
8
+ "**/*.test.ts",
9
+ "**/*.test.e2e.ts",
10
+ "**/*.test.manual-e2e.ts",
11
+ ]
12
+ }
package/tsconfig.json ADDED
@@ -0,0 +1,7 @@
1
+ {
2
+ "extends": "@rsdk/tsconfig/base.json",
3
+ "compilerOptions": {
4
+ "declaration": true,
5
+ "outDir": "dist"
6
+ }
7
+ }