add Index to comment for migrations and mirroring

[singuliere]

See original merge request from Loïc Dachary @ forgefriends

---

Comments have an id (see Gitea[0], GitLab[1] or GitHub[2], etc.), and the
comment migration format must represent it during migrations so that
it can be used during mirroring or incremental migrations.

[0] https://try.gitea.io/api/swagger#/issue/issueGetComment
[1] https://docs.gitlab.com/ee/api/discussions.html#get-single-issue-discussion-item
[2] https://docs.github.com/en/rest/reference/issues#get-an-issue-comment

[lunny]

What's the definition of comment index?

[singuliere]

What's the definition of comment index?

It is the unique identifier of the comment. It could be named ID, Number or Index. The name Index was chosen because it is also chosen in another pull request to unify the naming of unique identifiers in the context of migrations.

[singuliere]

The CI failure is unrelated to this PR, could someone please restart it?

+ make lint-backend

golangci-lint run --timeout 10m

level=error msg="[linters context] typechecking error: pattern ./...: open /drone/src/node_modules/esbuild-android-arm64: no such file or directory"

make: *** [Makefile:782: golangci-lint] Error 7

[singuliere]

It would be too complicated to add the comment identifier in the database. This pull request was simplified to only add the information in the migration files. It can later be used to set the information in the ForeignReference table when this pull request is merged.

[lunny]

The Index is per repository or per issue? Since there is no id or index from Github, what should be stored?

[singuliere]

The Index is per repository or per issue?

It depends. The index for Gitea is absolute even though the API endpoint is relative to the repository. The API endpoint for GitHub is also relative to the repository but the documentation does not specify if the id field is relative to the repository or not. However, since the API endpoint is not relatve to the issue, I think the id is not per issue.

Since there is no id or index from Github, what should be stored?

There is an idfor comments from GitHub. And for GitLab too and every other forge supported by Gitea at the moment.

Maybe I misunderstood your question?

[codecov-commenter]

Codecov Report

❗ No coverage uploaded for pull request base (main@b24e8d3). Click here to learn what that means.
The diff coverage is 13.33%.

@@           Coverage Diff           @@
##             main   #18806   +/-   ##
=======================================
  Coverage        ?   46.56%           
=======================================
  Files           ?      854           
  Lines           ?   122889           
  Branches        ?        0           
=======================================
  Hits            ?    57218           
  Misses          ?    58749           
  Partials        ?     6922           

Impacted Files	Coverage Δ
modules/migration/comment.go	100.00% <ø> (ø)
services/migrations/codebase.go	0.78% <0.00%> (ø)
services/migrations/gitlab.go	5.21% <0.00%> (ø)
services/migrations/gogs.go	2.02% <0.00%> (ø)
services/migrations/onedev.go	0.82% <0.00%> (ø)
services/migrations/github.go	66.30% <50.00%> (ø)
services/migrations/gitea_downloader.go	67.11% <100.00%> (ø)

---

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 b24e8d3...a53e163. Read the comment docs.

[Gusted]

In simple words this PR provide a value for the GetForeignIndex() for the comment structs?

Answered by dachary in matrix:

Yes, that's exactly the purpose of this PR. Without an Index in the migration files, there is no way to match a comment migrated into Gitea with the comment it comes from in the original forge.

[singuliere]

make l-g-t-m work

[singuliere]

make l-g-t-m work