You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
forgejo/models/fixtures
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>
2 years ago
..
access.yml Fix "access" fixtures and tests (#10247) 4 years ago
access_token.yml Hash App token (#6724) 5 years ago
action.yml RSS/Atom support for Repos (#19055) 2 years ago
attachment.yml Add repo_id for attachment (#16958) 3 years ago
collaboration.yml Fix "access" fixtures and tests (#10247) 4 years ago
comment.yml [API] Add "before" query to ListIssueComments and ListRepoIssue… (#9685) 5 years ago
commit_status.yml Status-API (#1332) 7 years ago
commit_status_index.yml Fix commit status index problem (#17061) 3 years ago
deleted_branch.yml Add deleted_branch table fixture (#2832) 7 years ago
deploy_key.yml Writable deploy keys (closes #671) (#3225) 7 years ago
email_address.yml Always store primary email address into email_address table and also the state (#15956) 3 years ago
external_login_user.yml add test coverage for original author conversion during migrations (#18506) 2 years ago
follow.yml Fix and test for delete user (#1713) 7 years ago
foreign_reference.yml Store the foreign ID of issues during migration (#18446) 2 years ago
gpg_key.yml Add missing fixture to clean gpg_key table (#2494) 7 years ago
gpg_key_import.yml add .gpg url (match github behaviour) (#6610) 5 years ago
hook_task.yml API endpoint for testing webhook (#3550) 6 years ago
issue.yml Add filter by owner and team to issue/pulls search endpoint (#16662) 3 years ago
issue_assignees.yml [UI] IssuePage multi repo select (#8741) 5 years ago
issue_index.yml Add a new table issue_index to store the max issue index so that issue could be deleted with no duplicated index (#15599) 3 years ago
issue_label.yml Add Organization Wide Labels (#10814) 4 years ago
issue_user.yml [API] ListIssues add more filters (#16174) 3 years ago
issue_watch.yml Refactor Issues Subscription (#8738) 5 years ago
label.yml API: fix set milestone on PR creation (#14981) 3 years ago
login_source.yml Add LDAP integration tests (#3897) 6 years ago
milestone.yml migrations: a deadline at January 1st, 1970 is valid (#18237) 2 years ago
notice.yml Unit tests for models/admin 8 years ago
notification.yml [API] Add notification endpoint (#9488) 5 years ago
oauth2_application.yml Integrate OAuth2 Provider (#5378) 5 years ago
oauth2_authorization_code.yml Integrate OAuth2 Provider (#5378) 5 years ago
oauth2_grant.yml Fix wrong user in OpenID response (#16736) 3 years ago
org_user.yml Restricted users (#6274) 5 years ago
project.yml Kanban board (#8346) 4 years ago
project_board.yml Kanban board (#8346) 4 years ago
project_issue.yml Kanban board (#8346) 4 years ago
protected_branch.yml Don't recreate database in integration tests (#1697) 7 years ago
public_key.yml test: command keys (#9357) 5 years ago
pull_request.yml Add review request api (#11355) 4 years ago
reaction.yml [API] Add Reactions (#9220) 5 years ago
release.yml [API] ListReleases add filter for draft and pre-releases (#16175) 3 years ago
renamed_branch.yml Add a simple way to rename branch like gh (#15870) 3 years ago
repo_archiver.yml Rework repository archive (#14723) 3 years ago
repo_indexer_status.yml Code/repo search (#2582) 7 years ago
repo_redirect.yml Unit tests for repo redirects (#961) 7 years ago
repo_topic.yml Add API endpoint for accessing repo topics (#7963) 5 years ago
repo_transfer.yml Repository transfer has to be confirmed, if user can not create repo for new owner (#14792) 3 years ago
repo_unit.yml Issues overview should not show issues from archived repos (#13220) 4 years ago
repository.yml Set is_empty in fixtures (#18869) 2 years ago
review.yml Add dismiss review feature (#12674) 3 years ago
star.yml Unit tests for models/star (#752) 8 years ago
stopwatch.yml [API] extend StopWatch (#9196) 5 years ago
team.yml Restricted users (#6274) 5 years ago
team_repo.yml Restrict permission check on repositories and fix some problems (#5314) 6 years ago
team_unit.yml Team permission allow different unit has different permission (#17811) 3 years ago
team_user.yml Restricted users (#6274) 5 years ago
topic.yml Add API endpoint for accessing repo topics (#7963) 5 years ago
tracked_time.yml [API] Extend times API (#9200) 5 years ago
two_factor.yml org/members: display 2FA members states + optimize sql requests (#7621) 5 years ago
user.yml Set is_empty in fixtures (#18869) 2 years ago
user_open_id.yml Show user OpenID URIs in their profile (#1314) 7 years ago
user_redirect.yml Redirect on changed user and org name (#11649) 3 years ago
watch.yml Auto-subscribe user to repository when they commit/tag to it (#7657) 5 years ago
webauthn_credential.yml Support webauthn (#17957) 2 years ago
webhook.yml Implement webhook branch filter (#7791) 5 years ago