Make gitea webhooks openproject compatible #28435

Chief-Detektor · 2023-12-12T10:52:59Z

This PR adds some fields to the gitea webhook payload that openproject expects to exists in order to process the webhooks.
These fields do exists in Github's webhook payload so adding them makes Gitea's native webhook more compatible towards Github's.

delvh · 2023-12-12T15:11:10Z

As expected:

Please run make generate-swagger and commit the result

Chief-Detektor · 2023-12-13T08:32:42Z

I ran make test-sqlite-migration test-sqlite locally on my MacBook and on my Linux-Desktop successfully. So I can only assume that something in the CI pipeline differs from what I have locally.

Chief-Detektor · 2023-12-13T08:52:45Z

Now I set the same env vars as in the test-sqlite test in the pipeline:

TAGS=bindata gogit sqlite sqlite_unlock_notify
RACE_ENABLED=true
TEST_TAGS=gogit sqlite sqlite_unlock_notify
USE_REPO_TEST_DIR=1

And I get the same error as in the pipeline.

Chief-Detektor · 2023-12-13T09:11:45Z

I'm working on a fix.

delvh · 2023-12-13T11:24:29Z

The fix is what I posted above…

delvh · 2023-12-13T11:24:52Z

make generate-swagger

Chief-Detektor · 2023-12-13T11:34:17Z

This is what I did yesterday already and you were right. See the corresponding commit.
But there is one other error that I just fixed.
The error happens during the db-tests/test-sqlite tests.
Pipeline should now be happy

delvh · 2023-12-15T11:30:44Z

