Introduce Filter CloudEvents Feature

[SpiritZhou]

Introduce filter CloudEvents feature

Checklist

• I have verified that my change is according to the deprecations & breaking changes policy
• Tests have been added
• Changelog has been updated and is aligned with our changelog requirements
• A PR is opened to update our Helm chart (repo) (if applicable, ie. when deployment manifests are modified)
• A PR is opened to update the documentation on (repo) (if applicable)
• Commits are signed with Developer Certificate of Origin (DCO - learn more)

Fixes #

Relates to #3533

[tomkerkhove]

Mind opening a doc PR?

[tomkerkhove]

Can we add some unit tests as well?

[tomkerkhove]

LGTM, but I'd like to see these two improvements though to improve the user experience/usability:

• https://github.com/kedacore/keda/pull/5424/files/2bfa4b99dde46f03786adddfbc2c8791d8cd5495#r1479293087
• Introduce Filter CloudEvents Feature  #5424 (comment)

[SpiritZhou]

LGTM, but I'd like to see these two improvements though to improve the user experience/usability:

• https://github.com/kedacore/keda/pull/5424/files/2bfa4b99dde46f03786adddfbc2c8791d8cd5495#r1479293087
• Introduce Filter CloudEvents Feature  #5424 (comment)

Improvements added.

[SpiritZhou]

/run-e2e internal
Update: You can check the progress here

[tomkerkhove]

Would you mind fixing the conflicts please?

[SpiritZhou]

Fixed.

[tomkerkhove]

@zroubalik / @JorTurFer Do you mind reviewing? I am not enough of an expert on the codebase but think it's generally OK

[JorTurFer]

Looking good! Nice job!

[JorTurFer]

Awesome job! Some comments inline

[JorTurFer]

I've been thinking about this. Does it make sense supporting both at the same time? I mean, shouldn't include and exclude be mutually exclusive? Maybe we should support both, but being mutually exlusive, @tomkerkhove ?

[SpiritZhou]

It will always let user confuse if include and exclude exist at the same time. It is better to have only one type in the specification.

[tomkerkhove]

End-users should be able to use both, for example:

eventSubscription: #Optional. Submit included/excluded event types will filter events when emitting events. 
  includedEventTypes: #Optional. Only events in this section will be emitted.
  - keda.scaledobject.failed.v1
  excludedEventTypes: #Optional. Events in this section will not be emitted.       
  - keda.scaledobject.ready.v1

But this should not be allowed and blocked:

eventSubscription: #Optional. Submit included/excluded event types will filter events when emitting events. 
  includedEventTypes: #Optional. Only events in this section will be emitted.
  - keda.scaledobject.ready.v1
  excludedEventTypes: #Optional. Events in this section will not be emitted.       
  - keda.scaledobject.ready.v1

[JorTurFer]

End-users should be able to use both, for example:

eventSubscription: #Optional. Submit included/excluded event types will filter events when emitting events.
includedEventTypes: #Optional. Only events in this section will be emitted.

• keda.scaledobject.failed.v1
  excludedEventTypes: #Optional. Events in this section will not be emitted.
• keda.scaledobject.ready.v1

Yeah, currently they can, but my doubt is if that makes sense. In the moment when you add include keda.scaledobject.failed.v1 you are automatically excluding keda.scaledobject.ready.v1 (because it's not the only included type). I mean, adding include or exclude, you are explicitly discarding the other group and supporting both at once can have more problems checking misconfigurations than the benefit we give to the users.

Maybe we can go adding them as mutually exclusive, we will maintain the flexibility for the users because they can use include or exclude, but we can improve the logic not supporting both at the same time. WDYT?

[tomkerkhove]

Oh in that way, that makes sense indeed. Let's only allow one or the other indeed

[tomkerkhove]

/run-e2e internal
Update: You can check the progress here

[JorTurFer]

LGTM!

[JorTurFer]

/run-e2e internal
Update: You can check the progress here

[JorTurFer]

/run-e2e internal
Update: You can check the progress here

[JorTurFer]

/skip-e2e