-
Notifications
You must be signed in to change notification settings - Fork 56
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into poc/e2e-test
- Loading branch information
Showing
14 changed files
with
167 additions
and
115 deletions.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| --- | ||
| '@aws-amplify/integration-tests': patch | ||
| 'create-amplify': patch | ||
| '@aws-amplify/backend': patch | ||
| --- | ||
|
|
||
| chore: add new defineBackend to better align with other backend factories |
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,5 @@ | ||
| --- | ||
| '@aws-amplify/backend-deployer': patch | ||
| --- | ||
|
|
||
| do not require confirmation at pipeline deploy |
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 |
|---|---|---|
| @@ -1,103 +1,14 @@ | ||
| import { Construct } from 'constructs'; | ||
| import { ConstructFactory } from '@aws-amplify/plugin-types'; | ||
| import { Construct } from 'constructs'; | ||
| import { Stack } from 'aws-cdk-lib'; | ||
| import { | ||
| NestedStackResolver, | ||
| StackResolver, | ||
| } from './engine/nested_stack_resolver.js'; | ||
| import { SingletonConstructContainer } from './engine/singleton_construct_container.js'; | ||
| import { ToggleableImportPathVerifier } from './engine/toggleable_import_path_verifier.js'; | ||
| import { | ||
| AttributionMetadataStorage, | ||
| StackMetadataBackendOutputStorageStrategy, | ||
| } from '@aws-amplify/backend-output-storage'; | ||
| import { createDefaultStack } from './default_stack_factory.js'; | ||
| import { getUniqueBackendIdentifier } from './backend_identifier.js'; | ||
| import { | ||
| BackendDeploymentType, | ||
| SandboxBackendIdentifier, | ||
| } from '@aws-amplify/platform-core'; | ||
| import { stackOutputKey } from '@aws-amplify/backend-output-schemas'; | ||
| import { fileURLToPath } from 'url'; | ||
|
|
||
| // Be very careful editing this value. It is the value used in the BI metrics to attribute stacks as Amplify root stacks | ||
| const rootStackTypeIdentifier = 'root'; | ||
|
|
||
| /** | ||
| * Class that collects and instantiates all the Amplify backend constructs | ||
| * Top level type for instance returned from `defineBackend`. Contains property `resources` for overriding | ||
| * Amplify generated resources and `getOrCreateStack()` for adding custom resources. | ||
| */ | ||
| export class Backend<T extends Record<string, ConstructFactory<Construct>>> { | ||
| private readonly stackResolver: StackResolver; | ||
| /** | ||
| * These are the resolved CDK constructs that are created by the inputs to the constructor | ||
| * Used for overriding properties of underlying CDK constructs or to reference in custom CDK code | ||
| */ | ||
| export type Backend<T extends Record<string, ConstructFactory<Construct>>> = { | ||
| getOrCreateStack: (name: string) => Stack; | ||
| readonly resources: { | ||
| [K in keyof T]: ReturnType<T[K]['getInstance']>; | ||
| }; | ||
| /** | ||
| * Initialize an Amplify backend with the given construct factories and in the given CDK App. | ||
| * If no CDK App is specified a new one is created | ||
| */ | ||
| constructor(constructFactories: T, stack: Stack = createDefaultStack()) { | ||
| new AttributionMetadataStorage().storeAttributionMetadata( | ||
| stack, | ||
| rootStackTypeIdentifier, | ||
| fileURLToPath(new URL('../package.json', import.meta.url)) | ||
| ); | ||
| this.stackResolver = new NestedStackResolver(stack); | ||
|
|
||
| const constructContainer = new SingletonConstructContainer( | ||
| this.stackResolver | ||
| ); | ||
|
|
||
| const outputStorageStrategy = new StackMetadataBackendOutputStorageStrategy( | ||
| stack | ||
| ); | ||
|
|
||
| const uniqueBackendIdentifier = getUniqueBackendIdentifier(stack); | ||
| outputStorageStrategy.addBackendOutputEntry(stackOutputKey, { | ||
| version: '1', | ||
| payload: { | ||
| deploymentType: | ||
| uniqueBackendIdentifier instanceof SandboxBackendIdentifier | ||
| ? BackendDeploymentType.SANDBOX | ||
| : BackendDeploymentType.BRANCH, | ||
| }, | ||
| }); | ||
|
|
||
| const importPathVerifier = new ToggleableImportPathVerifier(); | ||
|
|
||
| // register providers but don't actually execute anything yet | ||
| Object.values(constructFactories).forEach((factory) => { | ||
| if (typeof factory.provides === 'string') { | ||
| constructContainer.registerConstructFactory(factory.provides, factory); | ||
| } | ||
| }); | ||
|
|
||
| // now invoke all the factories and collect the constructs into this.resources | ||
| // eslint-disable-next-line @typescript-eslint/no-explicit-any | ||
| this.resources = {} as any; | ||
| Object.entries(constructFactories).forEach( | ||
| ([resourceName, constructFactory]) => { | ||
| // The type inference on this.resources is not happy about this assignment because it doesn't know the exact type of .getInstance() | ||
| // However, the assignment is okay because we are iterating over the entries of constructFactories and assigning the resource name to the corresponding instance | ||
| this.resources[resourceName as keyof T] = constructFactory.getInstance( | ||
| { | ||
| constructContainer, | ||
| outputStorageStrategy, | ||
| importPathVerifier, | ||
| } | ||
| // eslint-disable-next-line @typescript-eslint/no-explicit-any | ||
| ) as any; | ||
| } | ||
| ); | ||
| } | ||
|
|
||
| /** | ||
| * Returns a CDK stack within the Amplify project that can be used for creating custom resources | ||
| */ | ||
| getOrCreateStack = (name: string): Stack => { | ||
| return this.stackResolver.getStackFor(name); | ||
| }; | ||
| } | ||
| }; |
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,117 @@ | ||
| import { Construct } from 'constructs'; | ||
| import { ConstructFactory } from '@aws-amplify/plugin-types'; | ||
| import { Stack } from 'aws-cdk-lib'; | ||
| import { | ||
| NestedStackResolver, | ||
| StackResolver, | ||
| } from './engine/nested_stack_resolver.js'; | ||
| import { SingletonConstructContainer } from './engine/singleton_construct_container.js'; | ||
| import { ToggleableImportPathVerifier } from './engine/toggleable_import_path_verifier.js'; | ||
| import { | ||
| AttributionMetadataStorage, | ||
| StackMetadataBackendOutputStorageStrategy, | ||
| } from '@aws-amplify/backend-output-storage'; | ||
| import { createDefaultStack } from './default_stack_factory.js'; | ||
| import { getUniqueBackendIdentifier } from './backend_identifier.js'; | ||
| import { | ||
| BackendDeploymentType, | ||
| SandboxBackendIdentifier, | ||
| } from '@aws-amplify/platform-core'; | ||
| import { stackOutputKey } from '@aws-amplify/backend-output-schemas'; | ||
| import { fileURLToPath } from 'url'; | ||
| import { Backend } from './backend.js'; | ||
|
|
||
| // Be very careful editing this value. It is the value used in the BI metrics to attribute stacks as Amplify root stacks | ||
| const rootStackTypeIdentifier = 'root'; | ||
|
|
||
| /** | ||
| * Factory that collects and instantiates all the Amplify backend constructs | ||
| */ | ||
| export class BackendFactory< | ||
| T extends Record<string, ConstructFactory<Construct>> | ||
| > implements Backend<T> | ||
| { | ||
| private readonly stackResolver: StackResolver; | ||
| /** | ||
| * These are the resolved CDK constructs that are created by the inputs to the constructor | ||
| * Used for overriding properties of underlying CDK constructs or to reference in custom CDK code | ||
| */ | ||
| readonly resources: { | ||
| [K in keyof T]: ReturnType<T[K]['getInstance']>; | ||
| }; | ||
| /** | ||
| * Initialize an Amplify backend with the given construct factories and in the given CDK App. | ||
| * If no CDK App is specified a new one is created | ||
| */ | ||
| constructor(constructFactories: T, stack: Stack = createDefaultStack()) { | ||
| new AttributionMetadataStorage().storeAttributionMetadata( | ||
| stack, | ||
| rootStackTypeIdentifier, | ||
| fileURLToPath(new URL('../package.json', import.meta.url)) | ||
| ); | ||
| this.stackResolver = new NestedStackResolver(stack); | ||
|
|
||
| const constructContainer = new SingletonConstructContainer( | ||
| this.stackResolver | ||
| ); | ||
|
|
||
| const outputStorageStrategy = new StackMetadataBackendOutputStorageStrategy( | ||
| stack | ||
| ); | ||
|
|
||
| const uniqueBackendIdentifier = getUniqueBackendIdentifier(stack); | ||
| outputStorageStrategy.addBackendOutputEntry(stackOutputKey, { | ||
| version: '1', | ||
| payload: { | ||
| deploymentType: | ||
| uniqueBackendIdentifier instanceof SandboxBackendIdentifier | ||
| ? BackendDeploymentType.SANDBOX | ||
| : BackendDeploymentType.BRANCH, | ||
| }, | ||
| }); | ||
|
|
||
| const importPathVerifier = new ToggleableImportPathVerifier(); | ||
|
|
||
| // register providers but don't actually execute anything yet | ||
| Object.values(constructFactories).forEach((factory) => { | ||
| if (typeof factory.provides === 'string') { | ||
| constructContainer.registerConstructFactory(factory.provides, factory); | ||
| } | ||
| }); | ||
|
|
||
| // now invoke all the factories and collect the constructs into this.resources | ||
| // eslint-disable-next-line @typescript-eslint/no-explicit-any | ||
| this.resources = {} as any; | ||
| Object.entries(constructFactories).forEach( | ||
| ([resourceName, constructFactory]) => { | ||
| // The type inference on this.resources is not happy about this assignment because it doesn't know the exact type of .getInstance() | ||
| // However, the assignment is okay because we are iterating over the entries of constructFactories and assigning the resource name to the corresponding instance | ||
| this.resources[resourceName as keyof T] = constructFactory.getInstance( | ||
| { | ||
| constructContainer, | ||
| outputStorageStrategy, | ||
| importPathVerifier, | ||
| } | ||
| // eslint-disable-next-line @typescript-eslint/no-explicit-any | ||
| ) as any; | ||
| } | ||
| ); | ||
| } | ||
|
|
||
| /** | ||
| * Returns a CDK stack within the Amplify project that can be used for creating custom resources | ||
| */ | ||
| getOrCreateStack = (name: string): Stack => { | ||
| return this.stackResolver.getStackFor(name); | ||
| }; | ||
| } | ||
|
|
||
| /** | ||
| * Creates a new Amplify backend instance and returns it | ||
| * @param constructFactories - list of backend factories such as those created by `defineAuth` or `defineData` | ||
| */ | ||
| export const defineBackend = < | ||
| T extends Record<string, ConstructFactory<Construct>> | ||
| >( | ||
| constructFactories: T | ||
| ): Backend<T> => new BackendFactory(constructFactories); |
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.