pulumi/sdk/nodejs/resource.ts
joeduffy 087deb7643 Add optional dependsOn to Resource constructors
This change adds an optiona dependsOn parameter to Resource constructors,
to "force" a fake dependency between resources.  We have an extremely strong
desire to resort to using this only in unusual cases -- and instead rely
on the natural dependency DAG based on properties -- but experience in other
resource provisioning frameworks tells us that we're likely to need this in
the general case.  Indeed, we've already encountered the need in AWS's
API Gateway resources... and I suspect we'll run into more especially as we
tackle non-serverless resources like EC2 Instances, where "ambient"
dependencies are far more commonplace.

This also makes parallelism the default mode of operation, and we have a
new --serialize flag that can be used to suppress this default behavior.
Full disclosure: I expect this to become more Make-like, i.e. -j 8, where
you can specify the precise width of parallelism, when we tackle
pulumi/pulumi-fabric#106.  I also think there's a good chance we will flip
the default, so that serial execution is the default, so that developers
who don't benefit from the parallelism don't need to worry about dependsOn
in awkward ways.  This tends to be the way most tools (like Make) operate.

This fixes pulumi/pulumi-fabric#335.
2017-09-15 16:38:52 -07:00

35 lines
1.8 KiB
TypeScript

// Copyright 2016-2017, Pulumi Corporation. All rights reserved.
import { Computed, MaybeComputed } from "./computed";
import * as runtime from "./runtime";
export type ID = string; // a provider-assigned ID.
export type URN = string; // an automatically generated logical URN, used to stably identify resources.
// Resource represents a class whose CRUD operations are implemented by a provider plugin.
export abstract class Resource {
// id is the provider-assigned unique ID for this object. It is set during deployments.
public readonly id: Computed<ID>;
// urn is the stable logical URN used to distinctly address an object, both before and after deployments.
public readonly urn: Computed<URN>;
// creates and registers a new resource object. t is the fully qualified type token and name is the "name" part
// to use in creating a stable and globally unique URN for the object. dependsOn is an optional list of other
// resources that this resource depends on, controlling the order in which we perform resource operations.
constructor(t: string, name: string,
props: {[key: string]: MaybeComputed<any> | undefined}, dependsOn?: Resource[]) {
if (t === undefined || t === "") {
throw new Error("Missing resource type argument");
}
if (name === undefined || name === "") {
throw new Error("Missing resource name argument (for URN creation)");
}
// Now kick off the resource registration. If we are actually performing a deployment, this resource's
// properties will be resolved asynchronously after the operation completes, so that dependent computations
// resolve normally. If we are just planning, on the other hand, values will never resolve.
runtime.registerResource(this, t, name, props, dependsOn);
}
}