move foreignreference.go & error to models/foreignreference

Author: Loïc Dachary

models/error.go

@@ -1385,46 +1385,3 @@ func (err ErrNotValidReviewRequest) Error() string {
 		err.UserID,
 		err.RepoID)
 }
-
-//
-// ___________                  .__             __________        _____
-// \_   _____/__________   ____ |__| ____   ____\______   \ _____/ ____\___________   ____   ____   ____  ____
-//  |    __)/  _ \_  __ \_/ __ \|  |/ ___\ /    \|       _// __ \   __\/ __ \_  __ \_/ __ \ /    \_/ ___\/ __ \
-//  |     \(  <_> )  | \/\  ___/|  / /_/  >   |  \    |   \  ___/|  | \  ___/|  | \/\  ___/|   |  \  \__\  ___/
-//  \___  / \____/|__|    \___  >__\___  /|___|  /____|_  /\___  >__|  \___  >__|    \___  >___|  /\___  >___  >
-//      \/                    \/  /_____/      \/       \/     \/          \/            \/     \/     \/    \/
-//
-
-// ErrLocalIndexNotExist represents a "LocalIndexNotExist" kind of error.
-type ErrLocalIndexNotExist struct {
-	RepoID       int64
-	ForeignIndex int64
-	Type         string
-}
-
-// ErrLocalIndexNotExist checks if an error is a ErrLocalIndexNotExist.
-func IsErrLocalIndexNotExist(err error) bool {
-	_, ok := err.(ErrLocalIndexNotExist)
-	return ok
-}
-
-func (err ErrLocalIndexNotExist) Error() string {
-	return fmt.Sprintf("repository %d has no LocalIndex for ForeignIndex %d of type %s", err.RepoID, err.ForeignIndex, err.Type)
-}
-
-// ErrForeignIndexNotExist represents a "ForeignIndexNotExist" kind of error.
-type ErrForeignIndexNotExist struct {
-	RepoID     int64
-	LocalIndex int64
-	Type       string
-}
-
-// ErrForeignIndexNotExist checks if an error is a ErrForeignIndexNotExist.
-func IsErrForeignIndexNotExist(err error) bool {
-	_, ok := err.(ErrForeignIndexNotExist)
-	return ok
-}
-
-func (err ErrForeignIndexNotExist) Error() string {
-	return fmt.Sprintf("repository %d has no ForeignIndex for LocalIndex %d of type %s", err.RepoID, err.LocalIndex, err.Type)
-}

models/foreignreference/error.go

@@ -0,0 +1,43 @@
+// Copyright 2022 Gitea. All rights reserved.
+// Use of this source code is governed by a MIT-style
+// license that can be found in the LICENSE file.
+
+package foreignreference
+
+import (
+	"fmt"
+)
+
+// ErrLocalIndexNotExist represents a "LocalIndexNotExist" kind of error.
+type ErrLocalIndexNotExist struct {
+	RepoID       int64
+	ForeignIndex int64
+	Type         string
+}
+
+// ErrLocalIndexNotExist checks if an error is a ErrLocalIndexNotExist.
+func IsErrLocalIndexNotExist(err error) bool {
+	_, ok := err.(ErrLocalIndexNotExist)
+	return ok
+}
+
+func (err ErrLocalIndexNotExist) Error() string {
+	return fmt.Sprintf("repository %d has no LocalIndex for ForeignIndex %d of type %s", err.RepoID, err.ForeignIndex, err.Type)
+}
+
+// ErrForeignIndexNotExist represents a "ForeignIndexNotExist" kind of error.
+type ErrForeignIndexNotExist struct {
+	RepoID     int64
+	LocalIndex int64
+	Type       string
+}
+
+// ErrForeignIndexNotExist checks if an error is a ErrForeignIndexNotExist.
+func IsErrForeignIndexNotExist(err error) bool {
+	_, ok := err.(ErrForeignIndexNotExist)
+	return ok
+}
+
+func (err ErrForeignIndexNotExist) Error() string {
+	return fmt.Sprintf("repository %d has no ForeignIndex for LocalIndex %d of type %s", err.RepoID, err.LocalIndex, err.Type)
+}

models/foreignreference.go renamed to models/foreignreference/foreignreference.go

