@angular-devkit/core 15.0.0-next.4 → 15.0.0-next.6

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 (50) hide show
  1. package/node/BUILD.bazel +0 -1
  2. package/node/index.d.ts +0 -2
  3. package/node/index.js +0 -15
  4. package/package.json +2 -2
  5. package/src/index.d.ts +1 -3
  6. package/src/index.js +1 -5
  7. package/src/logger/logger.d.ts +1 -1
  8. package/src/logger/logger.js +2 -2
  9. package/src/utils/index.d.ts +0 -9
  10. package/src/workspace/json/reader.js +1 -1
  11. package/node/experimental/index.d.ts +0 -9
  12. package/node/experimental/index.js +0 -35
  13. package/node/experimental/jobs/index.d.ts +0 -8
  14. package/node/experimental/jobs/index.js +0 -24
  15. package/node/experimental/jobs/job-registry.d.ts +0 -19
  16. package/node/experimental/jobs/job-registry.js +0 -59
  17. package/src/analytics/api.d.ts +0 -46
  18. package/src/analytics/api.js +0 -9
  19. package/src/analytics/forwarder.d.ts +0 -67
  20. package/src/analytics/forwarder.js +0 -88
  21. package/src/analytics/index.d.ts +0 -53
  22. package/src/analytics/index.js +0 -96
  23. package/src/analytics/logging.d.ts +0 -22
  24. package/src/analytics/logging.js +0 -35
  25. package/src/analytics/multi.d.ts +0 -21
  26. package/src/analytics/multi.js +0 -37
  27. package/src/analytics/noop.d.ts +0 -18
  28. package/src/analytics/noop.js +0 -23
  29. package/src/experimental/jobs/README.md +0 -510
  30. package/src/experimental/jobs/api.d.ts +0 -332
  31. package/src/experimental/jobs/api.js +0 -73
  32. package/src/experimental/jobs/architecture.md +0 -260
  33. package/src/experimental/jobs/create-job-handler.d.ts +0 -48
  34. package/src/experimental/jobs/create-job-handler.js +0 -135
  35. package/src/experimental/jobs/dispatcher.d.ts +0 -31
  36. package/src/experimental/jobs/dispatcher.js +0 -50
  37. package/src/experimental/jobs/exception.d.ts +0 -15
  38. package/src/experimental/jobs/exception.js +0 -23
  39. package/src/experimental/jobs/fallback-registry.d.ts +0 -19
  40. package/src/experimental/jobs/fallback-registry.js +0 -27
  41. package/src/experimental/jobs/index.d.ts +0 -15
  42. package/src/experimental/jobs/index.js +0 -31
  43. package/src/experimental/jobs/simple-registry.d.ts +0 -44
  44. package/src/experimental/jobs/simple-registry.js +0 -77
  45. package/src/experimental/jobs/simple-scheduler.d.ts +0 -77
  46. package/src/experimental/jobs/simple-scheduler.js +0 -382
  47. package/src/experimental/jobs/strategy.d.ts +0 -28
  48. package/src/experimental/jobs/strategy.js +0 -99
  49. package/src/experimental.d.ts +0 -9
  50. package/src/experimental.js +0 -35
