Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

aws-stepfunctions-tasks: EventBridge aws. event source prefix check is more strict than it should be #30191

Open
FilipPyrek opened this issue May 14, 2024 · 1 comment · May be fixed by #30237
Labels
@aws-cdk/aws-stepfunctions-tasks bug This issue is a bug. effort/small Small work item – less than a day of effort p2

Comments

@FilipPyrek
Copy link

Describe the bug

We discovered that the EventBridgePutEvents is throwing an error even in cases when it's not necessary to throw.

For example our source looks like this aws-some-feature.this.that and according to the docs this should be valid.

All events that come from AWS services begin with "aws."

Whereas in the CDK code of EventBridgePutEvents is this check

if (entry.source?.startsWith('aws')) {

The correct implementation should be following

if (entry.source?.startsWith('aws.')) {

Expected Behavior

EventBridgePutEvents should not throw an error when source starts with aws. (but not just aws)

Current Behavior

EventBridgePutEvents throws an error when source starts with aws

Reproduction Steps

Use this task in a state machine.

import { EventBridgePutEvents } from 'aws-cdk-lib/aws-stepfunctions-tasks'

new EventBridgePutEvents(
  this,
  'SendEvent',
  {
    entries: [
      {
        eventBus: 'some-event-bus',
        source: `aws-feature-name-whatever-you-want`,
        detailType: 'some-detail',
        detail: TaskInput.fromJsonPathAt('$')
      }
    ]
  }
)

Possible Solution

Change this line: https://github.com/aws/aws-cdk/blob/205163fc0d2cac84d3d746a98c393e137f0e2388/packages/aws-cdk-lib/aws-stepfunctions-tasks/lib/eventbridge/put-events.ts#L136C7-L136C45

to:

- if (entry.source?.startsWith('aws')) {
+ if (entry.source?.startsWith('aws.')) { 

Additional Information/Context

No response

CDK CLI Version

v2.141.0

Framework Version

No response

Node.js Version

20.x

OS

MacOS (personal) / Ubuntu (in CI)

Language

TypeScript

Language Version

5.4.5

Other information

No response

@FilipPyrek FilipPyrek added bug This issue is a bug. needs-triage This issue or PR still needs to be triaged. labels May 14, 2024
@pahud
Copy link
Contributor

pahud commented May 16, 2024

Makes perfect sense to me. Thank you for the report.

@pahud pahud added p2 effort/small Small work item – less than a day of effort and removed needs-triage This issue or PR still needs to be triaged. labels May 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
@aws-cdk/aws-stepfunctions-tasks bug This issue is a bug. effort/small Small work item – less than a day of effort p2
Projects
None yet
2 participants