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.

Sign up for GitHub

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

Jump to bottom

Add EventListener UID to sink response, mark name/namespace as deprecated. #1087

Merged
merged 1 commit into from
May 12, 2021
Merged

Add EventListener UID to sink response, mark name/namespace as deprecated. #1087

merged 1 commit into from
May 12, 2021

Conversation

wlynch
Copy link
Member

@wlynch wlynch commented May 11, 2021

Changes

Add EventListener UID to sink response, mark name/namespace as deprecated.

The goal here is to provide a more opaque identifier to name/namespace,
which might contain PII in response. We will continue to support
name/namespace for the time being, but mark the fields as deprecated to
be removed in a later release.

This change also includes minor clean up to log annotations for common identifiers.

Part of #1070

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

- `eventListener` and `namespace` fields in EventListener response are now deprecated. Use `eventListenerUID` instead.

@tekton-robot tekton-robot added the release-note Denotes a PR that will be considered when it comes time to generate release notes. label May 11, 2021
@tekton-robot tekton-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label May 11, 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 79.2% 79.5% 0.4

@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 79.2% 79.5% 0.4

dibyom
dibyom reviewed May 11, 2021
View reviewed changes
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.

We need to fix the e2e tests with the updated sink response. Otherwise, LGTM!

pkg/sink/sink.go
@@ -79,23 +83,28 @@ type Response struct {

// HandleEvent processes an incoming HTTP event for the event listener.
func (r Sink) HandleEvent(response http.ResponseWriter, request *http.Request) {
log := r.Logger.With(
Copy link
Member

Choose a reason for hiding this comment

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

Nice!

@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 79.2% 79.5% 0.4

@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 79.2% 79.5% 0.4

@wlynch
Add EventListener UID to sink response, mark name/namespace as deprec…
3bbec64 
…ated.

The goal here is to provide a more opaque identifier to name/namespace,
which might contain PII in response. We will continue to support
name/namespace for the time being, but mark the fields as deprecated to
be removed in a later release.

This change also includes minor clean up to log annotations for common identifiers.
@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 79.2% 79.5% 0.4

@wlynch
Copy link
Member Author

wlynch commented May 12, 2021

We need to fix the e2e tests with the updated sink response. Otherwise, LGTM!

Done.

dibyom
dibyom approved these changes May 12, 2021
View reviewed changes
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.

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label May 12, 2021
@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 May 12, 2021
@tekton-robot tekton-robot merged commit a4fd0fa into tektoncd:main May 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dibyom dibyom dibyom approved these changes

@dlorenc dlorenc Awaiting requested review from dlorenc

Assignees

@dibyom dibyom

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. release-note Denotes a PR that will be considered when it comes time to generate release notes. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@wlynch @tekton-robot @dibyom