(CodePipeline-Actions): Event created from ECR-Action does not use the default value the ECR-Action is using

[Kruspe]

When creating an ECR Action, CDK creates an CloudWatch event. I was expecting it to only listen on PutImage events for the latest tag since that is the default value provided by the docs and.

Instead the event listens on every tag.

Reproduction Steps

new EcrSourceAction({
      actionName: 'Image',
      repository,
      output: imageArtifact,
      variablesNamespace: 'ImageVariables',
    });

Creates an event that triggers for all PutImages regardless of the tag.

What did you expect to happen?

new EcrSourceAction({
      actionName: 'Image',
      repository,
      output: imageArtifact,
      variablesNamespace: 'ImageVariables',
      imageTag: 'latest',
    });

The event created by this check only the latest tag but I only inserted the tag that is provided by default.

What actually happened?

The CW event listens for all PutImage calls regardless of the tag.

Environment

• CDK CLI Version : 1.95.1 (build ed2bbe6)
• Framework Version: 1.95.1
• Node.js Version: 15.12.0
• OS : BigSur 11.2.3
• Language (Version): TypeScript (3.8.3)

Other

If the described behaviour is the desired one I can create a PR for it. :)

This is 🐛 Bug Report

[skinny85]

Hey @Kruspe ,

thanks for opening the issue. I wonder if this could be related to #10901?

Thanks,
Adam

[Kruspe]

Hey @skinny85,

This seems to be unrelated. It might be connected but on my end the event does trigger an execution but simply not as I would expect it.

The event created by CDK is missing the tag information and thus triggers an execution for every new tag created through PutImage. Since the default value is latest I would expect the event to also only trigger an execution when an image with the latest tag is pushed.

Max

[skinny85]

Yep @Kruspe, I think you're right.

I suspect the problem is here:

aws-cdk/packages/@aws-cdk/aws-codepipeline-actions/lib/ecr/source-action.ts

Line 98 in 6743e3b

imageTag: this.props.imageTag,

We send the props.imageTag to the API that creates the Event, but we don't default it to 'latest' there, which is why it triggers for every push.

Let me work on a quick fix for this.

In the meantime, you should be able to work around this by explicitly passing latest as the imageTag property when creating the EcrSourceAction, like you posted.

Thanks,
Adam

[Kruspe]

Sounds good.
Let me know if you need me to do anything on this :)

Max

[github-actions]

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

[sparten11740]

@skinny85 imo the way to fix this would've been to change the docs - or at least to provide an alternative to trigger on all tags as part of the fix if latest is actually the desired default.

Defaulting imageTag to latest when not specified prevents us to watch changes on all tags because it's no longer possible to pass through undefined as imageTag to the underlying onCloudTrailImagePushed function. In our case that was desired behaviour

[skinny85]

Good call @sparten11740, I haven't thought of that.

What do you think about allowing '' (empty string) passed as the tag to mean "watch for all tags"?

[sparten11740]

@skinny85 that sounds reasonable

[skinny85]

@sparten11740 any chance you would be willing top open us a PR adding this feature? It should be relatively straightforward. Check out our "Contributing guide" for some info on how to get started with CDK development.

[sparten11740]

@skinny85 only today found the time to work on this, opened a PR with a proposed solution