refactor(core): fold "assets" to "core"

Fold the "assets" module, which includes the `Staging` construct that takes care of staging asset files into the cloud assembly during synthesis into "core". This is in order to allow implementing custom resources that leverage assets throughout the framework. A subsequent commit will add a mini-framework for custom resources that leverages this capability.
aws · Apr 30, 2020 · 4bd8453 · 4bd8453
1 parent 1ee629e
commit 4bd8453
Show file tree

Hide file tree

Showing 33 changed files with 361 additions and 193 deletions.
diff --git a/package.json b/package.json
@@ -45,8 +45,8 @@
       "**/jszip/**",
       "@aws-cdk/cdk-assets-schema/semver",
       "@aws-cdk/cdk-assets-schema/semver/**",
-      "@aws-cdk/assets/minimatch",
-      "@aws-cdk/assets/minimatch/**",
+      "@aws-cdk/core/minimatch",
+      "@aws-cdk/core/minimatch/**",
       "@aws-cdk/aws-codepipeline-actions/case",
       "@aws-cdk/aws-codepipeline-actions/case/**",
       "@aws-cdk/aws-ecr-assets/minimatch",

diff --git a/packages/@aws-cdk/assets/README.md b/packages/@aws-cdk/assets/README.md
@@ -2,15 +2,11 @@
 <!--BEGIN STABILITY BANNER-->
 ---
 
