maxmustermann/pulumi
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Reduce scope of serializataion breaking change

Browse source
This commit is contained in:
Luke Hoban 2020-01-21 23:12:11 -08:00 committed by Pat Gavlin
parent 204b779cbb
commit c41bccffce
4 changed files with 50 additions and 25 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
sdk/nodejs/remote/index.ts
View file

@ -94,9 +94,9 @@ class RemoteServer {
}
public async construct(libraryPath: string, resource: string, name: string, args: any, opts?: any): Promise<any> {
const serializedArgs = await runtime.serializeProperties("construct-args", args);
const serializedArgs = await runtime.serializeProperties("construct-args", args, { keepResources: true });
const argsStruct = gstruct.Struct.fromJavaScript(serializedArgs);
const serializedOpts = await runtime.serializeProperties("construct-opts", opts);
const serializedOpts = await runtime.serializeProperties("construct-opts", opts, { keepResources: true });
const optsStruct = gstruct.Struct.fromJavaScript(serializedOpts);
const client = await this.client;
const constructRequest = new runtimeProto.ConstructRequest();

4
sdk/nodejs/remote/server/index.ts
View file

@ -36,10 +36,10 @@ function construct(call: any, callback: (err: any, resp?: any) => void) {
const resource = call.request.getResource();
const name = call.request.getName();
const ctor = library[resource];
const res = new ctor(name, props, opts);
runtime.serializeProperties("inner-construct", res).then(resolved => {
runtime.serializeProperties("inner-construct", res, { keepResources: true }).then(resolved => {
const outStruct = gstruct.Struct.fromJavaScript(resolved);
const reply = new runtimeProto.ConstructResponse();
reply.setOuts(outStruct);

2
sdk/nodejs/runtime/resource.ts
View file

@ -558,7 +558,7 @@ export function registerResourceOutputs(res: Resource, outputs: Inputs | Promise
// The registration could very well still be taking place, so we will need to wait for its URN.
// Additionally, the output properties might have come from other resources, so we must await those too.
const urn = await res.urn.promise();
const resolved = await serializeProperties(opLabel, { outputs });
const resolved = await serializeProperties(opLabel, { outputs }, { keepResources: true });
const outputsObj = gstruct.Struct.fromJavaScript(resolved.outputs);
log.debug(`RegisterResourceOutputs RPC prepared: urn=${urn}` +
(excessiveDebugOutput ? `, outputs=${JSON.stringify(outputsObj)}` : ``));

65
sdk/nodejs/runtime/rpc.ts
View file

@ -82,7 +82,11 @@ export function transferProperties(onto: Resource, label: string, props: Inputs)
* be remoted over to registerResource.
*/
async function serializeFilteredProperties(
label: string, props: Inputs, acceptKey: (k: string) => boolean): Promise<[Record<string, any>, Map<string, Set<Resource>>]> {
label: string,
props: Inputs,
acceptKey: (k: string) => boolean,
opts?: SerializeOptions,
): Promise<[Record<string, any>, Map<string, Set<Resource>>]> {
const propertyToDependentResources = new Map<string, Set<Resource>>();
@ -91,7 +95,7 @@ async function serializeFilteredProperties(
if (acceptKey(k)) {
// We treat properties with undefined values as if they do not exist.
const dependentResources = new Set<Resource>();
const v = await serializeProperty(`${label}.${k}`, props[k], dependentResources);
const v = await serializeProperty(`${label}.${k}`, props[k], dependentResources, opts);
if (v !== undefined) {
result[k] = v;
propertyToDependentResources.set(k, dependentResources);
@ -110,12 +114,24 @@ export async function serializeResourceProperties(label: string, props: Inputs)
return serializeFilteredProperties(label, props, key => key !== "id" && key !== "urn");
}
/**
* SerializeOptions represents options that can be passed to a property serialization function.
*/
export interface SerializeOptions {
/**
* keepResources indicates that resource references should be maintained as strongly typed
* `Resource` instances instead of erased down to `id` (for CustomResources) or `urn` (for
* `ComponetResources`).
*/
keepResources?: boolean;
}
/**
* serializeProperties walks the props object passed in, awaiting all interior promises, creating a reasonable
* POJO object that can be remoted over to registerResource.
*/
export async function serializeProperties(label: string, props: Inputs) {
const [result] = await serializeFilteredProperties(label, props, _ => true);
export async function serializeProperties(label: string, props: Inputs, opts?: SerializeOptions) {
const [result] = await serializeFilteredProperties(label, props, _ => true, opts);
return result;
}
@ -231,7 +247,7 @@ export const specialResourceSig = "5cf8f73096256a8f31e491e813e4eb8e";
* serializeProperty serializes properties deeply. This understands how to wait on any unresolved promises, as
* appropriate, in addition to translating certain "special" values so that they are ready to go on the wire.
*/
export async function serializeProperty(ctx: string, prop: Input<any>, dependentResources: Set<Resource>): Promise<any> {
export async function serializeProperty(ctx: string, prop: Input<any>, dependentResources: Set<Resource>, opts: SerializeOptions = {}): Promise<any> {
// IMPORTANT:
// IMPORTANT: Keep this in sync with serializePropertiesSync in invoke.ts
// IMPORTANT:
@ -266,7 +282,7 @@ export async function serializeProperty(ctx: string, prop: Input<any>, dependent
const subctx = `Promise<${ctx}>`;
return serializeProperty(subctx,
await debuggablePromise(prop, `serializeProperty.await(${subctx})`), dependentResources);
await debuggablePromise(prop, `serializeProperty.await(${subctx})`), dependentResources, opts);
}
if (Output.isInstance(prop)) {
@ -293,7 +309,7 @@ export async function serializeProperty(ctx: string, prop: Input<any>, dependent
// which will wrap undefined, if it were to be resolved (since `Output` has no member named .isSecret).
// so we must compare to the literal true instead of just doing await prop.isSecret.
const isSecret = await prop.isSecret === true;
const value = await serializeProperty(`${ctx}.id`, prop.promise(), dependentResources);
const value = await serializeProperty(`${ctx}.id`, prop.promise(), dependentResources, opts);
if (!isKnown) {
return unknownValue;
@ -313,17 +329,21 @@ export async function serializeProperty(ctx: string, prop: Input<any>, dependent
}
if (CustomResource.isInstance(prop)) {
// Resources aren't serializable; instead, we serialize them as references to the URN property.
if (excessiveDebugOutput) {
log.debug(`Serialize property [${ctx}]: custom resource urn`);
}
dependentResources.add(prop);
const urn = await serializeProperty(`${ctx}.urn`, prop.urn, dependentResources);
return {
[specialSigKey]: specialResourceSig,
urn: urn,
};
if (opts.keepResources) {
// If we are keeping resources, emit a stronly typed wrapper over the URN
const urn = await serializeProperty(`${ctx}.urn`, prop.urn, dependentResources, opts);
return {
[specialSigKey]: specialResourceSig,
urn: urn,
};
}
// Else, return the id for backward compatibility.
return serializeProperty(`${ctx}.id`, prop.id, dependentResources, opts);
}
if (ComponentResource.isInstance(prop)) {
@ -345,11 +365,16 @@ export async function serializeProperty(ctx: string, prop: Input<any>, dependent
log.debug(`Serialize property [${ctx}]: component resource urn`);
}
const urn = await serializeProperty(`${ctx}.urn`, prop.urn, dependentResources);
return {
[specialSigKey]: specialResourceSig,
urn: urn,
};
if (opts.keepResources) {
// If we are keeping resources, emit a stronly typed wrapper over the URN
const urn = await serializeProperty(`${ctx}.urn`, prop.urn, dependentResources, opts);
return {
[specialSigKey]: specialResourceSig,
urn: urn,
};
}
// Else, return the urn for backward compatibility.
return serializeProperty(`${ctx}.urn`, prop.urn, dependentResources, opts);
}
if (prop instanceof Array) {
@ -359,7 +384,7 @@ export async function serializeProperty(ctx: string, prop: Input<any>, dependent
log.debug(`Serialize property [${ctx}]: array[${i}] element`);
}
// When serializing arrays, we serialize any undefined values as `null`. This matches JSON semantics.
const elem = await serializeProperty(`${ctx}[${i}]`, prop[i], dependentResources);
const elem = await serializeProperty(`${ctx}[${i}]`, prop[i], dependentResources, opts);
result.push(elem === undefined ? null : elem);
}
return result;
@ -374,7 +399,7 @@ export async function serializeProperty(ctx: string, prop: Input<any>, dependent
}
// When serializing an object, we omit any keys with undefined values. This matches JSON semantics.
const v = await serializeProperty(`${ctx}.${k}`, innerProp[k], dependentResources);
const v = await serializeProperty(`${ctx}.${k}`, innerProp[k], dependentResources, opts);
if (v !== undefined) {
obj[k] = v;
}