forgejo/models
Aravinth Manivannan fa73cbf5a7
Store the foreign ID of issues during migration (#18446)
Storing the foreign identifier of an imported issue in the database is a prerequisite to implement idempotent migrations or mirror for issues. It is a baby step towards mirroring that introduces a new table.

At the moment when an issue is created by the Gitea uploader, it fails if the issue already exists. The Gitea uploader could be modified so that, instead of failing, it looks up the database to find an existing issue. And if it does it would update the issue instead of creating a new one. However this is not currently possible because an information is missing from the database: the foreign identifier that uniquely represents the issue being migrated is not persisted. With this change, the foreign identifier is stored in the database and the Gitea uploader will then be able to run a query to figure out if a given issue being imported already exists.

The implementation of mirroring for issues, pull requests, releases, etc. can be done in three steps:

1. Store an identifier for the element being mirrored (issue, pull request...) in the database (this is the purpose of these changes)
2. Modify the Gitea uploader to be able to update an existing repository with all it contains (issues, pull request...) instead of failing if it exists
3. Optimize the Gitea uploader to speed up the updates, when possible.

The second step creates code that does not yet exist to enable idempotent migrations with the Gitea uploader. When a migration is done for the first time, the behavior is not changed. But when a migration is done for a repository that already exists, this new code is used to update it.

The third step can use the code created in the second step to optimize and speed up migrations. For instance, when a migration is resumed, an issue that has an update time that is not more recent can be skipped and only newly created issues or updated ones will be updated. Another example of optimization could be that a webhook notifies Gitea when an issue is updated. The code triggered by the webhook would download only this issue and call the code created in the second step to update the issue, as if it was in the process of an idempotent migration.

The ForeignReferences table is added to contain local and foreign ID pairs relative to a given repository. It can later be used for pull requests and other artifacts that can be mirrored. Although the foreign id could be added as a single field in issues or pull requests, it would need to be added to all tables that represent something that can be mirrored. Creating a new table makes for a simpler and more generic design. The drawback is that it requires an extra lookup to obtain the information. However, this extra information is only required during migration or mirroring and does not impact the way Gitea currently works.

The foreign identifier of an issue or pull request is similar to the identifier of an external user, which is stored in reactions, issues, etc. as OriginalPosterID and so on. The representation of a user is however different and the ability of users to link their account to an external user at a later time is also a logic that is different from what is involved in mirroring or migrations. For these reasons, despite some commonalities, it is unclear at this time how the two tables (foreign reference and external user) could be merged together.

The ForeignID field is extracted from the issue migration context so that it can be dumped in files with dump-repo and later restored via restore-repo.

The GetAllComments downloader method is introduced to simplify the implementation and not overload the Context for the purpose of pagination. It also clarifies in which context the comments are paginated and in which context they are not.

The Context interface is no longer useful for the purpose of retrieving the LocalID and ForeignID since they are now both available from the PullRequest and Issue struct. The Reviewable and Commentable interfaces replace and serve the same purpose.

The Context data member of PullRequest and Issue becomes a DownloaderContext to clarify that its purpose is not to support in memory operations while the current downloader is acting but is not otherwise persisted. It is, for instance, used by the GitLab downloader to store the IsMergeRequest boolean and sort out issues.

---
[source](https://lab.forgefriends.org/forgefriends/forgefriends/-/merge_requests/36)

Signed-off-by: Loïc Dachary <loic@dachary.org>
Co-authored-by: Loïc Dachary <loic@dachary.org>
2022-03-17 18:08:35 +01:00
..
admin Propagate context and ensure git commands run in request context (#17868) 2022-01-19 23:26:57 +00:00
appstate Sync gitea app path for git hooks and authorized keys when starting (#17335) 2021-10-21 17:22:43 +08:00
asymkey Collaborator trust model should trust collaborators (#18539) 2022-02-02 11:10:06 +01:00
auth Attempt to fix the webauthn migration again - part 3 (#18770) 2022-02-16 21:03:58 +00:00
avatars format with gofumpt (#18184) 2022-01-20 18:46:10 +01:00
db Move deletebeans into models/db (#18781) 2022-02-17 16:37:48 +08:00
fixtures Store the foreign ID of issues during migration (#18446) 2022-03-17 18:08:35 +01:00
foreignreference Store the foreign ID of issues during migration (#18446) 2022-03-17 18:08:35 +01:00
issues Show fullname on issue edits and gpg/ssh signing info (#18827) 2022-02-20 19:50:11 +00:00
migrations Store the foreign ID of issues during migration (#18446) 2022-03-17 18:08:35 +01:00
perm Team permission allow different unit has different permission (#17811) 2022-01-05 11:37:00 +08:00
repo Add config option to disable "Update branch by rebase" (#18745) 2022-03-04 03:30:49 -05:00
unit Let MinUnitAccessMode return correct perm (#18675) 2022-02-08 21:16:17 +00:00
unittest Add separate SSH_USER config option (#17584) 2022-02-07 16:56:45 -05:00
user Restrict email address validation (#17688) 2022-03-14 18:39:54 +01:00
webhook Add packagist webhook (#18224) 2022-01-23 21:46:30 +08:00
access.go Team permission allow different unit has different permission (#17811) 2022-01-05 11:37:00 +08:00
access_test.go Move repository model into models/repo (#17933) 2021-12-10 09:27:50 +08:00
action.go RSS/Atom support for Repos (#19055) 2022-03-13 17:40:47 +01:00
action_list.go RSS/Atom support for Repos (#19055) 2022-03-13 17:40:47 +01:00
action_test.go RSS/Atom support for Repos (#19055) 2022-03-13 17:40:47 +01:00
branches.go Move repository model into models/repo (#17933) 2021-12-10 09:27:50 +08:00
branches_test.go Move repository model into models/repo (#17933) 2021-12-10 09:27:50 +08:00
commit.go Collaborator trust model should trust collaborators (#18539) 2022-02-02 11:10:06 +01:00
commit_status.go Add missing X-Total-Count and fix some related bugs (#17968) 2021-12-15 13:39:34 +08:00
commit_status_test.go Move repository model into models/repo (#17933) 2021-12-10 09:27:50 +08:00
consistency.go format with gofumpt (#18184) 2022-01-20 18:46:10 +01:00
consistency_test.go A better go code formatter, and now make fmt can run in Windows (#17684) 2021-11-17 20:34:35 +08:00
engine_test.go Refactor install page (db type) (#17919) 2021-12-07 13:44:08 +08:00
error.go Some repository refactors (#17950) 2021-12-12 23:48:20 +08:00
fixture_generation.go Move repository model into models/repo (#17933) 2021-12-10 09:27:50 +08:00
fixture_test.go Decouple unit test code from business code (#17623) 2021-11-12 22:36:47 +08:00
helper.go Move repository model into models/repo (#17933) 2021-12-10 09:27:50 +08:00
helper_directory.go refactor: move from io/ioutil to io and os package (#17109) 2021-09-22 13:38:34 +08:00
helper_environment.go Move repository model into models/repo (#17933) 2021-12-10 09:27:50 +08:00
issue.go Store the foreign ID of issues during migration (#18446) 2022-03-17 18:08:35 +01:00
issue_assignees.go Move repository model into models/repo (#17933) 2021-12-10 09:27:50 +08:00
issue_assignees_test.go Move user related model into models/user (#17781) 2021-11-24 17:49:20 +08:00
issue_comment.go [API] Allow removing issues (#18879) 2022-03-01 01:20:15 +01:00
issue_comment_list.go Move repository model into models/repo (#17933) 2021-12-10 09:27:50 +08:00
issue_comment_test.go Propagate context and ensure git commands run in request context (#17868) 2022-01-19 23:26:57 +00:00
issue_dependency.go Move repository model into models/repo (#17933) 2021-12-10 09:27:50 +08:00
issue_dependency_test.go Move user related model into models/user (#17781) 2021-11-24 17:49:20 +08:00
issue_label.go Be more lenient with label colors (#17752) 2022-02-07 21:21:02 +00:00
issue_label_test.go Be more lenient with label colors (#17752) 2022-02-07 21:21:02 +00:00
issue_list.go Use conditions but not repo ids as query condition (#16839) 2021-12-29 21:02:12 +08:00
issue_list_test.go Decouple unit test, remove intermediate unittestbridge package (#17662) 2021-11-16 16:53:21 +08:00
issue_lock.go Fix CheckRepoStats and reuse it during migration (#18264) 2022-01-17 19:31:58 +01:00
issue_milestone.go Only view milestones from current repo (#18414) 2022-01-26 20:01:35 +00:00
issue_milestone_test.go Fix CheckRepoStats and reuse it during migration (#18264) 2022-01-17 19:31:58 +01:00
issue_reaction.go add test coverage for original author conversion during migrations (#18506) 2022-02-01 13:20:28 -05:00
issue_reaction_test.go Move repository model into models/repo (#17933) 2021-12-10 09:27:50 +08:00
issue_stopwatch.go Fix display time of milestones (#18753) 2022-02-16 00:50:10 +08:00
issue_stopwatch_test.go Move user related model into models/user (#17781) 2021-11-24 17:49:20 +08:00
issue_test.go Store the foreign ID of issues during migration (#18446) 2022-03-17 18:08:35 +01:00
issue_tracked_time.go Fix display time of milestones (#18753) 2022-02-16 00:50:10 +08:00
issue_tracked_time_test.go Refactor SecToTime() function (#18863) 2022-02-28 23:57:20 +01:00
issue_user.go Move repository model into models/repo (#17933) 2021-12-10 09:27:50 +08:00
issue_user_test.go Move repository model into models/repo (#17933) 2021-12-10 09:27:50 +08:00
issue_watch.go Add missing X-Total-Count and fix some related bugs (#17968) 2021-12-15 13:39:34 +08:00
issue_watch_test.go A better go code formatter, and now make fmt can run in Windows (#17684) 2021-11-17 20:34:35 +08:00
issue_xref.go Lock gofumpt to v0.3.0 and run it (#18866) 2022-02-23 20:16:07 +00:00
issue_xref_test.go Propagate context and ensure git commands run in request context (#17868) 2022-01-19 23:26:57 +00:00
lfs.go Improve SyncMirrors logging (#19045) 2022-03-10 10:09:48 +00:00
lfs_lock.go Move repository model into models/repo (#17933) 2021-12-10 09:27:50 +08:00
main_test.go Move keys to models/asymkey (#17917) 2021-12-10 16:14:24 +08:00
migrate.go Store the foreign ID of issues during migration (#18446) 2022-03-17 18:08:35 +01:00
migrate_test.go Store the foreign ID of issues during migration (#18446) 2022-03-17 18:08:35 +01:00
notification.go ignore missing comment for user notifications (#18954) 2022-03-03 16:18:26 +01:00
notification_test.go Move user related model into models/user (#17781) 2021-11-24 17:49:20 +08:00
org.go Move deletebeans into models/db (#18781) 2022-02-17 16:37:48 +08:00
org_team.go Add GetUserTeams (#18499) 2022-02-01 14:09:24 -05:00
org_team_test.go Add GetUserTeams (#18499) 2022-02-01 14:09:24 -05:00
org_test.go Move repository model into models/repo (#17933) 2021-12-10 09:27:50 +08:00
project.go Remove NewSession method from db.Engine interface (#17577) 2021-11-21 23:41:00 +08:00
project_board.go Support sorting for project board issuses (#17152) 2021-12-08 14:57:18 +08:00
project_issue.go Move repository model into models/repo (#17933) 2021-12-10 09:27:50 +08:00
project_test.go Decouple unit test code from business code (#17623) 2021-11-12 22:36:47 +08:00
protected_tag.go Move repository model into models/repo (#17933) 2021-12-10 09:27:50 +08:00
protected_tag_test.go Move repository model into models/repo (#17933) 2021-12-10 09:27:50 +08:00
pull.go Propagate context and ensure git commands run in request context (#17868) 2022-01-19 23:26:57 +00:00
pull_list.go Don't delete branch if other PRs with this branch are open (#18164) 2022-01-03 20:45:58 +01:00
pull_test.go Don't delete branch if other PRs with this branch are open (#18164) 2022-01-03 20:45:58 +01:00
release.go add test coverage for original author conversion during migrations (#18506) 2022-02-01 13:20:28 -05:00
repo.go use xorm builder for models.getReviewers() (#19033) 2022-03-10 19:12:10 +01:00
repo_activity.go Propagate context and ensure git commands run in request context (#17868) 2022-01-19 23:26:57 +00:00
repo_collaboration.go Some repository refactors (#17950) 2021-12-12 23:48:20 +08:00
repo_collaboration_test.go Move repository model into models/repo (#17933) 2021-12-10 09:27:50 +08:00
repo_generate.go Some repository refactors (#17950) 2021-12-12 23:48:20 +08:00
repo_generate_test.go Fixed assert statements. (#16089) 2021-06-07 07:27:09 +02:00
repo_list.go Allow to filter repositories by language in explore, user and organization repositories lists (#18430) 2022-01-28 13:29:04 +02:00
repo_list_test.go Decouple unit test, remove intermediate unittestbridge package (#17662) 2021-11-16 16:53:21 +08:00
repo_permission.go Team permission allow different unit has different permission (#17811) 2022-01-05 11:37:00 +08:00
repo_permission_test.go Move repository model into models/repo (#17933) 2021-12-10 09:27:50 +08:00
repo_test.go Allow users to self-request a PR review (#19030) 2022-03-08 22:48:47 +01:00
repo_transfer.go Some repository refactors (#17950) 2021-12-12 23:48:20 +08:00
repo_transfer_test.go Move repository model into models/repo (#17933) 2021-12-10 09:27:50 +08:00
review.go add test coverage for original author conversion during migrations (#18506) 2022-02-01 13:20:28 -05:00
review_test.go format with gofumpt (#18184) 2022-01-20 18:46:10 +01:00
statistic.go Refactor auth package (#17962) 2022-01-02 21:12:35 +08:00
task.go Move repository model into models/repo (#17933) 2021-12-10 09:27:50 +08:00
token.go Use base32 for 2FA scratch token (#18384) 2022-01-26 12:10:10 +08:00
token_test.go A better go code formatter, and now make fmt can run in Windows (#17684) 2021-11-17 20:34:35 +08:00
upload.go Remove NewSession method from db.Engine interface (#17577) 2021-11-21 23:41:00 +08:00
user.go Move deletebeans into models/db (#18781) 2022-02-17 16:37:48 +08:00
user_heatmap.go Move user related model into models/user (#17781) 2021-11-24 17:49:20 +08:00
user_heatmap_test.go RSS/Atom support for Repos (#19055) 2022-03-13 17:40:47 +01:00
user_test.go Use conditions but not repo ids as query condition (#16839) 2021-12-29 21:02:12 +08:00
userlist.go Move more model into models/user (#17826) 2021-11-28 22:11:58 +08:00
userlist_test.go Move more model into models/user (#17826) 2021-11-28 22:11:58 +08:00