@flusys/nestjs-shared 6.4.1 → 7.0.0-beta.1

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