-![cdk-constructs: Experimental](https://img.shields.io/badge/cdk--constructs-experimental-important.svg?style=for-the-badge)
+![Deprecated](https://img.shields.io/badge/deprecated-critical.svg?style=for-the-badge)
 
-> The APIs of higher level constructs in this module are experimental and under active development. They are subject to non-backward compatible changes or removal in any future version. These are not subject to the [Semantic Versioning](https://semver.org/) model and breaking changes will be announced in the release notes. This means that while you may use them, you may need to update your source code when upgrading to a newer version of this package.
+> This API may emit warnings. Backward compatibility is not guaranteed.
 
 ---
 <!--END STABILITY BANNER-->
 
-This module includes core classes for to CDK assets, used for copying asset
-files to a staging area. Most CDK users should not need to use the classes in
-this package directly.
-
-
+All types moved to @aws-cdk/core.
diff --git a/packages/@aws-cdk/assets/lib/api.ts b/packages/@aws-cdk/assets/lib/api.ts
diff --git a/packages/@aws-cdk/assets/lib/fs/follow-mode.ts b/packages/@aws-cdk/assets/lib/fs/follow-mode.ts
diff --git a/packages/@aws-cdk/assets/lib/fs/index.ts b/packages/@aws-cdk/assets/lib/fs/index.ts
diff --git a/packages/@aws-cdk/assets/lib/fs/options.ts b/packages/@aws-cdk/assets/lib/fs/options.ts
diff --git a/packages/@aws-cdk/assets/lib/index.ts b/packages/@aws-cdk/assets/lib/index.ts
@@ -1,4 +1,67 @@
-export * from './api';
-export * from './fs/follow-mode';
-export * from './fs/options';
-export * from './staging';
+import * as core from '@aws-cdk/core';
+
+/**
+ * Deprecated.
+ * @deprecated moved to `core.IAsset`
+ */
+export interface IAsset extends core.IAsset { }
+
+/**
+ * Deprecated.
+ * @deprecated moved to `core.StagingProps`
+ */
+export interface StagingProps extends core.AssetStagingProps {
+
+}
+
+/**
+ * Deprecated.
+ * @deprecated moved to `core.Staging`
+ */
+export class Staging extends core.AssetStaging { }
+
+/**
+ * Deprecated.
+ * @deprecated moved to `core.CopyOptions`
+ */
+export interface CopyOptions extends core.CopyOptions { }
+
+/**
+ * Deprecated.
+ * @deprecated moved to `core.CopyOptions`
+ */
+export interface FingerprintOptions extends core.FingerprintOptions { }
+
+/**
+ * Deprecated.
+ * @deprecated moved to `core.FollowMode`
+ */
+export enum FollowMode {
+  /**
+   * Never follow symlinks.
+   */
+  NEVER = 'never',
+
+  /**
+   * Materialize all symlinks, whether they are internal or external to the source directory.
+   */
+  ALWAYS = 'always',
+
+  /**
+   * Only follows symlinks that are external to the source directory.
+   */
+  EXTERNAL = 'external',
+
+  // ----------------- TODO::::::::::::::::::::::::::::::::::::::::::::
+  /**
+   * Forbids source from having any symlinks pointing outside of the source
+   * tree.
+   *
+   * This is the safest mode of operation as it ensures that copy operations
+   * won't materialize files from the user's file system. Internal symlinks are
+   * not followed.
+   *
+   * If the copy operation runs into an external symlink, it will fail.
+   */
+  BLOCK_EXTERNAL = 'internal-only',
+}
diff --git a/packages/@aws-cdk/assets/package.json b/packages/@aws-cdk/assets/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@aws-cdk/assets",
   "version": "0.0.0",
-  "description": "Integration of CDK apps with local assets",
+  "description": "This module is deprecated. All types are now available under the core module",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
   "jsii": {
@@ -64,7 +64,6 @@
   "license": "Apache-2.0",
   "devDependencies": {
     "@aws-cdk/assert": "0.0.0",
-    "@types/minimatch": "^3.0.3",
     "@types/nodeunit": "^0.0.30",
     "@types/sinon": "^9.0.0",
     "aws-cdk": "0.0.0",
@@ -78,7 +77,6 @@
   "dependencies": {
     "@aws-cdk/core": "0.0.0",
     "@aws-cdk/cx-api": "0.0.0",
-    "minimatch": "^3.0.4",
     "constructs": "^3.0.2"
   },
   "homepage": "https://github.com/aws/aws-cdk",
@@ -90,19 +88,14 @@
   "engines": {
     "node": ">= 10.12.0"
   },
-  "bundledDependencies": [
-    "minimatch"
-  ],
-  "stability": "experimental",
-  "maturity": "experimental",
+  "stability": "deprecated",
+  "maturity": "deprecated",
+  "awscdkio": {
+    "announce": false
+  },
   "awslint": {
     "exclude": [
-      "docs-public-apis:@aws-cdk/assets.StagingProps",
-      "docs-public-apis:@aws-cdk/assets.StagingProps.sourcePath",
-      "docs-public-apis:@aws-cdk/assets.FollowMode"
+      "construct-ctor-props-type:@aws-cdk/assets.Staging"
     ]
-  },
-  "awscdkio": {
-    "announce": false
   }
 }
diff --git a/packages/@aws-cdk/aws-codebuild/package.json b/packages/@aws-cdk/aws-codebuild/package.json
@@ -78,7 +78,6 @@
     "pkglint": "0.0.0"
   },
   "dependencies": {
-    "@aws-cdk/assets": "0.0.0",
     "@aws-cdk/aws-cloudwatch": "0.0.0",
     "@aws-cdk/aws-codecommit": "0.0.0",
     "@aws-cdk/aws-ec2": "0.0.0",
@@ -95,7 +94,6 @@
   },
   "homepage": "https://github.com/aws/aws-cdk",
   "peerDependencies": {
-    "@aws-cdk/assets": "0.0.0",
     "@aws-cdk/aws-cloudwatch": "0.0.0",
     "@aws-cdk/aws-codecommit": "0.0.0",
     "@aws-cdk/aws-ec2": "0.0.0",

diff --git a/packages/@aws-cdk/aws-ecr-assets/lib/image-asset.ts b/packages/@aws-cdk/aws-ecr-assets/lib/image-asset.ts
@@ -1,14 +1,13 @@
-import * as assets from '@aws-cdk/assets';
 import * as ecr from '@aws-cdk/aws-ecr';
-import { Construct, Stack, Token } from '@aws-cdk/core';
+import { AssetStaging, Construct, FingerprintOptions, IAsset, Stack, Token } from '@aws-cdk/core';
 import * as fs from 'fs';
 import * as minimatch from 'minimatch';
 import * as path from 'path';
 
 /**
  * Options for DockerImageAsset
  */
-export interface DockerImageAssetOptions extends assets.FingerprintOptions {
+export interface DockerImageAssetOptions extends FingerprintOptions {
   /**
    * ECR repository name
    *
@@ -64,7 +63,7 @@ export interface DockerImageAssetProps extends DockerImageAssetOptions {
  *
  * The image will be created in build time and uploaded to an ECR repository.
  */
-export class DockerImageAsset extends Construct implements assets.IAsset {
+export class DockerImageAsset extends Construct implements IAsset {
   /**
    * The full URI of the image (including a tag). Use this reference to pull
    * the asset.
@@ -128,7 +127,7 @@ export class DockerImageAsset extends Construct implements assets.IAsset {
     // deletion of the ECR repository the app used).
     extraHash.version = '1.21.0';
 
-    const staging = new assets.Staging(this, 'Staging', {
+    const staging = new AssetStaging(this, 'Staging', {
       ...props,
       exclude,
       sourcePath: dir,

diff --git a/packages/@aws-cdk/aws-ecr-assets/package.json b/packages/@aws-cdk/aws-ecr-assets/package.json
@@ -71,7 +71,6 @@
     "@aws-cdk/cloud-assembly-schema": "0.0.0"
   },
   "dependencies": {
-    "@aws-cdk/assets": "0.0.0",
     "@aws-cdk/aws-cloudformation": "0.0.0",
     "@aws-cdk/aws-ecr": "0.0.0",
     "@aws-cdk/aws-iam": "0.0.0",
@@ -84,7 +83,6 @@
   },
   "homepage": "https://github.com/aws/aws-cdk",
   "peerDependencies": {
-    "@aws-cdk/assets": "0.0.0",
     "@aws-cdk/aws-cloudformation": "0.0.0",
     "@aws-cdk/aws-ecr": "0.0.0",
     "@aws-cdk/aws-iam": "0.0.0",

diff --git a/packages/@aws-cdk/aws-elasticloadbalancingv2-targets/package.json b/packages/@aws-cdk/aws-elasticloadbalancingv2-targets/package.json
@@ -84,7 +84,6 @@
     "pkglint": "0.0.0"
   },
   "dependencies": {
-    "@aws-cdk/assets": "0.0.0",
     "@aws-cdk/aws-ec2": "0.0.0",
     "@aws-cdk/aws-elasticloadbalancingv2": "0.0.0",
     "@aws-cdk/aws-iam": "0.0.0",
@@ -94,7 +93,6 @@
   },
   "homepage": "https://github.com/aws/aws-cdk",
   "peerDependencies": {
-    "@aws-cdk/assets": "0.0.0",
     "@aws-cdk/aws-ec2": "0.0.0",
     "@aws-cdk/aws-elasticloadbalancingv2": "0.0.0",
     "@aws-cdk/aws-iam": "0.0.0",

diff --git a/packages/@aws-cdk/aws-s3-assets/lib/asset.ts b/packages/@aws-cdk/aws-s3-assets/lib/asset.ts
@@ -1,4 +1,3 @@
-import * as assets from '@aws-cdk/assets';
 import * as iam from '@aws-cdk/aws-iam';
 import * as s3 from '@aws-cdk/aws-s3';
 import * as cdk from '@aws-cdk/core';
@@ -8,7 +7,7 @@ import * as path from 'path';
 
 const ARCHIVE_EXTENSIONS = [ '.zip', '.jar' ];
 
-export interface AssetOptions extends assets.CopyOptions {
+export interface AssetOptions extends cdk.CopyOptions {
 
   /**
    * A list of principals that should be able to read this asset from S3.
@@ -50,7 +49,7 @@ export interface AssetProps extends AssetOptions {
  * An asset represents a local file or directory, which is automatically uploaded to S3
  * and then can be referenced within a CDK application.
  */
-export class Asset extends cdk.Construct implements assets.IAsset {
+export class Asset extends cdk.Construct implements cdk.IAsset {
   /**
    * Attribute that represents the name of the bucket this asset exists in.
    */
@@ -92,7 +91,7 @@ export class Asset extends cdk.Construct implements assets.IAsset {
     super(scope, id);
 
     // stage the asset source (conditionally).
-    const staging = new assets.Staging(this, 'Stage', {
+    const staging = new cdk.AssetStaging(this, 'Stage', {
       ...props,
       sourcePath: path.resolve(props.path),
     });

diff --git a/packages/@aws-cdk/aws-s3-assets/package.json b/packages/@aws-cdk/aws-s3-assets/package.json
@@ -72,7 +72,6 @@
     "ts-mock-imports": "^1.3.0"
   },
   "dependencies": {
-    "@aws-cdk/assets": "0.0.0",
     "@aws-cdk/aws-iam": "0.0.0",
     "@aws-cdk/aws-s3": "0.0.0",
     "@aws-cdk/core": "0.0.0",
@@ -81,7 +80,6 @@
   },
   "homepage": "https://github.com/aws/aws-cdk",
   "peerDependencies": {
-    "@aws-cdk/assets": "0.0.0",
     "@aws-cdk/aws-iam": "0.0.0",
     "@aws-cdk/aws-s3": "0.0.0",
     "@aws-cdk/core": "0.0.0",

diff --git a/packages/@aws-cdk/aws-s3-deployment/package.json b/packages/@aws-cdk/aws-s3-deployment/package.json
@@ -95,7 +95,6 @@
   },
   "homepage": "https://github.com/aws/aws-cdk",
   "peerDependencies": {
-    "@aws-cdk/assets": "0.0.0",
     "@aws-cdk/aws-cloudformation": "0.0.0",
     "@aws-cdk/aws-cloudfront": "0.0.0",
     "@aws-cdk/aws-iam": "0.0.0",

diff --git a/packages/@aws-cdk/aws-stepfunctions-tasks/package.json b/packages/@aws-cdk/aws-stepfunctions-tasks/package.json
@@ -87,7 +87,6 @@
     "pkglint": "0.0.0"
   },
   "dependencies": {
-    "@aws-cdk/assets": "0.0.0",
     "@aws-cdk/aws-cloudwatch": "0.0.0",
     "@aws-cdk/aws-batch": "0.0.0",
     "@aws-cdk/aws-ec2": "0.0.0",
@@ -107,7 +106,6 @@
   },
   "homepage": "https://github.com/aws/aws-cdk",
   "peerDependencies": {
-    "@aws-cdk/assets": "0.0.0",
     "@aws-cdk/aws-batch": "0.0.0",
     "@aws-cdk/aws-cloudwatch": "0.0.0",
     "@aws-cdk/aws-ec2": "0.0.0",