refactor(core): improvements to Construct API (#2767)

Closes #1934 BREAKING CHANGE: * **core:** `node.stack` is now `Stack.of(construct)` (fixes #2766) * **core:** `node.resolve` has been moved to `stack.resolve`. * **core:** `node.stringifyJson` has been moved to `stack.stringifyJson`. * **core:** `node.validateTree` is now `ConstructNode.validate(node)` * **core:** `node.prepareTree` is now `ConstructNode.prepare(node)` * **core:** `node.getContext` is now `node.tryGetContext` * **core:** `node.recordReference` is now `node.addReference` * **core:** `node.apply` is now `node.applyAspect` * **core:** `node.ancestors()` is now `node.scopes` * **core:** `node.required` has been removed. * **core:** `node.typename` has been removed. * **core:** `node.addChild` is now private * **core:** `node.findReferences()` is now `node.references` * **core:** `node.findDependencies()` is now `node.dependencies` * **core:** `stack.dependencies()` is now `stack.dependencies` * **core:** `CfnElement.stackPath` has been removed. * **core:** `CloudFormationLang` is now internal (use `stack.toJsonString()`)
aws · Jun 6, 2019 · 3f7a0ad · 3f7a0ad
1 parent 9a34d47
commit 3f7a0ad
Show file tree

Hide file tree

Showing 148 changed files with 939 additions and 988 deletions.
diff --git a/packages/@aws-cdk/app-delivery/lib/pipeline-deploy-stack-action.ts b/packages/@aws-cdk/app-delivery/lib/pipeline-deploy-stack-action.ts
@@ -105,7 +105,7 @@ export class PipelineDeployStackAction extends cdk.Construct {
  constructor(scope: cdk.Construct, id: string, props: PipelineDeployStackActionProps) {
  super(scope, id);
 
- if (!cdk.environmentEquals(props.stack.env, this.node.stack.env)) {
+ if (!cdk.environmentEquals(props.stack.env, cdk.Stack.of(this).env)) {
  // FIXME: Add the necessary to extend to stacks in a different account
  throw new Error(`Cross-environment deployment is not supported`);
  }

diff --git a/packages/@aws-cdk/app-delivery/test/test.pipeline-deploy-stack-action.ts b/packages/@aws-cdk/app-delivery/test/test.pipeline-deploy-stack-action.ts
@@ -6,6 +6,7 @@ import cpactions = require('@aws-cdk/aws-codepipeline-actions');
 import iam = require('@aws-cdk/aws-iam');
 import s3 = require('@aws-cdk/aws-s3');
 import cdk = require('@aws-cdk/cdk');
+import { ConstructNode } from '@aws-cdk/cdk';
 import cxapi = require('@aws-cdk/cx-api');
 import fc = require('fast-check');
 import nodeunit = require('nodeunit');
@@ -289,7 +290,7 @@ export = nodeunit.testCase({
  for (let i = 0 ; i < assetCount ; i++) {
  deployedStack.node.addMetadata(cxapi.ASSET_METADATA, {});
  }
- test.deepEqual(action.node.validateTree().map(x => x.message),
+ test.deepEqual(ConstructNode.validate(action.node).map(x => x.message),
  [`Cannot deploy the stack DeployedStack because it references ${assetCount} asset(s)`]);
  }
  )

diff --git a/packages/@aws-cdk/assets/lib/asset.ts b/packages/@aws-cdk/assets/lib/asset.ts
@@ -198,7 +198,7 @@ export class Asset extends cdk.Construct implements IAsset {
  * (e.g. "Code" for AWS::Lambda::Function)
  */
  public addResourceMetadata(resource: cdk.CfnResource, resourceProperty: string) {
- if (!this.node.getContext(cxapi.ASSET_RESOURCE_METADATA_ENABLED_CONTEXT)) {
+ if (!this.node.tryGetContext(cxapi.ASSET_RESOURCE_METADATA_ENABLED_CONTEXT)) {
  return; // not enabled
  }
 

diff --git a/packages/@aws-cdk/assets/lib/staging.ts b/packages/@aws-cdk/assets/lib/staging.ts
@@ -57,7 +57,7 @@ export class Staging extends Construct {
  this.copyOptions = props;
  this.sourceHash = fingerprint(this.sourcePath, props);
 
- const stagingDisabled = this.node.getContext(cxapi.DISABLE_ASSET_STAGING_CONTEXT);
+ const stagingDisabled = this.node.tryGetContext(cxapi.DISABLE_ASSET_STAGING_CONTEXT);
  if (stagingDisabled) {
  this.stagedPath = this.sourcePath;
  } else {

diff --git a/packages/@aws-cdk/assets/test/test.asset.ts b/packages/@aws-cdk/assets/test/test.asset.ts
@@ -31,7 +31,7 @@ export = {
  // verify that now the template contains parameters for this asset
  const session = app.synth();
 
- test.deepEqual(stack.node.resolve(entry!.data), {
+ test.deepEqual(stack.resolve(entry!.data), {
  path: SAMPLE_ASSET_DIR,
  id: 'MyStackMyAssetBDDF29E3',
  packaging: 'zip',
@@ -84,7 +84,7 @@ export = {
  // synthesize first so "prepare" is called
  const template = SynthUtils.synthesize(stack).template;
 
- test.deepEqual(stack.node.resolve(entry!.data), {
+ test.deepEqual(stack.resolve(entry!.data), {
  path: 'asset.78add9eaf468dfa2191da44a7da92a21baba4c686cf6053d772556768ef21197.txt',
  packaging: 'file',
  id: 'MyAsset',

diff --git a/packages/@aws-cdk/aws-apigateway/lib/deployment.ts b/packages/@aws-cdk/aws-apigateway/lib/deployment.ts
@@ -1,4 +1,4 @@
-import { Construct, DeletionPolicy, Resource, Token } from '@aws-cdk/cdk';
+import { Construct, DeletionPolicy, Resource, Stack, Token } from '@aws-cdk/cdk';
 import crypto = require('crypto');
 import { CfnDeployment, CfnDeploymentProps } from './apigateway.generated';
 import { IRestApi } from './restapi';
@@ -99,7 +99,7 @@ class LatestDeploymentResource extends CfnDeployment {
  constructor(scope: Construct, id: string, props: CfnDeploymentProps) {
  super(scope, id, props);
 
- this.originalLogicalId = this.node.stack.logicalIds.getLogicalId(this);
+ this.originalLogicalId = Stack.of(this).logicalIds.getLogicalId(this);
  }
 
  /**
@@ -121,12 +121,14 @@ class LatestDeploymentResource extends CfnDeployment {
  * add via `addToLogicalId`.
  */
  protected prepare() {
+ const stack = Stack.of(this);
+
  // if hash components were added to the deployment, we use them to calculate
  // a logical ID for the deployment resource.
  if (this.hashComponents.length > 0) {
  const md5 = crypto.createHash('md5');
  this.hashComponents
- .map(c => this.node.resolve(c))
+ .map(c => stack.resolve(c))
  .forEach(c => md5.update(JSON.stringify(c)));
 
  this.overrideLogicalId(this.originalLogicalId + md5.digest("hex"));

diff --git a/packages/@aws-cdk/aws-apigateway/lib/integrations/aws.ts b/packages/@aws-cdk/aws-apigateway/lib/integrations/aws.ts
@@ -1,4 +1,5 @@
 import cdk = require('@aws-cdk/cdk');
+import { Stack } from '@aws-cdk/cdk';
 import { Integration, IntegrationOptions, IntegrationType } from '../integration';
 import { Method } from '../method';
 import { parseAwsApiCall } from '../util';
@@ -80,7 +81,7 @@ export class AwsIntegration extends Integration {
  integrationHttpMethod: props.integrationHttpMethod || 'POST',
  uri: new cdk.Token(() => {
  if (!this.scope) { throw new Error('AwsIntegration must be used in API'); }
- return this.scope.node.stack.formatArn({
+ return Stack.of(this.scope).formatArn({
  service: 'apigateway',
  account: backend,
  resource: apiType,

diff --git a/packages/@aws-cdk/aws-apigateway/lib/method.ts b/packages/@aws-cdk/aws-apigateway/lib/method.ts
@@ -1,4 +1,4 @@
-import { Construct, Resource } from '@aws-cdk/cdk';
+import { Construct, Resource, Stack } from '@aws-cdk/cdk';
 import { CfnMethod, CfnMethodProps } from './apigateway.generated';
 import { ConnectionType, Integration } from './integration';
 import { MockIntegration } from './integrations/mock';
@@ -197,7 +197,7 @@ export class Method extends Resource {
  } else if (options.credentialsPassthrough) {
  // arn:aws:iam::*:user/*
  // tslint:disable-next-line:max-line-length
- credentials = this.node.stack.formatArn({ service: 'iam', region: '', account: '*', resource: 'user', sep: '/', resourceName: '*' });
+ credentials = Stack.of(this).formatArn({ service: 'iam', region: '', account: '*', resource: 'user', sep: '/', resourceName: '*' });
  }
 
  return {

diff --git a/packages/@aws-cdk/aws-apigateway/lib/restapi.ts b/packages/@aws-cdk/aws-apigateway/lib/restapi.ts
@@ -1,5 +1,5 @@
 import iam = require('@aws-cdk/aws-iam');
-import { CfnOutput, Construct, IResource as IResourceBase, Resource } from '@aws-cdk/cdk';
+import { CfnOutput, Construct, IResource as IResourceBase, Resource, Stack } from '@aws-cdk/cdk';
 import { ApiKey, IApiKey } from './api-key';
 import { CfnAccount, CfnRestApi } from './apigateway.generated';
 import { Deployment } from './deployment';
@@ -284,7 +284,7 @@ export class RestApi extends Resource implements IRestApi {
  method = '*';
  }
 
- return this.node.stack.formatArn({
+ return Stack.of(this).formatArn({
  service: 'execute-api',
  resource: this.restApiId,
  sep: '/',
@@ -343,7 +343,7 @@ export class RestApi extends Resource implements IRestApi {
  private configureCloudWatchRole(apiResource: CfnRestApi) {
  const role = new iam.Role(this, 'CloudWatchRole', {
  assumedBy: new iam.ServicePrincipal('apigateway.amazonaws.com'),
- managedPolicyArns: [ this.node.stack.formatArn({
+ managedPolicyArns: [ Stack.of(this).formatArn({
  service: 'iam',
  region: '',
  account: 'aws',

diff --git a/packages/@aws-cdk/aws-apigateway/lib/stage.ts b/packages/@aws-cdk/aws-apigateway/lib/stage.ts
@@ -1,4 +1,4 @@
-import { Construct, Resource } from '@aws-cdk/cdk';
+import { Construct, Resource, Stack } from '@aws-cdk/cdk';
 import { CfnStage } from './apigateway.generated';
 import { Deployment } from './deployment';
 import { IRestApi } from './restapi';
@@ -209,7 +209,7 @@ export class Stage extends Resource {
  if (!path.startsWith('/')) {
  throw new Error(`Path must begin with "/": ${path}`);
  }
- return `https://${this.restApi.restApiId}.execute-api.${this.node.stack.region}.${this.node.stack.urlSuffix}/${this.stageName}${path}`;
+ return `https://${this.restApi.restApiId}.execute-api.${Stack.of(this).region}.${Stack.of(this).urlSuffix}/${this.stageName}${path}`;
  }
 
  private renderMethodSettings(props: StageProps): CfnStage.MethodSettingProperty[] | undefined {

diff --git a/packages/@aws-cdk/aws-apigateway/test/test.deployment.ts b/packages/@aws-cdk/aws-apigateway/test/test.deployment.ts
@@ -152,7 +152,6 @@ export = {
  test.done();
 
  function synthesize() {
- stack.node.prepareTree();
  return SynthUtils.synthesize(stack).template;
  }
  },

diff --git a/packages/@aws-cdk/aws-apigateway/test/test.method.ts b/packages/@aws-cdk/aws-apigateway/test/test.method.ts
@@ -148,7 +148,7 @@ export = {
  });
 
  // THEN
- test.deepEqual(method.node.resolve(method.methodArn), {
+ test.deepEqual(stack.resolve(method.methodArn), {
  "Fn::Join": [
  "",
  [
@@ -182,7 +182,7 @@ export = {
  });
 
  // THEN
- test.deepEqual(method.node.resolve(method.testMethodArn), {
+ test.deepEqual(stack.resolve(method.testMethodArn), {
  "Fn::Join": [
  "",
  [

diff --git a/packages/@aws-cdk/aws-apigateway/test/test.restapi.ts b/packages/@aws-cdk/aws-apigateway/test/test.restapi.ts
@@ -336,7 +336,7 @@ export = {
  const imported = apigateway.RestApi.fromRestApiId(stack, 'imported-api', 'api-rxt4498f');
 
  // THEN
- test.deepEqual(imported.node.resolve(imported.restApiId), 'api-rxt4498f');
+ test.deepEqual(stack.resolve(imported.restApiId), 'api-rxt4498f');
  test.done();
  },
 
@@ -347,7 +347,7 @@ export = {
  api.root.addMethod('GET');
 
  // THEN
- test.deepEqual(api.node.resolve(api.url), { 'Fn::Join':
+ test.deepEqual(stack.resolve(api.url), { 'Fn::Join':
  [ '',
  [ 'https://',
  { Ref: 'apiC8550315' },
@@ -358,7 +358,7 @@ export = {
  "/",
  { Ref: 'apiDeploymentStageprod896C8101' },
  '/' ] ] });
- test.deepEqual(api.node.resolve(api.urlForPath('/foo/bar')), { 'Fn::Join':
+ test.deepEqual(stack.resolve(api.urlForPath('/foo/bar')), { 'Fn::Join':
  [ '',
  [ 'https://',
  { Ref: 'apiC8550315' },
@@ -405,7 +405,7 @@ export = {
  const arn = api.executeApiArn('method', '/path', 'stage');
 
  // THEN
- test.deepEqual(api.node.resolve(arn), { 'Fn::Join':
+ test.deepEqual(stack.resolve(arn), { 'Fn::Join':
  [ '',
  [ 'arn:',
  { Ref: 'AWS::Partition' },
@@ -438,7 +438,7 @@ export = {
  const method = api.root.addMethod('ANY');
 
  // THEN
- test.deepEqual(api.node.resolve(method.methodArn), { 'Fn::Join':
+ test.deepEqual(stack.resolve(method.methodArn), { 'Fn::Join':
  [ '',
  [ 'arn:',
  { Ref: 'AWS::Partition' },

diff --git a/packages/@aws-cdk/aws-autoscaling/lib/auto-scaling-group.ts b/packages/@aws-cdk/aws-autoscaling/lib/auto-scaling-group.ts
@@ -363,7 +363,7 @@ export class AutoScalingGroup extends AutoScalingGroupBase implements
  });
  this.connections = new ec2.Connections({ securityGroups: [this.securityGroup] });
  this.securityGroups.push(this.securityGroup);
- this.node.apply(new Tag(NAME_TAG, this.node.path));
+ this.node.applyAspect(new Tag(NAME_TAG, this.node.path));
 
  this.role = props.role || new iam.Role(this, 'InstanceRole', {
  assumedBy: new iam.ServicePrincipal('ec2.amazonaws.com')

diff --git a/packages/@aws-cdk/aws-autoscaling/test/test.auto-scaling-group.ts b/packages/@aws-cdk/aws-autoscaling/test/test.auto-scaling-group.ts
@@ -382,8 +382,8 @@ export = {
  pauseTimeSec: 345
  },
  });
- asg.node.apply(new cdk.Tag('superfood', 'acai'));
- asg.node.apply(new cdk.Tag('notsuper', 'caramel', { applyToLaunchedInstances: false }));
+ asg.node.applyAspect(new cdk.Tag('superfood', 'acai'));
+ asg.node.applyAspect(new cdk.Tag('notsuper', 'caramel', { applyToLaunchedInstances: false }));
 
  // THEN
  expect(stack).to(haveResource("AWS::AutoScaling::AutoScalingGroup", {

diff --git a/packages/@aws-cdk/aws-cloudtrail/lib/index.ts b/packages/@aws-cdk/aws-cloudtrail/lib/index.ts
@@ -3,7 +3,7 @@ import iam = require('@aws-cdk/aws-iam');
 import kms = require('@aws-cdk/aws-kms');
 import logs = require('@aws-cdk/aws-logs');
 import s3 = require('@aws-cdk/aws-s3');
-import { Construct, Resource } from '@aws-cdk/cdk';
+import { Construct, Resource, Stack } from '@aws-cdk/cdk';
 import { CfnTrail } from './cloudtrail.generated';
 
 // AWS::CloudTrail CloudFormation Resources:
@@ -136,7 +136,7 @@ export class Trail extends Resource {
  .addServicePrincipal(cloudTrailPrincipal));
 
  s3bucket.addToResourcePolicy(new iam.PolicyStatement()
- .addResource(s3bucket.arnForObjects(`AWSLogs/${this.node.stack.accountId}/*`))
+ .addResource(s3bucket.arnForObjects(`AWSLogs/${Stack.of(this).accountId}/*`))
  .addActions("s3:PutObject")
  .addServicePrincipal(cloudTrailPrincipal)
  .setCondition("StringEquals", {'s3:x-amz-acl': "bucket-owner-full-control"}));

diff --git a/packages/@aws-cdk/aws-cloudwatch/lib/alarm.ts b/packages/@aws-cdk/aws-cloudwatch/lib/alarm.ts
@@ -1,4 +1,4 @@
-import { Construct, IResource, Resource, Token } from '@aws-cdk/cdk';
+import { Construct, IResource, Resource, Stack, Token } from '@aws-cdk/cdk';
 import { IAlarmAction } from './alarm-action';
 import { CfnAlarm } from './cloudwatch.generated';
 import { HorizontalAnnotation } from './graph';
@@ -80,7 +80,7 @@ export class Alarm extends Resource implements IAlarm {
  public static fromAlarmArn(scope: Construct, id: string, alarmArn: string): IAlarm {
  class Import extends Resource implements IAlarm {
  public readonly alarmArn = alarmArn;
- public readonly alarmName = scope.node.stack.parseArn(alarmArn, ':').resourceName!;
+ public readonly alarmName = Stack.of(scope).parseArn(alarmArn, ':').resourceName!;
  }
  return new Import(scope, id);
  }

diff --git a/packages/@aws-cdk/aws-cloudwatch/lib/dashboard.ts b/packages/@aws-cdk/aws-cloudwatch/lib/dashboard.ts
@@ -1,4 +1,4 @@
-import { Construct, Resource, Token } from "@aws-cdk/cdk";
+import { Construct, Resource, Stack, Token } from "@aws-cdk/cdk";
 import { CfnDashboard } from './cloudwatch.generated';
 import { Column, Row } from "./layout";
 import { IWidget } from "./widget";
@@ -61,7 +61,7 @@ export class Dashboard extends Resource {
  dashboardBody: new Token(() => {
  const column = new Column(...this.rows);
  column.position(0, 0);
- return this.node.stringifyJson({
+ return Stack.of(this).toJsonString({
  start: props ? props.start : undefined,
  end: props ? props.end : undefined,
  periodOverride: props ? props.periodOverride : undefined,

diff --git a/packages/@aws-cdk/aws-cloudwatch/test/test.graphs.ts b/packages/@aws-cdk/aws-cloudwatch/test/test.graphs.ts
@@ -17,7 +17,7 @@ export = {
  });
 
  // THEN
- test.deepEqual(stack.node.resolve(widget.toJson()), [{
+ test.deepEqual(stack.resolve(widget.toJson()), [{
  type: 'metric',
  width: 6,
  height: 6,
@@ -45,7 +45,7 @@ export = {
  });
 
  // THEN
- test.deepEqual(stack.node.resolve(widget.toJson()), [{
+ test.deepEqual(stack.resolve(widget.toJson()), [{
  type: 'metric',
  width: 6,
  height: 6,
@@ -74,7 +74,7 @@ export = {
  });
 
  // THEN
- test.deepEqual(stack.node.resolve(widget.toJson()), [{
+ test.deepEqual(stack.resolve(widget.toJson()), [{
  type: 'metric',
  width: 6,
  height: 3,
@@ -105,7 +105,7 @@ export = {
  });
 
  // THEN
- test.deepEqual(stack.node.resolve(widget.toJson()), [{
+ test.deepEqual(stack.resolve(widget.toJson()), [{
  type: 'metric',
  width: 6,
  height: 6,
@@ -139,7 +139,7 @@ export = {
  });
 
  // THEN
- test.deepEqual(stack.node.resolve(widget.toJson()), [{
+ test.deepEqual(stack.resolve(widget.toJson()), [{
  type: 'metric',
  width: 6,
  height: 6,
@@ -182,7 +182,7 @@ export = {
  });
 
  // THEN
- test.deepEqual(stack.node.resolve(widget.toJson()), [{
+ test.deepEqual(stack.resolve(widget.toJson()), [{
  type: 'metric',
  width: 6,
  height: 6,
@@ -229,7 +229,7 @@ export = {
  });
 
  // THEN
- test.deepEqual(stack.node.resolve(widget.toJson()), [{
+ test.deepEqual(stack.resolve(widget.toJson()), [{
  type: 'metric',
  width: 6,
  height: 6,