@@ -1,22 +0,0 @@
1
- /**
2
- * @license
3
- * Copyright Google LLC All Rights Reserved.
4
- *
5
- * Use of this source code is governed by an MIT-style license that can be
6
- * found in the LICENSE file at https://angular.io/license
7
- */
8
- import { Logger } from '../logger';
9
- import { Analytics, EventOptions, PageviewOptions, ScreenviewOptions, TimingOptions } from './api';
10
- /**
11
- * Analytics implementation that logs analytics events to a logger. This should be used for
12
- * debugging mainly.
13
- */
14
- export declare class LoggingAnalytics implements Analytics {
15
- protected _logger: Logger;
16
- constructor(_logger: Logger);
17
- event(category: string, action: string, options?: EventOptions): void;
18
- screenview(screenName: string, appName: string, options?: ScreenviewOptions): void;
19
- pageview(path: string, options?: PageviewOptions): void;
20
- timing(category: string, variable: string, time: string | number, options?: TimingOptions): void;
21
- flush(): Promise<void>;
22
- }
@@ -1,35 +0,0 @@
1
- "use strict";
2
- /**
3
- * @license
4
- * Copyright Google LLC All Rights Reserved.
5
- *
6
- * Use of this source code is governed by an MIT-style license that can be
7
- * found in the LICENSE file at https://angular.io/license
8
- */
9
- Object.defineProperty(exports, "__esModule", { value: true });
10
- exports.LoggingAnalytics = void 0;
11
- /**
12
- * Analytics implementation that logs analytics events to a logger. This should be used for
13
- * debugging mainly.
14
- */
15
- class LoggingAnalytics {
16
- constructor(_logger) {
17
- this._logger = _logger;
18
- }
19
- event(category, action, options) {
20
- this._logger.info('event ' + JSON.stringify({ category, action, ...options }));
21
- }
22
- screenview(screenName, appName, options) {
23
- this._logger.info('screenview ' + JSON.stringify({ screenName, appName, ...options }));
24
- }
25
- pageview(path, options) {
26
- this._logger.info('pageview ' + JSON.stringify({ path, ...options }));
27
- }
28
- timing(category, variable, time, options) {
29
- this._logger.info('timing ' + JSON.stringify({ category, variable, time, ...options }));
30
- }
31
- flush() {
32
- return Promise.resolve();
33
- }
34
- }
35
- exports.LoggingAnalytics = LoggingAnalytics;
@@ -1,21 +0,0 @@
1
- /**
2
- * @license
3
- * Copyright Google LLC All Rights Reserved.
4
- *
5
- * Use of this source code is governed by an MIT-style license that can be
6
- * found in the LICENSE file at https://angular.io/license
7
- */
8
- import { Analytics, EventOptions, PageviewOptions, ScreenviewOptions, TimingOptions } from './api';
9
- /**
10
- * Analytics implementation that reports to multiple analytics backend.
11
- */
12
- export declare class MultiAnalytics implements Analytics {
13
- protected _backends: Analytics[];
14
- constructor(_backends?: Analytics[]);
15
- push(...backend: Analytics[]): void;
16
- event(category: string, action: string, options?: EventOptions): void;
17
- screenview(screenName: string, appName: string, options?: ScreenviewOptions): void;
18
- pageview(path: string, options?: PageviewOptions): void;
19
- timing(category: string, variable: string, time: string | number, options?: TimingOptions): void;
20
- flush(): Promise<void>;
21
- }
@@ -1,37 +0,0 @@
1
- "use strict";
2
- /**
3
- * @license
4
- * Copyright Google LLC All Rights Reserved.
5
- *
6
- * Use of this source code is governed by an MIT-style license that can be
7
- * found in the LICENSE file at https://angular.io/license
8
- */
9
- Object.defineProperty(exports, "__esModule", { value: true });
10
- exports.MultiAnalytics = void 0;
11
- /**
12
- * Analytics implementation that reports to multiple analytics backend.
13
- */
14
- class MultiAnalytics {
15
- constructor(_backends = []) {
16
- this._backends = _backends;
17
- }
18
- push(...backend) {
19
- this._backends.push(...backend);
20
- }
21
- event(category, action, options) {
22
- this._backends.forEach((be) => be.event(category, action, options));
23
- }
24
- screenview(screenName, appName, options) {
25
- this._backends.forEach((be) => be.screenview(screenName, appName, options));
26
- }
27
- pageview(path, options) {
28
- this._backends.forEach((be) => be.pageview(path, options));
29
- }
30
- timing(category, variable, time, options) {
31
- this._backends.forEach((be) => be.timing(category, variable, time, options));
32
- }
33
- flush() {
34
- return Promise.all(this._backends.map((x) => x.flush())).then(() => { });
35
- }
36
- }
37
- exports.MultiAnalytics = MultiAnalytics;
@@ -1,18 +0,0 @@
1
- /**
2
- * @license
3
- * Copyright Google LLC All Rights Reserved.
4
- *
5
- * Use of this source code is governed by an MIT-style license that can be
6
- * found in the LICENSE file at https://angular.io/license
7
- */
8
- import { Analytics } from './api';
9
- /**
10
- * Analytics implementation that does nothing.
11
- */
12
- export declare class NoopAnalytics implements Analytics {
13
- event(): void;
14
- screenview(): void;
15
- pageview(): void;
16
- timing(): void;
17
- flush(): Promise<void>;
18
- }
@@ -1,23 +0,0 @@
1
- "use strict";
2
- /**
3
- * @license
4
- * Copyright Google LLC All Rights Reserved.
5
- *
6
- * Use of this source code is governed by an MIT-style license that can be
7
- * found in the LICENSE file at https://angular.io/license
8
- */
9
- Object.defineProperty(exports, "__esModule", { value: true });
10
- exports.NoopAnalytics = void 0;
11
- /**
12
- * Analytics implementation that does nothing.
13
- */
14
- class NoopAnalytics {
15
- event() { }
16
- screenview() { }
17
- pageview() { }
18
- timing() { }
19
- flush() {
20
- return Promise.resolve();
21
- }
22
- }
23
- exports.NoopAnalytics = NoopAnalytics;
@@ -1,510 +0,0 @@
1
- # Description
2
-
3
- Jobs is the Angular DevKit subsystem for scheduling and running generic functions with clearly
4
- typed inputs and outputs. A `Job` instance is a function associated with metadata. You can
5
- schedule a job, synchronize it with other jobs, and use it to schedule other jobs.
6
-
7
- The whole API is serializable, allowing you to use a Node Stream or message channel to
8
- communicate between the job and the job scheduler.
9
-
10
- Jobs are lazy, cold, and guaranteed to execute exactly once when scheduled. Subscribing to a job
11
- returns messages from the point where the job is at.
12
-
13
- ## Argument, Input, Output and Channels
14
-
15
- A job receives a single argument when scheduled and can also listen to an input channel. It can
16
- emit multiple outputs, and can also provide multiple output channels that emit asynchronous JSON
17
- messages, which can be typed.
18
-
19
- The I/O model is like that of an executable, where the argument corresponds to arguments on the
20
- command line, the input channel to STDIN, the output channel to STDOUT, and the channels
21
- would be additional output streams.
22
-
23
- ## LifeCycle
24
-
25
- A `Job` goes through multiple LifeCycle messages before its completion;
26
-
27
- 1. `JobState.Queued`. The job was queued and is waiting. This is the default state from the
28
- scheduler.
29
- 1. `JobState.Ready`. The job's dependencies (see
30
- ["Synchronizing and Dependencies"](#Dependencies)) are done running, the argument is
31
- validated, and the job is ready to execute.
32
- 1. `JobState.Started`. The argument has been validated, the job has been called and is running.
33
- This is handled by the job itself (or `createJobHandler()`).
34
- 1. `JobState.Ended`. The job has ended and is done running. This is handled by the job itself (or
35
- `createJobHandler()`).
36
- 1. `JobState.Errored`. A unrecoverable error happened.
37
-
38
- Each state (except `Queued`) corresponds to a `JobOutboundMessage` on the `outboundBus` observable
39
- that triggers the state change. The `Scheduler` emits the `Ready` and `Errored` messages; the job
40
- implementation should not emit them, and if it does they are filtered out. You can listen for
41
- these messages or use the corresponding state member.
42
-
43
- The job implementation should emit the `Start` and `End` messages when it is starting the job logic
44
- itself. Only the first `Start` and `End` messages will be forwarded. Any more will be filtered out.
45
-
46
- The `Queued` state is set as the job is scheduled, so there is no need to listen for the message.
47
-
48
- ## `Job<OutputType>` Object
49
-
50
- The `Job` object that is returned when you schedule a job provides access to the job's status and
51
- utilities for tracking and modifying the job.
52
-
53
- 1. `id`. A unique symbol that can be used as a Map key.
54
- 1. `description`. The description of the job from the scheduler. See `JobDescription` object.
55
- 1. `argument`. The argument value that was used to start the job.
56
- 1. `input`. An `Observer` that can be used to send validated inputs to the job itself.
57
- 1. `output`. An `Observable<OutputType>` that filters out messages to get only the returned output
58
- of a job.
59
- 1. `promise`. A promise that waits for the last output of a job. Returns the last value outputted
60
- (or no value if there's no last value).
61
- 1. `state`. The current state of the job (see `LifeCycle`).
62
- 1. `channels`. A map of side channels the user can listen to as `Observable`.
63
- 1. `ping()`. A function that can be used to ping the job, receiving a `Promise` for when the ping
64
- is answered.
65
- 1. `stop()`. Sends a `stop` input to the job, which suggests to stop the job. The job itself can
66
- choose to ignore this message.
67
- 1. `inboundBus`. The raw input `Observer<JobInboundMessage>`. This can be used to send messages to
68
- the `context.inboundBus` observable in the job. These are `JobInboundMessage` messages. See
69
- ["Communicating With Jobs"](#Communicating).
70
- 1. `outboundBus`. The raw output `Observable<JobOutput>`. This can be used to listen to messages
71
- from the job. See ["Communicating With Jobs"](#Communicating).
72
-
73
- ## `JobHandlerContext<I, O>` Object
74
-
75
- The `JobHandlerContext<>` is passed to the job handler code in addition to its argument. The
76
- context contains the following members:
77
-
78
- 1. `description`. The description of the job. Its name and schemas.
79
- 1. `scheduler`. A `Scheduler<>` instance that can be used to create additional jobs.
80
- 1. `dependencies`. A generic list of other job instances that were run as dependencies when
81
- scheduling this job. Their `id` is not guaranteed to match the `id` of the `Job<>` instance
82
- itself (those `Job<>`s might just be proxies). The state of those `Job<>` is guaranteed to be
83
- `JobState.Ended`, as `JobState.Errored` would have prevented this handler from running.
84
- 1. `inboundBus`. The raw input observable, complement of the `inboundBus` observer from the `Job<>`.
85
-
86
- # Examples
87
-
88
- An example of a job that adds all input together and return the output value. We use a
89
- simple synchronous job registry and a simple job scheduler.
90
-
91
- ```typescript
92
- import { jobs } from '@angular-devkit/core';
93
-
94
- const add = jobs.createJobHandle<number[], number>((input) =>
95
- input.reduce((total, curr) => total + curr, 0),
96
- );
97
-
98
- // Register the job in a SimpleJobRegistry. Different registries have different API.
99
- const registry = new jobs.SimpleJobRegistry();
100
- const scheduler = new jobs.SimpleScheduler(registry);
101
- registry.register(add, {
102
- name: 'add',
103
- input: { type: 'array', items: { type: 'number' } },
104
- output: { type: 'number' },
105
- });
106
-
107
- scheduler
108
- .schedule('add', [1, 2, 3, 4])
109
- .promise.then((output) => console.log('1 + 2 + 3 + 4 is ' + output));
110
- ```
111
-
112
- # Creating Jobs
113
-
114
- A job is at its core a function with a description object attached to it. The description object
115
- stores the JSON schemas used to validate the types of the argument passed in, the input and
116
- output values. By default, a job accepts and can output any JSON object.
117
-
118
- ```typescript
119
- import { Observable } from 'rxjs';
120
- import { jobs } from '@angular-devkit/core';
121
-
122
- const argument = {
123
- type: 'array',
124
- items: { type: 'number' },
125
- };
126
- const output = {
127
- type: 'number',
128
- };
129
-
130
- export function add(argument: number[]): Observable<jobs.JobOutboundMessage<number>> {
131
- return new Observable((o) => {
132
- o.next({ kind: jobs.JobOutboundMessageKind.Start });
133
- o.next({
134
- kind: jobs.JobOutboundMessageKind.Output,
135
- output: argument.reduce((total, curr) => total + curr, 0),
136
- });
137
- o.next({ kind: jobs.JobOutboundMessageKind.End });
138
- o.complete();
139
- });
140
- }
141
-
142
- // Add a property to `add` to make it officially a JobHandler. The Job system does not recognize
143
- // any function as a JobHandler.
144
- add.jobDescription = {
145
- argument: argument,
146
- output: output,
147
- };
148
-
149
- // Call the job with an array as argument, and log its output.
150
- declare const scheduler: jobs.Scheduler;
151
- scheduler.schedule('add', [1, 2, 3, 4]).output.subscribe((x) => console.log(x)); // Will output 10.
152
- ```
153
-
154
- This is a lot of boilerplate, so we made some helpers to improve readability and manage argument,
155
- input and output automatically:
156
-
157
- ```typescript
158
- // Add is a JobHandler function, like the above.
159
- export const add = jobs.createJobHandler<number[], number>((argument) =>
160
- argument.reduce((total, curr) => total + curr, 0),
161
- );
162
-
163
- // Schedule like above.
164
- ```
165
-
166
- You can also return a Promise or an Observable, as jobs are asynchronous. This helper will set
167
- start and end messages appropriately. It will also manage channels automatically (see below).
168
-
169
- A more complex job can be declared like this:
170
-
171
- ```typescript
172
- import { Observable } from 'rxjs';
173
- import { jobs } from '@angular-devkit/core';
174
-
175
- // Show progress with each count in a separate output channel. Output "more" in a channel.
176
- export const count = jobs.createJobHandler<number, number>(
177
- // Receive a context that contains additional methods to create channels.
178
- (argument: number, { createChannel }) =>
179
- new Observable<number>((o) => {
180
- const side = createChannel('side', { type: 'string', const: 'more' });
181
- const progress = createChannel('progress', { type: 'number' });
182
- let i = 0;
183
- function doCount() {
184
- o.next(i++);
185
- progress.next(i / argument);
186
- side.next('more');
187
-
188
- if (i < argument) {
189
- setTimeout(doCount, 100);
190
- } else {
191
- o.complete();
192
- }
193
- }
194
- setTimeout(doCount, 100);
195
- }),
196
- {
197
- argument: { type: 'number' },
198
- output: { type: 'number' },
199
- },
200
- );
201
-
202
- // Get a hold of a scheduler that refers to the job above.
203
- declare const scheduler: jobs.Scheduler;
204
-
205
- const job = scheduler.schedule('count', 0);
206
- job.getChannel('side').subscribe((x) => console.log(x));
207
- // You can type a channel too. Messages will be filtered out.
208
- job
209
- .getChannel<number>('progress', { type: 'number' })
210
- .subscribe((x) => console.log(x));
211
- ```
212
-
213
- ## <a name="Communicating"></a>Communicating With Jobs
214
-
215
- Jobs can be started and updated in a separate process or thread, and as such communication with a
216
- job should avoid using global objects (which might not be shared). The jobs API and schedulers
217
- provide 2 communication streams (one for input and the other for output), named `inboundBus` and
218
- `outboundBus`.
219
-
220
- ### Raw Input Stream
221
-
222
- The `schedule()` function returns a `Job<>` interface that contains a `inboundBus` member of type
223
- `Observer<JobInboundMessage>`. All messages sent _to_ the job goes through this stream. The `kind`
224
- member of the `JobInboundMessage` interface dictates what kind of message it is sending:
225
-
226
- 1. `JobInboundMessageKind.Ping`. A simple message that should be answered with
227
- `JobOutboundMessageKind.Pong` when the job is responsive. The `id` field of the message should
228
- be used when returning `Pong`.
229
- 1. `JobInboundMessageKind.Stop`. The job should be stopped. This is used when
230
- cancelling/unsubscribing from the `output` (or by calling `stop()`). Any inputs or outputs
231
- after this message will be ignored.
232
- 1. `JobInboundMessageKind.Input` is used when sending inputs to a job. These correspond to the
233
- `next` methods of an `Observer` and are reported to the job through its `context.input`
234
- Observable. There is no way to communicate an error to the job.
235
-
236
- Using the `createJobHandler()` helper, all those messages are automatically handled by the
237
- boilerplate code. If you need direct access to raw inputs, you should subscribe to the
238
- `context.inboundBus` Observable.
239
-
240
- ### Raw Output Stream
241
-
242
- The `Job<>` interface also contains a `outboundBus` member (of type
243
- `Observable<JobOutboundMessage<O>>` where `O` is the typed output of the job) which is the output
244
- complement of `inboundBus`. All messages sent _from_ the job goes through this stream. The `kind`
245
- member of the `JobOutboundMessage<O>` interface dictates what kind of message it is sending:
246
-
247
- 1. `JobOutboundMessageKind.Create`. The `Job<>` was created, its dependencies are done, and the
248
- library is validating Argument and calling the internal job code.
249
- 1. `JobOutboundMessageKind.Start`. The job code itself should send that message when started.
250
- `createJobHandler()` will do it automatically.
251
- 1. `JobOutboundMessageKind.End`. The job has ended. This is done by the job itself and should always
252
- be sent when completed. The scheduler will listen to this message to set the state and unblock
253
- dependent jobs. `createJobHandler()` automatically send this message.
254
- 1. `JobOutboundMessageKind.Pong`. The job should answer a `JobInboundMessageKind.Ping` message with
255
- this. Automatically done by `createJobHandler()`.
256
- 1. `JobOutboundMessageKind.Output`. An `Output` has been generated by the job.
257
- 1. `JobOutboundMessageKind.ChannelMessage`, `JobOutboundMessageKind.ChannelError` and
258
- `JobOutboundMessageKind.ChannelComplete` are used for output channels. These correspond to the
259
- `next`, `error` and `complete` methods of an `Observer` and are available to the callee through
260
- the `job.channels` map of Observable.
261
-
262
- Those messages can be accessed directly through the `job.outboundBus` member. The job itself should
263
- return an `Observable<JobOutboundMessage<O>>`. The `createJobHandler()` helper handles most of use
264
- cases of this and makes it easier for jobs to handle this.
265
-
266
- ## Job Dispatchers
267
-
268
- Dispatchers are a helper that redirect to different jobs given conditions. To create a job
269
- dispatcher, use the `createDispatcher()` function:
270
-
271
- ```typescript
272
- import { jobs } from '@angular-devkit/core';
273
-
274
- // A dispatcher that installs node modules given a user's preference.
275
- const dispatcher = jobs.createDispatcher({
276
- name: 'node-install',
277
- argument: { properties: { moduleName: { type: 'string' } } },
278
- output: { type: 'boolean' },
279
- });
280
-
281
- const npmInstall = jobs.createJobHandler(/* ... */, { name: 'npm-install' });
282
- const yarnInstall = jobs.createJobHandler(/* ... */, { name: 'yarn-install' });
283
- const pnpmInstall = jobs.createJobHandler(/* ... */, { name: 'pnpm-install' });
284
-
285
- declare const registry: jobs.SimpleJobRegistry;
286
- registry.register(dispatcher);
287
- registry.register(npmInstall);
288
- registry.register(yarnInstall);
289
- registry.register(pnpmInstall);
290
-
291
- // Default to npm.
292
- dispatcher.setDefaultDelegate(npmInstall.name);
293
- // If the user is asking for yarn over npm, uses it.
294
- dispatcher.addConditionalDelegate(() => userWantsYarn, yarnInstall.name);
295
- ```
296
-
297
- ## Execution Strategy
298
-
299
- Jobs are always run in parallel and will always start, but many helper functions are provided
300
- when creating a job to help you control the execution strategy;
301
-
302
- 1. `serialize()`. Multiple runs of this job will be queued with each others.
303
- 1. `memoize(replayMessages = false)` will create a job, or reuse the same job when inputs are
304
- matching. If the inputs don't match, a new job will be started and its outputs will be stored.
305
-
306
- These strategies can be used when creating the job:
307
-
308
- ```typescript
309
- // Same input and output as above.
310
-
311
- export const add = jobs.strategy.memoize()(
312
- jobs.createJobHandler<number[], number>((argument) =>
313
- argument.reduce((total, curr) => total + curr, 0),
314
- ),
315
- );
316
- ```
317
-
318
- Strategies can be reused to synchronize between jobs. For example, given jobs `jobA` and `jobB`,
319
- you can reuse the strategy to serialize both jobs together;
320
-
321
- ```typescript
322
- const strategy = jobs.strategy.serialize();
323
- const jobA = strategy(jobs.createJobHandler(...));
324
- const jobB = strategy(jobs.createJobHandler(...));
325
- ```
326
-
327
- Even further, we can have package A and package B run in serialization, and B and C also be
328
- serialized. Running A and C will run in parallel, while running B will wait for both A and C
329
- to finish.
330
-
331
- ```typescript
332
- const strategy1 = jobs.strategy.serialize();
333
- const strategy2 = jobs.strategy.serialize();
334
- const jobA = strategy1(jobs.createJobHandler(...));
335
- const jobB = strategy1(strategy2(jobs.createJobHandler(...)));
336
- const jobC = strategy2(jobs.createJobHandler(...));
337
- ```
338
-
339
- # Scheduling Jobs
340
-
341
- Jobs can be scheduled using a `Scheduler` interface, which contains a `schedule()` method:
342
-
343
- ```typescript
344
- interface Scheduler {
345
- /**
346
- * Schedule a job to be run, using its name.
347
- * @param name The name of job to be run.
348
- * @param argument The argument to send to the job when starting it.
349
- * @param options Scheduling options.
350
- * @returns The Job being run.
351
- */
352
- schedule<I extends MinimumInputValueT, O extends MinimumOutputValueT>(
353
- name: JobName,
354
- argument: I,
355
- options?: ScheduleJobOptions,
356
- ): Job<JsonValue, O>;
357
- }
358
- ```
359
-
360
- The scheduler also has a `getDescription()` method to get a `JobDescription` object for a certain
361
- name; that description contains schemas for the argument, input, output, and other channels:
362
-
363
- ```typescript
364
- interface Scheduler {
365
- /**
366
- * Get a job description for a named job.
367
- *
368
- * @param name The name of the job.
369
- * @returns A description, or null if the job cannot be scheduled.
370
- */
371
- getDescription(name: JobName): JobDescription | null;
372
-
373
- /**
374
- * Returns true if the job name has been registered.
375
- * @param name The name of the job.
376
- * @returns True if the job exists, false otherwise.
377
- */
378
- has(name: JobName): boolean;
379
- }
380
- ```
381
-
382
- Finally, the scheduler interface has a `pause()` method to stop scheduling. This will queue all
383
- jobs and wait for the unpause function to be called before unblocking all the jobs scheduled.
384
- This does not affect already running jobs.
385
-
386
- ```typescript
387
- interface Scheduler {
388
- /**
389
- * Pause the scheduler, temporary queueing _new_ jobs. Returns a resume function that should be
390
- * used to resume execution. If multiple `pause()` were called, all their resume functions must
391
- * be called before the Scheduler actually starts new jobs. Additional calls to the same resume
392
- * function will have no effect.
393
- *
394
- * Jobs already running are NOT paused. This is pausing the scheduler only.
395
- *
396
- * @returns A function that can be run to resume the scheduler. If multiple `pause()` calls
397
- * were made, all their return function must be called (in any order) before the
398
- * scheduler can resume.
399
- */
400
- pause(): () => void;
401
- }
402
- ```
403
-
404
- ## <a name="Dependencies"></a>Synchronizing and Dependencies
405
-
406
- When scheduling jobs, it is often necessary to run jobs after certain other jobs are finished.
407
- This is done through the `dependencies` options in the `schedule()` method.
408
-
409
- These jobs will also be passed to the job being scheduled, through its context. This can be
410
- useful if, for example, the output of those jobs are of a known type, or have known side channels.
411
-
412
- An example of this would be a compiler that needs to know the output directory of other compilers
413
- before it, in a tool chain.
414
-
415
- ### Dependencies
416
-
417
- When scheduling jobs, the user can add a `dependencies` field to the scheduling options. The
418
- scheduler will wait for those dependencies to finish before running the job, and pass those jobs
419
- in the context of the job.
420
-
421
- ### Accessing Dependencies
422
-
423
- Jobs are called with a `JobHandlerContext` as a second argument, which contains a
424
- `dependencies: Job<JsonValue>[]` member which contains all dependencies that were used when
425
- scheduling the job. Those aren't fully typed as they are determined by the user, and not the job
426
- itself. They also can contain jobs that are not finished, and the job should use the `state`
427
- member of the job itself before trying to access its content.
428
-
429
- ### Scheduler Sub Jobs
430
-
431
- The `JobHandlerContext` also contains a `scheduler` member which can be used to schedule jobs
432
- using the same scheduler that was used for the job. This allows jobs to call other jobs
433
- and wait for them to end.
434
-
435
- ## Available Schedulers
436
-
437
- The Core Angular DevKit library provides 2 implementations for the `Scheduler` interface:
438
-
439
- ## SimpleJobRegistry
440
-
441
- Available in the jobs namespace. A registry that accept job registration, and can also schedule
442
- jobs.
443
-
444
- ```typescript
445
- import { jobs } from '@angular-devkit/core';
446
-
447
- const add = jobs.createJobHandler<number[], number>((argument) =>
448
- argument.reduce((total, curr) => total + curr, 0),
449
- );
450
-
451
- // Register the job in a SimpleJobRegistry. Different registries have different API.
452
- const registry = new jobs.SimpleJobRegistry();
453
- const scheduler = new SimpleJobScheduler(registry);
454
-
455
- registry.register(add, {
456
- name: 'add',
457
- argument: { type: 'array', items: { type: 'number' } },
458
- output: { type: 'number' },
459
- });
460
-
461
- scheduler.schedule('add', [1, 2, 3, 4]);
462
- ```
463
-
464
- ## NodeModuleJobRegistry
465
-
466
- Available through `@angular-devkit/core/node`.
467
-
468
- A scheduler that loads jobs using their node package names. These jobs need to use the
469
- `createJobHandler()` helper and report their argument/input/output schemas that way.
470
-
471
- ```typescript
472
- declare const registry: NodeModuleJobRegistry;
473
- const scheduler = new SimpleJobScheduler(registry);
474
-
475
- scheduler.schedule('some-node-package#someExport', 'input');
476
- ```
477
-
478
- # Gotchas
479
-
480
- 1. Deadlocking Dependencies
481
- It is impossible to add dependencies to an already running job, but it is entirely possible to
482
- get locked between jobs. Be aware of your own dependencies.
483
-
484
- 1. Using `job.promise`
485
- `job.promise` waits for the job to ends. Don't rely on it unless you know the job is not
486
- watching and running for a long time. If you aren't sure, use
487
- `job.output.pipe(first()).toPromise()` instead which will return the first next output,
488
- regardless of whether the job watches and rerun or not.
489
-
490
- # FAQ
491
-
492
- 1. Laziness
493
- A job is lazy until executed, but its messages will be replayed when resubscribed.
494
-
495
- 1. Serialize Strategy vs Dependencies
496
- Strategies are functions that transform the execution of a job, and can be used when
497
- declaring the job, or registering it. Dependencies, on the other hand, are listed when
498
- scheduling a job to order jobs during scheduling.
499
-
500
- A job has no control over the way it's scheduled, and its dependencies. It can, however,
501
- declare that it shouldn't run at the same time as itself. Alternatively, a user could
502
- schedule a job twice and imply that the second run should wait for the first to finish. In
503
- practice, this would be equivalent to having the job be serialized, but the important detail
504
- is in _whom_ is defining the rules; using the `serialize()` strategy, the job implementation
505
- is, while when using dependencies, the user is.
506
-
507
- The user does not need to know how to job needs to synchronize with itself, and the job does
508
- not need to know how it synchronizes with other jobs that it doesn't know about. That's part
509
- of the strength of this system as every job can be developed in a vacuum, only caring about
510
- its contracts (argument, input and output) and its own synchronization.