satellite/satellitedb: add version column to api_keys table

This change adds a column that holds API key versions. This will allow us to implement version-specific functionality (such as Object Lock features) for API keys. storj/edge#399 Change-Id: I5297d145db2b9c9c51a387610bcb539086c95b3e
storj · Mar 22, 2024 · 58e3191 · 58e3191
1 parent cca4f20
commit 58e3191
Show file tree

Hide file tree

Showing 11 changed files with 1,385 additions and 490 deletions.
diff --git a/satellite/console/apikeys.go b/satellite/console/apikeys.go
@@ -62,6 +62,7 @@ type APIKeyInfo struct {
 	Head            []byte    `json:"-"`
 	Secret          []byte    `json:"-"`
 	CreatedAt       time.Time `json:"createdAt"`
+	Version         uint      `json:"version"`
 
 	// TODO move this closer to metainfo
 	ProjectRateLimit  *int `json:"-"`

diff --git a/satellite/console/consoleweb/consoleapi/apidocs.gen.md b/satellite/console/consoleweb/consoleapi/apidocs.gen.md
@@ -268,6 +268,7 @@ Gets API keys by project ID
 			userAgent: 			string
 			name: string
 			createdAt: string // Date timestamp formatted as `2006-01-02T15:00:00Z`
+			version: number
 		}
 
 	]

diff --git a/satellite/satellitedb/apikeys.go b/satellite/satellitedb/apikeys.go
@@ -74,7 +74,7 @@ func (keys *apikeys) GetPagedByProjectID(ctx context.Context, projectID uuid.UUI
 	}
 
 	repoundQuery := keys.db.Rebind(`
-		SELECT ak.id, ak.project_id, ak.name, ak.user_agent, ak.created_at, p.public_id
+		SELECT ak.id, ak.project_id, ak.name, ak.user_agent, ak.created_at, ak.version, p.public_id
 		FROM api_keys ak, projects p
 		WHERE ak.project_id = ?
 		AND ak.project_id = p.id
@@ -98,7 +98,7 @@ func (keys *apikeys) GetPagedByProjectID(ctx context.Context, projectID uuid.UUI
 	for rows.Next() {
 		ak := console.APIKeyInfo{}
 
-		err = rows.Scan(&ak.ID, &ak.ProjectID, &ak.Name, &ak.UserAgent, &ak.CreatedAt, &ak.ProjectPublicID)
+		err = rows.Scan(&ak.ID, &ak.ProjectID, &ak.Name, &ak.UserAgent, &ak.CreatedAt, &ak.Version, &ak.ProjectPublicID)
 		if err != nil {
 			return nil, err
 		}
@@ -207,7 +207,9 @@ func (keys *apikeys) Create(ctx context.Context, head []byte, info console.APIKe
 		return nil, err
 	}
 
-	optional := dbx.ApiKey_Create_Fields{}
+	optional := dbx.ApiKey_Create_Fields{
+		Version: dbx.ApiKey_Version(info.Version),
+	}
 	if info.UserAgent != nil {
 		optional.UserAgent = dbx.ApiKey_UserAgent(info.UserAgent)
 	}
@@ -279,6 +281,7 @@ func apiKeyToAPIKeyInfo(ctx context.Context, key *dbx.ApiKey) (_ *console.APIKey
 		CreatedAt: key.CreatedAt,
 		Head:      key.Head,
 		Secret:    key.Secret,
+		Version:   key.Version,
 	}
 
 	if key.UserAgent != nil {

diff --git a/satellite/satellitedb/dbx/project.dbx b/satellite/satellitedb/dbx/project.dbx
@@ -234,6 +234,8 @@ model api_key (
     field  created_at  timestamp        (autoinsert)
     // created_by is an UUID of the user who created this key.
     field  created_by  user.id restrict (nullable)
+    // version specifies the version number of the api key.
+    field  version     uint       (default 0)
 )
 
 create api_key ( )

diff --git a/satellite/satellitedb/dbx/satellitedb.dbx.go b/satellite/satellitedb/dbx/satellitedb.dbx.go
diff --git a/satellite/satellitedb/dbx/satellitedb.dbx.pgx.sql b/satellite/satellitedb/dbx/satellitedb.dbx.pgx.sql
@@ -524,6 +524,7 @@ CREATE TABLE api_keys (
 	user_agent bytea,
 	created_at timestamp with time zone NOT NULL,
 	created_by bytea REFERENCES users( id ),
+	version integer NOT NULL DEFAULT 0,
 	PRIMARY KEY ( id ),
 	UNIQUE ( head ),
 	UNIQUE ( name, project_id )

diff --git a/satellite/satellitedb/dbx/satellitedb.dbx.pgxcockroach.sql b/satellite/satellitedb/dbx/satellitedb.dbx.pgxcockroach.sql
@@ -524,6 +524,7 @@ CREATE TABLE api_keys (
 	user_agent bytea,
 	created_at timestamp with time zone NOT NULL,
 	created_by bytea REFERENCES users( id ),
+	version integer NOT NULL DEFAULT 0,
 	PRIMARY KEY ( id ),
 	UNIQUE ( head ),
 	UNIQUE ( name, project_id )

diff --git a/satellite/satellitedb/migrate.go b/satellite/satellitedb/migrate.go
@@ -2678,6 +2678,14 @@ func (db *satelliteDB) ProductionMigration() *migrate.Migration {
 					`ALTER TABLE bucket_metainfos ADD COLUMN created_by bytea REFERENCES users( id ) DEFAULT NULL;`,
 				},
 			},
+			{
+				DB:          &db.migrationDB,
+				Description: "add version column to api_keys table",
+				Version:     265,
+				Action: migrate.SQL{
+					`ALTER TABLE api_keys ADD COLUMN version integer NOT NULL DEFAULT 0;`,
+				},
+			},
 			// NB: after updating testdata in `testdata`, run
 			//     `go generate` to update `migratez.go`.
 		},