feat: new synthesizer separates assets out per CDK application

packages/@aws-cdk/core-synthesizer/.eslintrc.js

@@ -0,0 +1,4 @@
+const baseConfig = require('@aws-cdk/cdk-build-tools/config/eslintrc');
+baseConfig.ignorePatterns.push('resources/**/*');
+baseConfig.parserOptions.project = __dirname + '/tsconfig.json';
+module.exports = baseConfig;

packages/@aws-cdk/core-synthesizer/.gitignore

@@ -0,0 +1,22 @@
+*.js
+*.d.ts
+tsconfig.json
+*.generated.ts
+*.js.map
+dist
+coverage
+.nyc_output
+.jsii
+
+.LAST_BUILD
+nyc.config.js
+.LAST_PACKAGE
+*.snk
+!.eslintrc.js
+
+junit.xml
+!jest.config.js
+!**/*.snapshot/**/asset.*/*.js
+!**/*.snapshot/**/asset.*/*.d.ts
+
+!**/*.snapshot/**/asset.*/**

packages/@aws-cdk/core-synthesizer/.npmignore

@@ -0,0 +1,14 @@
+
+.LAST_BUILD
+*.snk
+junit.xml
+*.ts
+!*.d.ts
+!*.js
+!*.lit.ts
+coverage
+.nyc_output
+*.tgz
+.eslintrc.js
+# exclude cdk artifacts
+**/cdk.out

packages/@aws-cdk/core-synthesizer/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

packages/@aws-cdk/core-synthesizer/NOTICE

@@ -0,0 +1,2 @@
+AWS Cloud Development Kit (AWS CDK)
+Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.

packages/@aws-cdk/core-synthesizer/README.md

@@ -0,0 +1 @@
+# Synthesizer

packages/@aws-cdk/core-synthesizer/lib/index.ts

@@ -0,0 +1,2 @@
+export * from './staging-stack';
+export * from './synthesizer';

packages/@aws-cdk/core-synthesizer/lib/staging-stack.ts

@@ -0,0 +1,61 @@
+import * as ecr from '@aws-cdk/aws-ecr';
+import * as s3 from '@aws-cdk/aws-s3';
+import { DockerImageAssetSource, RemovalPolicy, Stack, StackProps } from '@aws-cdk/core';
+import { Construct, IConstruct } from 'constructs';
+
+/**
+ * Information on how a Staging Stack should look.
+ */
+export interface IStagingStack extends IConstruct {
+  /**
+   * // TODO
+   */
+  readonly stagingBucket: s3.Bucket;
+
+  /**
+   * // TODO
+   */
+  readonly stagingRepos: Record<string, ecr.Repository>;
+
+  /**
+   * // TODO
+   */
+  locateRepo(asset: DockerImageAssetSource): ecr.Repository;
+}
+
+/**
+ * Staging Stack Properties
+ */
+export interface StagingStackProps extends StackProps {
+}
+
+/**
+ * A default Staging Stack
+ */
+export class StagingStack extends Stack implements IStagingStack {
+  /**
+   * // TODO
+   */
+  public readonly stagingBucket: s3.Bucket;
+
+  /**
+   * // TODO
+   */
+  public readonly stagingRepos: Record<string, ecr.Repository>;
+
+  constructor(scope: Construct, id: string, props: StagingStackProps = {}) {
+    super(scope, id, props);
+
+    this.stagingBucket = new s3.Bucket(this, 'StagingBucket', {
+      autoDeleteObjects: true,
+      removalPolicy: RemovalPolicy.DESTROY,
+    });
+
+    this.stagingRepos = {};
+  }
+
+  public locateRepo(asset: DockerImageAssetSource): ecr.Repository {
+    // TODO: not the source hash! construct path
+    return this.stagingRepos[asset.sourceHash];
+  }
+}

packages/@aws-cdk/core-synthesizer/lib/synthesizer.ts

@@ -0,0 +1,79 @@
+import { App, AssetManifestBuilder, DockerImageAssetLocation, DockerImageAssetSource, FileAssetLocation, FileAssetSource, IBoundStackSynthesizer, IReusableStackSynthesizer, ISynthesisSession, Stack, StackSynthesizer } from '@aws-cdk/core';
+import { assertBound } from '@aws-cdk/core/lib/stack-synthesizers/_shared';
+import { IStagingStack, StagingStack } from './staging-stack';
+
+/**
+ * New stack synthesizer properties
+ */
+export interface NewStackSynthesizerProps {
+  /**
+   * Bring a custom staging stack into the app.
+   *
+   * @default - default staging stack
+   */
+  readonly stagingStack?: IStagingStack;
+}
+
+/**
+ * New Stack Synthesizer
+ */
+export class NewStackSynthesizer extends StackSynthesizer implements IReusableStackSynthesizer, IBoundStackSynthesizer {
+  private qualifier?: string;
+  private stagingStack: IStagingStack;
+  private assetManifest = new AssetManifestBuilder();
+
+  constructor(props: NewStackSynthesizerProps = {}) {
+    super();
+
+    // TODO: ensure no tokens
+
+    // TODO: revisit scope
+    this.stagingStack = props.stagingStack ?? new StagingStack(new App(), 'StagingStack', {});
+  }
+
+  /**
+   * // TODO
+   */
+  public reusableBind(stack: Stack): IBoundStackSynthesizer {
+    // Create a copy of the current object and bind that
+    const copy = Object.create(this);
+    copy.bind(stack);
+    return copy;
+  }
+
+  /**
+   * // TODO
+   */
+  public synthesize(_session: ISynthesisSession): void {
+    assertBound(this.qualifier);
+
+    // TODO: finish implementing
+  }
+
+  /**
+   * // TODO
+   */
+  public addFileAsset(asset: FileAssetSource): FileAssetLocation {
+    assertBound(this.stagingStack.stagingBucket.bucketName);
+
+    const location = this.assetManifest.defaultAddFileAsset(this.boundStack, asset, {
+      bucketName: this.stagingStack.stagingBucket.bucketName,
+      // TODO: more props
+    });
+    return this.cloudFormationLocationFromFileAsset(location);
+  }
+
+  /**
+   * // TODO
+   */
+  public addDockerImageAsset(asset: DockerImageAssetSource): DockerImageAssetLocation {
+    const repo = this.stagingStack.locateRepo(asset);
+    assertBound(repo.repositoryName);
+
+    const location = this.assetManifest.defaultAddDockerImageAsset(this.boundStack, asset, {
+      repositoryName: repo.repositoryName,
+      // TODO: more props
+    });
+    return this.cloudFormationLocationFromDockerImageAsset(location);
+  }
+}