What I've noticed so far:
I'm not sure if you are aware, but the types you changed are also what's returned by the API as well (that's why make generate-swagger was necessary)
The problem is that we guarantee API stability.
In other words, we need to be sure that what you added should forever be there/ has already been added to the GitHub API too.
Is either of this the case?

Chief-Detektor · 2023-12-15T16:02:02Z

The latter is the case. All additions to the webhook payloads are mirroring the GitHub's payload.
My initial approach was to add a module to Openproject but then I realized that it is more sensible to add those missing fields to gitea than to create a whole module including database migrations to openproject.
So I created a test environment with an openproject and a gitea instance and triggered the flow described here. Openproject would error and log the missing field to stdout. Once I had the missing field added I repeated this procedure until there were no errors anymore and the behavior was like described in the link I provided.
I other words: I implemented the missing fields against/using the official OpenProject GitHub module. Hence I am pretty confident this PR makes the API more GitHub like than it is right now.

services/convert/pull.go

models/issues/pull.go

claesrosell · 2024-01-05T11:07:46Z

It would be awesome if this PR could be merged.
Atlassian is canceling its self-hosted options for Jira and Bitbucket, organizations that do not want to move to a cloud environment are looking for other options. One of the options is a Gitea / OpenPrpoject combo. Unfortunately, there is no working integration between those two solutions.

modules/structs/pull.go

services/convert/pull.go

models/issues/pull.go

kresss · 2024-05-15T11:41:05Z

Is there any chance this PR will move forward? We are looking for this feature. Happy to help if I can.

services/convert/pull.go

wxiaoguang · 2024-05-15T13:00:16Z

models/issues/pull.go

+	if pr.ID == 0 {
+		conds = conds.And(builder.Eq{"invalidated": false})
+	}


It looks counter-intuitive. Why pr.ID == 0 means invalidated==false?

Honestly, I can't answer that question as I basically copied this function from here

gitea/models/issues/review.go

Line 995 in ea8e4ba

func (r *Review) GetCodeCommentsCount(ctx context.Context) int {

It could very well be that the entire check there is redundant and not needed for the function to work properly.
However, in order to evaluate that I need to revive my dev setup for this project. I'm a bit busy right now so it might take some days.

@6543 the code GetCodeCommentsCount was written in API: Add pull review endpoints (#11224)

Do you have ideas about why checking pr.ID == 0 ?

ping @6543 ~~~

I think it doesn't need this if, so let's remove it until there is a clear requirement.

@wxiaoguang it had it's reason back then i guess but I cant find one now

Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>

models/issues/pull.go

wxiaoguang

It only adds some fields, so it can be safely backported.

This PR adds some fields to the gitea webhook payload that [openproject](https://www.openproject.org/) expects to exists in order to process the webhooks. These fields do exists in Github's webhook payload so adding them makes Gitea's native webhook more compatible towards Github's.

Backport #28435 by Chief-Detektor Co-authored-by: André Rosenhammer <andre.rosenhammer@gmail.com>

* giteaofficial/main: [skip ci] Updated licenses and gitignores Make gitea webhooks openproject compatible (go-gitea#28435) Change `--border-radius-circle` to `--border-radius-full` (go-gitea#30936) Fix `View File` button link if branch deleted on pull request files pages (go-gitea#31063)

This release stands as a monumental milestone in our development journey with a record-breaking incorporation of [1528](https://github.com/go-gitea/gitea/pulls?q=is%3Apr+milestone%3A1.22.0+is%3Amerged) pull requests. It marks the most extensive update in Gitea's history, showcasing a plethora of new features and infrastructure improvements. Noteworthy advancements in this release include the introduction of `HTMX` and `Tailwind`, signaling a strategic shift as we gradually phase out `jquery` and `Fomantic UI`. These changes reflect our commitment to embracing modern technologies and enhancing the user experience. Key highlights of this release encompass significant changes categorized under `BREAKING`, `FEATURES`, `ENHANCEMENTS`, and `PERFORMANCE`, each contributing to a more robust and efficient Gitea platform. * BREAKING * Improve reverse proxy documents and clarify the AppURL guessing behavior (go-gitea#31003) (go-gitea#31020) * Remember log in for a month by default (go-gitea#30150) * Breaking summary for template refactoring (go-gitea#29395) * All custom templates need to follow these changes * Recommend/convert to use case-sensitive collation for MySQL/MSSQL (go-gitea#28662) * Make offline mode as default to not connect external avatar service by default (go-gitea#28548) * Include public repos in the doer's dashboard for issue search (go-gitea#28304) * Use restricted sanitizer for repository description (go-gitea#28141) * Support storage base path as prefix (go-gitea#27827) * Enhanced auth token / remember me (go-gitea#27606) * Rename the default themes to `gitea-light`, `gitea-dark`, `gitea-auto` (go-gitea#27419) * If you didn't see the new themes, please remove the `[ui].THEMES` config option from `app.ini` * Require MySQL 8.0, PostgreSQL 12, MSSQL 2012 (go-gitea#27337) * FEATURES * Allow everyone to read or write a wiki by a repo unit setting (go-gitea#30495) * Use raw Wiki links for non-renderable Wiki files (go-gitea#30273) * Render embedded code preview by permalink in markdown (go-gitea#30234) (go-gitea#30249) * Support repo code search without setting up an indexer (go-gitea#29998) * Support pasting URLs over markdown text (go-gitea#29566) * Allow to change primary email before account activation (go-gitea#29412) * Customizable "Open with" applications for repository clone (go-gitea#29320) * Allow options to disable user deletion from the interface on app.ini (go-gitea#29275) * Extend issue template YAML engine (go-gitea#29274) * Add support for `linguist-detectable` and `linguist-documentation` (go-gitea#29267) * Implement code frequency graph (go-gitea#29191) * Show commit status for releases (go-gitea#29149) * Add user blocking (go-gitea#29028) * Actions Artifacts v4 backend (go-gitea#28965) * Add merge style `fast-forward-only` (go-gitea#28954) * Retarget depending pulls when the parent branch is deleted (go-gitea#28686) * Add global setting on how timestamps should be rendered (go-gitea#28657) * Implement actions badge SVGs (go-gitea#28102) * Add skip ci functionality (go-gitea#28075) * Show latest commit for file (go-gitea#28067) * Allow to sync tags from the admin dashboard (go-gitea#28045) * Add Profile Readme for Organisations (go-gitea#27955) * Implement contributors graph (go-gitea#27882) * Artifact deletion in actions ui (go-gitea#27172) * Add API routes to get runner registration token (go-gitea#27144) * Add support for forking single branch (go-gitea#25821) * Add support for sha256 repositories (go-gitea#23894) * Add admin API route for managing user's badges (go-gitea#23106) * ENHANCEMENTS * Make gitea webhooks openproject compatible (go-gitea#28435) (go-gitea#31081) * Support using label names when changing issue labels (go-gitea#30943) (go-gitea#30958) * Fix various problems around project board view (go-gitea#30696) (go-gitea#30902) * Improve context popup rendering (go-gitea#30824) (go-gitea#30829) * Allow to save empty comment (go-gitea#30706) * Prevent allow/reject reviews on merged/closed PRs (go-gitea#30686) * Initial support for colorblindness-friendly themes (go-gitea#30625) * Some NuGet package enhancements (go-gitea#30280) (go-gitea#30324) * Markup color and font size fixes (go-gitea#30282) (go-gitea#30310) * Show 12 lines in markup code preview (go-gitea#30255) (go-gitea#30257) * Add `[other].SHOW_FOOTER_POWERED_BY` setting to hide `Powered by` (go-gitea#30253) * Pulse page improvements (go-gitea#30149) * Render code tags in commit messages (go-gitea#30146) * Prevent re-review and dismiss review actions on closed and merged PRs (go-gitea#30065) * Cancel previous runs of the same PR automatically (go-gitea#29961) * Drag-and-drop improvements for projects and issue pins (go-gitea#29875) * Add default board to new projects, remove uncategorized pseudo-board (go-gitea#29874) * Prevent layout shift in `<overflow-menu>` items (go-gitea#29831) * Add skip ci support for pull request title (go-gitea#29774) * Add more stats tables (go-gitea#29730) * Update API to return 'source_id' for users (go-gitea#29718) * Determine fuzziness of bleve indexer by keyword length (go-gitea#29706) * Expose fuzzy search for issues/pulls (go-gitea#29701) * Put an edit file button on pull request files to allow a quick operation (go-gitea#29697) * Fix action runner offline label padding (go-gitea#29691) * Update allowed attachment types (go-gitea#29688) * Completely style the webkit autofill (go-gitea#29683) * Highlight archived labels (go-gitea#29680) * Add a warning for disallowed email domains (go-gitea#29658) * Set user's 24h preference from their current OS locale (go-gitea#29651) * Add setting to disable user features when user login type is not plain (go-gitea#29615) * Improve natural sort (go-gitea#29611) * Make wiki default branch name changeable (go-gitea#29603) * Unify search boxes (go-gitea#29530) * Add support for API blob upload of release attachments (go-gitea#29507) * Detect broken git hooks (go-gitea#29494) * Sync branches to DB immediately when handling git hook calling (go-gitea#29493) * Allow options to disable user GPG key configuration from the interface on app.ini (go-gitea#29486) * Allow options to disable user SSH key configuration from the interface on app.ini (go-gitea#29447) * Use relative links for commits, mentions, and issues in markdown (go-gitea#29427) * Add `<overflow-menu>`, rename webcomponents (go-gitea#29400) * Include resource state events in Gitlab downloads (go-gitea#29382) * Properly migrate target branch change GitLab comment (go-gitea#29340) * Recolor dark theme to blue shade (go-gitea#29283) * Partially enable MSSQL case-sensitive collation support (go-gitea#29238) * Auto-update the system status in the admin dashboard (go-gitea#29163) * Integrate alpine `noarch` packages into other architectures index (go-gitea#29137) * Document how the TOC election process works (go-gitea#29135) * Tweak repo header (go-gitea#29134) * Make blockquote border size less aggressive (go-gitea#29124) * Downscale pasted PNG images based on metadata (go-gitea#29123) * Show `View at this point in history` for every commit (go-gitea#29122) * Add support for action artifact serve direct (go-gitea#29120) * Change webhook-type in create-view (go-gitea#29114) * Drop "@" from the email sender to avoid spam filters (go-gitea#29109) * Allow non-admin users to delete review requests (go-gitea#29057) * Improve user search display name (go-gitea#29002) * Include username in email headers (go-gitea#28981) * Show whether a PR is WIP inside popups (go-gitea#28975) * Also match weakly validated ETags (go-gitea#28957) * Support nuspec manifest download for Nuget packages (go-gitea#28921) * Fix hardcoded GitHub icon used as migrated release avatar (go-gitea#28910) * Propagate install_if and provider_priority to APKINDEX (go-gitea#28899) * Add artifacts v4 JWT to job message and accept it (go-gitea#28885) * Enable/disable owner and repo projects independently (go-gitea#28805) * Add non-JS fallback for reaction tooltips (go-gitea#28785) * Add the ability to see open and closed issues at the same time (go-gitea#28757) * Move sign-in labels to be above inputs (go-gitea#28753) * Display the latest sync time for pull mirrors on the repo page (go-gitea#28712) * Show in Web UI if the file is vendored and generated (go-gitea#28620) * Add orphaned topic consistency check (go-gitea#28507) * Add branch protection setting for ignoring stale approvals (go-gitea#28498) * Add option to set language in admin user view (go-gitea#28449) * Fix incorrect run order of action jobs (go-gitea#28367) * Add missing exclusive in advanced label options (go-gitea#28322) * Added instance-level variables (go-gitea#28115) * Add edit option for README.md (go-gitea#28071) * Fix link to `Code` tab on wiki commits (go-gitea#28041) * Allow to set explore page default sort (go-gitea#27951) * Improve PR diff view on mobile (go-gitea#27883) * Properly migrate automatic merge GitLab comments (go-gitea#27873) * Display issue task list on project cards (go-gitea#27865) * Add Index to pull_auto_merge.doer_id (go-gitea#27811) * Fix display member unit in the menu bar if there are no hidden members in public org (go-gitea#27795) * List all Debian package versions in `Packages` (go-gitea#27786) * Allow pull requests Manually Merged option to be used by non-admins (go-gitea#27780) * Only show diff file tree when more than one file changed (go-gitea#27775) * Show placeholder email in privacy popup (go-gitea#27770) * Revamp repo header (go-gitea#27760) * Add `must-change-password` command line parameter (go-gitea#27626) * Unify password changing and invalidate auth tokens (go-gitea#27625) * Add border to file tree 'sub-items' and add padding to 'item-file' (go-gitea#27593) * Add slow SQL query warning (go-gitea#27545) * Pre-register OAuth application for tea (go-gitea#27509) * Differentiate between `push` and `pull` `mirror sync in progress` (go-gitea#27390) * Link to file from its history (go-gitea#27354) * Add a shortcut to user's profile page to admin user details (go-gitea#27299) * Doctor: delete action entries without existing user (go-gitea#27292) * Show total TrackedTime on issue/pull/milestone lists (go-gitea#26672) * Don't show the new pull request button when the page is not compare pull (go-gitea#26431) * Add `Hide/Show all checks` button to commit status check (go-gitea#26284) * Improvements of releases list and tags list (go-gitea#25859) * PERFORMANCE * Fix package list performance (go-gitea#30520) (go-gitea#30616) * Add commit status summary table to reduce query from commit status table (go-gitea#30223) * Refactor markup/csv: don't read all to memory (go-gitea#29760) * Lazy load object format with command line and don't do it in OpenRepository (go-gitea#29712) * Add cache for branch divergence on branch list page (go-gitea#29577) * Do some performance optimization for issues list and view issue/pull (go-gitea#29515) * Cache repository default branch commit status to reduce query on commit status table (go-gitea#29444) * Use `crypto/sha256` (go-gitea#29386) * Some performance optimization on the dashboard and issues page (go-gitea#29010) * Add combined index for issue_user.uid and issue_id (go-gitea#28080) # -----BEGIN PGP SIGNATURE----- # # iQIzBAABCAAdFiEEumb2f9c/cFjXEtMIw7fJG2Mvc4oFAmZUPBEACgkQw7fJG2Mv # c4polxAAjJgg1UISxasNGbX/V4G2P9eeXam9lQ5DYAGS6d+RYdTcYdGSbOZujIGG # cVqoZjYCJm7b3KuL1Jjrf7sIAjPB3E9gO8aJ3r+6PGjRpMwCACPUlCo8QWRPDhcU # /eWleWFs59ZMxHnHT3oLH0TGwbdY4tc35/iKElUIc6sX8WBal0SsYScfBJrRTtS/ # DxBaovmkiG0RUWHK3mK0zHrRW9nJecz/4XFWIHgBjKzvCHlzSYrOjUPvytERlWtO # o7i+1Wsret1JLWoW53L3ZQIXCwBBLYjsan9oq7YgSD0Usl9En3o0+S06+TVNiWMp # MNbOQt2SQsIJPPP83pql+rPbKqAp1dibWXLF70mJrBVpdw/b0VHK2K8fIa5Eiilk # EOR9D8uoOgjvxWVjNI9Gg+lzbT0KoQI90Iexwcloq22MDFPJC3EqirDpwBdkZFJA # 5/6iGvPILD1SVkAzjdMD6Ukc8zWwPVLENwcTCVxr8H2q6/Jbo+29WIlCM+/0a0t3 # 1kN77Yx1So9VFUOqPjHsoO72Wc/Zved1ZDqg9UgqP6L2dH2ns0mh92QM+Pplqi2T # NsJQih4NeZsfDQ7rm0oMcvFqV21a62zZYDi/KqFePRAs5D9K4PU2EmR7jcvf4uax # ZRyHsqDh00/OSYE/CefriyIMshWmTVCDbT/I3/SCXZX1scrKa3k= # =UO/N # -----END PGP SIGNATURE----- # gpg: Signature made Mon, May 27, 2024 3:53:53 PM # gpg: using RSA key BA66F67FD73F7058D712D308C3B7C91B632F738A # gpg: Can't check signature: No public key # Conflicts: # .github/workflows/release-nightly.yml

GiteaBot added the lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. label Dec 12, 2023

pull-request-size bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Dec 12, 2023

delvh changed the title ~~Add missing fields to gitea webhook for openproject compatibility.~~ Make gitea webhooks openproject compatible Dec 12, 2023

github-actions bot added the modifies/api This PR adds API routes or modifies them label Dec 12, 2023

Chief-Detektor force-pushed the main branch from 502b2ca to 1fbb8cc Compare December 12, 2023 17:47

6543 reviewed Dec 20, 2023

View reviewed changes

services/convert/pull.go Outdated Show resolved Hide resolved

models/issues/pull.go Show resolved Hide resolved

6543 reviewed Dec 21, 2023

View reviewed changes

models/issues/pull.go Outdated Show resolved Hide resolved

delvh reviewed Jan 5, 2024

View reviewed changes

modules/structs/pull.go Outdated Show resolved Hide resolved

services/convert/pull.go Outdated Show resolved Hide resolved

services/convert/pull.go Outdated Show resolved Hide resolved

models/issues/pull.go Show resolved Hide resolved

delvh added type/feature Completely new functionality. Can only be merged if feature freeze is not active. topic/webhooks labels Jan 5, 2024

Chief-Detektor added 6 commits January 5, 2024 23:33

Add missing fields to gitea webhook for openproject compatibility.

6b2157c

Update swagger files.

99487dd

Fix diff calculation when using sqlite.

f0c74fb

Remove superfluous parameter for DiffOptions.

635d411

Remove suoerfluous parameter for FindCommentsOptions.

b1fe6e5

Use GetDiffShortStat to obtain diff changes. Add descriptive comments.

7b7fa4f

Chief-Detektor force-pushed the main branch from f0c640c to 7b7fa4f Compare January 5, 2024 22:33

delvh approved these changes Jan 5, 2024

View reviewed changes

GiteaBot added lgtm/need 1 This PR needs approval from one additional maintainer to be merged. and removed lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. labels Jan 5, 2024

wxiaoguang reviewed May 15, 2024

View reviewed changes

services/convert/pull.go Outdated Show resolved Hide resolved

wxiaoguang added backport/v1.22 This PR should be backported to Gitea 1.22 type/enhancement An improvement of existing functionality and removed type/feature Completely new functionality. Can only be merged if feature freeze is not active. labels May 15, 2024

Merge branch 'main' into main

27312d0

github-actions bot added the modifies/go Pull requests that update Go code label May 15, 2024

wxiaoguang reviewed May 15, 2024

View reviewed changes

6543 and others added 2 commits May 15, 2024 21:44

Update services/convert/pull.go

2632a49

Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>

Merge branch 'main' into main

886337e

6543 added this to the 1.23.0 milestone May 15, 2024

This comment was marked as outdated.

Sign in to view

wxiaoguang reviewed May 26, 2024

View reviewed changes

models/issues/pull.go Outdated Show resolved Hide resolved

Update models/issues/pull.go

b3b694d

wxiaoguang approved these changes May 26, 2024

View reviewed changes

GiteaBot added lgtm/done This PR has enough approvals to get merged. There are no important open reservations anymore. and removed lgtm/need 1 This PR needs approval from one additional maintainer to be merged. labels May 26, 2024

Merge branch 'main' into main

1e2399e

wxiaoguang enabled auto-merge (squash) May 26, 2024 03:42

lunny added the reviewed/wait-merge This pull request is part of the merge queue. It will be merged soon. label May 26, 2024

wxiaoguang merged commit 14f6105 into go-gitea:main May 26, 2024
26 checks passed

GiteaBot mentioned this pull request May 26, 2024

Make gitea webhooks openproject compatible (#28435) #31081

Merged

GiteaBot added backport/done All backports for this PR have been created and removed reviewed/wait-merge This pull request is part of the merge queue. It will be merged soon. labels May 26, 2024

wxiaoguang pushed a commit that referenced this pull request May 26, 2024

Make gitea webhooks openproject compatible (#28435) (#31081)

1171b24

Backport #28435 by Chief-Detektor Co-authored-by: André Rosenhammer <andre.rosenhammer@gmail.com>

everflux mentioned this pull request Jun 13, 2024

Release event not working as expected woodpecker-ci/woodpecker#3666

Closed

3 tasks

go-gitea locked as resolved and limited conversation to collaborators Aug 24, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Make gitea webhooks openproject compatible #28435

Make gitea webhooks openproject compatible #28435

Chief-Detektor commented Dec 12, 2023

delvh commented Dec 12, 2023

Chief-Detektor commented Dec 13, 2023

Chief-Detektor commented Dec 13, 2023

Chief-Detektor commented Dec 13, 2023

delvh commented Dec 13, 2023

delvh commented Dec 13, 2023

Chief-Detektor commented Dec 13, 2023

delvh commented Dec 15, 2023

Chief-Detektor commented Dec 15, 2023

claesrosell commented Jan 5, 2024

kresss commented May 15, 2024

wxiaoguang May 15, 2024

Chief-Detektor May 15, 2024

wxiaoguang May 16, 2024

wxiaoguang May 20, 2024

wxiaoguang May 24, 2024

wxiaoguang May 26, 2024

6543 May 28, 2024

This comment was marked as outdated.

wxiaoguang left a comment

Make gitea webhooks openproject compatible #28435

Make gitea webhooks openproject compatible #28435

Conversation

Chief-Detektor commented Dec 12, 2023

delvh commented Dec 12, 2023

Chief-Detektor commented Dec 13, 2023

Chief-Detektor commented Dec 13, 2023

Chief-Detektor commented Dec 13, 2023

delvh commented Dec 13, 2023

delvh commented Dec 13, 2023

Chief-Detektor commented Dec 13, 2023

delvh commented Dec 15, 2023

Chief-Detektor commented Dec 15, 2023

claesrosell commented Jan 5, 2024

kresss commented May 15, 2024

wxiaoguang May 15, 2024

Choose a reason for hiding this comment

Chief-Detektor May 15, 2024

Choose a reason for hiding this comment

wxiaoguang May 16, 2024

Choose a reason for hiding this comment

wxiaoguang May 20, 2024

Choose a reason for hiding this comment

wxiaoguang May 24, 2024

Choose a reason for hiding this comment

wxiaoguang May 26, 2024

Choose a reason for hiding this comment

6543 May 28, 2024

Choose a reason for hiding this comment

This comment was marked as outdated.

wxiaoguang left a comment

Choose a reason for hiding this comment