refactor(database): move repo logic into separate package

[jbrockopp]

Based off of #574 and #663

This change continues the refactor efforts initially introduced in the above PRs.

This adds a new repo package to the github.com/go-vela/server/database package.

This contains a RepoService interface declaring all functions necessary for repo based interactions with the database:

server/database/repo/service.go

Lines 11 to 51 in b296e48

	// RepoService represents the Vela interface for repo
	// functions with the supported Database backends.
	//
	//nolint:revive // ignore name stutter
	type RepoService interface {
	// Repo Data Definition Language Functions
	//
	// https://en.wikipedia.org/wiki/Data_definition_language
	// CreateRepoIndexes defines a function that creates the indexes for the repos table.
	CreateRepoIndexes() error
	// CreateRepoTable defines a function that creates the repos table.
	CreateRepoTable(string) error
	// Repo Data Manipulation Language Functions
	//
	// https://en.wikipedia.org/wiki/Data_manipulation_language
	// CountRepos defines a function that gets the count of all repos.
	CountRepos() (int64, error)
	// CountReposForOrg defines a function that gets the count of repos by org name.
	CountReposForOrg(string, map[string]interface{}) (int64, error)
	// CountReposForUser defines a function that gets the count of repos by user ID.
	CountReposForUser(*library.User, map[string]interface{}) (int64, error)
	// CreateRepo defines a function that creates a new repo.
	CreateRepo(*library.Repo) error
	// DeleteRepo defines a function that deletes an existing repo.
	DeleteRepo(*library.Repo) error
	// GetRepo defines a function that gets a repo by ID.
	GetRepo(int64) (*library.Repo, error)
	// GetRepoForOrg defines a function that gets a repo by org and repo name.
	GetRepoForOrg(string, string) (*library.Repo, error)
	// ListRepos defines a function that gets a list of all repos.
	ListRepos() ([]*library.Repo, error)
	// ListReposForOrg defines a function that gets a list of repos by org name.
	ListReposForOrg(string, string, map[string]interface{}, int, int) ([]*library.Repo, int64, error)
	// ListReposForUser defines a function that gets a list of repos by user ID.
	ListReposForUser(*library.User, string, map[string]interface{}, int, int) ([]*library.Repo, int64, error)
	// UpdateRepo defines a function that updates an existing repo.
	UpdateRepo(*library.Repo) error
	}

This package also contains the engine which implements the above service interface:

server/database/repo/repo.go

Lines 25 to 39 in b296e48

	// engine represents the repo functionality that implements the RepoService interface.
	engine struct {
	// engine configuration settings used in repo functions
	config *config
	// gorm.io/gorm database client used in repo functions
	//
	// https://pkg.go.dev/gorm.io/gorm#DB
	client *gorm.DB
	// sirupsen/logrus logger used in repo functions
	//
	// https://pkg.go.dev/github.com/sirupsen/logrus#Entry
	logger *logrus.Entry
	}

This engine contains no raw SQL queries for integrating with the repos table.

Instead, we leverage our DB library's (https://gorm.io/) agnostic abstraction for integrating with that table.

[codecov]

Codecov Report

Merging #687 (b0b3f00) into main (49e720d) will decrease coverage by 0.00%.
The diff coverage is 79.55%.

@@            Coverage Diff             @@
##             main     #687      +/-   ##
==========================================
- Coverage   55.09%   55.09%   -0.01%     
==========================================
  Files         201      210       +9     
  Lines       15959    15912      -47     
==========================================
- Hits         8793     8767      -26     
+ Misses       6788     6768      -20     
+ Partials      378      377       -1     

Impacted Files	Coverage Δ
api/metrics.go	0.00% <0.00%> (ø)
api/repo.go	0.00% <0.00%> (ø)
api/scm.go	0.00% <0.00%> (ø)
api/user.go	0.00% <0.00%> (ø)
api/webhook.go	0.00% <0.00%> (ø)
database/repo/repo.go	51.72% <51.72%> (ø)
database/sqlite/sqlite.go	62.18% <66.66%> (+1.42%)	⬆️
database/postgres/postgres.go	62.04% <72.72%> (+1.71%)	⬆️
database/repo/create.go	76.92% <76.92%> (ø)
database/repo/update.go	76.92% <76.92%> (ø)
... and 18 more

[wass3r]

i see you replaced .Scan() with .Take() in a few places. based on GORM docs (https://gorm.io/docs/query.html#Retrieving-a-single-object), it looks like Take already does LIMIT 1? Can we remove the preceding .Limit(1) in those instances? clearly it passed unit testing so it must account for it somehow?

[jbrockopp]

@wass3r good catch! 👍

To provide some context in case anyone is curious, this is the reason why we're using Take():

https://gorm.io/docs/v2_release_note.html#ErrRecordNotFound

In short, for several of our DB queries, we expect an error if the record doesn't exist.

However, gorm.io changed their behavior from V1 -> V2 regarding when that error message is returned:

go-gorm/gorm#4416

In order to account for this today, we have extra code across our DB package that does this:

server/database/postgres/repo.go

Lines 37 to 40 in 2f14f38

	// check if the query returned a record not found error or no rows were returned
	if errors.Is(result.Error, gorm.ErrRecordNotFound) || result.RowsAffected == 0 {
	return nil, gorm.ErrRecordNotFound
	}

Links for reference:

• fix(postgres): add workaround for gorm record not found #409
• fix(sqlite): add workaround for gorm record not found #410

[ecrupper]

LGTM