#947 base event payload #976

seregamorph · 2020-11-09T19:53:42Z

Description

** Address issue #947: move common fields to base class GHEventPayload **
Reference: Webhook payload object common properties

Before submitting a PR:

We love getting PRs, but we hate asking people for the same basic changes every time.

Push your changes to a branch other than master. Create your PR from that branch.
Add JavaDocs and other comments
Write tests that run and pass in CI. See CONTRIBUTING.md for details on how to capture snapshot data.
Run mvn clean compile locally. This may reformat your code, commit those changes.
Run mvn -D enable-ci clean install site locally. If this command doesn't succeed, your change will not pass CI.

When creating a PR:

Fill in the "Description" above.
Enable "Allow edits from maintainers".

seregamorph · 2020-11-09T19:54:27Z

pom.xml

+      <groupId>org.slf4j</groupId>
+      <artifactId>slf4j-simple</artifactId>
+      <version>1.7.2</version>
+      <scope>test</scope>


to avoid this message on test execution:

SLF4J: Failed to load class "org.slf4j.impl.StaticLoggerBinder". SLF4J: Defaulting to no-operation (NOP) logger implementation SLF4J: See http://www.slf4j.org/codes.html#StaticLoggerBinder for further details.

It is out of scope, but not sure if this deserves separate PR.

seregamorph · 2020-11-09T19:58:15Z

src/main/java/org/kohsuke/github/GHEventPayload.java

@@ -16,14 +16,30 @@
 *      and payloads</a>
 */
 @SuppressWarnings("UnusedDeclaration")
