Make the Stage insertion API in CodePipeline more flexible #460

skinny85 · 2018-08-01T00:17:03Z

Allows inserting Stages into CodePipeline at an arbitrary index, and also before or after any given Stage.

Fixes #347

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license.

skinny85 · 2018-08-06T17:18:45Z

@eladb ping (you've opened the original issue, after all ;) )

eladb · 2018-08-07T08:17:13Z

@skinny85 sorry! I provided some feedback the previous PR but forgot to "submit feedback". Copying the notes to this PR now. Apologies...

eladb · 2018-08-07T08:15:21Z

packages/@aws-cdk/aws-codepipeline/lib/pipeline.ts

+    /**
+     * Get the number of Stages in this Pipeline.
+     */
+    public get stagesLength(): number {


eladb · 2018-08-07T08:18:26Z

packages/@aws-cdk/aws-codepipeline/lib/pipeline.ts

@@ -216,23 +230,71 @@ export class Pipeline extends cdk.Construct implements events.IEventRuleTarget {
     *       onChildAdded type hook.
     * @override
     */
-    protected addChild(child: cdk.Construct, name: string) {
-        super.addChild(child, name);
+    protected addChild(child: cdk.Construct, name: string, props?: any) {


I don’t think this change is needed and we are extremely sensitive to extensions of the surface area of Construct.

I see why you need to propagate props to addChild but that’s not a robust way to do this. What promises you that everyone will pass in their props to Construct?

I think the way to address this is to render the stages array only during synthesis (using a Token). Then, you wouldn’t even need to override addChild at all. When you synthesize, you will iterate over your children and devise the list of stages according to their placement.

Changes in Construct are not needed anymore after #568.

packages/@aws-cdk/aws-codepipeline/lib/pipeline.ts

eladb · 2018-08-07T08:19:42Z

packages/@aws-cdk/aws-codepipeline/lib/stage.ts

+ * @see #justAfterStage
+ * @see #atIndex
+ */
+export interface StagePlacement {


Not sure I think the parent/child semantics make total sense here. Why not just “before” and “after”? What am I missing?

It's just a matter of wording. I wanted to make it clear that inserting a Stage before/after a given Stage will "displace" any stage that was before/after that Stage there before (see how clunky this explanation is?), and that's why I came up with the child/parent wording. I'm open to suggestions on how to improve those docs, of course.

eladb · 2018-08-07T08:20:20Z

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

     */
-    constructor(parent: Construct, name: string) {


Please revert this change to Construct

As said above, not needed anymore.

skinny85 · 2018-08-15T00:42:40Z

Well then. After #568, this change got a whole lot easier.

skinny85 · 2018-08-15T16:58:45Z

@eladb ping :)

skinny85 · 2018-08-15T23:19:52Z

Rebased on top of #568 which was pushed and changed the PR base branch to master.

eladb · 2018-08-16T10:33:47Z

packages/@aws-cdk/aws-codepipeline/lib/pipeline.ts

+    /**
+     * Get a duplicate of this Pipeline's list of Stages.
+     */
+    public get stages(): Stage[] {


Is this really needed? (Keep surface area to minimum)

I figured it might be nice for more complicated Stage-inserting scenarios, but I can remove it if you don't like it.

Let's leave this out for now unless there's a clear use case

Sure. Will remove.

packages/@aws-cdk/aws-codepipeline/lib/stage.ts

packages/@aws-cdk/aws-codepipeline/lib/pipeline.ts

eladb · 2018-08-16T10:38:31Z

packages/@aws-cdk/aws-codepipeline/lib/stage.ts

+     *
+     * @default the stage is added at the end of the Pipeline
+     */
+    placed?: StagePlacement;


I would call this placement. Our properties are usually nouns and not verbs

I named it so that the code reads a little better (new Stage(this, 'Stage', { placed: { atIndex: 3 }})), but I can change it to placement if you prefer that.

As I said, properties are usually nouns and not verbs. Just trying to keep our semantic style uniform

eladb

Please fix the couple of remaining items and merge

eladb · 2018-09-03T09:58:11Z

packages/@aws-cdk/aws-codepipeline/lib/pipeline.ts

+    /**
+     * Get a duplicate of this Pipeline's list of Stages.
+     */
+    public get stages(): Stage[] {


Let's leave this out for now unless there's a clear use case

packages/@aws-cdk/aws-codepipeline/lib/pipeline.ts

packages/@aws-cdk/aws-codepipeline/lib/stage.ts

eladb · 2018-09-03T10:00:15Z

packages/@aws-cdk/aws-codepipeline/lib/stage.ts

+     *
+     * @default the stage is added at the end of the Pipeline
+     */
+    placed?: StagePlacement;


As I said, properties are usually nouns and not verbs. Just trying to keep our semantic style uniform

eladb · 2018-09-16T13:21:45Z

Any updates on this?

skinny85 · 2018-09-17T21:20:10Z

Any updates on this?

Incorporated feedback from your last review, and rebased.

eladb · 2018-09-17T21:21:50Z

packages/@aws-cdk/aws-codepipeline/README.md

+```ts
+const sourceStage = new Stage(this, 'Source', {
+    pipeline,
+    placement: {


Do we also allow people to optionally specify placement in addStage? It would be nicer if this used addStage instead of new Stage

Yes, but we have to merge either this, or the addStage PR first (they're both based on master). Once I do that, I'll rebase the other one on top of the new master, and edit accordingly.

Cool. Both are approved.

eladb · 2018-09-17T21:24:03Z

packages/@aws-cdk/aws-codepipeline/lib/pipeline.ts

     */
-    public _addStage(stage: Stage): void {
+    public _addStage(stage: Stage, placement?: StagePlacement): void {


Here's a way to completely hide this method, which is soon going to be very confusing with addStage: you can make it private (I'd call it something else, like: _attachStage) and when invoking it from Stage, you can invoke it by casing to any:

(pipeline as any)._attachStage(this, placement)

Not ideal, but it will hide it from the public API, which is what we want.

…more flexible. This commit allows clients of CodePipeline to create new Stages placed at an arbitrary index in the Pipeline, or before/after a given Stage (instead of only appending new Stages at the end).

skinny85 · 2018-09-17T23:36:16Z

Rebased on top of the merged Pipeline#addStage PR, incorporating the latest feedback.

__NOTICE__: This release includes a framework-wide [__breaking change__](#712) which changes the type of all the string resource attributes across the framework. Instead of using strong-types that extend `cdk.Token` (such as `QueueArn`, `TopicName`, etc), we now represent all these attributes as normal `string`s, and codify the tokens into the string (using the feature introduced in [#168](#168)). Furthermore, the `cdk.Arn` type has been removed. In order to format/parse ARNs, use the static methods on `cdk.ArnUtils`. See motivation and discussion in [#695](#695). * **cfn2ts:** use stringified tokens for resource attributes instead of strong types ([#712](#712)) ([6508f78](6508f78)), closes [#518](#518) [#695](#695) [#744](#744) * **aws-dynamodb:** Attribute type for keys, changes the signature of the `addPartitionKey` and `addSortKey` methods to be consistent across the board. ([#720](#720)) ([e6cc189](e6cc189)) * **aws-codebuild:** fix typo "priviledged" -> "privileged * **assets:** cab't use multiple assets in the same stack ([#725](#725)) ([bba2e5b](bba2e5b)), closes [#706](#706) * **aws-codebuild:** typo in BuildEnvironment "priviledged" -> "privileged ([#734](#734)) ([72fec36](72fec36)) * **aws-ecr:** fix addToResourcePolicy ([#737](#737)) ([eadbda5](eadbda5)) * **aws-events:** ruleName can now be specified ([#726](#726)) ([a7bc5ee](a7bc5ee)), closes [#708](#708) * **aws-lambda:** jsii use no long requires 'sourceAccount' ([#728](#728)) ([9e7d311](9e7d311)), closes [#714](#714) * **aws-s3:** remove `policy` argument ([#730](#730)) ([a79190c](a79190c)), closes [#672](#672) * **cdk:** "cdk init" java template is broken ([#732](#732)) ([281c083](281c083)), closes [#711](#711) [aws/jsii#233](aws/jsii#233) * **aws-apigateway:** new API Gateway Construct Library ([#665](#665)) ([b0f3857](b0f3857)) * **aws-cdk:** detect presence of EC2 credentials ([#724](#724)) ([8e8c295](8e8c295)), closes [#702](#702) [#130](#130) * **aws-codepipeline:** make the Stage insertion API in CodePipeline more flexible ([#460](#460)) ([d182818](d182818)) * **aws-codepipeline:** new "Pipeline#addStage" convenience method ([#647](#647)) ([25c9fa0](25c9fa0)) * **aws-rds:** add support for parameter groups ([#729](#729)) ([2541508](2541508)), closes [#719](#719) * **docs:** add documentation for CDK toolkit plugings ([#733](#733)) ([965b918](965b918)) * **dependencies:** upgrade to [jsii 0.7.6](https://github.com/awslabs/jsii/releases/tag/v0.7.6)

* v0.9.2 __NOTICE__: This release includes a framework-wide [__breaking change__](#712) which changes the type of all the string resource attributes across the framework. Instead of using strong-types that extend `cdk.Token` (such as `QueueArn`, `TopicName`, etc), we now represent all these attributes as normal `string`s, and codify the tokens into the string (using the feature introduced in [#168](#168)). Furthermore, the `cdk.Arn` type has been removed. In order to format/parse ARNs, use the static methods on `cdk.ArnUtils`. See motivation and discussion in [#695](#695). * **cfn2ts:** use stringified tokens for resource attributes instead of strong types ([#712](#712)) ([6508f78](6508f78)), closes [#518](#518) [#695](#695) [#744](#744) * **aws-dynamodb:** Attribute type for keys, changes the signature of the `addPartitionKey` and `addSortKey` methods to be consistent across the board. ([#720](#720)) ([e6cc189](e6cc189)) * **aws-codebuild:** fix typo "priviledged" -> "privileged * **assets:** cab't use multiple assets in the same stack ([#725](#725)) ([bba2e5b](bba2e5b)), closes [#706](#706) * **aws-codebuild:** typo in BuildEnvironment "priviledged" -> "privileged ([#734](#734)) ([72fec36](72fec36)) * **aws-ecr:** fix addToResourcePolicy ([#737](#737)) ([eadbda5](eadbda5)) * **aws-events:** ruleName can now be specified ([#726](#726)) ([a7bc5ee](a7bc5ee)), closes [#708](#708) * **aws-lambda:** jsii use no long requires 'sourceAccount' ([#728](#728)) ([9e7d311](9e7d311)), closes [#714](#714) * **aws-s3:** remove `policy` argument ([#730](#730)) ([a79190c](a79190c)), closes [#672](#672) * **cdk:** "cdk init" java template is broken ([#732](#732)) ([281c083](281c083)), closes [#711](#711) [aws/jsii#233](aws/jsii#233) * **aws-apigateway:** new API Gateway Construct Library ([#665](#665)) ([b0f3857](b0f3857)) * **aws-cdk:** detect presence of EC2 credentials ([#724](#724)) ([8e8c295](8e8c295)), closes [#702](#702) [#130](#130) * **aws-codepipeline:** make the Stage insertion API in CodePipeline more flexible ([#460](#460)) ([d182818](d182818)) * **aws-codepipeline:** new "Pipeline#addStage" convenience method ([#647](#647)) ([25c9fa0](25c9fa0)) * **aws-rds:** add support for parameter groups ([#729](#729)) ([2541508](2541508)), closes [#719](#719) * **docs:** add documentation for CDK toolkit plugings ([#733](#733)) ([965b918](965b918)) * **dependencies:** upgrade to [jsii 0.7.6](https://github.com/awslabs/jsii/releases/tag/v0.7.6)

This was referenced Aug 1, 2018

codepipeline: There should be a way to insert a stage before an existing one (and not append) #347

Closed

Make the Stage insertion API in CodePipeline more flexible #437

Closed

skinny85 requested a review from eladb August 6, 2018 17:33

eladb suggested changes Aug 7, 2018

View reviewed changes

skinny85 force-pushed the feature/pipeline-insert-stage branch from a496315 to 1e41ed3 Compare August 15, 2018 00:41

skinny85 changed the base branch from master to adamruka/stage-gets-pipeline-in-props August 15, 2018 00:41

skinny85 force-pushed the feature/pipeline-insert-stage branch from 1e41ed3 to b257d46 Compare August 15, 2018 23:19

skinny85 changed the base branch from adamruka/stage-gets-pipeline-in-props to master August 15, 2018 23:19

eladb reviewed Aug 16, 2018

View reviewed changes

eladb approved these changes Sep 3, 2018

View reviewed changes

skinny85 force-pushed the feature/pipeline-insert-stage branch from b257d46 to 92ecac4 Compare September 17, 2018 21:19

eladb approved these changes Sep 17, 2018

View reviewed changes

feat(aws-codepipeline): Make the Stage insertion API in CodePipeline …

4830254

…more flexible. This commit allows clients of CodePipeline to create new Stages placed at an arbitrary index in the Pipeline, or before/after a given Stage (instead of only appending new Stages at the end).

skinny85 force-pushed the feature/pipeline-insert-stage branch from 92ecac4 to 4830254 Compare September 17, 2018 23:35

skinny85 merged commit d182818 into aws:master Sep 18, 2018

skinny85 deleted the feature/pipeline-insert-stage branch September 18, 2018 17:27

NGL321 added the contribution/core This is a PR that came from AWS. label Sep 27, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Make the Stage insertion API in CodePipeline more flexible #460

Make the Stage insertion API in CodePipeline more flexible #460

skinny85 commented Aug 1, 2018 •

edited

skinny85 commented Aug 6, 2018

eladb commented Aug 7, 2018

eladb Aug 7, 2018

skinny85 Aug 15, 2018

eladb Aug 7, 2018

skinny85 Aug 15, 2018

eladb Aug 7, 2018

skinny85 Aug 15, 2018

eladb Aug 7, 2018

skinny85 Aug 15, 2018

skinny85 commented Aug 15, 2018

skinny85 commented Aug 15, 2018

skinny85 commented Aug 15, 2018

eladb Aug 16, 2018

skinny85 Aug 28, 2018

eladb Sep 3, 2018

skinny85 Sep 10, 2018

eladb Aug 16, 2018

skinny85 Aug 28, 2018

eladb Sep 3, 2018

skinny85 Sep 10, 2018

eladb left a comment

eladb Sep 3, 2018

eladb Sep 3, 2018

eladb commented Sep 16, 2018

skinny85 commented Sep 17, 2018

eladb Sep 17, 2018

skinny85 Sep 17, 2018

eladb Sep 17, 2018

eladb Sep 17, 2018

skinny85 Sep 17, 2018

skinny85 commented Sep 17, 2018

Make the Stage insertion API in CodePipeline more flexible #460

Make the Stage insertion API in CodePipeline more flexible #460

Conversation

skinny85 commented Aug 1, 2018 • edited

skinny85 commented Aug 6, 2018

eladb commented Aug 7, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

skinny85 commented Aug 15, 2018

skinny85 commented Aug 15, 2018

skinny85 commented Aug 15, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

eladb left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

eladb commented Sep 16, 2018

skinny85 commented Sep 17, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

skinny85 commented Sep 17, 2018

skinny85 commented Aug 1, 2018 •

edited