Intriniscs Design Doc by viksrivat · Pull Request #1260 · aws/aws-sam-cli

viksrivat · 2019-07-09T17:01:37Z

Issue #, if available:

Description of changes:

Checklist:

Write Design Document (Do I need to write a design document?)
Write unit tests
Write/update functional tests
Write/update integration tests
make pr passes
Write documentation

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

designs/intrinsics_design.md

jfuss · 2019-07-11T16:50:13Z

designs/intrinsics_design.md

+
+### AWS::AccountId
+
+This property will be resolved by running an aws command to figure out the configuration. If there is an error, a randomly such as non-authenticated, a randomly generated string will take its place. 


Why? We have a default value already, why are we reaching out to the cloud for this?

jfuss · 2019-07-11T16:52:35Z

designs/intrinsics_design.md

+
+### AWS::StackId
+
+Currently, there is no real way to figure this one out. It will be a randomly generated String


static to remain consistent with what we do now. Also we should just state here what the static values are.

You should do a pass through all of these Pseudo Parameters and apply this feedback to each.

jfuss · 2019-07-11T16:53:33Z

designs/intrinsics_design.md

+
+## Implementing the Code
+
+This can be seperated into a Intrinsics resolver and a SymbolResolver.


I think an Intrinsics resolver is but should define what a SymbolResolver is and what it does.

designs/intrinsics_design.md

jfuss · 2019-07-11T17:51:46Z

designs/intrinsics_design.md

+
+## Integration into SAM-CLI
+
+This can be very easily plugged into the current SAM-CLI code. This needs to be run after the SamBaseTranslator runs in the ApiProvider. This will go through every property and check if it requires intrinsic resolution. 


SamBaseTranslator runs in any provider not just the ApiProvider.

I was talking about how it can be integrated into the current codebase and where this can be added into the ApiProvider

jfuss · 2019-07-15T14:50:40Z

designs/intrinsics_design.md

+* Customers can use tools such as AWS CDK to generate a template. The templates will have intrinsic properties. The customer can create their AWS CDK project with `cdk init app` and then generate their CloudFormation code using `cdk synth.`They can input their CloudFormation code to test it locally using the SAM CLI command. 
+* Customers can author CloudFormation resources and test them locally by inputting their templates into sam local start-api.
+
+Once the user has their  CloudFormation code, they will be running `sam local start-api --template /path/to/template.yaml`


Comment above still holds. This looks like it was from your other design and not sure how it relates to the intrinsic support.

jfuss · 2019-07-15T15:55:38Z

designs/intrinsics_design.md

+
+This intrinsic function is very similar to the Fn::And function, but will check that at least one of the items in the last returns a truthy value. 
+
+## Pseudo Parameters


Can we add what each of the Pseudo Parameters resolve to?

jfuss · 2019-07-15T16:01:55Z

designs/intrinsics_design.md

+}
+```
+
+* common_attribute_resolver: resolves common attributes that will be true across all


Is this used for helping resolve Fn::GetAtt for all the 'common' attributes a resource could typically have?

jfuss · 2019-07-15T16:06:35Z

designs/intrinsics_design.md

+```
+
+
+First pseudo types are checked. If item is present in the logical_id_translator it is returned. Otherwise, it falls back to the default_pseudo_resolver. Then the default_type_resolver is checked, which has common attributes and functions for each types. Then the common_attribute_resolver is run, which has functions that are common for each attribute.


All of this is for Pseudo Parameters? Pseudo parameters are all predefined. Seems like a lot of extra work that isn't needed.

The paragraph might need to be clarified. The paragraph describes the flow of logic for resolving symbol table attributes.

jfuss · 2019-07-15T16:15:57Z

designs/intrinsics_design.md

+    processed_template[processed_key] = processed_resource
+```
+
+If there is an error with the resource, the item will be ignored and processed.


What do you mean by error with the resource? Without understanding what you mean, it's hard to tell if this really should just ignore or bubble up the error to the customer.

The idea was to not break any workflows for unresolved symbol table or reference errors. Currently, in SAM these properties are ignored and wouldn't cause any errors, so by ignoring the errors we are using the same functionality. This is true for refs that exist to cloud instances. To ignore the error, we just copy the resource as is.
I will update this in the description.

jfuss

LGTM

Initial Design

6f03dd3

viksrivat changed the title ~~Initial Design~~ Intriniscs Design Doc Jul 9, 2019

viksrivat mentioned this pull request Jul 9, 2019

Intrinsics support #1261

Merged

6 tasks

Cleanup markdown

92bc72a

jfuss suggested changes Jul 11, 2019

View reviewed changes

viksrivat added 4 commits July 11, 2019 11:16

Update design doc with comments

d141e4b

Cleanup Fn::GetAtt and SymbolTable description

24f90bb

Update Pseudo Parameters design

8e112a2

Fix typos

a5ad9f7

jfuss self-assigned this Jul 15, 2019

jfuss suggested changes Jul 15, 2019

View reviewed changes

Update error handling

ea51e95

jfuss approved these changes Aug 7, 2019

View reviewed changes

jfuss added the stage/accepted Accepted and will be fixed label Aug 7, 2019

jfuss added 2 commits August 8, 2019 14:13

Merge branch 'develop' into feature/intrinsics_design

726c11f

Merge branch 'develop' into feature/intrinsics_design

d1be5b3

jfuss merged commit 2f96a9a into aws:develop Aug 9, 2019


		### AWS::AccountId

		This property will be resolved by running an aws command to figure out the configuration. If there is an error, a randomly such as non-authenticated, a randomly generated string will take its place.


		### AWS::StackId

		Currently, there is no real way to figure this one out. It will be a randomly generated String


		## Implementing the Code

		This can be seperated into a Intrinsics resolver and a SymbolResolver.


		## Integration into SAM-CLI

		This can be very easily plugged into the current SAM-CLI code. This needs to be run after the SamBaseTranslator runs in the ApiProvider. This will go through every property and check if it requires intrinsic resolution.


		This intrinsic function is very similar to the Fn::And function, but will check that at least one of the items in the last returns a truthy value.

		## Pseudo Parameters

		```


		First pseudo types are checked. If item is present in the logical_id_translator it is returned. Otherwise, it falls back to the default_pseudo_resolver. Then the default_type_resolver is checked, which has common attributes and functions for each types. Then the common_attribute_resolver is run, which has functions that are common for each attribute.

Conversation

viksrivat commented Jul 9, 2019

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

viksrivat Jul 11, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jfuss left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

viksrivat Jul 11, 2019 •

edited

Loading