Skip to content

Commit f6624b9

Browse files
alan-agius4angular-robot[bot]
alan-agius4
authored and
angular-robot[bot]
committed
feat(@angular-devkit/core): update SchemaRegistry compile to return Promise
Use promise based methods to reduce RXJS usage and boiler-platting. BREAKING CHANGE: Several changes to the `SchemaRegistry`. - `compile` method now returns a `Promise`. - Deprecated `flatten` has been removed without replacement.
1 parent 5ceedcb commit f6624b9

File tree

15 files changed

+498
-652
lines changed

15 files changed

+498
-652
lines changed

‎goldens/public-api/angular_devkit/core/index.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -172,9 +172,7 @@ class CoreSchemaRegistry implements SchemaRegistry {
172172
addPreTransform(visitor: JsonVisitor, deps?: JsonVisitor[]): void;
173173
// (undocumented)
174174
addSmartDefaultProvider<T>(source: string, provider: SmartDefaultProvider<T>): void;
175-
compile(schema: JsonSchema): Observable<SchemaValidator>;
176-
// @deprecated
177-
flatten(schema: JsonObject): Observable<JsonObject>;
175+
compile(schema: JsonSchema): Promise<SchemaValidator>;
178176
// (undocumented)
179177
registerUriHandler(handler: UriHandler): void;
180178
// (undocumented)
@@ -186,6 +184,7 @@ class CoreSchemaRegistry implements SchemaRegistry {
186184
usePromptProvider(provider: PromptProvider): void;
187185
// (undocumented)
188186
useXDeprecatedProvider(onUsage: (message: string) => void): void;
187+
ɵflatten(schema: JsonObject): Promise<JsonObject>;
189188
}
190189

191190
// @public (undocumented)
@@ -873,13 +872,13 @@ interface SchemaRegistry {
873872
// (undocumented)
874873
addSmartDefaultProvider<T>(source: string, provider: SmartDefaultProvider<T>): void;
875874
// (undocumented)
876-
compile(schema: Object): Observable<SchemaValidator>;
877-
// @deprecated (undocumented)
878-
flatten(schema: JsonObject | string): Observable<JsonObject>;
875+
compile(schema: Object): Promise<SchemaValidator>;
879876
// (undocumented)
880877
usePromptProvider(provider: PromptProvider): void;
881878
// (undocumented)
882879
useXDeprecatedProvider(onUsage: (message: string) => void): void;
880+
// (undocumented)
881+
ɵflatten(schema: JsonObject | string): Promise<JsonObject>;
883882
}
884883

885884
// @public (undocumented)
@@ -894,7 +893,7 @@ class SchemaValidationException extends BaseException {
894893
// @public (undocumented)
895894
interface SchemaValidator {
896895
// (undocumented)
897-
(data: JsonValue, options?: SchemaValidatorOptions): Observable<SchemaValidatorResult>;
896+
(data: JsonValue, options?: SchemaValidatorOptions): Promise<SchemaValidatorResult>;
898897
}
899898

900899
// @public (undocumented)

‎packages/angular/cli/src/command-builder/utilities/json-schema.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,7 @@ export async function parseJsonSchemaToOptions(
197197
options.push(option);
198198
}
199199

200-
const flattenedSchema = await registry.flatten(schema).toPromise();
200+
const flattenedSchema = await registry.ɵflatten(schema);
201201
json.schema.visitJsonSchema(flattenedSchema, visitor);
202202

203203
// Sort by positional and name.

‎packages/angular/cli/src/utilities/config.ts

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -253,9 +253,8 @@ export async function validateWorkspace(data: json.JsonObject, isGlobal: boolean
253253

254254
const { formats } = await import('@angular-devkit/schematics');
255255
const registry = new json.schema.CoreSchemaRegistry(formats.standardFormats);
256-
const validator = await registry.compile(schemaToValidate).toPromise();
257-
258-
const { success, errors } = await validator(data).toPromise();
256+
const validator = await registry.compile(schemaToValidate);
257+
const { success, errors } = await validator(data);
259258
if (!success) {
260259
throw new json.schema.SchemaValidationException(errors);
261260
}

‎packages/angular_devkit/architect/src/architect.ts

Lines changed: 18 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@ import {
1515
last,
1616
map,
1717
shareReplay,
18-
switchMap,
1918
takeUntil,
2019
} from 'rxjs/operators';
2120
import {
@@ -65,7 +64,7 @@ function _createJobHandlerFromBuilderInfo(
6564
function handler(argument: json.JsonObject, context: JobHandlerContext) {
6665
// Add input validation to the inbound bus.
6766
const inboundBusWithInputValidation = context.inboundBus.pipe(
68-
concatMap((message) => {
67+
concatMap(async (message) => {
6968
if (message.kind === JobInboundMessageKind.Input) {
7069
const v = message.value as BuilderInput;
7170
const options = {
@@ -74,20 +73,17 @@ function _createJobHandlerFromBuilderInfo(
7473
};
7574

7675
// Validate v against the options schema.
77-
return registry.compile(info.optionSchema).pipe(
78-
concatMap((validation) => validation(options)),
79-
map((validationResult: json.schema.SchemaValidatorResult) => {
80-
const { data, success, errors } = validationResult;
81-
if (success) {
82-
return { ...v, options: data } as BuilderInput;
83-
}
84-
85-
throw new json.schema.SchemaValidationException(errors);
86-
}),
87-
map((value) => ({ ...message, value })),
88-
);
76+
const validation = await registry.compile(info.optionSchema);
77+
const validationResult = await validation(options);
78+
const { data, success, errors } = validationResult;
79+
80+
if (!success) {
81+
throw new json.schema.SchemaValidationException(errors);
82+
}
83+
84+
return { ...message, value: { ...v, options: data } } as JobInboundMessage<BuilderInput>;
8985
} else {
90-
return of(message as JobInboundMessage<BuilderInput>);
86+
return message as JobInboundMessage<BuilderInput>;
9187
}
9288
}),
9389
// Using a share replay because the job might be synchronously sending input, but
@@ -335,19 +331,14 @@ function _validateOptionsFactory(host: ArchitectHost, registry: json.schema.Sche
335331
throw new Error(`No builder info were found for builder ${JSON.stringify(builderName)}.`);
336332
}
337333

338-
return registry
339-
.compile(builderInfo.optionSchema)
340-
.pipe(
341-
concatMap((validation) => validation(options)),
342-
switchMap(({ data, success, errors }) => {
343-
if (success) {
344-
return of(data as json.JsonObject);
345-
}
334+
const validation = await registry.compile(builderInfo.optionSchema);
335+
const { data, success, errors } = await validation(options);
346336

347-
throw new json.schema.SchemaValidationException(errors);
348-
}),
349-
)
350-
.toPromise();
337+
if (!success) {
338+
throw new json.schema.SchemaValidationException(errors);
339+
}
340+
341+
return data as json.JsonObject;
351342
},
352343
{
353344
name: '..validateOptions',

‎packages/angular_devkit/architect/src/jobs/simple-scheduler.ts

Lines changed: 25 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -65,9 +65,9 @@ export class JobOutputSchemaValidationError extends schema.SchemaValidationExcep
6565
interface JobHandlerWithExtra extends JobHandler<JsonValue, JsonValue, JsonValue> {
6666
jobDescription: JobDescription;
6767

68-
argumentV: Observable<schema.SchemaValidator>;
69-
outputV: Observable<schema.SchemaValidator>;
70-
inputV: Observable<schema.SchemaValidator>;
68+
argumentV: Promise<schema.SchemaValidator>;
69+
outputV: Promise<schema.SchemaValidator>;
70+
inputV: Promise<schema.SchemaValidator>;
7171
}
7272

7373
function _jobShare<T>(): MonoTypeOperatorFunction<T> {
@@ -159,9 +159,9 @@ export class SimpleScheduler<
159159

160160
const handlerWithExtra = Object.assign(handler.bind(undefined), {
161161
jobDescription: description,
162-
argumentV: this._schemaRegistry.compile(description.argument).pipe(shareReplay(1)),
163-
inputV: this._schemaRegistry.compile(description.input).pipe(shareReplay(1)),
164-
outputV: this._schemaRegistry.compile(description.output).pipe(shareReplay(1)),
162+
argumentV: this._schemaRegistry.compile(description.argument),
163+
inputV: this._schemaRegistry.compile(description.input),
164+
outputV: this._schemaRegistry.compile(description.output),
165165
}) as JobHandlerWithExtra;
166166
this._internalJobDescriptionMap.set(name, handlerWithExtra);
167167

@@ -284,6 +284,7 @@ export class SimpleScheduler<
284284
* Create the job.
285285
* @private
286286
*/
287+
// eslint-disable-next-line max-lines-per-function
287288
private _createJob<A extends MinimumArgumentT, I extends MinimumInputT, O extends MinimumOutputT>(
288289
name: JobName,
289290
argument: A,
@@ -305,12 +306,14 @@ export class SimpleScheduler<
305306
.pipe(
306307
concatMap((message) =>
307308
handler.pipe(
308-
switchMap((handler) => {
309+
switchMap(async (handler) => {
309310
if (handler === null) {
310311
throw new JobDoesNotExistException(name);
311-
} else {
312-
return handler.inputV.pipe(switchMap((validate) => validate(message)));
313312
}
313+
314+
const validator = await handler.inputV;
315+
316+
return validator(message);
314317
}),
315318
),
316319
),
@@ -395,24 +398,20 @@ export class SimpleScheduler<
395398
}
396399

397400
return handler.pipe(
398-
switchMap((handler) => {
401+
switchMap(async (handler) => {
399402
if (handler === null) {
400403
throw new JobDoesNotExistException(name);
401-
} else {
402-
return handler.outputV.pipe(
403-
switchMap((validate) => validate(message.value)),
404-
switchMap((output) => {
405-
if (!output.success) {
406-
throw new JobOutputSchemaValidationError(output.errors);
407-
}
408-
409-
return of({
410-
...message,
411-
output: output.data as O,
412-
} as JobOutboundMessageOutput<O>);
413-
}),
414-
);
415404
}
405+
const validate = await handler.outputV;
406+
const output = await validate(message.value);
407+
if (!output.success) {
408+
throw new JobOutputSchemaValidationError(output.errors);
409+
}
410+
411+
return {
412+
...message,
413+
output: output.data as O,
414+
} as JobOutboundMessageOutput<O>;
416415
}),
417416
) as Observable<JobOutboundMessage<O>>;
418417
}),
@@ -457,7 +456,7 @@ export class SimpleScheduler<
457456
return maybeObservable.pipe(
458457
// Keep the order of messages.
459458
concatMap((message) => {
460-
return schemaRegistry.compile(schema).pipe(
459+
return from(schemaRegistry.compile(schema)).pipe(
461460
switchMap((validate) => validate(message)),
462461
filter((x) => x.success),
463462
map((x) => x.data as T),
@@ -518,7 +517,7 @@ export class SimpleScheduler<
518517
}
519518

520519
// Validate the argument.
521-
return handler.argumentV
520+
return from(handler.argumentV)
522521
.pipe(
523522
switchMap((validate) => validate(argument)),
524523
switchMap((output) => {

‎packages/angular_devkit/build_angular/src/testing/builder-harness.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -214,8 +214,8 @@ export class BuilderHarness<T> {
214214
}
215215
}
216216

217-
const validator = await this.schemaRegistry.compile(schema ?? true).toPromise();
218-
const { data } = await validator(options).toPromise();
217+
const validator = await this.schemaRegistry.compile(schema ?? true);
218+
const { data } = await validator(options);
219219

220220
return data as json.JsonObject;
221221
},
@@ -237,7 +237,7 @@ export class BuilderHarness<T> {
237237
const logs: logging.LogEntry[] = [];
238238
context.logger.subscribe((e) => logs.push(e));
239239

240-
return this.schemaRegistry.compile(this.builderInfo.optionSchema).pipe(
240+
return observableFrom(this.schemaRegistry.compile(this.builderInfo.optionSchema)).pipe(
241241
mergeMap((validator) => validator(targetOptions)),
242242
map((validationResult) => validationResult.data),
243243
mergeMap((data) =>

‎packages/angular_devkit/core/src/json/schema/interface.ts

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export interface SchemaValidatorOptions {
2828
}
2929

3030
export interface SchemaValidator {
31-
(data: JsonValue, options?: SchemaValidatorOptions): Observable<SchemaValidatorResult>;
31+
(data: JsonValue, options?: SchemaValidatorOptions): Promise<SchemaValidatorResult>;
3232
}
3333

3434
export type SchemaFormatter = Format;
@@ -72,13 +72,10 @@ export type PromptProvider = (
7272
) => SubscribableOrPromise<{ [id: string]: JsonValue }>;
7373

7474
export interface SchemaRegistry {
75-
compile(schema: Object): Observable<SchemaValidator>;
76-
/**
77-
* @deprecated since 11.2 without replacement.
78-
* Producing a flatten schema document does not in all cases produce a schema with identical behavior to the original.
79-
* See: https://json-schema.org/draft/2019-09/json-schema-core.html#rfc.appendix.B.2
80-
*/
81-
flatten(schema: JsonObject | string): Observable<JsonObject>;
75+
compile(schema: Object): Promise<SchemaValidator>;
76+
77+
/** @private */
78+
ɵflatten(schema: JsonObject | string): Promise<JsonObject>;
8279
addFormat(format: SchemaFormat): void;
8380
addSmartDefaultProvider<T>(source: string, provider: SmartDefaultProvider<T>): void;
8481
usePromptProvider(provider: PromptProvider): void;

0 commit comments

Comments
 (0)