updateCheckRun call fails since 1.128

[hcoles]

As originally raised in #1156, calls to update check runs that worked in 1.122 now fail once the enum mapping issue is worked around.

The following code

   GitHub github = new GitHubBuilder()
       .withOAuthToken("value supplied by github actions")
       .withEndpoint("value supplied by github actions")
       .build();

   GHCheckRun checkRun = repo.createCheckRun("whatever", "value supplied by github actions").withStatus(GHCheckRun.Status.IN_PROGRESS).create();

   repo.updateCheckRun(checkRun.getId())
      .add(output)
      .withConclusion(GHCheckRun.Conclusion.SUCCESS)
      .withStatus(GHCheckRun.Status.COMPLETED)
      .create();

Runs without issue in 1.122 to 1.127, but fails during the updateCheckRun call from 1.128 onwards with

Caused by: org.kohsuke.github.GHFileNotFoundException: https://api.github.com/repos/XXX/XXX/check-runs/2676567691 {"message":"Not Found","documentation_url":"https://docs.github.com/rest"}
    at org.kohsuke.github.GitHubClient.interpretApiError (GitHubClient.java:482)
    at org.kohsuke.github.GitHubClient.sendRequest (GitHubClient.java:409)
    at org.kohsuke.github.GitHubClient.sendRequest (GitHubClient.java:357)
    at org.kohsuke.github.Requester.fetch (Requester.java:76)
    at org.kohsuke.github.GHCheckRunBuilder.create (GHCheckRunBuilder.java:153)

@gsmet has indicated that this represents an authentication failure, however it seems strange that the call to create the checkrun succeeds, while the call to update it fails using the same credentials.

[gsmet]

Ah yeah, if the check creation succeeds, then there might be something else going on.

[hcoles]

Just had a little dig through the git history, and the change that seems to break things is this

8e20f4d

change for #754

It seems that github does not support X-HTTP-Method-Override for this call.

[gsmet]

Interesting. That explains why I didn't see it in my GitHub App as I'm using the OkHttp connector.

[hcoles]

Yes, looks like I can workaround this with OkHttp.

[bitwiseman]

@hcoles

It seems that github does not support X-HTTP-Method-Override for this call.

😭🤦

Hm, so if I rerecorded the tests from #754 they would probably now fail. The question is do we revert #754?

[gsmet]

I really am baffled that we are still struggling with this in 2021...

You can report this to GitHub but they are relatively slow to fix things in the APIs so I don't think we have much choice unfortunately.

But that means we need to use the new JDK Http Client introduced in Java 11 for JDK 11+ if we don't want to have recent JDK complaining about this reflection. I think it fixes this, right?

So if I had to go with a plan, that would be:

• revert Illegal Reflective Access Operation to field java.net.HttpURLConnection.method #754 and release because it's going to break a lot of existing apps
• make the JDK 11 HttpClient alternative a priority (and probably make sure all the methods are supported there first)

[hcoles]

@gsmet You could perhaps provide both versions as Java11AndBelowGithubClient and Java12PlusGithubClient or something similar, but less clunky, so it becomes the caller's problem to choose?

I will be switching to OkHttp. I'd rather not have the dependency, but I'll need to support all of 8, 11, and 16.

[hcoles]

Not directly relevant to this issue, but previously I tried calls out from Junit using a personal access token. This now fails when calling the checks api with a message saying I must authenticate as a github app.

Can anyone confirm that this is a behaviour change, or is my memory flakey? Also, is there an easy workaround?

[gsmet]

I think we need to make the correct client the automatic default. It can be done using a MR jar (but it's some infrastructure).

As for your issue with a PAT, you are providing it directly or using ~/.github? If you provide it to the API, maybe GH has changed something on their side. I must admit that I develop GitHub Apps so I don't really know.

[gsmet]

BTW, if you end up having to develop a GitHub App, my pet project might be of interest to you: https://github.com/quarkiverse/quarkus-github-app .

[hcoles]

I provide the token directly.

Thanks for the link, I've been wanting an excuse to play with quarkus.

[bitwiseman]

@hcoles
Okhttp also support caching which is generally huge improvement for rate limit usage.