@@ -2,20 +2,20 @@
 // Use of this source code is governed by a MIT-style
 // license that can be found in the LICENSE file.
 
-package models
+package foreignreference
 
 import (
 	"code.gitea.io/gitea/models/db"
 )
 
-// ForeignType* are valid values for the Type field of ForeignReference
+// Type* are valid values for the Type field of ForeignReference
 const (
-	ForeignTypeIssue         = "issue"
-	ForeignTypePullRequest   = "pull_request"
-	ForeignTypeComment       = "comment"
-	ForeignTypeReview        = "review"
-	ForeignTypeReviewComment = "review_comment"
-	ForeignTypeRelease       = "release"
+	TypeIssue         = "issue"
+	TypePullRequest   = "pull_request"
+	TypeComment       = "comment"
+	TypeReview        = "review"
+	TypeReviewComment = "review_comment"
+	TypeRelease       = "release"
 )
 
 // ForeignReference represents external references

models/issue.go

@@ -15,6 +15,7 @@ import (
 
 	admin_model "code.gitea.io/gitea/models/admin"
 	"code.gitea.io/gitea/models/db"
+	"code.gitea.io/gitea/models/foreignreference"
 	"code.gitea.io/gitea/models/issues"
 	"code.gitea.io/gitea/models/perm"
 	repo_model "code.gitea.io/gitea/models/repo"
@@ -67,12 +68,12 @@ type Issue struct {
 	UpdatedUnix timeutil.TimeStamp `xorm:"INDEX updated"`
 	ClosedUnix  timeutil.TimeStamp `xorm:"INDEX"`
 
-	Attachments      []*repo_model.Attachment `xorm:"-"`
-	Comments         []*Comment               `xorm:"-"`
-	Reactions        ReactionList             `xorm:"-"`
-	TotalTrackedTime int64                    `xorm:"-"`
-	Assignees        []*user_model.User       `xorm:"-"`
-	ForeignReference *ForeignReference        `xorm:"-"`
+	Attachments      []*repo_model.Attachment           `xorm:"-"`
+	Comments         []*Comment                         `xorm:"-"`
+	Reactions        ReactionList                       `xorm:"-"`
+	TotalTrackedTime int64                              `xorm:"-"`
+	Assignees        []*user_model.User                 `xorm:"-"`
+	ForeignReference *foreignreference.ForeignReference `xorm:"-"`
 
 	// IsLocked limits commenting abilities to users on an issue
 	// with write access
@@ -276,16 +277,20 @@ func (issue *Issue) loadForeignReference(ctx context.Context) (err error) {
 	if issue.ForeignReference != nil {
 		return nil
 	}
-	reference := &ForeignReference{
-		LocalIndex: issue.Index,
+	reference := &foreignreference.ForeignReference{
 		RepoID:     issue.RepoID,
-		Type:       ForeignTypeIssue,
+		LocalIndex: issue.Index,
+		Type:       foreignreference.TypeIssue,
 	}
 	has, err := db.GetEngine(ctx).Get(reference)
 	if err != nil {
 		return err
 	} else if !has {
-		return ErrForeignIndexNotExist{issue.RepoID, issue.Index, ForeignTypeIssue}
+		return foreignreference.ErrForeignIndexNotExist{
+			RepoID:     issue.RepoID,
+			LocalIndex: issue.Index,
+			Type:       foreignreference.TypeIssue,
+		}
 	}
 	issue.ForeignReference = reference
 	return nil
@@ -352,7 +357,7 @@ func (issue *Issue) loadAttributes(ctx context.Context) (err error) {
 		}
 	}
 
-	if err = issue.loadForeignReference(ctx); err != nil && !IsErrForeignIndexNotExist(err) {
+	if err = issue.loadForeignReference(ctx); err != nil && !foreignreference.IsErrForeignIndexNotExist(err) {
 		return err
 	}
 
@@ -1136,16 +1141,20 @@ func GetIssueByIndex(repoID, index int64) (*Issue, error) {
 
 // GetIssueByForeignIndex returns raw issue by foreign ID
 func GetIssueByForeignIndex(ctx context.Context, repoID, foreignIndex int64) (*Issue, error) {
-	reference := &ForeignReference{
+	reference := &foreignreference.ForeignReference{
 		RepoID:       repoID,
 		ForeignIndex: strconv.FormatInt(foreignIndex, 10),
-		Type:         ForeignTypeIssue,
+		Type:         foreignreference.TypeIssue,
 	}
 	has, err := db.GetEngine(ctx).Get(reference)
 	if err != nil {
 		return nil, err
 	} else if !has {
-		return nil, ErrLocalIndexNotExist{repoID, foreignIndex, ForeignTypeIssue}
+		return nil, foreignreference.ErrLocalIndexNotExist{
+			RepoID:       repoID,
+			ForeignIndex: foreignIndex,
+			Type:         foreignreference.TypeIssue,
+		}
 	}
 	return GetIssueByIndex(repoID, reference.LocalIndex)
 }

models/issue_test.go

@@ -14,6 +14,7 @@ import (
 	"time"
 
 	"code.gitea.io/gitea/models/db"
+	"code.gitea.io/gitea/models/foreignreference"
 	repo_model "code.gitea.io/gitea/models/repo"
 	"code.gitea.io/gitea/models/unittest"
 	user_model "code.gitea.io/gitea/models/user"
@@ -548,13 +549,13 @@ func TestIssueForeignReference(t *testing.T) {
 
 	var foreignIndex int64 = 12345
 	_, err = GetIssueByForeignIndex(context.Background(), issue.RepoID, foreignIndex)
-	assert.True(t, IsErrLocalIndexNotExist(err))
+	assert.True(t, foreignreference.IsErrLocalIndexNotExist(err))
 
-	_, err = db.GetEngine(db.DefaultContext).Insert(&ForeignReference{
+	_, err = db.GetEngine(db.DefaultContext).Insert(&foreignreference.ForeignReference{
 		LocalIndex:   issue.Index,
 		ForeignIndex: strconv.FormatInt(foreignIndex, 10),
 		RepoID:       issue.RepoID,
-		Type:         ForeignTypeIssue,
+		Type:         foreignreference.TypeIssue,
 	})
 	assert.NoError(t, err)
 

models/migrate_test.go

@@ -8,6 +8,7 @@ import (
 	"strconv"
 	"testing"
 
+	"code.gitea.io/gitea/models/foreignreference"
 	repo_model "code.gitea.io/gitea/models/repo"
 	"code.gitea.io/gitea/models/unittest"
 	user_model "code.gitea.io/gitea/models/user"
@@ -60,10 +61,10 @@ func assertCreateIssues(t *testing.T, isPull bool) {
 		IsClosed:    true,
 		Labels:      []*Label{label},
 		Reactions:   []*Reaction{reaction},
-		ForeignReference: &ForeignReference{
+		ForeignReference: &foreignreference.ForeignReference{
 			ForeignIndex: strconv.FormatInt(foreignIndex, 10),
 			RepoID:       repo.ID,
-			Type:         ForeignTypeIssue,
+			Type:         foreignreference.TypeIssue,
 		},
 	}
 	err := InsertIssues(is)

services/migrations/gitea_uploader.go

@@ -17,6 +17,7 @@ import (
 
 	"code.gitea.io/gitea/models"
 	"code.gitea.io/gitea/models/db"
+	"code.gitea.io/gitea/models/foreignreference"
 	repo_model "code.gitea.io/gitea/models/repo"
 	user_model "code.gitea.io/gitea/models/user"
 	"code.gitea.io/gitea/modules/git"
@@ -374,11 +375,11 @@ func (g *GiteaLocalUploader) CreateIssues(issues ...*base.Issue) error {
 			Labels:      labels,
 			CreatedUnix: timeutil.TimeStamp(issue.Created.Unix()),
 			UpdatedUnix: timeutil.TimeStamp(issue.Updated.Unix()),
-			ForeignReference: &models.ForeignReference{
+			ForeignReference: &foreignreference.ForeignReference{
 				LocalIndex:   issue.GetLocalIndex(),
 				ForeignIndex: strconv.FormatInt(issue.GetForeignIndex(), 10),
 				RepoID:       g.repo.ID,
-				Type:         models.ForeignTypeIssue,
+				Type:         foreignreference.TypeIssue,
 			},
 		}