@flusys/nestjs-shared 6.4.1 → 7.0.0

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.
Files changed (111) hide show
  1. package/README.md +437 -0
  2. package/cjs/classes/api-service.class.js +71 -8
  3. package/cjs/classes/api-service.class.spec.js +220 -0
  4. package/cjs/classes/disabled-event-bus.class.js +15 -0
  5. package/cjs/classes/disabled-event-bus.class.spec.js +40 -0
  6. package/cjs/classes/domain-event.publisher.js +76 -0
  7. package/cjs/classes/domain-event.publisher.spec.js +234 -0
  8. package/cjs/classes/event-bus.registry.js +69 -0
  9. package/cjs/classes/event-bus.registry.spec.js +116 -0
  10. package/cjs/classes/event-transports/event-transport.registry.js +41 -0
  11. package/cjs/classes/event-transports/event-transport.registry.spec.js +31 -0
  12. package/cjs/classes/event-transports/index.js +23 -0
  13. package/cjs/classes/event-transports/kafka-transport.optional.js +151 -0
  14. package/cjs/classes/event-transports/kafka-transport.optional.spec.js +199 -0
  15. package/cjs/classes/event-transports/memory-transport.js +54 -0
  16. package/cjs/classes/event-transports/memory-transport.spec.js +58 -0
  17. package/cjs/classes/event-transports/rabbitmq-transport.optional.js +184 -0
  18. package/cjs/classes/event-transports/rabbitmq-transport.optional.spec.js +256 -0
  19. package/cjs/classes/hybrid-event-bus.class.js +261 -0
  20. package/cjs/classes/hybrid-event-bus.class.spec.js +189 -0
  21. package/cjs/classes/index.js +5 -0
  22. package/cjs/constants/index.js +24 -0
  23. package/cjs/decorators/index.js +1 -0
  24. package/cjs/decorators/on-domain-event.decorator.js +13 -0
  25. package/cjs/decorators/on-domain-event.decorator.spec.js +50 -0
  26. package/cjs/entities/user-root.js +2 -2
  27. package/cjs/enums/event-action.enum.js +18 -0
  28. package/cjs/enums/index.js +1 -0
  29. package/cjs/interfaces/event-bus.interface.js +4 -0
  30. package/cjs/interfaces/index.js +1 -0
  31. package/cjs/modules/event-bus/event-bus.explorer.js +124 -0
  32. package/cjs/modules/event-bus/event-bus.explorer.spec.js +189 -0
  33. package/cjs/modules/event-bus/event-bus.integration.spec.js +254 -0
  34. package/cjs/modules/event-bus/event-bus.module.js +94 -0
  35. package/cjs/modules/event-bus/event-bus.module.spec.js +149 -0
  36. package/cjs/modules/event-bus/module-events.provider.js +39 -0
  37. package/cjs/modules/event-bus/module-events.provider.spec.js +56 -0
  38. package/cjs/modules/index.js +3 -0
  39. package/cjs/utils/event-pattern.util.js +98 -0
  40. package/cjs/utils/event-pattern.util.spec.js +234 -0
  41. package/cjs/utils/index.js +2 -0
  42. package/cjs/utils/optional-module.util.js +35 -0
  43. package/cjs/utils/optional-module.util.spec.js +14 -0
  44. package/classes/api-service.class.d.ts +11 -1
  45. package/classes/disabled-event-bus.class.d.ts +6 -0
  46. package/classes/domain-event.publisher.d.ts +14 -0
  47. package/classes/event-bus.registry.d.ts +14 -0
  48. package/classes/event-transports/event-transport.registry.d.ts +10 -0
  49. package/classes/event-transports/index.d.ts +2 -0
  50. package/classes/event-transports/kafka-transport.optional.d.ts +21 -0
  51. package/classes/event-transports/memory-transport.d.ts +13 -0
  52. package/classes/event-transports/rabbitmq-transport.optional.d.ts +27 -0
  53. package/classes/hybrid-event-bus.class.d.ts +32 -0
  54. package/classes/index.d.ts +5 -0
  55. package/constants/index.d.ts +6 -0
  56. package/decorators/index.d.ts +1 -0
  57. package/decorators/on-domain-event.decorator.d.ts +1 -0
  58. package/enums/event-action.enum.d.ts +7 -0
  59. package/enums/index.d.ts +1 -0
  60. package/fesm/classes/api-service.class.js +71 -8
  61. package/fesm/classes/api-service.class.spec.js +220 -0
  62. package/fesm/classes/disabled-event-bus.class.js +11 -0
  63. package/fesm/classes/disabled-event-bus.class.spec.js +36 -0
  64. package/fesm/classes/domain-event.publisher.js +63 -0
  65. package/fesm/classes/domain-event.publisher.spec.js +230 -0
  66. package/fesm/classes/event-bus.registry.js +65 -0
  67. package/fesm/classes/event-bus.registry.spec.js +112 -0
  68. package/fesm/classes/event-transports/event-transport.registry.js +35 -0
  69. package/fesm/classes/event-transports/event-transport.registry.spec.js +27 -0
  70. package/fesm/classes/event-transports/index.js +6 -0
  71. package/fesm/classes/event-transports/kafka-transport.optional.js +144 -0
  72. package/fesm/classes/event-transports/kafka-transport.optional.spec.js +195 -0
  73. package/fesm/classes/event-transports/memory-transport.js +46 -0
  74. package/fesm/classes/event-transports/memory-transport.spec.js +54 -0
  75. package/fesm/classes/event-transports/rabbitmq-transport.optional.js +174 -0
  76. package/fesm/classes/event-transports/rabbitmq-transport.optional.spec.js +252 -0
  77. package/fesm/classes/hybrid-event-bus.class.js +217 -0
  78. package/fesm/classes/hybrid-event-bus.class.spec.js +185 -0
  79. package/fesm/classes/index.js +5 -0
  80. package/fesm/constants/index.js +7 -0
  81. package/fesm/decorators/index.js +1 -0
  82. package/fesm/decorators/on-domain-event.decorator.js +10 -0
  83. package/fesm/decorators/on-domain-event.decorator.spec.js +46 -0
  84. package/fesm/entities/user-root.js +1 -1
  85. package/fesm/enums/event-action.enum.js +8 -0
  86. package/fesm/enums/index.js +1 -0
  87. package/fesm/interfaces/event-bus.interface.js +1 -0
  88. package/fesm/interfaces/index.js +1 -0
  89. package/fesm/modules/event-bus/event-bus.explorer.js +114 -0
  90. package/fesm/modules/event-bus/event-bus.explorer.spec.js +185 -0
  91. package/fesm/modules/event-bus/event-bus.integration.spec.js +250 -0
  92. package/fesm/modules/event-bus/event-bus.module.js +84 -0
  93. package/fesm/modules/event-bus/event-bus.module.spec.js +145 -0
  94. package/fesm/modules/event-bus/module-events.provider.js +26 -0
  95. package/fesm/modules/event-bus/module-events.provider.spec.js +52 -0
  96. package/fesm/modules/index.js +3 -0
  97. package/fesm/utils/event-pattern.util.js +86 -0
  98. package/fesm/utils/event-pattern.util.spec.js +230 -0
  99. package/fesm/utils/index.js +2 -0
  100. package/fesm/utils/optional-module.util.js +25 -0
  101. package/fesm/utils/optional-module.util.spec.js +10 -0
  102. package/interfaces/event-bus.interface.d.ts +74 -0
  103. package/interfaces/index.d.ts +1 -0
  104. package/modules/event-bus/event-bus.explorer.d.ts +14 -0
  105. package/modules/event-bus/event-bus.module.d.ts +8 -0
  106. package/modules/event-bus/module-events.provider.d.ts +3 -0
  107. package/modules/index.d.ts +3 -0
  108. package/package.json +2 -2
  109. package/utils/event-pattern.util.d.ts +3 -0
  110. package/utils/index.d.ts +2 -0
  111. package/utils/optional-module.util.d.ts +1 -0
