forgejo/services/f3/driver/reaction.go
Earl Warren 4ed79ea8eb
[F3] Forgejo driver and CLI
user, topic, project, label, milestone, repository, pull_request,
release, asset, comment, reaction, review providers

Signed-off-by: Earl Warren <contact@earl-warren.org>

Preserve file size when creating attachments

Introduced in c6f5029708

repoList.LoadAttributes has a ctx argument now

Rename `repo.GetOwner` to `repo.LoadOwner`

bd66fa586a

upgrade to the latest gof3

(cherry picked from commit c770713656)

[F3] ID remapping logic is in place, remove workaround

(cherry picked from commit d0fee30167)

[F3] it is experimental, do not enable by default

(cherry picked from commit de325b21d0)
(cherry picked from commit 547e7b3c40)
(cherry picked from commit 820df3a56b)
(cherry picked from commit eaba87689b)
(cherry picked from commit 1b86896b3b)
(cherry picked from commit 0046aac1c6)
(cherry picked from commit f14220df8f)
(cherry picked from commit 559b731001)
(cherry picked from commit 801f7d600d)
(cherry picked from commit 6aa76e9bcf)
(cherry picked from commit a8757dcb07)

[F3] promote F3 users to matching OAuth2 users on first sign-in

(cherry picked from commit bd7fef7496)
(cherry picked from commit 07412698e8)
(cherry picked from commit d143e5b2a3)

[F3] upgrade to gof3 50a6e740ac04

Add new methods GetIDString() & SetIDString() & ToFormatInterface()
Change the prototype of the fixture function

(cherry picked from commit d7b263ff8b)
(cherry picked from commit b3eaf2249d)
(cherry picked from commit d492ddd9bb)

[F3] add GetLocalMatchingRemote with a default implementation

(cherry picked from commit 0a22015039)
(cherry picked from commit f1310c38fb)
(cherry picked from commit deb68552f2)

[F3] GetLocalMatchingRemote for user

(cherry picked from commit e73cb837f5)
(cherry picked from commit a24bc0b85e)
(cherry picked from commit 846a522ecc)

[F3] GetAdminUser now has a ctx argument

(cherry picked from commit 37357a92af)
(cherry picked from commit 660bc1673c)
(cherry picked from commit 72d692a767)

[F3] introduce UserTypeF3

To avoid conflicts should UserTypeRemoteUser be used differently by Gitea

(cherry picked from commit 6de2701bb3)

[F3] user.Put: idempotency

(cherry picked from commit 821e38573c)
(cherry picked from commit f7638f5414)

[F3] upgrade to urfave v2

(cherry picked from commit cc3dbdfd1d)

[F3] update gof3

(cherry picked from commit 2eee960751)

[F3] move f3 under forgejo-cli

* simplify the tests by re-using the forgejo-cli helpers to capture
  the output
* unify CmdF3 to be structured in the same way CmdActions is

(cherry picked from commit 4c9fe58b74)

[F3] replace f3 with forgejo-cli f3

(cherry picked from commit 7ba7ceef1b)

[F3] s/ListOptions/Paginator/

[F3] user: add unit tests

[F3] user comparison of F3 managed users is on content

[F3] issue: add unit tests

[F3] gof3 now has one more argument to Put()

[F3] re-use gof3 unit tests for the driver

(cherry picked from commit af7ee6200c)

Conflicts:
	tests/integration/integration_test.go
	because of some code removed in forgejo-development, trivial
	context conflict resolution

