-
Notifications
You must be signed in to change notification settings - Fork 91
/
bull.module.ts
284 lines (268 loc) · 8.73 KB
/
bull.module.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
import {
createConditionalDepHolder,
IConditionalDepHolder,
} from '@nestjs/bull-shared';
import { DynamicModule, Module, Provider, Type } from '@nestjs/common';
import { DiscoveryModule } from '@nestjs/core';
import { BullMetadataAccessor } from './bull-metadata.accessor';
import { BullExplorer } from './bull.explorer';
import {
createQueueOptionProviders,
createQueueProviders,
} from './bull.providers';
import {
SharedBullAsyncConfiguration,
SharedBullConfigurationFactory,
} from './interfaces';
import {
BullModuleAsyncOptions,
BullModuleOptions,
BullOptionsFactory,
BullRootModuleOptions,
} from './interfaces/bull-module-options.interface';
import {
BULL_CONFIG_DEFAULT_TOKEN,
getQueueOptionsToken,
getSharedConfigToken,
} from './utils';
@Module({})
export class BullModule {
/**
* Registers a globally available configuration for all queues.
*
* @param bullConfig shared bull configuration object
*/
static forRoot(bullConfig: BullRootModuleOptions): DynamicModule;
/**
* Registers a globally available configuration under a specified "configKey".
*
* @param configKey a key under which the configuration should be available
* @param sharedBullConfig shared bull configuration object
*/
static forRoot(
configKey: string,
bullConfig: BullRootModuleOptions,
): DynamicModule;
/**
* Registers a globally available configuration for all queues
* or using a specified "configKey" (if passed).
*
* @param keyOrConfig a key under which the configuration should be available or a bull configuration object
* @param bullConfig bull configuration object
*/
static forRoot(
keyOrConfig: string | BullRootModuleOptions,
bullConfig?: BullRootModuleOptions,
): DynamicModule {
const [configKey, sharedBullConfig] =
typeof keyOrConfig === 'string'
? [keyOrConfig, bullConfig]
: [undefined, keyOrConfig];
const sharedBullConfigProvider: Provider = {
provide: getSharedConfigToken(configKey),
useValue: sharedBullConfig,
};
return {
global: true,
module: BullModule,
providers: [sharedBullConfigProvider],
exports: [sharedBullConfigProvider],
};
}
/**
* Registers a globally available configuration for all queues.
*
* @param asyncBullConfig shared bull configuration async factory
*/
static forRootAsync(
asyncBullConfig: SharedBullAsyncConfiguration,
): DynamicModule;
/**
* Registers a globally available configuration under a specified "configKey".
*
* @param configKey a key under which the configuration should be available
* @param asyncBullConfig shared bull configuration async factory
*/
static forRootAsync(
configKey: string,
asyncBullConfig: SharedBullAsyncConfiguration,
): DynamicModule;
/**
* Registers a globally available configuration for all queues
* or using a specified "configKey" (if passed).
*
* @param keyOrAsyncConfig a key under which the configuration should be available or a bull configuration object
* @param asyncBullConfig shared bull configuration async factory
*/
static forRootAsync(
keyOrAsyncConfig: string | SharedBullAsyncConfiguration,
asyncBullConfig?: SharedBullAsyncConfiguration,
): DynamicModule {
const [configKey, asyncSharedBullConfig] =
typeof keyOrAsyncConfig === 'string'
? [keyOrAsyncConfig, asyncBullConfig]
: [undefined, keyOrAsyncConfig];
const imports = this.getUniqImports([asyncSharedBullConfig]);
const providers = this.createAsyncSharedConfigurationProviders(
configKey,
asyncSharedBullConfig,
);
return {
global: true,
module: BullModule,
imports,
providers,
exports: providers,
};
}
static registerQueue(...options: BullModuleOptions[]): DynamicModule {
const queueProviders = createQueueProviders([].concat(options));
const queueOptionProviders = createQueueOptionProviders([].concat(options));
return {
module: BullModule,
imports: [BullModule.registerCore()],
providers: [...queueOptionProviders, ...queueProviders],
exports: queueProviders,
};
}
static registerQueueAsync(
...options: BullModuleAsyncOptions[]
): DynamicModule {
const optionsArr = [].concat(options);
const queueProviders = createQueueProviders(optionsArr);
const imports = this.getUniqImports(optionsArr);
const asyncQueueOptionsProviders = options
.map((queueOptions) => this.createAsyncProviders(queueOptions))
.reduce((a, b) => a.concat(b), []);
return {
imports: imports.concat(BullModule.registerCore()),
module: BullModule,
providers: [...asyncQueueOptionsProviders, ...queueProviders],
exports: queueProviders,
};
}
private static createAsyncProviders(
options: BullModuleAsyncOptions,
): Provider[] {
const optionalSharedConfigHolder = createConditionalDepHolder(
getSharedConfigToken(options.configKey),
BULL_CONFIG_DEFAULT_TOKEN,
);
if (options.useExisting || options.useFactory) {
return [
optionalSharedConfigHolder,
this.createAsyncOptionsProvider(options, optionalSharedConfigHolder),
];
}
if (!options.useClass) {
// fallback to the "registerQueue" in case someone accidentally used the "registerQueueAsync" instead
return createQueueOptionProviders([options]);
}
const useClass = options.useClass as Type<BullOptionsFactory>;
return [
optionalSharedConfigHolder,
this.createAsyncOptionsProvider(options, optionalSharedConfigHolder),
{
provide: useClass,
useClass,
},
];
}
private static createAsyncOptionsProvider(
asyncOptions: BullModuleAsyncOptions,
optionalSharedConfigHolderRef: Type<
IConditionalDepHolder<BullRootModuleOptions>
>,
): Provider {
if (asyncOptions.useFactory) {
return {
provide: getQueueOptionsToken(asyncOptions.name),
useFactory: async (
optionalDepHolder: IConditionalDepHolder<BullRootModuleOptions>,
...factoryArgs: unknown[]
) => {
return {
...optionalDepHolder.getDependencyRef(asyncOptions.name),
...(await asyncOptions.useFactory(...factoryArgs)),
};
},
inject: [optionalSharedConfigHolderRef, ...(asyncOptions.inject || [])],
};
}
// `as Type<BullOptionsFactory>` is a workaround for microsoft/TypeScript#31603
const inject = [
(asyncOptions.useClass ||
asyncOptions.useExisting) as Type<BullOptionsFactory>,
];
return {
provide: getQueueOptionsToken(asyncOptions.name),
useFactory: async (
optionalDepHolder: IConditionalDepHolder<BullRootModuleOptions>,
optionsFactory: BullOptionsFactory,
) => {
return {
...optionalDepHolder.getDependencyRef(asyncOptions.name),
...(await optionsFactory.createBullOptions()),
};
},
inject: [optionalSharedConfigHolderRef, ...inject],
};
}
private static createAsyncSharedConfigurationProviders(
configKey: string | undefined,
options: SharedBullAsyncConfiguration,
): Provider[] {
if (options.useExisting || options.useFactory) {
return [this.createAsyncSharedConfigurationProvider(configKey, options)];
}
const useClass = options.useClass as Type<SharedBullConfigurationFactory>;
return [
this.createAsyncSharedConfigurationProvider(configKey, options),
{
provide: useClass,
useClass,
},
];
}
private static createAsyncSharedConfigurationProvider(
configKey: string | undefined,
options: SharedBullAsyncConfiguration,
): Provider {
if (options.useFactory) {
return {
provide: getSharedConfigToken(configKey),
useFactory: options.useFactory,
inject: options.inject || [],
};
}
// `as Type<SharedBullConfigurationFactory>` is a workaround for microsoft/TypeScript#31603
const inject = [
(options.useClass ||
options.useExisting) as Type<SharedBullConfigurationFactory>,
];
return {
provide: getSharedConfigToken(configKey),
useFactory: async (optionsFactory: SharedBullConfigurationFactory) =>
optionsFactory.createSharedConfiguration(),
inject,
};
}
private static registerCore() {
return {
global: true,
module: BullModule,
imports: [DiscoveryModule],
providers: [BullExplorer, BullMetadataAccessor],
};
}
private static getUniqImports(
options: Array<BullModuleAsyncOptions | SharedBullAsyncConfiguration>,
) {
return (
options
.map((option) => option.imports)
.reduce((acc, i) => acc.concat(i || []), [])
.filter((v, i, a) => a.indexOf(v) === i) || []
);
}
}