-public abstract class GHEventPayload {


Pay attention: class made non-abstract. Reasoning: it allow to instantiate common event object:

GitHub.offline() .parseEventPayload(new StringReader(payload), GHEventPayload.class)

Why this may be needed: if you want to validate the X-Hub-Signature before handling the payload, you may need common information like repository to resolve the secret.
Possible workaround in case if the class is still abstract: make an empty subclass (in your local project, but in org.kohsuke.github package) and instantiate it.
Possible incompatibility: not expected.

seregamorph · 2020-11-09T19:58:57Z

src/main/java/org/kohsuke/github/GHEventPayload.java

    protected GitHub root;

+    // https://docs.github.com/en/free-pro-team@latest/developers/webhooks-and-events/webhook-events-and-payloads#webhook-payload-object-common-properties
+    // Webhook payload object common properties: action, sender, repository, organization, installation
+    private String action;


as declared in #947 moved from subclasses. Field may be null depending on the event type

seregamorph · 2020-11-09T19:59:33Z

src/main/java/org/kohsuke/github/GHEventPayload.java

    void wrapUp(GitHub root) {
        this.root = root;
        if (sender != null) {
            sender.wrapUp(root);
        }
+        if (repository != null) {


aggregated from overriden wrapUp methods and a getter with side effect (see below) because of fields lift

seregamorph · 2020-11-09T20:00:16Z

src/main/java/org/kohsuke/github/GHEventPayload.java

-         * @return the repository
-         */
-        public GHRepository getRepository() {
-            repository.root = root;


replaced with wrapUp on the super-class

seregamorph · 2020-11-09T20:02:53Z

src/main/java/org/kohsuke/github/GHEventPayload.java

    private GHUser sender;
+    GHRepository repository;


some fields are package visible, because subclasses work with them directly. Considerable: make private, replace with accessors

@seregamorph
Yes, please make these private.

seregamorph · 2020-11-09T20:03:57Z

src/main/java/org/kohsuke/github/GHEventPayload.java

        private GHPullRequestReview review;
-        private GHPullRequest pull_request;


note: snake_case replaced with camelCase, mapper is set up to force snake_case, so it was redundant

seregamorph · 2020-11-09T20:04:42Z

src/main/java/org/kohsuke/github/GHEventPayload.java

        @Override
        void wrapUp(GitHub root) {
            super.wrapUp(root);
            if (repository != null)
                repository.wrap(root);
-            if (organization != null) {


moved to superclass

seregamorph · 2020-11-09T20:05:34Z

src/test/java/org/kohsuke/github/GHEventPayloadTest.java

@@ -232,6 +242,7 @@ public void pull_request_labeled() throws Exception {
        assertThat(event.getPullRequest().getAdditions(), is(137));
        assertThat(event.getPullRequest().getDeletions(), is(81));
        assertThat(event.getPullRequest().getChangedFiles(), is(22));
+        assertThat(event.getPullRequest().getLabels().iterator().next().getName(), is("Ready for Review"));


test for already addressed #943

seregamorph · 2020-11-09T20:06:23Z

src/test/resources/org/kohsuke/github/GHEventPayloadTest/ping.json

@@ -0,0 +1,149 @@
+{
+  "zen": "Design for failure.",


the payload got from real requests (only some usernames were changed)

bitwiseman

Excellent! Theres some additional cleanup needed, but other than that this is looking great!

Thanks for contributing!

bitwiseman · 2020-11-12T18:08:39Z

src/main/java/org/kohsuke/github/GHEventPayload.java

    private GHUser sender;
+    GHRepository repository;


@seregamorph
Yes, please make these private.

bitwiseman · 2020-11-12T18:13:30Z

src/main/java/org/kohsuke/github/GHEventPayload.java


    GHEventPayload() {
    }

+    /**
+     * Most webhook payloads contain an action property that contains the specific activity that triggered the event.


Suggested change

* Most webhook payloads contain an action property that contains the specific activity that triggered the event.

* Gets the action for the trigged event.

*

* Most but not all webhook payloads contain an action property that contains the specific activity that triggered the event.

done (typo in suggestion fixed)

bitwiseman · 2020-11-12T23:14:33Z

src/main/java/org/kohsuke/github/GHEventPayload.java

        void wrapUp(GitHub root) {
            super.wrapUp(root);
            repository.wrap(root);


The super handles the repository.wrap(), right?

Suggested change

void wrapUp(GitHub root) {

super.wrapUp(root);

repository.wrap(root);

void wrapUp(GitHub root) {

super.wrapUp(root);

done. the inherited method removed (contains only a call to super)

…payload

seregamorph · 2020-11-13T08:41:34Z

src/main/java/org/kohsuke/github/GHEventPayload.java

            if (repository != null) {
-                repository.wrap(root);


seregamorph · 2020-11-13T08:41:50Z

src/main/java/org/kohsuke/github/GHEventPayload.java

                throw new IllegalStateException(
                        "Expected check_suite payload, but got something else. Maybe we've got another type of event?");
-            else
-                installation.wrapUp(root);


seregamorph · 2020-11-13T08:42:43Z

src/main/java/org/kohsuke/github/GHEventPayload.java

-         */
-        public GHRepository getRepository() {
-            return repository;
+            pullRequest.root = root;


BTW this logic kept, but this line looks redundant (see wrapUp)

seregamorph · 2020-11-13T08:45:15Z

src/main/java/org/kohsuke/github/GHEventPayload.java

-        }
-
-        @Override
-        void wrapUp(GitHub root) {


fully inherited - hence removed

seregamorph · 2020-11-13T08:46:55Z

src/main/java/org/kohsuke/github/GHEventPayload.java

@@ -112,11 +113,14 @@ void wrapUp(GitHub root) {
            sender.wrapUp(root);
        }
        if (repository != null) {
-            repository.root = root;
+            repository.wrap(root);


note: repository.root = root; replaced with repository.wrap(root);, a more complex. This way we can inherit this action in subclasses and remove repository.wrap(root); line from them.

hub4j#947 base event payload

929d9fb

seregamorph commented Nov 9, 2020

View reviewed changes

seregamorph mentioned this pull request Nov 9, 2020

Base event payload fields in GHEventPayload #947

Closed

bitwiseman requested changes Nov 12, 2020

View reviewed changes

seregamorph added 2 commits November 13, 2020 10:27

Merge remote-tracking branch 'origin/master' into feature/base-event-…

74496d3

…payload

hub4j#947 address review comments

b51d655

seregamorph commented Nov 13, 2020

View reviewed changes

src/main/java/org/kohsuke/github/GHEventPayload.java

if (repository != null) {

repository.wrap(root);

Copy link

Contributor Author

seregamorph Nov 13, 2020

Choose a reason for hiding this comment

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

inherited

seregamorph commented Nov 13, 2020

View reviewed changes

bitwiseman approved these changes Nov 17, 2020

View reviewed changes

bitwiseman merged commit 8ababb6 into hub4j:master Nov 17, 2020

seregamorph deleted the feature/base-event-payload branch November 18, 2020 15:25

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

#947 base event payload #976

#947 base event payload #976

seregamorph commented Nov 9, 2020

seregamorph Nov 9, 2020

seregamorph Nov 9, 2020

seregamorph Nov 9, 2020

seregamorph Nov 9, 2020

seregamorph Nov 9, 2020

seregamorph Nov 9, 2020

bitwiseman Nov 12, 2020

seregamorph Nov 13, 2020

seregamorph Nov 9, 2020

seregamorph Nov 9, 2020

seregamorph Nov 9, 2020

seregamorph Nov 9, 2020

bitwiseman left a comment

bitwiseman Nov 12, 2020

bitwiseman Nov 12, 2020

seregamorph Nov 13, 2020

bitwiseman Nov 12, 2020

seregamorph Nov 13, 2020

seregamorph Nov 13, 2020

seregamorph Nov 13, 2020

seregamorph Nov 13, 2020

seregamorph Nov 13, 2020

seregamorph Nov 13, 2020

		private GHPullRequestReview review;
		private GHPullRequest pull_request;

-     * Most webhook payloads contain an action property that contains the specific activity that triggered the event.
+     *  Gets the action for the trigged event.
+     *
+     * Most but not all webhook payloads contain an action property that contains the specific activity that triggered the event.

#947 base event payload #976

#947 base event payload #976

Conversation

seregamorph commented Nov 9, 2020

Description

Before submitting a PR:

When creating a PR:

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bitwiseman left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment