enterprise-portal: init database schema and handler store by unknwon · Pull Request #63139 · sourcegraph/sourcegraph-public-snapshot

unknwon · 2024-06-06T21:02:01Z

This PR scaffolds the database schema and code structure based on CORE-99 comment with some modifications. See inline comments for more elaborations.

It uses GORM's ONLY for auto migration, just to kick things off, we may migrate to file-based migration like we are planning for SAMS.
It then uses the *pgxpool.Pool as the DB interface for executing business logic queries.

Additionally, refactored subscriptionsservice/v1.go to use a Store that provide single interface for accessing data(base), as we have been doing in SAMS and SSC.

Test plan

Enterprise Portal starts locally, and database is initialized:

unknwon · 2024-06-06T21:20:04Z

"customdsn" would never work, this PR is the first user of PGDSN(?) 😂

I think this is a regression from recent PR to use pool, I've definitely used PGDSN for msp-testbed before

unknwon · 2024-06-06T21:26:37Z

Copied from https://github.com/sourcegraph/sourcegraph-accounts/blob/main/backend/internal/redislock/mutex.go

unknwon · 2024-06-06T21:26:57Z

Copied from https://github.com/sourcegraph/sourcegraph-accounts/blob/main/backend/internal/redislock/mutex_test.go and adjusted test setup accordingly.

unknwon · 2024-06-06T21:29:36Z

+// Subscription is a product subscription record.
+type Subscription struct {
+	// ID is the prefixed UUID-format identifier for the subscription.
+	ID string `gorm:"primaryKey"`
+	// InstanceDomain is the instance domain associated with the subscription, e.g.
+	// "acme.sourcegraphcloud.com".
+	InstanceDomain string `gorm:"index"`
+}


EP is still not the source of truth for subscriptions yet, so I think start small makes sense for things we actually need. Later PR(s) we will combine data in the handler layer, until EP becomes the source of truth.

We will add full-blown columns during when we move source-of-truth from dotcom to EP.

bobheadxi · 2024-06-06T21:48:55Z

+// NewStoreV1 returns a new StoreV1 using the given client and database handles.
+func NewStoreV1(opts NewStoreV1Options) StoreV1 {
+	return &storeV1{
+		db:       opts.DB,
+		dotcomDB: opts.DotcomDB,
+	}
+}
+
+func (s *storeV1) ListEnterpriseSubscriptionLicenses(ctx context.Context, filters []*subscriptionsv1.ListEnterpriseSubscriptionLicensesFilter, limit int) ([]*dotcomdb.LicenseAttributes, error) {
+	return s.dotcomDB.ListEnterpriseSubscriptionLicenses(ctx, filters, limit)
+}


nice, thanks 😁

bobheadxi · 2024-06-06T22:16:46Z

+// shouldSkipMigration returns true if the migration should be skipped.
+func shouldSkipMigration(previousVersion, currentVersion string) bool {
+	// Skip for PR-builds.
+	if strings.HasPrefix(currentVersion, "_candidate") {
+		return true
+	}
+
+	const releaseBuildVersionExample = "277307_2024-06-06_5.4-9185da3c3e42"
+	// We always run the full auto-migration if the version is not release-build like.
+	if len(currentVersion) < len(releaseBuildVersionExample) ||
+		len(previousVersion) < len(releaseBuildVersionExample) {
+		return false
+	}
+
+	// The release build version is sorted lexicographically, so we can compare it as a string.
+	return previousVersion >= currentVersion
+}


scary given the naming conventions are outside our control 😆 but hopefully is okay

Haha we will see!

bobheadxi

Nice 💪

cla-bot Bot added the cla-signed label Jun 6, 2024

unknwon force-pushed the jc/00-ep-database branch 2 times, most recently from d1f30f5 to da9dae2 Compare June 6, 2024 21:12

unknwon commented Jun 6, 2024

View reviewed changes

enterprise-portal: init database schema and handler store

ee31f85

unknwon force-pushed the jc/00-ep-database branch from da9dae2 to ee31f85 Compare June 6, 2024 21:23

unknwon commented Jun 6, 2024

View reviewed changes

Comment thread cmd/enterprise-portal/internal/database/subscriptions.go Outdated

unknwon marked this pull request as ready for review June 6, 2024 21:35

unknwon requested a review from a team June 6, 2024 21:35