Add GET requests to webhook

[shilch]

Add option to use GET methods for webhooks to support Jenkins build triggers.

[jolheiser]

Pretty sure Jenkins accepts both GET and POST, depending on whether you use a token or other auth? 🤔

EDIT: Tested with curl, definitely accepts both GET and POST requests.

[shilch]

AFAIK the jenkins build trigger doesn't accept POST requests.

[techknowlogick]

The Gitea Jenkins plugin (https://github.com/jenkinsci/gitea-plugin) has been working successfully for some time now without GET requests.

[shilch]

@techknowlogick That plugin is pull-based, i.e. it fetches every x minutes - based on configuration.

[shilch]

@jolheiser Can you provide the curl command, please? GET works fine for me, POST does not.

[jolheiser]

For my instance, I use

curl -X POST https://username:[email protected]/job/project/build

[techknowlogick]

Seems this plugin also accepts POSTs from Gitea https://wiki.jenkins.io/plugins/servlet/mobile?contentId=106267244#content/view/106267244

[codecov-io]

Codecov Report

Merging #6771 into master will decrease coverage by <.01%.
The diff coverage is 50%.

@@            Coverage Diff             @@
##           master    #6771      +/-   ##
==========================================
- Coverage   41.18%   41.18%   -0.01%     
==========================================
  Files         424      425       +1     
  Lines       58459    58477      +18     
==========================================
+ Hits        24078    24082       +4     
- Misses      31196    31209      +13     
- Partials     3185     3186       +1

Impacted Files	Coverage Δ
models/migrations/migrations.go	1.52% <ø> (ø)	⬆️
modules/auth/repo_form.go	41.73% <ø> (ø)	⬆️
routers/repo/webhook.go	1.39% <0%> (-0.01%)	⬇️
models/migrations/v86.go	0% <0%> (ø)
models/webhook.go	59.83% <65.21%> (-0.34%)	⬇️
modules/avatar/avatar.go	81.25% <0%> (-18.75%)	⬇️
models/repo_list.go	67.89% <0%> (+1.05%)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 55a8e12...2b4675a. Read the comment docs.

[shilch]

@jolheiser That doesn't trigger any build for me, unfortunately. Only GET requests do, tested it on multiple systems.

@techknowlogick While that might be a solution for most people, I can not add plugins to our systems due to compliance without a lot of hassle. Also, people will probably find GET hooks quite useful for other systems than jenkins.

[jolheiser]

What version of Jenkins are you using? As far as I can tell I don't have any plugins that added the functionality.
Sorry if this just seems like bikeshedding now, but I'm somewhat curious. Most instructions I find when I Google it seem to recommend POST.

[lunny]

Some webhook maybe failed when the request body is big enough.

[shilch]

@jolheiser I'm using the latest one from docker
@lunny @lafriks URLs are unbounded in length:

The HTTP protocol does not place any a priori limit on the length of a URI.

[lunny]

@shilch The http standard didn't limit that length of GET request but in fact, browsers did that. For Chrome, it's 8182 bytes. See https://stackoverflow.com/questions/2659952/maximum-length-of-http-get-request

[kolaente]

@lunny I'd say that's not a problem here since we're not dealing with browsers.

[techknowlogick]

@kolaente even though we aren't dealing with web browsers, web servers still have max limit on GET request as well. For example if URI is too long nginx will give Error 414: uri too large

[lafriks]

Maybe do not send payload with get requests as in such cases most probably it won't be needed anyway

[kolaente]

I'd say we should send the payload to be consistent. If the receiving end needs the payload via url, its their responsibility to configure their nginx/apache/whatever appropriate or just use post requests.

This is somewhat of an edge case, so I'd say we do the minimum needed to get this working, as its not our job to fix other peoples broken software.

[lafriks]

GET would be needed to trigger builds etc mostly not to actually use gitea payload data

[kolaente]

@shilch Could you add a setting whether to send payload or not?