Framework: Tokens can be converted to strings #518
There are no files selected for viewing
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
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,83 @@ | ||
| import { resolve, Token } from "../core/tokens"; | ||
| import { CloudFormationToken, isIntrinsic } from "./cloudformation-token"; | ||
|
|
||
| /** | ||
| * Class for JSON routines that are framework-aware | ||
| */ | ||
| export class CloudFormationJSON { | ||
| /** | ||
| * Turn an arbitrary structure potentially containing Tokens into JSON. | ||
|
There was a problem hiding this comment. Return type should be There was a problem hiding this comment. It actually returns a |
||
| */ | ||
| public static stringify(obj: any): any { | ||
| return new Token(() => { | ||
| // Resolve inner value so that if they evaluate to literals, we maintain the type. | ||
| // | ||
| // Then replace intrinsics with a special sublcass of Token that overrides toJSON() to | ||
|
There was a problem hiding this comment. "sublcass" => "subclass", "to and" => "and" (i think) |
||
| // and deep-escapes the intrinsic, so if we resolve() the strings again it evaluates | ||
| // to the right string. | ||
| const resolved = resolve(obj); | ||
|
|
||
| // We can just directly return this value, since resolve() will be called | ||
| // on our return value anyway. | ||
| return JSON.stringify(deepReplaceIntrinsics(resolved)); | ||
| }); | ||
|
|
||
| /** | ||
| * Recurse into a structure, replace all intrinsics with | ||
|
|
||
| */ | ||
| function deepReplaceIntrinsics(x: any): any { | ||
| if (isIntrinsic(x)) { | ||
| return wrapIntrinsic(x); | ||
| } | ||
|
|
||
| if (Array.isArray(x)) { | ||
| return x.map(deepReplaceIntrinsics); | ||
| } | ||
|
|
||
| if (typeof x === 'object') { | ||
| for (const key of Object.keys(x)) { | ||
| x[key] = deepReplaceIntrinsics(x[key]); | ||
| } | ||
| } | ||
|
|
||
| return x; | ||
| } | ||
|
|
||
| function wrapIntrinsic(intrinsic: any): IntrinsicToken { | ||
| return new IntrinsicToken(() => deepQuoteStringsForJSON(intrinsic)); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| class IntrinsicToken extends CloudFormationToken { | ||
| /** | ||
| * Special handler that gets called when JSON.stringify() is used. | ||
| */ | ||
| public toJSON() { | ||
| return this.toString(); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Deep escape strings for use in a JSON context | ||
| */ | ||
| function deepQuoteStringsForJSON(x: any): any { | ||
| if (typeof x === 'string') { | ||
| // Whenever we escape a string we strip off the outermost quotes | ||
| // since we're already in a quoted context. | ||
| const stringified = JSON.stringify(x); | ||
| return stringified.substring(1, stringified.length - 1); | ||
| } | ||
|
|
||
| if (Array.isArray(x)) { | ||
| return x.map(deepQuoteStringsForJSON); | ||
| } | ||
|
|
||
| if (typeof x === 'object') { | ||
| for (const key of Object.keys(x)) { | ||
| x[key] = deepQuoteStringsForJSON(x[key]); | ||
| } | ||
| } | ||
|
|
||
| return x; | ||
| } | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| import { Token } from "../core/tokens"; | ||
|
|
||
| /** | ||
| * Base class for CloudFormation built-ins | ||
| */ | ||
| export class CloudFormationToken extends Token { | ||
| constructor(valueOrFunction: any, stringRepresentationHint?: string) { | ||
| super(valueOrFunction, { | ||
| joiner: CLOUDFORMATION_JOINER, | ||
| stringRepresentationHint | ||
| }); | ||
| } | ||
| } | ||
|
|
||
| import { FnConcat } from "./fn"; | ||
|
|
||
| /** | ||
| * The default intrinsics Token engine for CloudFormation | ||
| */ | ||
| export const CLOUDFORMATION_JOINER = { | ||
| joinerName: 'CloudFormation', | ||
|
|
||
| joinStringFragments(fragments: any[]): any { | ||
| return new FnConcat(...fragments.map(x => isIntrinsic(x) ? x : `${x}`)); | ||
|
There was a problem hiding this comment. Instead of There was a problem hiding this comment. That fails in the case of |
||
| } | ||
| }; | ||
|
|
||
| /** | ||
| * Return whether the given value represents a CloudFormation intrinsic | ||
| */ | ||
| export function isIntrinsic(x: any) { | ||
| if (Array.isArray(x) || x === null || typeof x !== 'object') { return false; } | ||
|
There was a problem hiding this comment. use There was a problem hiding this comment. But |
||
|
|
||
| const keys = Object.keys(x); | ||
| if (keys.length !== 1) { return false; } | ||
|
|
||
| return keys[0] === 'Ref' || keys[0].startsWith('Fn::'); | ||
| } | ||
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
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
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
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
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
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This wraps a token and
CloudFormationJSON.stringifyalso returns aToken. Can we eliminate one layer?