Fix Swagger serialization #34
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The Swagger spec object can contain embedded computed objects, so we actually can't compute its value entirely promptly anymore. (Previously we JSON serialized it using our custom runtime implementation, which apparently tolerated unavailable computed values.) This change properly mapValue-ifies the serialization logic, in all its ugly glory. Unfortunately, this also means we can't promptly compute the hash based entirely on the values, which is used for resource object ID calculation. For now, we will just skip the non-prompt parts; this will lead to false hash collisions, but anything else would be super hacky and all of this will get better imminently once the current round of changes land and we can tackle pulumi/pulumi#331.
lukehoban
reviewed
Sep 9, 2017
| @@ -59,6 +59,47 @@ interface SwaggerSpec { | |||
| "x-amazon-apigateway-binary-media-types"?: string[]; | |||
| } | |||
|
|
|||
| // jsonStringifySwaggerSpec creates a JSON string out of a Swagger spec object. This is required versus an | |||
| // ordinary JSON.stringify because the spec contains computed values. | |||
| function jsonStringifySwaggerSpec(spec: SwaggerSpec): { json: string | fabric.Computed<string>, hash: string } { | |||
There was a problem hiding this comment.
Curious - why does this need to support the case of returning a string instead of just always returning a fabric.Computed<string>? Not that it really matters assuming we undo all of this after pulumi/pulumi#331.
There was a problem hiding this comment.
If there are no methods, there would be no computeds, and because Property isn't public there's no way to create a zero initialized one without resorting to internal runtime APIs. Obviously if we kept any of this, we'd need to fix this, but as you say, we aren't.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The Swagger spec object can contain embedded computed objects, so
we actually can't compute its value entirely promptly anymore. (Previously
we JSON serialized it using our custom runtime implementation, which
apparently tolerated unavailable computed values.) This change properly
mapValue-ifies the serialization logic, in all its ugly glory. Unfortunately,
this also means we can't promptly compute the hash based entirely on the
values, which is used for resource object ID calculation. For now, we will
just skip the non-prompt parts; this will lead to false hash collisions, but
anything else would be super hacky and all of this will get better imminently
once the current round of changes land and we can tackle pulumi/pulumi#331.