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

Fix eventlistener crash with multiple interceptors extensions #1282

Merged

Conversation

larhauga
Copy link
Contributor

@larhauga larhauga commented Dec 8, 2021

When multiple interceptors are present in an event listener and they produce an extension, a race condition can occur due to a global variable written to in a goroutine.

It is possible that this also affects which pipelines could be triggered if the extensions are used for trigger routing.

Changes

A global shared variable was being written to when extensions were
present in the interceptor output. This resulted in a race condition
verified by go test -race ./pkg/sink with the new test.

Submitter Checklist

These are the criteria that every PR should meet, please check them off as you
review them:

  • Includes tests (if functionality changed/added)
  • Includes docs (if user facing)
  • Commit messages follow commit message best practices
  • Release notes block has been filled in or deleted (only if no user facing changes)

See the contribution guide for more details.

Release Notes

  • Bug fixes
Fix race condition in eventlistener when multiple interceptors return extentions

@tekton-robot tekton-robot added the release-note Denotes a PR that will be considered when it comes time to generate release notes. label Dec 8, 2021
@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Dec 8, 2021

CLA Signed

The committers are authorized under a signed CLA.

@tekton-robot tekton-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Dec 8, 2021
@tekton-robot
Copy link

Hi @larhauga. Thanks for your PR.

I'm waiting for a tektoncd member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@larhauga larhauga force-pushed the fix-race-in-interceptor-extensions branch from d754f90 to 3795f09 Compare December 8, 2021 11:01
@dibyom
Copy link
Member

dibyom commented Dec 8, 2021

/ok-to-test

@tekton-robot tekton-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Dec 8, 2021
@tekton-robot
Copy link

The following is the coverage report on the affected files.
Say /test pull-tekton-triggers-go-coverage to re-run this coverage report

File Old Coverage New Coverage Delta
pkg/sink/sink.go 75.8% 77.9% 2.2

Copy link
Member

@dibyom dibyom left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @larhauga This was a great find.

I have one minor comment on the test. If you are particularly motivated to fix that in this PR, that is fine -- just open an issue for it :)

/approve

pkg/sink/sink_test.go Outdated Show resolved Hide resolved
@tekton-robot
Copy link

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: dibyom

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@tekton-robot tekton-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Dec 8, 2021
A global shared variable was being written to when extentions were
present in the interceptor output. This resulted in a race condition
verified by `go test -race ./pkg/sink` with the new test.
@larhauga larhauga force-pushed the fix-race-in-interceptor-extensions branch from 3795f09 to 4889d48 Compare December 8, 2021 19:27
@tekton-robot
Copy link

The following is the coverage report on the affected files.
Say /test pull-tekton-triggers-go-coverage to re-run this coverage report

File Old Coverage New Coverage Delta
pkg/sink/sink.go 75.8% 75.9% 0.1

@larhauga
Copy link
Contributor Author

larhauga commented Dec 8, 2021

Thank you @larhauga This was a great find.

I have one minor comment on the test. If you are particularly motivated to fix that in this PR, that is fine -- just open an issue for it :)

My pleasure! The tests are updated with the your suggestion of a function for the TT.

@dibyom
Copy link
Member

dibyom commented Dec 8, 2021

Thank you! Looks great
/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Dec 8, 2021
@tekton-robot tekton-robot merged commit d360e8f into tektoncd:main Dec 8, 2021
@larhauga larhauga deleted the fix-race-in-interceptor-extensions branch December 8, 2021 22:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. lgtm Indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. release-note Denotes a PR that will be considered when it comes time to generate release notes. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants