[db] Move db models to gitpod-db/go module

Author: Laurie T. Malau

components/common-go/go.mod

@@ -34,13 +34,6 @@ require (
 k8s.io/apimachinery v0.24.4
 )
 
-require (
-github.com/go-sql-driver/mysql v1.6.0
-github.com/relvacode/iso8601 v1.1.0
-gorm.io/driver/mysql v1.4.4
-gorm.io/gorm v1.24.1
-)
-
 require (
 github.com/beorn7/perks v1.0.1 // indirect
 github.com/blang/semver v3.5.1+incompatible // indirect
@@ -54,8 +47,6 @@ require (
 github.com/gogo/protobuf v1.3.2 // indirect
 github.com/golang/protobuf v1.5.2 // indirect
 github.com/google/gofuzz v1.1.0 // indirect
-github.com/jinzhu/inflection v1.0.0 // indirect
-github.com/jinzhu/now v1.1.5 // indirect
 github.com/json-iterator/go v1.1.12 // indirect
 github.com/matttproud/golang_protobuf_extensions v1.0.1 // indirect
 github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect

components/common-go/go.sum

@@ -6,6 +6,17 @@ packages:
  - name: lib
  type: go
  srcs:
- - "**"
+ - "**/*.go"
+ - "go.mod"
+ - "go.sum"
+ deps:
+ - :init-testdb
+ - components/common-go:lib
  config:
  packaging: library
+
+ - name: init-testdb
+ type: generic
+ deps:
+ - components/gitpod-db:dbtest-init
+ ephemeral: true

components/gitpod-db/go/BUILD.yaml

@@ -2,7 +2,7 @@
 // Licensed under the GNU Affero General Public License (AGPL).
 // See License-AGPL.txt in the project root for license information.
 
-package common_db
+package db
 
 import (
 "fmt"

components/common-go/db/conn.go components/gitpod-db/go/conn.gocomponents/common-go/db/conn.go renamed to components/gitpod-db/go/conn.go

@@ -10,7 +10,6 @@ import (
 "fmt"
 "time"
 
-common_db "github.com/gitpod-io/gitpod/common-go/db"
 "github.com/gitpod-io/gitpod/common-go/log"
 "github.com/google/uuid"
 "google.golang.org/grpc/codes"
@@ -28,13 +27,13 @@ const (
 )
 
 type CostCenter struct {
-ID AttributionID  `gorm:"primary_key;column:id;type:char;size:36;" json:"id"`
-CreationTime common_db.VarcharTime `gorm:"primary_key;column:creationTime;type:varchar;size:255;" json:"creationTime"`
-SpendingLimit int32  `gorm:"column:spendingLimit;type:int;default:0;" json:"spendingLimit"`
-BillingStrategy BillingStrategy  `gorm:"column:billingStrategy;type:varchar;size:255;" json:"billingStrategy"`
-BillingCycleStart common_db.VarcharTime `gorm:"column:billingCycleStart;type:varchar;size:255;" json:"billingCycleStart"`
-NextBillingTime common_db.VarcharTime `gorm:"column:nextBillingTime;type:varchar;size:255;" json:"nextBillingTime"`
-LastModified time.Time  `gorm:"->;column:_lastModified;type:timestamp;default:CURRENT_TIMESTAMP(6);" json:"_lastModified"`
+ID AttributionID `gorm:"primary_key;column:id;type:char;size:36;" json:"id"`
+CreationTime VarcharTime  `gorm:"primary_key;column:creationTime;type:varchar;size:255;" json:"creationTime"`
+SpendingLimit int32 `gorm:"column:spendingLimit;type:int;default:0;" json:"spendingLimit"`
+BillingStrategy BillingStrategy `gorm:"column:billingStrategy;type:varchar;size:255;" json:"billingStrategy"`
+BillingCycleStart VarcharTime  `gorm:"column:billingCycleStart;type:varchar;size:255;" json:"billingCycleStart"`
+NextBillingTime VarcharTime  `gorm:"column:nextBillingTime;type:varchar;size:255;" json:"nextBillingTime"`
+LastModified time.Time `gorm:"->;column:_lastModified;type:timestamp;default:CURRENT_TIMESTAMP(6);" json:"_lastModified"`
 }
 
 // TableName sets the insert table name for this struct type
@@ -84,11 +83,11 @@ func (c *CostCenterManager) GetOrCreateCostCenter(ctx context.Context, attributi
 }
 result = CostCenter{
 ID: attributionID,
-CreationTime: common_db.NewVarCharTime(now),
+CreationTime: NewVarCharTime(now),
 BillingStrategy: CostCenter_Other,
 SpendingLimit: defaultSpendingLimit,
-BillingCycleStart: common_db.NewVarCharTime(now),
-NextBillingTime: common_db.NewVarCharTime(now.AddDate(0, 1, 0)),
+BillingCycleStart: NewVarCharTime(now),
+NextBillingTime: NewVarCharTime(now.AddDate(0, 1, 0)),
 }
 err := c.conn.Save(&result).Error
 if err != nil {
@@ -147,7 +146,7 @@ func (c *CostCenterManager) UpdateCostCenter(ctx context.Context, newCC CostCent
 now := time.Now()
 
 // we always update the creationTime
-newCC.CreationTime = common_db.NewVarCharTime(now)
+newCC.CreationTime = NewVarCharTime(now)
 // we don't allow setting billingCycleStart or nextBillingTime from outside
 newCC.BillingCycleStart = existingCC.BillingCycleStart
 newCC.NextBillingTime = existingCC.NextBillingTime
@@ -173,9 +172,9 @@ func (c *CostCenterManager) UpdateCostCenter(ctx context.Context, newCC CostCent
 // Downgrading from stripe
 if existingCC.BillingStrategy == CostCenter_Stripe && newCC.BillingStrategy == CostCenter_Other {
 newCC.SpendingLimit = c.cfg.ForUsers
-newCC.BillingCycleStart = common_db.NewVarCharTime(now)
+newCC.BillingCycleStart = NewVarCharTime(now)
 // see you next month
-newCC.NextBillingTime = common_db.NewVarCharTime(now.AddDate(0, 1, 0))
+newCC.NextBillingTime = NewVarCharTime(now.AddDate(0, 1, 0))
 }
 
 // Upgrading to Stripe
@@ -185,9 +184,9 @@ func (c *CostCenterManager) UpdateCostCenter(ctx context.Context, newCC CostCent
 return CostCenter{}, err
 }
 
-newCC.BillingCycleStart = common_db.NewVarCharTime(now)
+newCC.BillingCycleStart = NewVarCharTime(now)
 // set an informative nextBillingTime, even though we don't manage Stripe billing cycle
-newCC.NextBillingTime = common_db.NewVarCharTime(now.AddDate(0, 1, 0))
+newCC.NextBillingTime = NewVarCharTime(now.AddDate(0, 1, 0))
 }
 } else if isTeam {
 // Billing strategy is Other, and it remains unchanged
@@ -201,9 +200,9 @@ func (c *CostCenterManager) UpdateCostCenter(ctx context.Context, newCC CostCent
 // Downgrading from stripe
 if existingCC.BillingStrategy == CostCenter_Stripe && newCC.BillingStrategy == CostCenter_Other {
 newCC.SpendingLimit = c.cfg.ForTeams
-newCC.BillingCycleStart = common_db.NewVarCharTime(now)
+newCC.BillingCycleStart = NewVarCharTime(now)
 // see you next month
-newCC.NextBillingTime = common_db.NewVarCharTime(now.AddDate(0, 1, 0))
+newCC.NextBillingTime = NewVarCharTime(now.AddDate(0, 1, 0))
 }
 
 // Upgrading to Stripe
@@ -213,9 +212,9 @@ func (c *CostCenterManager) UpdateCostCenter(ctx context.Context, newCC CostCent
 return CostCenter{}, err
 }
 
-newCC.BillingCycleStart = common_db.NewVarCharTime(now)
+newCC.BillingCycleStart = NewVarCharTime(now)
 // set an informative nextBillingTime, even though we don't manage Stripe billing cycle
-newCC.NextBillingTime = common_db.NewVarCharTime(now.AddDate(0, 1, 0))
+newCC.NextBillingTime = NewVarCharTime(now.AddDate(0, 1, 0))
 }
 } else {
 return CostCenter{}, status.Errorf(codes.InvalidArgument, "Unknown attribution entity %s", string(attributionID))
@@ -260,7 +259,7 @@ func (c *CostCenterManager) NewInvoiceUsageRecord(ctx context.Context, attributi
 AttributionID: attributionID,
 Description: "Credits",
 CreditCents: creditCents * -1,
-EffectiveTime: common_db.NewVarCharTime(now),
+EffectiveTime: NewVarCharTime(now),
 Kind: InvoiceUsageKind,
 Draft: false,
 }, nil
@@ -272,18 +271,16 @@ func (c *CostCenterManager) ListLatestCostCentersWithBillingTimeBefore(ctx conte
 var results []CostCenter
 var batch []CostCenter
 
-subquery := db.
-Table((&CostCenter{}).TableName()).
+subquery := db.Table((&CostCenter{}).TableName()).
 // Retrieve the latest CostCenter for a given (attribution) ID.
 Select("DISTINCT id, MAX(creationTime) AS creationTime").
 Group("id")
-tx := db.
-Table(fmt.Sprintf("%s as cc", (&CostCenter{}).TableName())).
+tx := db.Table(fmt.Sprintf("%s as cc", (&CostCenter{}).TableName())).
 // Join on our set of latest CostCenter records
 Joins("INNER JOIN (?) AS expiredCC on cc.id = expiredCC.id AND cc.creationTime = expiredCC.creationTime", subquery).
 Where("cc.billingStrategy = ?", strategy).
 Where("nextBillingTime != ?", "").
-Where("nextBillingTime < ?", common_db.TimeToISO8601(billingTimeBefore)).
+Where("nextBillingTime < ?", TimeToISO8601(billingTimeBefore)).
 FindInBatches(&batch, 1000, func(tx *gorm.DB, iteration int) error {
 results = append(results, batch...)
 return nil
@@ -336,9 +333,9 @@ func (c *CostCenterManager) ResetUsage(ctx context.Context, cc CostCenter) (Cost
 ID: cc.ID,
 SpendingLimit: spendingLimit,
 BillingStrategy: cc.BillingStrategy,
-BillingCycleStart: common_db.NewVarCharTime(now),
-NextBillingTime: common_db.NewVarCharTime(nextBillingTime),
-CreationTime: common_db.NewVarCharTime(now),
+BillingCycleStart: NewVarCharTime(now),
+NextBillingTime: NewVarCharTime(nextBillingTime),
+CreationTime: NewVarCharTime(now),
 }
 err = c.conn.Save(&newCostCenter).Error
 if err != nil {

components/usage/pkg/db/cost_center.go components/gitpod-db/go/cost_center.gocomponents/usage/pkg/db/cost_center.go renamed to components/gitpod-db/go/cost_center.go

@@ -9,9 +9,9 @@ import (
 "testing"
 "time"
 
-common_db "github.com/gitpod-io/gitpod/common-go/db"
-"github.com/gitpod-io/gitpod/usage/pkg/db"
-"github.com/gitpod-io/gitpod/usage/pkg/db/dbtest"
+db "github.com/gitpod-io/gitpod/components/gitpod-db/go"
+
+"github.com/gitpod-io/gitpod/components/gitpod-db/go/dbtest"
 "github.com/google/uuid"
 "github.com/stretchr/testify/require"
 "google.golang.org/grpc/codes"
@@ -73,28 +73,28 @@ func TestCostCenterManager_GetOrCreateCostCenter_ResetsExpired(t *testing.T) {
 
 expiredCC := db.CostCenter{
 ID: db.NewTeamAttributionID(uuid.New().String()),
-CreationTime: common_db.NewVarCharTime(now),
+CreationTime: db.NewVarCharTime(now),
 SpendingLimit: 0,
 BillingStrategy: db.CostCenter_Other,
-NextBillingTime: common_db.NewVarCharTime(expired),
-BillingCycleStart: common_db.NewVarCharTime(now),
+NextBillingTime: db.NewVarCharTime(expired),
+BillingCycleStart: db.NewVarCharTime(now),
 }
 unexpiredCC := db.CostCenter{
 ID: db.NewUserAttributionID(uuid.New().String()),
-CreationTime: common_db.NewVarCharTime(now),
+CreationTime: db.NewVarCharTime(now),
 SpendingLimit: 500,
 BillingStrategy: db.CostCenter_Other,
-NextBillingTime: common_db.NewVarCharTime(unexpired),
-BillingCycleStart: common_db.NewVarCharTime(now),
+NextBillingTime: db.NewVarCharTime(unexpired),
+BillingCycleStart: db.NewVarCharTime(now),
 }
 // Stripe billing strategy should not be reset
 stripeCC := db.CostCenter{
 ID: db.NewUserAttributionID(uuid.New().String()),
-CreationTime: common_db.NewVarCharTime(now),
+CreationTime: db.NewVarCharTime(now),
 SpendingLimit: 0,
 BillingStrategy: db.CostCenter_Stripe,
-NextBillingTime: common_db.VarcharTime{},
-BillingCycleStart: common_db.NewVarCharTime(now),
+NextBillingTime: db.VarcharTime{},
+BillingCycleStart: db.NewVarCharTime(now),
 }
 
 dbtest.CreateCostCenters(t, conn,
@@ -103,21 +103,21 @@ func TestCostCenterManager_GetOrCreateCostCenter_ResetsExpired(t *testing.T) {
 dbtest.NewCostCenter(t, stripeCC),
 )
 
-// expired CostCenter should be reset, so we get a new CreationTime
+// expired db.CostCenter should be reset, so we get a new CreationTime
 retrievedExpiredCC, err := mnr.GetOrCreateCostCenter(context.Background(), expiredCC.ID)
 require.NoError(t, err)
 t.Cleanup(func() {
 conn.Model(&db.CostCenter{}).Delete(retrievedExpiredCC.ID)
 })
-require.Equal(t, common_db.NewVarCharTime(expired).Time().AddDate(0, 1, 0), retrievedExpiredCC.NextBillingTime.Time())
+require.Equal(t, db.NewVarCharTime(expired).Time().AddDate(0, 1, 0), retrievedExpiredCC.NextBillingTime.Time())
 require.Equal(t, expiredCC.ID, retrievedExpiredCC.ID)
 require.Equal(t, expiredCC.BillingStrategy, retrievedExpiredCC.BillingStrategy)
 require.WithinDuration(t, now, expiredCC.CreationTime.Time(), 3*time.Second, "new cost center creation time must be within 3 seconds of now")
 
 // unexpired cost center must not be reset
 retrievedUnexpiredCC, err := mnr.GetOrCreateCostCenter(context.Background(), unexpiredCC.ID)
 require.NoError(t, err)
-require.Equal(t, common_db.NewVarCharTime(unexpired).Time(), retrievedUnexpiredCC.NextBillingTime.Time())
+require.Equal(t, db.NewVarCharTime(unexpired).Time(), retrievedUnexpiredCC.NextBillingTime.Time())
 require.Equal(t, unexpiredCC.ID, retrievedUnexpiredCC.ID)
 require.Equal(t, unexpiredCC.BillingStrategy, retrievedUnexpiredCC.BillingStrategy)
 require.WithinDuration(t, unexpiredCC.CreationTime.Time(), retrievedUnexpiredCC.CreationTime.Time(), 100*time.Millisecond)
@@ -349,16 +349,16 @@ func TestCostCenter_ListLatestCostCentersWithBillingTimeBefore(t *testing.T) {
 dbtest.NewCostCenter(t, db.CostCenter{
 ID: db.NewTeamAttributionID(attributionID),
 SpendingLimit: 100,
-CreationTime: common_db.NewVarCharTime(firstCreation),
+CreationTime: db.NewVarCharTime(firstCreation),
 BillingStrategy: db.CostCenter_Other,
-NextBillingTime: common_db.NewVarCharTime(firstCreation),
+NextBillingTime: db.NewVarCharTime(firstCreation),
 }),
 dbtest.NewCostCenter(t, db.CostCenter{
 ID: db.NewTeamAttributionID(attributionID),
 SpendingLimit: 100,
-CreationTime: common_db.NewVarCharTime(secondCreation),
+CreationTime: db.NewVarCharTime(secondCreation),
 BillingStrategy: db.CostCenter_Other,
-NextBillingTime: common_db.NewVarCharTime(secondCreation),
+NextBillingTime: db.NewVarCharTime(secondCreation),
 }),
 }
 
@@ -386,14 +386,14 @@ func TestCostCenter_ListLatestCostCentersWithBillingTimeBefore(t *testing.T) {
 dbtest.NewCostCenter(t, db.CostCenter{
 ID: db.NewTeamAttributionID(attributionID),
 SpendingLimit: 100,
-CreationTime: common_db.NewVarCharTime(firstCreation),
+CreationTime: db.NewVarCharTime(firstCreation),
 BillingStrategy: db.CostCenter_Other,
-NextBillingTime: common_db.NewVarCharTime(firstCreation),
+NextBillingTime: db.NewVarCharTime(firstCreation),
 }),
 dbtest.NewCostCenter(t, db.CostCenter{
 ID: db.NewTeamAttributionID(attributionID),
 SpendingLimit: 100,
-CreationTime: common_db.NewVarCharTime(secondCreation),
+CreationTime: db.NewVarCharTime(secondCreation),
 BillingStrategy: db.CostCenter_Stripe,
 }),
 }
@@ -418,7 +418,7 @@ func TestCostCenterManager_ResetUsage(t *testing.T) {
 })
 _, err := mnr.ResetUsage(context.Background(), db.CostCenter{
 ID: db.NewUserAttributionID(uuid.New().String()),
-CreationTime: common_db.NewVarCharTime(time.Now()),
+CreationTime: db.NewVarCharTime(time.Now()),
 SpendingLimit: 500,
 BillingStrategy: db.CostCenter_Stripe,
 })
@@ -433,10 +433,10 @@ func TestCostCenterManager_ResetUsage(t *testing.T) {
 })
 oldCC := db.CostCenter{
 ID: db.NewTeamAttributionID(uuid.New().String()),
-CreationTime: common_db.NewVarCharTime(time.Now()),
+CreationTime: db.NewVarCharTime(time.Now()),
 SpendingLimit: 0,
 BillingStrategy: db.CostCenter_Other,
-NextBillingTime: common_db.NewVarCharTime(ts),
+NextBillingTime: db.NewVarCharTime(ts),
 }
 newCC, err := mnr.ResetUsage(context.Background(), oldCC)
 require.NoError(t, err)