Skip to content

feat(@angular-devkit/schematics): allow workflow impl to define their own sinks #12330

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vikerman merged 1 commit into from
Sep 20, 2018
Merged

feat(@angular-devkit/schematics): allow workflow impl to define their own sinks #12330

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions packages/angular_devkit/schematics/src/sink/sink.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,6 @@ import { Tree } from '../tree/interface';


export interface Sink {
preCommitAction: (action: Action) => void | PromiseLike<Action> | Observable<Action> | Action;
preCommit: () => void | Observable<void>;
postCommit: () => void | Observable<void>;

commit(tree: Tree): Observable<void>;
}

Expand Down
67 changes: 41 additions & 26 deletions packages/angular_devkit/schematics/src/workflow/base.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import { UnsuccessfulWorkflowExecution } from '../exception/exception';
import { standardFormats } from '../formats';
import { DryRunEvent, DryRunSink } from '../sink/dryrun';
import { HostSink } from '../sink/host';
import { Sink } from '../sink/sink';
import { HostTree } from '../tree/host-tree';
import { Tree } from '../tree/interface';
import { optimize } from '../tree/static';
Expand Down Expand Up @@ -96,6 +97,35 @@ export abstract class BaseWorkflow implements Workflow {
return this._lifeCycle.asObservable();
}

protected _createSinks(): Sink[] {
let error = false;

const dryRunSink = new DryRunSink(this._host, this._force);
const dryRunSubscriber = dryRunSink.reporter.subscribe(event => {
this._reporter.next(event);
error = error || (event.kind == 'error');
});

// We need two sinks if we want to output what will happen, and actually do the work.
return [
dryRunSink,
// Add a custom sink that clean ourselves and throws an error if an error happened.
{
commit() {
dryRunSubscriber.unsubscribe();
if (error) {
return throwError(new UnsuccessfulWorkflowExecution());
}

return of();
},
},

// Only add a HostSink if this is not a dryRun.
...(!this._dryRun ? [new HostSink(this._host, this._force)] : []),
];
}

execute(
options: Partial<WorkflowExecutionContext> & RequiredWorkflowExecutionContext,
): Observable<void> {
Expand All @@ -112,17 +142,7 @@ export abstract class BaseWorkflow implements Workflow {
|| (parentContext && parentContext.collection === options.collection);
const schematic = collection.createSchematic(options.schematic, allowPrivate);

// We need two sinks if we want to output what will happen, and actually do the work.
// Note that fsSink is technically not used if `--dry-run` is passed, but creating the Sink
// does not have any side effect.
const dryRunSink = new DryRunSink(this._host, this._force);
const fsSink = new HostSink(this._host, this._force);

let error = false;
const dryRunSubscriber = dryRunSink.reporter.subscribe(event => {
this._reporter.next(event);
error = error || (event.kind == 'error');
});
const sinks = this._createSinks();

this._lifeCycle.next({ kind: 'workflow-start' });

Expand All @@ -141,23 +161,18 @@ export abstract class BaseWorkflow implements Workflow {
).pipe(
map(tree => optimize(tree)),
concatMap((tree: Tree) => {
return concat(
dryRunSink.commit(tree).pipe(ignoreElements()),
of(tree),
// Process all sinks.
return of(tree).pipe(
...sinks.map(sink => {
return concatMap((tree: Tree) => {
return concat(
sink.commit(tree).pipe(ignoreElements()),
of(tree),
);
});
}),
);
}),
concatMap((tree: Tree) => {
dryRunSubscriber.unsubscribe();
if (error) {
return throwError(new UnsuccessfulWorkflowExecution());
}

if (this._dryRun) {
return of();
}

return fsSink.commit(tree).pipe(defaultIfEmpty(), last());
}),
concatMap(() => {
if (this._dryRun) {
return of();
Expand Down