@@ -0,0 +1,124 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", {
3
+ value: true
4
+ });
5
+ Object.defineProperty(exports, "EventBusExplorer", {
6
+ enumerable: true,
7
+ get: function() {
8
+ return EventBusExplorer;
9
+ }
10
+ });
11
+ const _common = require("@nestjs/common");
12
+ const _core = require("@nestjs/core");
13
+ const _constants = require("../../constants");
14
+ function _define_property(obj, key, value) {
15
+ if (key in obj) {
16
+ Object.defineProperty(obj, key, {
17
+ value: value,
18
+ enumerable: true,
19
+ configurable: true,
20
+ writable: true
21
+ });
22
+ } else {
23
+ obj[key] = value;
24
+ }
25
+ return obj;
26
+ }
27
+ function _ts_decorate(decorators, target, key, desc) {
28
+ var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
29
+ if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
30
+ 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;
31
+ return c > 3 && r && Object.defineProperty(target, key, r), r;
32
+ }
33
+ function _ts_metadata(k, v) {
34
+ if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
35
+ }
36
+ function _ts_param(paramIndex, decorator) {
37
+ return function(target, key) {
38
+ decorator(target, key, paramIndex);
39
+ };
40
+ }
41
+ let EventBusExplorer = class EventBusExplorer {
42
+ async onApplicationBootstrap() {
43
+ const bus = this.eventBus;
44
+ if (!bus) return;
45
+ const wrappers = [
46
+ ...this.discovery.getProviders(),
47
+ ...this.discovery.getControllers()
48
+ ];
49
+ // The same provider is returned once per module that registers it; binding
50
+ // it twice would run every handler twice for a single event.
51
+ const seen = new Set();
52
+ let bound = 0;
53
+ for (const wrapper of wrappers){
54
+ const instance = wrapper.instance;
55
+ if (!instance || typeof instance !== 'object' || wrapper.isNotMetatype) {
56
+ this.warnIfUnreachableConsumer(wrapper);
57
+ continue;
58
+ }
59
+ if (seen.has(instance)) continue;
60
+ seen.add(instance);
61
+ bound += await this.bindInstance(instance, bus);
62
+ }
63
+ if (bound) {
64
+ const active = bus.getActiveTransports();
65
+ this.logger.log(`Bound ${bound} domain event handler(s); transport '${bus.getTransportLabel()}' ` + `live over ${active.length ? active.join(', ') : 'no transport'}`);
66
+ }
67
+ }
68
+ async bindInstance(instance, bus) {
69
+ const prototype = Object.getPrototypeOf(instance);
70
+ if (!prototype) return 0;
71
+ let bound = 0;
72
+ for (const methodName of this.metadataScanner.getAllMethodNames(prototype)){
73
+ const method = instance[methodName];
74
+ const patterns = this.readPatterns(method);
75
+ if (!patterns.length) continue;
76
+ const handler = method;
77
+ for (const pattern of patterns){
78
+ await bus.subscribe(pattern, (event)=>handler.call(instance, event));
79
+ bound++;
80
+ }
81
+ }
82
+ return bound;
83
+ }
84
+ /**
85
+ * A request scoped provider has no singleton instance to bind, so its
86
+ * handlers would never run - that must not fail silently.
87
+ */ warnIfUnreachableConsumer(wrapper) {
88
+ const prototype = wrapper.metatype?.prototype;
89
+ if (wrapper.instance || !prototype) return;
90
+ const hasHandler = this.metadataScanner.getAllMethodNames(prototype).some((methodName)=>this.readPatterns(prototype[methodName]).length > 0);
91
+ if (hasHandler) {
92
+ this.logger.warn(`${wrapper.name} declares @OnDomainEvent methods but has no singleton instance ` + `(request scoped providers cannot consume events) - move the handler to a default scoped provider`);
93
+ }
94
+ }
95
+ readPatterns(method) {
96
+ if (typeof method !== 'function') return [];
97
+ return Reflect.getMetadata(_constants.DOMAIN_EVENT_HANDLER_KEY, method) ?? [];
98
+ }
99
+ // NOTE: @Inject() required for bundled code - type metadata may be lost during esbuild
100
+ // @Optional() so nothing here is a hard dependency on EventBusModule being registered
101
+ constructor(eventBus, discovery, metadataScanner){
102
+ _define_property(this, "eventBus", void 0);
103
+ _define_property(this, "discovery", void 0);
104
+ _define_property(this, "metadataScanner", void 0);
105
+ _define_property(this, "logger", void 0);
106
+ this.eventBus = eventBus;
107
+ this.discovery = discovery;
108
+ this.metadataScanner = metadataScanner;
109
+ this.logger = new _common.Logger(EventBusExplorer.name);
110
+ }
111
+ };
112
+ EventBusExplorer = _ts_decorate([
113
+ (0, _common.Injectable)(),
114
+ _ts_param(0, (0, _common.Optional)()),
115
+ _ts_param(0, (0, _common.Inject)(_constants.EVENT_BUS_INSTANCE)),
116
+ _ts_param(1, (0, _common.Inject)(_core.DiscoveryService)),
117
+ _ts_param(2, (0, _common.Inject)(_core.MetadataScanner)),
118
+ _ts_metadata("design:type", Function),
119
+ _ts_metadata("design:paramtypes", [
120
+ Object,
121
+ typeof _core.DiscoveryService === "undefined" ? Object : _core.DiscoveryService,
122
+ typeof _core.MetadataScanner === "undefined" ? Object : _core.MetadataScanner
123
+ ])
124
+ ], EventBusExplorer);
@@ -0,0 +1,189 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", {
3
+ value: true
4
+ });
5
+ const _common = require("@nestjs/common");
6
+ const _core = require("@nestjs/core");
7
+ const _ondomaineventdecorator = require("../../decorators/on-domain-event.decorator");
8
+ const _eventbusexplorer = require("./event-bus.explorer");
9
+ function _define_property(obj, key, value) {
10
+ if (key in obj) {
11
+ Object.defineProperty(obj, key, {
12
+ value: value,
13
+ enumerable: true,
14
+ configurable: true,
15
+ writable: true
16
+ });
17
+ } else {
18
+ obj[key] = value;
19
+ }
20
+ return obj;
21
+ }
22
+ function _ts_decorate(decorators, target, key, desc) {
23
+ var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
24
+ if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
25
+ 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;
26
+ return c > 3 && r && Object.defineProperty(target, key, r), r;
27
+ }
28
+ function _ts_metadata(k, v) {
29
+ if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
30
+ }
31
+ let Consumer = class Consumer {
32
+ onCreated(event) {
33
+ this.received.push(event.name);
34
+ }
35
+ onAuthOrIam() {}
36
+ notAHandler() {}
37
+ constructor(){
38
+ _define_property(this, "received", []);
39
+ }
40
+ };
41
+ _ts_decorate([
42
+ (0, _ondomaineventdecorator.OnDomainEvent)('storage.*.created'),
43
+ _ts_metadata("design:type", Function),
44
+ _ts_metadata("design:paramtypes", [
45
+ Object
46
+ ]),
47
+ _ts_metadata("design:returntype", void 0)
48
+ ], Consumer.prototype, "onCreated", null);
49
+ _ts_decorate([
50
+ (0, _ondomaineventdecorator.OnDomainEvent)('auth.#', 'iam.#'),
51
+ _ts_metadata("design:type", Function),
52
+ _ts_metadata("design:paramtypes", []),
53
+ _ts_metadata("design:returntype", void 0)
54
+ ], Consumer.prototype, "onAuthOrIam", null);
55
+ function createExplorer(wrappers) {
56
+ const eventBus = {
57
+ subscribe: jest.fn().mockResolvedValue(undefined),
58
+ getTransportLabel: ()=>'memory',
59
+ getActiveTransports: ()=>[
60
+ 'memory'
61
+ ]
62
+ };
63
+ const discovery = {
64
+ getProviders: ()=>wrappers.map((wrapper)=>wrapper && typeof wrapper === 'object' && 'instance' in wrapper ? wrapper : {
65
+ instance: wrapper,
66
+ isNotMetatype: false
67
+ }),
68
+ getControllers: ()=>[]
69
+ };
70
+ return {
71
+ eventBus,
72
+ explorer: new _eventbusexplorer.EventBusExplorer(eventBus, discovery, new _core.MetadataScanner())
73
+ };
74
+ }
75
+ describe('EventBusExplorer', ()=>{
76
+ it('should subscribe every decorated method with all of its patterns', async ()=>{
77
+ const { eventBus, explorer } = createExplorer([
78
+ new Consumer()
79
+ ]);
80
+ await explorer.onApplicationBootstrap();
81
+ expect(eventBus.subscribe).toHaveBeenCalledTimes(3);
82
+ expect(eventBus.subscribe.mock.calls.map(([pattern])=>pattern)).toEqual([
83
+ 'storage.*.created',
84
+ 'auth.#',
85
+ 'iam.#'
86
+ ]);
87
+ });
88
+ it('should bind a handler that calls back into the owning instance', async ()=>{
89
+ const consumer = new Consumer();
90
+ const { eventBus, explorer } = createExplorer([
91
+ consumer
92
+ ]);
93
+ await explorer.onApplicationBootstrap();
94
+ const [, handler] = eventBus.subscribe.mock.calls[0];
95
+ handler({
96
+ name: 'storage.folder.created'
97
+ });
98
+ expect(consumer.received).toEqual([
99
+ 'storage.folder.created'
100
+ ]);
101
+ });
102
+ it('should ignore providers without decorated methods', async ()=>{
103
+ const { eventBus, explorer } = createExplorer([
104
+ {
105
+ plain: ()=>undefined
106
+ }
107
+ ]);
108
+ await explorer.onApplicationBootstrap();
109
+ expect(eventBus.subscribe).not.toHaveBeenCalled();
110
+ });
111
+ it('should ignore null instances', async ()=>{
112
+ const { eventBus, explorer } = createExplorer([
113
+ null,
114
+ undefined
115
+ ]);
116
+ await explorer.onApplicationBootstrap();
117
+ expect(eventBus.subscribe).not.toHaveBeenCalled();
118
+ });
119
+ it('should bind an instance once even when several modules expose it', async ()=>{
120
+ const consumer = new Consumer();
121
+ const { eventBus, explorer } = createExplorer([
122
+ consumer,
123
+ consumer
124
+ ]);
125
+ await explorer.onApplicationBootstrap();
126
+ expect(eventBus.subscribe).toHaveBeenCalledTimes(3);
127
+ });
128
+ it('should deliver an event once to a provider shared by several modules', async ()=>{
129
+ const consumer = new Consumer();
130
+ const { eventBus, explorer } = createExplorer([
131
+ consumer,
132
+ consumer
133
+ ]);
134
+ await explorer.onApplicationBootstrap();
135
+ const handlers = eventBus.subscribe.mock.calls.filter(([pattern])=>pattern === 'storage.*.created').map(([, handler])=>handler);
136
+ handlers.forEach((handler)=>handler({
137
+ name: 'storage.folder.created'
138
+ }));
139
+ expect(consumer.received).toEqual([
140
+ 'storage.folder.created'
141
+ ]);
142
+ });
143
+ it('should warn about a consumer that has no singleton instance to bind', async ()=>{
144
+ const warn = jest.spyOn(_common.Logger.prototype, 'warn').mockImplementation(()=>undefined);
145
+ const { eventBus, explorer } = createExplorer([
146
+ {
147
+ instance: undefined,
148
+ name: 'ScopedConsumer',
149
+ metatype: Consumer,
150
+ isNotMetatype: false
151
+ }
152
+ ]);
153
+ await explorer.onApplicationBootstrap();
154
+ expect(eventBus.subscribe).not.toHaveBeenCalled();
155
+ expect(warn).toHaveBeenCalledWith(expect.stringContaining('ScopedConsumer'));
156
+ warn.mockRestore();
157
+ });
158
+ it('should stay quiet about a scoped provider that declares no handler', async ()=>{
159
+ const warn = jest.spyOn(_common.Logger.prototype, 'warn').mockImplementation(()=>undefined);
160
+ let Plain = class Plain {
161
+ doWork() {}
162
+ };
163
+ const { explorer } = createExplorer([
164
+ {
165
+ instance: undefined,
166
+ name: 'Plain',
167
+ metatype: Plain,
168
+ isNotMetatype: false
169
+ }
170
+ ]);
171
+ await explorer.onApplicationBootstrap();
172
+ expect(warn).not.toHaveBeenCalled();
173
+ warn.mockRestore();
174
+ });
175
+ it('should do nothing when no event bus is provided', async ()=>{
176
+ const discovery = {
177
+ getProviders: jest.fn(()=>[
178
+ {
179
+ instance: new Consumer(),
180
+ isNotMetatype: false
181
+ }
182
+ ]),
183
+ getControllers: ()=>[]
184
+ };
185
+ const explorer = new _eventbusexplorer.EventBusExplorer(undefined, discovery, new _core.MetadataScanner());
186
+ await expect(explorer.onApplicationBootstrap()).resolves.toBeUndefined();
187
+ expect(discovery.getProviders).not.toHaveBeenCalled();
188
+ });
189
+ });
@@ -0,0 +1,254 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", {
3
+ value: true
4
+ });
5
+ const _common = require("@nestjs/common");
6
+ const _testing = require("@nestjs/testing");
7
+ const _domaineventpublisher = require("../../classes/domain-event.publisher");
8
+ const _eventbusregistry = require("../../classes/event-bus.registry");
9
+ const _constants = require("../../constants");
10
+ const _ondomaineventdecorator = require("../../decorators/on-domain-event.decorator");
11
+ const _eventactionenum = require("../../enums/event-action.enum");
12
+ const _interfaces = require("../../interfaces");
13
+ const _eventbusmodule = require("./event-bus.module");
14
+ const _moduleeventsprovider = require("./module-events.provider");
15
+ function _define_property(obj, key, value) {
16
+ if (key in obj) {
17
+ Object.defineProperty(obj, key, {
18
+ value: value,
19
+ enumerable: true,
20
+ configurable: true,
21
+ writable: true
22
+ });
23
+ } else {
24
+ obj[key] = value;
25
+ }
26
+ return obj;
27
+ }
28
+ function _ts_decorate(decorators, target, key, desc) {
29
+ var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
30
+ if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
31
+ 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;
32
+ return c > 3 && r && Object.defineProperty(target, key, r), r;
33
+ }
34
+ function _ts_metadata(k, v) {
35
+ if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
36
+ }
37
+ const STORAGE_MODULE_OPTIONS = 'STORAGE_MODULE_OPTIONS';
38
+ let AuditConsumer = class AuditConsumer {
39
+ onAny(event) {
40
+ this.everything.push(event.name);
41
+ }
42
+ onUploaded(event) {
43
+ this.uploads.push(String(event.payload.metadata?.location));
44
+ }
45
+ onCreated(event) {
46
+ this.creates.push(event.name);
47
+ }
48
+ constructor(){
49
+ _define_property(this, "everything", []);
50
+ _define_property(this, "uploads", []);
51
+ _define_property(this, "creates", []);
52
+ }
53
+ };
54
+ _ts_decorate([
55
+ (0, _ondomaineventdecorator.OnDomainEvent)('**'),
56
+ _ts_metadata("design:type", Function),
57
+ _ts_metadata("design:paramtypes", [
58
+ typeof _interfaces.DomainEvent === "undefined" ? Object : _interfaces.DomainEvent
59
+ ]),
60
+ _ts_metadata("design:returntype", void 0)
61
+ ], AuditConsumer.prototype, "onAny", null);
62
+ _ts_decorate([
63
+ (0, _ondomaineventdecorator.OnDomainEvent)('storage.file_manager.uploaded'),
64
+ _ts_metadata("design:type", Function),
65
+ _ts_metadata("design:paramtypes", [
66
+ typeof _interfaces.DomainEvent === "undefined" ? Object : _interfaces.DomainEvent
67
+ ]),
68
+ _ts_metadata("design:returntype", void 0)
69
+ ], AuditConsumer.prototype, "onUploaded", null);
70
+ _ts_decorate([
71
+ (0, _ondomaineventdecorator.OnDomainEvent)('storage.*.created', 'auth.*.created'),
72
+ _ts_metadata("design:type", Function),
73
+ _ts_metadata("design:paramtypes", [
74
+ typeof _interfaces.DomainEvent === "undefined" ? Object : _interfaces.DomainEvent
75
+ ]),
76
+ _ts_metadata("design:returntype", void 0)
77
+ ], AuditConsumer.prototype, "onCreated", null);
78
+ AuditConsumer = _ts_decorate([
79
+ (0, _common.Injectable)()
80
+ ], AuditConsumer);
81
+ function buildStorageModule(events) {
82
+ let FakeStorageModule = class FakeStorageModule {
83
+ };
84
+ FakeStorageModule = _ts_decorate([
85
+ (0, _common.Module)({
86
+ providers: [
87
+ {
88
+ provide: STORAGE_MODULE_OPTIONS,
89
+ useValue: {
90
+ config: {
91
+ events
92
+ }
93
+ }
94
+ },
95
+ (0, _moduleeventsprovider.createModuleEventsProvider)('storage', STORAGE_MODULE_OPTIONS)
96
+ ]
97
+ })
98
+ ], FakeStorageModule);
99
+ return FakeStorageModule;
100
+ }
101
+ async function bootstrap(events) {
102
+ const app = await _testing.Test.createTestingModule({
103
+ imports: [
104
+ _eventbusmodule.EventBusModule.forRoot({
105
+ transport: 'memory'
106
+ }),
107
+ buildStorageModule(events)
108
+ ],
109
+ providers: [
110
+ AuditConsumer
111
+ ]
112
+ }).compile();
113
+ await app.init();
114
+ return {
115
+ app,
116
+ consumer: app.get(AuditConsumer),
117
+ bus: app.get(_constants.EVENT_BUS_INSTANCE)
118
+ };
119
+ }
120
+ describe('EventBusModule (integration)', ()=>{
121
+ let app;
122
+ afterEach(async ()=>{
123
+ await app?.close();
124
+ app = undefined;
125
+ _eventbusregistry.EventBusRegistry.reset();
126
+ });
127
+ it('delivers a published event to every matching decorated handler', async ()=>{
128
+ const started = await bootstrap({
129
+ enabled: true
130
+ });
131
+ app = started.app;
132
+ await (0, _domaineventpublisher.publishDomainEvent)({
133
+ module: 'storage',
134
+ entity: 'file_manager',
135
+ action: 'uploaded',
136
+ ids: [
137
+ 'key-1'
138
+ ],
139
+ metadata: {
140
+ location: 'local'
141
+ }
142
+ });
143
+ expect(started.consumer.uploads).toEqual([
144
+ 'local'
145
+ ]);
146
+ expect(started.consumer.everything).toEqual([
147
+ 'storage.file_manager.uploaded'
148
+ ]);
149
+ expect(started.consumer.creates).toEqual([]);
150
+ });
151
+ it('routes a single segment wildcard to the right handler', async ()=>{
152
+ const started = await bootstrap({
153
+ enabled: true
154
+ });
155
+ app = started.app;
156
+ await (0, _domaineventpublisher.publishDomainEvent)({
157
+ module: 'storage',
158
+ entity: 'folder',
159
+ action: _eventactionenum.EventAction.CREATED,
160
+ ids: [
161
+ 'folder-1'
162
+ ]
163
+ });
164
+ expect(started.consumer.creates).toEqual([
165
+ 'storage.folder.created'
166
+ ]);
167
+ expect(started.consumer.uploads).toEqual([]);
168
+ });
169
+ it('publishes nothing when the feature module did not enable events', async ()=>{
170
+ const started = await bootstrap({
171
+ enabled: false
172
+ });
173
+ app = started.app;
174
+ await (0, _domaineventpublisher.publishDomainEvent)({
175
+ module: 'storage',
176
+ entity: 'file_manager',
177
+ action: 'uploaded',
178
+ ids: [
179
+ 'key-1'
180
+ ]
181
+ });
182
+ expect(started.consumer.everything).toEqual([]);
183
+ });
184
+ it('registers the feature module config supplied through its own options', async ()=>{
185
+ const started = await bootstrap({
186
+ enabled: true,
187
+ includePayload: false
188
+ });
189
+ app = started.app;
190
+ expect(_eventbusregistry.EventBusRegistry.getModuleConfig('storage')).toEqual({
191
+ enabled: true,
192
+ includePayload: false
193
+ });
194
+ expect(_eventbusregistry.EventBusRegistry.shouldIncludePayload('storage')).toBe(false);
195
+ });
196
+ it('exposes the bus for direct publish and subscribe', async ()=>{
197
+ const started = await bootstrap({
198
+ enabled: true
199
+ });
200
+ app = started.app;
201
+ const received = [];
202
+ await started.bus.subscribe('billing.#', (event)=>{
203
+ received.push(event.name);
204
+ });
205
+ await (0, _domaineventpublisher.publishDomainEvent)({
206
+ module: 'billing',
207
+ entity: 'invoice',
208
+ action: 'settled'
209
+ });
210
+ expect(received).toEqual([]);
211
+ _eventbusregistry.EventBusRegistry.configureModule('billing', {
212
+ enabled: true
213
+ });
214
+ await (0, _domaineventpublisher.publishDomainEvent)({
215
+ module: 'billing',
216
+ entity: 'invoice',
217
+ action: 'settled'
218
+ });
219
+ expect(received).toEqual([
220
+ 'billing.invoice.settled'
221
+ ]);
222
+ });
223
+ it('tears the bus down when the application shuts down', async ()=>{
224
+ const started = await bootstrap({
225
+ enabled: true
226
+ });
227
+ await started.app.close();
228
+ expect(_eventbusregistry.EventBusRegistry.getBus()).toBeUndefined();
229
+ });
230
+ it('boots an app that never registers EventBusModule and publishes nothing', async ()=>{
231
+ app = await _testing.Test.createTestingModule({
232
+ imports: [
233
+ buildStorageModule({
234
+ enabled: true
235
+ })
236
+ ],
237
+ providers: [
238
+ AuditConsumer
239
+ ]
240
+ }).compile();
241
+ await app.init();
242
+ const consumer = app.get(AuditConsumer);
243
+ await (0, _domaineventpublisher.publishDomainEvent)({
244
+ module: 'storage',
245
+ entity: 'file_manager',
246
+ action: 'uploaded',
247
+ ids: [
248
+ 'key-1'
249
+ ]
250
+ });
251
+ expect(_eventbusregistry.EventBusRegistry.getBus()).toBeUndefined();
252
+ expect(consumer.everything).toEqual([]);
253
+ });
254
+ });
@@ -0,0 +1,94 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", {
3
+ value: true
4
+ });
5
+ Object.defineProperty(exports, "EventBusModule", {
6
+ enumerable: true,
7
+ get: function() {
8
+ return EventBusModule;
9
+ }
10
+ });
11
+ const _config = require("@flusys/nestjs-core/config");
12
+ const _common = require("@nestjs/common");
13
+ const _core = require("@nestjs/core");
14
+ const _disabledeventbusclass = require("../../classes/disabled-event-bus.class");
15
+ const _eventbusregistry = require("../../classes/event-bus.registry");
16
+ const _hybrideventbusclass = require("../../classes/hybrid-event-bus.class");
17
+ const _constants = require("../../constants");
18
+ const _eventbusexplorer = require("./event-bus.explorer");
19
+ function _ts_decorate(decorators, target, key, desc) {
20
+ var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
21
+ if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
22
+ 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;
23
+ return c > 3 && r && Object.defineProperty(target, key, r), r;
24
+ }
25
+ let EventBusModule = class EventBusModule {
26
+ static forRoot(options = {}) {
27
+ const enabled = options.enabled ?? _config.envConfig.getBoolean('ENABLE_DOMAIN_EVENTS', false);
28
+ return enabled ? this.enabledModule(options) : this.disabledModule(options);
29
+ }
30
+ static enabledModule(options) {
31
+ return {
32
+ module: EventBusModule,
33
+ global: options.global ?? true,
34
+ imports: [
35
+ _core.DiscoveryModule
36
+ ],
37
+ providers: [
38
+ {
39
+ provide: _constants.EVENT_BUS_MODULE_OPTIONS,
40
+ useValue: options
41
+ },
42
+ {
43
+ provide: _constants.EVENT_BUS_INSTANCE,
44
+ useFactory: ()=>{
45
+ const bus = new _hybrideventbusclass.HybridEventBus(options);
46
+ _eventbusregistry.EventBusRegistry.setBus(bus);
47
+ _eventbusregistry.EventBusRegistry.setDefaultModuleEvents(options.defaultModuleEvents ?? {});
48
+ return bus;
49
+ }
50
+ },
51
+ _eventbusexplorer.EventBusExplorer
52
+ ],
53
+ exports: [
54
+ _constants.EVENT_BUS_INSTANCE,
55
+ _constants.EVENT_BUS_MODULE_OPTIONS
56
+ ]
57
+ };
58
+ }
59
+ /**
60
+ * The explorer is left out, so no handler is bound and nothing ever calls
61
+ * `subscribe` - which is what would otherwise open a broker connection. The
62
+ * bus is not registered either, so every `publishDomainEvent` call is a no-op
63
+ * rather than an error.
64
+ */ static disabledModule(options) {
65
+ return {
66
+ module: EventBusModule,
67
+ global: options.global ?? true,
68
+ providers: [
69
+ {
70
+ provide: _constants.EVENT_BUS_MODULE_OPTIONS,
71
+ useValue: options
72
+ },
73
+ {
74
+ provide: _constants.EVENT_BUS_INSTANCE,
75
+ useFactory: ()=>{
76
+ new _common.Logger(EventBusModule.name).log('Domain events are disabled - set ENABLE_DOMAIN_EVENTS=true to publish and consume them');
77
+ return new _disabledeventbusclass.DisabledEventBus();
78
+ }
79
+ }
80
+ ],
81
+ exports: [
82
+ _constants.EVENT_BUS_INSTANCE,
83
+ _constants.EVENT_BUS_MODULE_OPTIONS
84
+ ]
85
+ };
86
+ }
87
+ async onApplicationShutdown() {
88
+ await _eventbusregistry.EventBusRegistry.getBus()?.close();
89
+ _eventbusregistry.EventBusRegistry.reset();
90
+ }
91
+ };
92
+ EventBusModule = _ts_decorate([
93
+ (0, _common.Module)({})
94
+ ], EventBusModule);