fix: detect deploymentType from Stack Tags #2116
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
🦋 Changeset detectedLatest commit: eb32eb4 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Amplifiyer
added
the
run-e2e
Amplifiyer
commented
Oct 16, 2024
Comment on lines
+157
to
+163
| const stackDescription = await this.cfnClient.send( | ||
| new DescribeStacksCommand({ StackName: stackSummary.StackName }) | ||
| ); | ||
|
|
||
| try { | ||
| const backendOutput: BackendOutput = | ||
| await this.backendOutputClient.getOutput(backendIdentifier); | ||
|
|
||
| return backendOutput[platformOutputKey].payload | ||
| .deploymentType as DeploymentType; | ||
| } catch (error) { | ||
| if ( | ||
| (error as BackendOutputClientError).code === | ||
| BackendOutputClientErrorType.METADATA_RETRIEVAL_ERROR | ||
| ) { | ||
| // Ignore stacks where metadata cannot be retrieved. These are not Amplify stacks, or not compatible with this library. | ||
| return; | ||
| } | ||
| throw error; | ||
| } | ||
| return stackDescription.Stacks?.[0].Tags?.find( | ||
| (tag) => tag.Key === 'amplify:deployment-type' | ||
| )?.Value as DeploymentType; |
There was a problem hiding this comment.
This is the only functional change, rest are all test changes.
| @@ -171,98 +149,4 @@ void describe('Deployed Backend Client list delete failed stacks', () => { | |||
|
|
|||
| assert.equal(listStacksMockFn.mock.callCount(), 2); | |||
| }); | |||
|
|
|||
| void it('paginates listBackends when one page contains stacks, but it gets filtered due to not deleted failed status', async () => { | |||
There was a problem hiding this comment.
This test was duplicate of the one above.
| assert.equal(listStacksMockFn.mock.callCount(), 2); | ||
| }); | ||
|
|
||
| void it('paginates listBackends when one page contains stacks, but it gets filtered due to sandbox deploymentType', async () => { |
There was a problem hiding this comment.
Same, this test was duplicate of the one above.
Amplifiyer
requested review from
johnpc,
bzsurbhi and
ArseniyKotov
and removed request for
johnpc
sobolk
approved these changes
Oct 16, 2024
rtpascual
approved these changes
Oct 16, 2024
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.
Problem
listBackendscallstryGetDeploymentTypeto load the entire stack metadata and then infer deployment type from it.This creates issue if the stack is being created or deleted and the metadata is not available causing the
fetchBackendOutputto throw causing thelistBackendscall to fail.Issue number, if available:
Changes
Infer
deploymentTypefrom stack tags instead. If we can't we don't include that stack/backend in the result.Corresponding docs PR, if applicable:
Validation
Checklist
run-e2elabel set.By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.