feat(eventsources/bitbucketserver): add OneEventPerChange config option for webhook event handling #3135
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ryancurrah
force-pushed
the
bitbucket-server-support-one-event-per-change
branch
from
46eb4fb
to
c5db188
Compare
…on for webhook event handling Add OneEventPerChange config option to control whether to process each change in a repo:refs_changed webhook event as a separate event. This allows independent processing of each tag or reference update in a single webhook event useful for triggering distinct workflows in Argo Workflows. Signed-off-by: Ryan Currah <ryan@currah.ca>
ryancurrah
force-pushed
the
bitbucket-server-support-one-event-per-change
branch
from
c5db188
to
6cd8e4f
Compare
whynowy
reviewed
May 29, 2024
| @@ -1051,7 +1051,7 @@ type BitbucketAuth struct { | |||
| OAuthToken *corev1.SecretKeySelector `json:"oauthToken,omitempty" protobuf:"bytes,2,opt,name=oauthToken"` | |||
| } | |||
|
|
|||
| // BasicAuth holds the information required to authenticate user via basic auth mechanism | |||
| // BitbucketBasicAuth holds the information required to authenticate user via basic auth mechanism | |||
| // It returns a slice of byte slices containing the processed or original webhook events, and any error encountered during processing. | ||
| func webhookHandler(request *http.Request, logger *zap.SugaredLogger, body []byte, bitbucketserverEventSource *v1alpha1.BitbucketServerEventSource, router *Router) ([][]byte, error) { | ||
| if request.Header.Get("X-Event-Key") != "repo:refs_changed" { | ||
| // Don't continue if this is not a repo:refs_changed webhook event. |
There was a problem hiding this comment.
Is this the same as the previous logic?
There was a problem hiding this comment.
Pretty much the same except I learned that Bitbucket sends the event type/key in a HTTP header named X-Event-Key. Which means we don't have to decode every event now. Making the code easier to read and little more performant.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add OneEventPerChange config option to control whether to process each change in a repo:refs_changed webhook event as a separate event. This allows independent processing of each tag or reference update in a single webhook event, useful for triggering distinct workflows in Argo Workflows.
Example Webhook Event with Multiple Changes
{ "eventKey": "repo:refs_changed", "date": "2024-05-15T23:58:18+0000", "actor": { "name": "ryancurrah", "emailAddress": "ryancurrah@foobar.com", "id": 4127, "displayName": "Ryan Currah", "active": true, "slug": "ryancurrah", "type": "NORMAL", "links": { "self": [ { "href": "https://bitbucket.foobar.com/users/ryancurrah" } ] } }, "repository": { "slug": "baz", "id": 222, "name": "baz", "hierarchyId": "12dcc1b4996b9c76cb12", "scmId": "git", "state": "AVAILABLE", "statusMessage": "Available", "forkable": true, "project": { "key": "TEST", "id": 6084, "name": "TEST", "public": false, "type": "NORMAL", "links": { "self": [ { "href": "https://bitbucket.foobar.com/projects/TEST" } ] } }, "public": false, "links": { "clone": [ { "href": "ssh://git@bitbucket.foobar.com:7999/test/baz.git", "name": "ssh" }, { "href": "https://bitbucket.foobar.com/scm/test/baz.git", "name": "http" } ], "self": [ { "href": "https://bitbucket.foobar.com/projects/TEST/repos/baz/browse" } ] } }, "changes": [ { "ref": { "id": "refs/heads/test-tag-webhooks", "displayId": "test-tag-webhooks", "type": "BRANCH" }, "refId": "refs/heads/test-tag-webhooks", "fromHash": "0000000000000000000000000000000000000000", "toHash": "165bb6a516be59cfc3bde5dce04bd206a18b9e7f", "type": "ADD" }, { "ref": { "id": "refs/tags/v0.0.0-1", "displayId": "v0.0.0-1", "type": "TAG" }, "refId": "refs/tags/v0.0.0-1", "fromHash": "0000000000000000000000000000000000000000", "toHash": "8b473721c4cad133e9cb3917c7b705d541041cdc", "type": "ADD" } ] }The above ☝️ webhook event would be turned into two
BitbucketServerEventDataevents,.changes[]will not have a length greater than one.Split Up Webhook Event 1 (Shortened for brevity)
{ "eventKey": "repo:refs_changed", "date": "2024-05-15T23:58:18+0000", "actor": { "name": "ryancurrah", "emailAddress": "ryancurrah@foobar.com", "id": 4127, "displayName": "Ryan Currah", .......................................... } }, "changes": [ { "ref": { "id": "refs/heads/test-tag-webhooks", "displayId": "test-tag-webhooks", "type": "BRANCH" }, "refId": "refs/heads/test-tag-webhooks", "fromHash": "0000000000000000000000000000000000000000", "toHash": "165bb6a516be59cfc3bde5dce04bd206a18b9e7f", "type": "ADD" } ] }Split Up Webhook Event 2 (Shortened for brevity)
{ "eventKey": "repo:refs_changed", "date": "2024-05-15T23:58:18+0000", "actor": { "name": "ryancurrah", "emailAddress": "ryancurrah@foobar.com", "id": 4127, "displayName": "Ryan Currah", .......................................... } }, "changes": [ { "ref": { "id": "refs/tags/v0.0.0-1", "displayId": "v0.0.0-1", "type": "TAG" }, "refId": "refs/tags/v0.0.0-1", "fromHash": "0000000000000000000000000000000000000000", "toHash": "8b473721c4cad133e9cb3917c7b705d541041cdc", "type": "ADD" } ] }Checklist: