Make many fixes to closure serialization Primary things that i've done as part of this change: Added support for cyclic objects. Properly serialize objects that are shared across different function. previously you would get multiple copies, now you properly reference the same copy. Remove the usages of 'hashes' for functions. Because we track identity of objects, we no longer need them. Serialize properties of functions (if they have any). Handle Objects/Functions with different __proto__s than normal. i.e. classes/constructors. but also anything the user may have done themselves to the object. Handle generator functions. Handle functions with 'computed' names. Handle functions with 'symbol' names. Handle serializing Promises as Promises. Removed the dual Closure/AsyncClosure tree. One existed solely so we could have a tree without promises (for use in testing maybe?). Because this all exists in a part of our codebase that is entirely async, it's fine to have promises in the tree, and to await them when serializing the Closure to a string. Handle serializing class-constructors and methods. Including properly handling 'super' calls.
156 lines
4.8 KiB
TypeScript
156 lines
4.8 KiB
TypeScript
// Copyright 2016-2017, Pulumi Corporation. All rights reserved.
|
|
|
|
import * as resource from "../resource";
|
|
import * as runtime from "../runtime";
|
|
|
|
/**
|
|
* CheckResult represents the results of a call to `ResourceProvider.check`.
|
|
*/
|
|
export interface CheckResult {
|
|
/**
|
|
* The inputs to use, if any.
|
|
*/
|
|
readonly inputs?: any;
|
|
|
|
/**
|
|
* Any validation failures that occurred.
|
|
*/
|
|
readonly failures?: CheckFailure[];
|
|
}
|
|
|
|
/**
|
|
* CheckFailure represents a single failure in the results of a call to `ResourceProvider.check`
|
|
*/
|
|
export interface CheckFailure {
|
|
/**
|
|
* The property that failed validation.
|
|
*/
|
|
readonly property: string;
|
|
|
|
/**
|
|
* The reason that the property failed validation.
|
|
*/
|
|
readonly reason: string;
|
|
}
|
|
|
|
/**
|
|
* DiffResult represents the results of a call to `ResourceProvider.diff`.
|
|
*/
|
|
export interface DiffResult {
|
|
/**
|
|
* If this update requires a replacement, the set of properties triggering it.
|
|
*/
|
|
readonly replaces?: string[];
|
|
|
|
/**
|
|
* An optional list of properties that will not ever change.
|
|
*/
|
|
readonly stables?: string[];
|
|
|
|
/**
|
|
* If true, and a replacement occurs, the resource will first be deleted before being recreated. This is to
|
|
* void potential side-by-side issues with the default create before delete behavior.
|
|
*/
|
|
readonly deleteBeforeReplace?: boolean;
|
|
}
|
|
|
|
/**
|
|
* CreateResult represents the results of a call to `ResourceProvider.create`.
|
|
*/
|
|
export interface CreateResult {
|
|
/**
|
|
* The ID of the created resource.
|
|
*/
|
|
readonly id: resource.ID;
|
|
|
|
/**
|
|
* Any properties that were computed during creation.
|
|
*/
|
|
readonly outs?: any;
|
|
}
|
|
|
|
/**
|
|
* UpdateResult represents the results of a call to `ResourceProvider.update`.
|
|
*/
|
|
export interface UpdateResult {
|
|
/**
|
|
* Any properties that were computed during updating.
|
|
*/
|
|
readonly outs?: any;
|
|
}
|
|
|
|
/**
|
|
* ResourceProvider represents an object that provides CRUD operations for a particular type of resource.
|
|
*/
|
|
export interface ResourceProvider {
|
|
/**
|
|
* Check validates that the given property bag is valid for a resource of the given type.
|
|
*
|
|
* @param olds The old input properties to use for validation.
|
|
* @param news The new input properties to use for validation.
|
|
*/
|
|
check?: (olds: any, news: any) => Promise<CheckResult>;
|
|
|
|
/**
|
|
* Diff checks what impacts a hypothetical update will have on the resource's properties.
|
|
*
|
|
* @param id The ID of the resource to diff.
|
|
* @param olds The old values of properties to diff.
|
|
* @param news The new values of properties to diff.
|
|
*/
|
|
diff?: (id: resource.ID, olds: any, news: any) => Promise<DiffResult>;
|
|
|
|
/**
|
|
* Create allocates a new instance of the provided resource and returns its unique ID afterwards.
|
|
* If this call fails, the resource must not have been created (i.e., it is "transacational").
|
|
*
|
|
* @param inputs The properties to set during creation.
|
|
*/
|
|
create: (inputs: any) => Promise<CreateResult>;
|
|
|
|
/**
|
|
* Update updates an existing resource with new values.
|
|
*
|
|
* @param id The ID of the resource to update.
|
|
* @param olds The old values of properties to update.
|
|
* @param news The new values of properties to update.
|
|
*/
|
|
update?: (id: resource.ID, olds: any, news: any) => Promise<UpdateResult>;
|
|
|
|
/**
|
|
* Delete tears down an existing resource with the given ID. If it fails, the resource is assumed to still exist.
|
|
*
|
|
* @param id The ID of the resource to delete.
|
|
* @param props The current properties on the resource.
|
|
*/
|
|
delete?: (id: resource.ID, props: any) => Promise<void>;
|
|
}
|
|
|
|
function serializeProvider(provider: ResourceProvider): Promise<string> {
|
|
return runtime.serializeFunctionAsync(() => provider);
|
|
}
|
|
|
|
/**
|
|
* Resource represents a Pulumi Resource that incorporates an inline implementation of the Resource's CRUD operations.
|
|
*/
|
|
export abstract class Resource extends resource.CustomResource {
|
|
/**
|
|
* Creates a new dynamic resource.
|
|
*
|
|
* @param provider The implementation of the resource's CRUD operations.
|
|
* @param name The name of the resource.
|
|
* @param props The arguments to use to populate the new resource. Must not define the reserved
|
|
* property "__provider".
|
|
* @param opts A bag of options that control this resource's behavior.
|
|
*/
|
|
constructor(provider: ResourceProvider, name: string, props: resource.Inputs,
|
|
opts?: resource.ResourceOptions) {
|
|
const providerKey: string = "__provider";
|
|
if (props[providerKey]) {
|
|
throw new Error("A dynamic resource must not define the __provider key");
|
|
}
|
|
props[providerKey] = serializeProvider(provider);
|
|
|
|
super("pulumi-nodejs:dynamic:Resource", name, props, opts);
|
|
}
|
|
}
|