gitea/models/migrations
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
..
fixtures Attempt to fix the webauthn migration again - part 3 (#18770) 2022-02-16 21:03:58 +00:00
migrations_test.go format with gofumpt (#18184) 2022-01-20 18:46:10 +01:00
migrations.go Store the foreign ID of issues during migration (#18446) 2022-03-17 18:08:35 +01:00
testlogger_test.go migrations: add test for importing pull requests in gitea uploader (#18752) 2022-02-25 17:20:50 +08:00
v70.go chore(models): rewrite code format. (#14754) 2021-03-14 19:52:12 +01:00
v71.go Use base32 for 2FA scratch token (#18384) 2022-01-26 12:10:10 +08:00
v72.go Upgrade xorm to v0.8.0 (#8536) 2019-10-17 11:26:49 +02:00
v73.go Upgrade xorm to v0.8.0 (#8536) 2019-10-17 11:26:49 +02:00
v74.go Upgrade xorm to v0.8.0 (#8536) 2019-10-17 11:26:49 +02:00
v75.go Upgrade xorm to v0.8.0 (#8536) 2019-10-17 11:26:49 +02:00
v76.go chore(models): rewrite code format. (#14754) 2021-03-14 19:52:12 +01:00
v77.go Upgrade xorm to v0.8.0 (#8536) 2019-10-17 11:26:49 +02:00
v78.go Upgrade xorm to v0.8.0 (#8536) 2019-10-17 11:26:49 +02:00
v79.go chore(models): rewrite code format. (#14754) 2021-03-14 19:52:12 +01:00
v80.go Upgrade xorm to v0.8.0 (#8536) 2019-10-17 11:26:49 +02:00
v81.go Upgrade xorm to v1.0.0 (#10646) 2020-03-22 11:12:55 -04:00
v82.go Propagate context and ensure git commands run in request context (#17868) 2022-01-19 23:26:57 +00:00
v83.go Upgrade xorm to v0.8.0 (#8536) 2019-10-17 11:26:49 +02:00
v84.go Upgrade xorm to v0.8.0 (#8536) 2019-10-17 11:26:49 +02:00
v85.go Use base32 for 2FA scratch token (#18384) 2022-01-26 12:10:10 +08:00
v86.go Upgrade xorm to v0.8.0 (#8536) 2019-10-17 11:26:49 +02:00
v87.go Upgrade xorm to v0.8.0 (#8536) 2019-10-17 11:26:49 +02:00
v88.go chore(models): rewrite code format. (#14754) 2021-03-14 19:52:12 +01:00
v89.go Upgrade xorm to v0.8.0 (#8536) 2019-10-17 11:26:49 +02:00
v90.go Upgrade xorm to v0.8.0 (#8536) 2019-10-17 11:26:49 +02:00
v91.go Upgrade xorm to v0.8.0 (#8536) 2019-10-17 11:26:49 +02:00
v92.go chore(models): rewrite code format. (#14754) 2021-03-14 19:52:12 +01:00
v93.go Upgrade xorm to v0.8.0 (#8536) 2019-10-17 11:26:49 +02:00
v94.go Upgrade xorm to v0.8.0 (#8536) 2019-10-17 11:26:49 +02:00
v95.go Upgrade xorm to v0.8.0 (#8536) 2019-10-17 11:26:49 +02:00
v96.go chore(models): rewrite code format. (#14754) 2021-03-14 19:52:12 +01:00
v97.go Upgrade xorm to v0.8.0 (#8536) 2019-10-17 11:26:49 +02:00
v98.go Upgrade xorm to v0.8.0 (#8536) 2019-10-17 11:26:49 +02:00
v99.go Migrations (v82,v96,v99,v136) remove dependencies (#12286) 2020-07-22 09:27:22 -05:00
v100.go chore(models): rewrite code format. (#14754) 2021-03-14 19:52:12 +01:00
v101.go Allow more than 255 characters for tokens in external_login_user table (#8554) 2019-10-18 09:58:36 +03:00
v102.go Use transaction in V102 migration (#12395) 2020-08-06 19:16:49 +01:00
v103.go Allow Protected Branches to Whitelist Deploy Keys (#8483) 2019-10-21 09:21:45 +01:00
v104.go chore(models): rewrite code format. (#14754) 2021-03-14 19:52:12 +01:00
v105.go chore(models): rewrite code format. (#14754) 2021-03-14 19:52:12 +01:00
v106.go Auto-subscribe user to repository when they commit/tag to it (#7657) 2019-11-10 09:22:19 +00:00
v107.go chore(models): rewrite code format. (#14754) 2021-03-14 19:52:12 +01:00
v108.go Improve notification (#8835) 2019-11-12 16:33:34 +08:00
v109.go Team permission to create repository in organization (#8312) 2019-11-20 19:27:49 +08:00
v110.go Upgrade xorm to v1.0.0 (#10646) 2020-03-22 11:12:55 -04:00
v111.go Move unit into models/unit/ (#17576) 2021-11-09 20:57:58 +01:00
v112.go Add a storage layer for attachments (#11387) 2020-08-18 12:23:45 +08:00
v113.go Change target branch for pull request (#6488) 2019-12-16 14:20:25 +08:00
v114.go chore(models): rewrite code format. (#14754) 2021-03-14 19:52:12 +01:00
v115.go refactor: move from io/ioutil to io and os package (#17109) 2021-09-22 13:38:34 +08:00
v116.go chore(models): rewrite code format. (#14754) 2021-03-14 19:52:12 +01:00
v117.go Add branch protection option to block merge on requested changes. (#9592) 2020-01-03 19:47:09 +02:00
v118.go Mark PR reviews as stale at push and allow to dismiss stale approvals (#9532) 2020-01-09 01:47:45 +00:00
v119.go Refactor: Remove Dependencys from Migration v112-v119 (#11811) 2020-06-09 16:34:05 -04:00
v120.go Add owner_name column for table repository for maintaince reason (#9717) 2020-01-12 17:36:21 +08:00
v121.go Restricted users (#6274) 2020-01-13 18:33:46 +01:00
v122.go chore(models): rewrite code format. (#14754) 2021-03-14 19:52:12 +01:00
v123.go Migrate reactions when migrating repository from github (#9599) 2020-01-15 12:14:07 +01:00
v124.go chore(models): rewrite code format. (#14754) 2021-03-14 19:52:12 +01:00
v125.go Migrate reviews when migrating repository from github (#9463) 2020-01-23 19:28:15 +02:00
v126.go Update topics repo count when deleting repository (#10051) 2020-01-31 08:57:19 +02:00
v127.go Language statistics bar for repositories (#8037) 2020-02-11 11:34:17 +02:00
v128.go Delete old git.NewCommand() and use it as git.NewCommandContext() (#18552) 2022-02-06 20:01:47 +01:00
v129.go chore(models): rewrite code format. (#14754) 2021-03-14 19:52:12 +01:00
v130.go Add an abstract json layout to make it's easier to change json library (#16528) 2021-07-24 18:03:58 +02:00
v131.go System-wide webhooks (#10546) 2020-03-09 00:08:05 +02:00
v132.go Allow to set protected file patterns that can not be changed under no conditions (#10806) 2020-03-27 00:26:34 +02:00
v133.go make avatar lookup occur at image request (#10540) 2020-03-27 14:34:39 +02:00
v134.go Delete old git.NewCommand() and use it as git.NewCommandContext() (#18552) 2022-02-06 20:01:47 +01:00
v135.go Add Organization Wide Labels (#10814) 2020-04-01 01:14:46 -03:00
v136.go Propagate context and ensure git commands run in request context (#17868) 2022-01-19 23:26:57 +00:00
v137.go Prevent merge of outdated PRs on protected branches (#11012) 2020-04-16 22:00:36 -03:00
v138.go Add a way to mark Conversation (code comment) resolved (#11037) 2020-04-18 10:50:25 -03:00
v139.go Fix issue ref migration (#11419) 2020-05-15 15:05:18 +01:00
v140.go Change language statistics to save size instead of percentage (#11681) 2020-05-30 10:46:15 +03:00
v141.go Fix migration v141 (#14387) 2021-01-28 23:58:33 +01:00
v142.go A better go code formatter, and now make fmt can run in Windows (#17684) 2021-11-17 20:34:35 +08:00
v143.go Decrease the num_stars when deleting a repo (#11954) 2020-07-07 15:16:34 -04:00
v144.go A better go code formatter, and now make fmt can run in Windows (#17684) 2021-11-17 20:34:35 +08:00
v145.go Fix Migration 145 on MSSQL if varchar is changed to nvarchar (#12445) 2020-08-10 16:01:10 +03:00
v146.go chore(models): rewrite code format. (#14754) 2021-03-14 19:52:12 +01:00
v147.go Fix various documentation, user-facing, and source comment typos (#16367) 2021-07-08 13:38:13 +02:00
v148.go [BugFix] Fix comment broken issue ref dependence (#12651) 2020-09-04 09:36:56 +08:00
v149.go Add Created & Updated to Milestone (#12662) 2020-09-05 13:38:54 -04:00
v150.go Add Primary Key to Topic and RepoTopic (#12639) 2020-09-10 20:45:01 +01:00
v151.go Add migration for password algorithm change (#12784) 2020-09-15 18:02:41 -04:00
v152.go Add configurable Trust Models (#11712) 2020-09-20 00:44:55 +08:00
v153.go Add team support for review request (#12039) 2020-10-12 20:55:13 +01:00
v154.go Save TimeStamps for Star, Label, Follow, Watch and Collaboration to Database (#13124) 2020-10-12 20:01:57 -04:00
v155.go [Enhancement] Allow admin to merge pr with protected file changes (#12078) 2020-10-13 14:50:57 -04:00
v156.go Propagate context and ensure git commands run in request context (#17868) 2022-01-19 23:26:57 +00:00
v157.go chore(models): rewrite code format. (#14754) 2021-03-14 19:52:12 +01:00
v158.go chore(models): rewrite code format. (#14754) 2021-03-14 19:52:12 +01:00
v159.go Include OriginalAuthor in Reaction constraint (#13505) 2020-11-10 22:37:11 +00:00
v160.go Add block on official review requests branch protection (#13705) 2020-11-28 21:30:46 +02:00
v161.go Fix database keyword quote problem on migration v161 (#17522) 2021-11-05 00:47:01 +02:00
v162.go Add support for corporate WeChat webhooks (#15910) 2021-07-23 12:41:27 +08:00
v163.go Change topic name size from 25 to 50 (#14150) 2020-12-26 23:28:47 +00:00
v164.go Minimal OpenID Connect implementation (#14139) 2021-01-02 00:33:27 +08:00
v165.go Fix wrong type on hooktask to convert typ from char(16) to varchar(16) (#14148) 2021-01-06 16:11:23 +01:00
v166.go Remove unused commit (#14741) 2021-02-20 15:02:39 +01:00
v167.go Redirect on changed user and org name (#11649) 2021-01-24 16:23:05 +01:00
v168.go noop (#14521) 2021-01-29 23:52:13 +08:00
v169.go Use OldRef instead of CommitSHA for DeleteBranch comments (#14604) 2021-02-08 11:09:14 +08:00
v170.go Add dismiss review feature (#12674) 2021-02-11 18:32:25 +01:00
v171.go Add v171 (addSortingColToProjectBoard) migration for #14634 (#14652) 2021-02-12 13:01:26 +02:00
v172.go v172 migration adds created_unix field instead of expiry (#15458) 2021-04-13 20:04:17 -04:00
v173.go Add UI to delete tracked times (#14100) 2021-02-19 12:52:11 +02:00
v174.go Delete Labels & IssueLabels on Repo Delete too (#15039) 2021-03-19 21:01:24 +02:00
v175.go A better go code formatter, and now make fmt can run in Windows (#17684) 2021-11-17 20:34:35 +08:00
v176_test.go format with gofumpt (#18184) 2022-01-20 18:46:10 +01:00
v176.go Create Proper Migration Tests (#15116) 2021-03-24 19:27:22 +01:00
v177_test.go format with gofumpt (#18184) 2022-01-20 18:46:10 +01:00
v177.go Create Proper Migration Tests (#15116) 2021-03-24 19:27:22 +01:00
v178.go Add LFS Migration and Mirror (#14726) 2021-04-08 18:25:57 -04:00
v179.go OAuth2 auto-register (#5123) 2021-04-14 14:02:12 +02:00
v180.go Add an abstract json layout to make it's easier to change json library (#16528) 2021-07-24 18:03:58 +02:00
v181_test.go format with gofumpt (#18184) 2022-01-20 18:46:10 +01:00
v181.go Rework repository archive (#14723) 2021-06-23 17:12:38 -04:00
v182_test.go format with gofumpt (#18184) 2022-01-20 18:46:10 +01:00
v182.go Add primary_key to issue_index (#16813) 2021-08-25 09:42:51 +01:00
v183.go Add push to remote mirror repository (#15157) 2021-06-14 19:20:43 +02:00
v184.go Check if column exist before rename if exist, just return with no error (#17870) 2021-12-02 21:17:24 +08:00
v185.go Rework repository archive (#14723) 2021-06-23 17:12:38 -04:00
v186.go Add tag protection (#15629) 2021-06-25 16:28:55 +02:00
v187.go Refactor Webhook + Add X-Hub-Signature (#16176) 2021-06-27 20:21:09 +01:00
v188.go Add option to provide signature for a token to verify key ownership (#14054) 2021-07-13 15:28:07 +02:00
v189_test.go format with gofumpt (#18184) 2022-01-20 18:46:10 +01:00
v189.go Add an abstract json layout to make it's easier to change json library (#16528) 2021-07-24 18:03:58 +02:00
v190.go Add agit flow support in gitea (#14295) 2021-07-28 17:42:56 +08:00
v191.go format with gofumpt (#18184) 2022-01-20 18:46:10 +01:00
v192.go Add primary_key to issue_index (#16813) 2021-08-25 09:42:51 +01:00
v193_test.go Add repo_id for attachment (#16958) 2021-09-08 17:19:30 +02:00
v193.go Add repo_id for attachment (#16958) 2021-09-08 17:19:30 +02:00
v194.go Support unprotected file patterns (#16395) 2021-09-11 16:21:17 +02:00
v195_test.go format with gofumpt (#18184) 2022-01-20 18:46:10 +01:00
v195.go Fix commit status index problem (#17061) 2021-09-23 18:50:06 +08:00
v196.go Kanban colored boards (#16647) 2021-09-29 22:53:12 +02:00
v197.go Add a simple way to rename branch like gh (#15870) 2021-10-08 19:03:04 +02:00
v198.go Save and view issue/comment content history (#16909) 2021-10-10 18:40:03 -04:00
v199.go Refactor update checker to use AppState (#17387) 2021-10-21 17:10:49 +01:00
v200.go Sync gitea app path for git hooks and authorized keys when starting (#17335) 2021-10-21 17:22:43 +08:00
v201.go Refactor update checker to use AppState (#17387) 2021-10-21 17:10:49 +01:00
v202.go Add support for ssh commit signing (#17743) 2021-12-19 00:37:18 -05:00
v203.go Support sorting for project board issuses (#17152) 2021-12-08 14:57:18 +08:00
v204.go Migration 204 use Sync2 (#18044) 2021-12-20 18:58:38 +01:00
v205.go Increase Salt randomness (#18179) 2022-01-04 15:13:52 +00:00
v206.go Team permission allow different unit has different permission (#17811) 2022-01-05 11:37:00 +08:00
v207.go Attempt to fix the webauthn migration again - part 3 (#18770) 2022-02-16 21:03:58 +00:00
v208.go Attempt to fix the webauthn migration again - part 3 (#18770) 2022-02-16 21:03:58 +00:00
v209.go Attempt to fix the webauthn migration again - part 3 (#18770) 2022-02-16 21:03:58 +00:00
v210_test.go Lock gofumpt to v0.3.0 and run it (#18866) 2022-02-23 20:16:07 +00:00
v210.go Update the webauthn_credential_id_sequence in Postgres (#19048) 2022-03-10 23:04:55 +01:00
v211.go Store the foreign ID of issues during migration (#18446) 2022-03-17 18:08:35 +01:00