[F3] more idempotent tests (#1275)

Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/1275
Co-authored-by: Loïc Dachary <loic@dachary.org>
Co-committed-by: Loïc Dachary <loic@dachary.org>

[F3] tests: do SQL update if nothing changes

[F3] tests comment idempotence

[F3] tests milestone idempotence

[F3] tests pull_request idempotence

[F3] tests release idempotence

[F3] tests asset idempotence

[F3] tests project idempotence

[F3] tests review idempotence

(cherry picked from commit 91038bb4e8)
(cherry picked from commit a7d2a65214)
(cherry picked from commit 59a17e5a34)

[F3] sub command of forgejo-cli

(cherry picked from commit 4d098e9b83)

[F3] implement --quiet, --debug, --verbose

(cherry picked from commit 82e2e17b45)

[F3] fix off by one error when importing repositories

(cherry picked from commit 31689b1397)

[F3] upgrade gof3

(cherry picked from commit 87b8cfe5a1)

[F3] set the logger for all drivers

The logger is set for the local Forgejo driver only. Even when --debug
is specified, the other drivers do not display debug
information. Use the gof3 context to set the logger for all of them at
once.

(cherry picked from commit 8aa7de8ba0)

[F3] the closed date of an issue may be nil

(cherry picked from commit 93d3eaf0b5)

[F3] update gof3 to support system users

there now is a workaround to hardcode system users when they are not
supported by the API

(cherry picked from commit 915484daa7)
(cherry picked from commit b47ac73b8a)

[F3] upgrade gof3 with a version that can deal with system users

When they are missing from what the API returns, it will replace the
missing user with the Ghost user instead of leaving it be a null pointer.

(cherry picked from commit 9eeeab7f8e)

[F3] tests do not need a running Forgejo server

(cherry picked from commit b2b9749ac9)

[F3] upgrade gof3 to correctly fetch PRs from forks

(cherry picked from commit d2448de302)

[F3] upgrade gof3 to resolve incorrect object ID mappings

(cherry picked from commit af8c9de89f)

[F3] mirroring a repository needs --mirror instead of --bare

(cherry picked from commit 9941131920)

[F3] PR create the pull/N/head from the original PR head

It is incorrect to assume they are identical because:

* the IDs of a PR may be remapped and pull/N/head will become
  pull/M/head
* the head of a remote fork is a branch named after the fork

(cherry picked from commit 9c220bf23e)

[F3] gof3 upgrade with non overlapping PR references

(cherry picked from commit f1b2f82e7e)

[F3] refactor issue insertion to preserve the creation date

issues_model.NewIssue() is convenient but will override the creation
date. Update the database instead.

(cherry picked from commit 729f4be1e4)

[F3] gof3 upgrade to get performance improvements

(cherry picked from commit 996ac35d4d)
(cherry picked from commit 906e9eb3f5)
(cherry picked from commit c340e22197)
(cherry picked from commit bb0ed72e08)
(cherry picked from commit 500e640d6d)

[F3] TestForgeMethods needs to populate the database

(cherry picked from commit e6da71229f)
(cherry picked from commit e3bd088895)
(cherry picked from commit 2255136187)
(cherry picked from commit 69584b1baf)
(cherry picked from commit bc37771dc3)
(cherry picked from commit 90592146c6)
(cherry picked from commit 6160eb38d9)
2023-12-04 13:58:14 +01:00

187 lines
4.8 KiB
Go

// SPDX-License-Identifier: MIT
package driver
import (
"context"
"fmt"
"code.gitea.io/gitea/models/db"
issues_model "code.gitea.io/gitea/models/issues"
user_model "code.gitea.io/gitea/models/user"
"lab.forgefriends.org/friendlyforgeformat/gof3/forges/common"
"lab.forgefriends.org/friendlyforgeformat/gof3/format"
"lab.forgefriends.org/friendlyforgeformat/gof3/util"
"xorm.io/builder"
)
type Reaction struct {
issues_model.Reaction
}
func ReactionConverter(f *issues_model.Reaction) *Reaction {
return &Reaction{
Reaction: *f,
}
}
func (o Reaction) GetID() int64 {
return o.ID
}
func (o Reaction) GetIDString() string {
return fmt.Sprintf("%d", o.GetID())
}
func (o *Reaction) SetID(id int64) {
o.ID = id
}
func (o *Reaction) SetIDString(id string) {
o.SetID(util.ParseInt(id))
}
func (o *Reaction) IsNil() bool {
return o.ID == 0
}
func (o *Reaction) Equals(other *Reaction) bool {
return o.UserID == other.UserID && o.Type == other.Type
}
func (o *Reaction) ToFormatInterface() format.Interface {
return o.ToFormat()
}
func (o *Reaction) ToFormat() *format.Reaction {
return &format.Reaction{
Common: format.NewCommon(o.ID),
UserID: format.NewUserReference(o.User.ID),
Content: o.Type,
}
}
func (o *Reaction) FromFormat(reaction *format.Reaction) {
*o = Reaction{
Reaction: issues_model.Reaction{
ID: reaction.GetID(),
UserID: reaction.UserID.GetID(),
User: &user_model.User{
ID: reaction.UserID.GetID(),
},
Type: reaction.Content,
},
}
}
type ReactionProvider struct {
BaseProvider
}
func (o *ReactionProvider) ToFormat(ctx context.Context, reaction *Reaction) *format.Reaction {
return reaction.ToFormat()
}
func (o *ReactionProvider) FromFormat(ctx context.Context, m *format.Reaction) *Reaction {
var reaction Reaction
reaction.FromFormat(m)
return &reaction
}
//
// Although it would be possible to use a higher level logic instead of the database,
// as of September 2022 (1.18 dev)
// (i) models/issues/reaction.go imposes a significant overhead
// (ii) is fragile and bugous https://github.com/go-gitea/gitea/issues/20860
//
func (o *ReactionProvider) GetObjects(ctx context.Context, user *User, project *Project, parents []common.ContainerObjectInterface, page int) []*Reaction {
cond := builder.NewCond()
switch l := parents[len(parents)-1].(type) {
case *Issue:
cond = cond.And(builder.Eq{"reaction.issue_id": l.ID})
cond = cond.And(builder.Eq{"reaction.comment_id": 0})
case *Comment:
cond = cond.And(builder.Eq{"reaction.comment_id": l.ID})
default:
panic(fmt.Errorf("unexpected type %T", parents[len(parents)-1]))
}
sess := db.GetEngine(ctx).Where(cond)
if page > 0 {
sess = db.SetSessionPagination(sess, &db.ListOptions{Page: page, PageSize: o.g.perPage})
}
reactions := make([]*issues_model.Reaction, 0, 10)
if err := sess.Find(&reactions); err != nil {
panic(err)
}
_, err := (issues_model.ReactionList)(reactions).LoadUsers(ctx, nil)
if err != nil {
panic(err)
}
return util.ConvertMap[*issues_model.Reaction, *Reaction](reactions, ReactionConverter)
}
func (o *ReactionProvider) ProcessObject(ctx context.Context, user *User, project *Project, parents []common.ContainerObjectInterface, reaction *Reaction) {
}
func (o *ReactionProvider) Get(ctx context.Context, user *User, project *Project, parents []common.ContainerObjectInterface, exemplar *Reaction) *Reaction {
reaction := &Reaction{}
has, err := db.GetEngine(ctx).ID(exemplar.GetID()).Get(&reaction.Reaction)
if err != nil {
panic(err)
} else if !has {
return &Reaction{}
}
if _, err := (issues_model.ReactionList{&reaction.Reaction}).LoadUsers(ctx, nil); err != nil {
panic(err)
}
return reaction
}
func (o *ReactionProvider) Put(ctx context.Context, user *User, project *Project, parents []common.ContainerObjectInterface, reaction, existing *Reaction) *Reaction {
r := &issues_model.Reaction{
Type: reaction.Type,
UserID: o.g.GetDoer().ID,
}
switch l := parents[len(parents)-1].(type) {
case *Issue:
r.IssueID = l.ID
r.CommentID = 0
case *Comment:
i, ok := parents[len(parents)-2].(*Issue)
if !ok {
panic(fmt.Errorf("unexpected type %T", parents[len(parents)-2]))
}
r.IssueID = i.ID
r.CommentID = l.ID
default:
panic(fmt.Errorf("unexpected type %T", parents[len(parents)-1]))
}
ctx, committer, err := db.TxContext(ctx)
if err != nil {
panic(err)
}
defer committer.Close()
if _, err := db.GetEngine(ctx).Insert(r); err != nil {
panic(err)
}
if err := committer.Commit(); err != nil {
panic(err)
}
return ReactionConverter(r)
}
func (o *ReactionProvider) Delete(ctx context.Context, user *User, project *Project, parents []common.ContainerObjectInterface, reaction *Reaction) *Reaction {
r := o.Get(ctx, user, project, parents, reaction)
if !r.IsNil() {
if _, err := db.GetEngine(ctx).Delete(&reaction.Reaction); err != nil {
panic(err)
}
return reaction
}
return r
}