[public api] personal access token db model

Author: Laurie T. Malau

components/common-go/db/personal_access_token.go

@@ -0,0 +1,75 @@
+// Copyright (c) 2022 Gitpod GmbH. All rights reserved.
+// Licensed under the GNU Affero General Public License (AGPL).
+// See License-AGPL.txt in the project root for license information.
+
+package common_db
+
+import (
+	"context"
+	"fmt"
+	"time"
+
+	"github.com/google/uuid"
+	"google.golang.org/grpc/codes"
+	"google.golang.org/grpc/status"
+	"gorm.io/gorm"
+)
+
+type PersonalAccessToken struct {
+	ID             uuid.UUID `gorm:"primary_key;column:id;type:varchar;size:255;" json:"id"`
+	UserID         uuid.UUID `gorm:"column:userId;type:varchar;size:255;" json:"userId"`
+	Hash           string    `gorm:"column:hash;type:varchar;size:255;" json:"hash"`
+	Name           string    `gorm:"column:name;type:varchar;size:255;" json:"name"`
+	Description    string    `gorm:"column:description;type:varchar;size:255;" json:"description"`
+	Scopes         []string  `gorm:"column:scopes;type:text;size:65535;" json:"scopes"`
+	ExpirationTime time.Time `gorm:"column:expirationTime;type:timestamp;" json:"expirationTime"`
+	CreatedAt      time.Time `gorm:"column:createdAt;type:timestamp;default:CURRENT_TIMESTAMP(6);" json:"createdAt"`
+	LastModified   time.Time `gorm:"column:_lastModified;type:timestamp;default:CURRENT_TIMESTAMP(6);" json:"_lastModified"`
+
+	// deleted is reserved for use by db-sync.
+	_ bool `gorm:"column:deleted;type:tinyint;default:0;" json:"deleted"`
+}
+
+// TableName sets the insert table name for this struct type
+func (d *PersonalAccessToken) TableName() string {
+	return "d_b_personal_access_token"
+}
+
+func GetToken(ctx context.Context, conn *gorm.DB, id string) (PersonalAccessToken, error) {
+	var token PersonalAccessToken
+
+	db := conn.WithContext(ctx)
+
+	db = db.Where("id = ?", id).Find(&token)
+	if db.Error != nil {
+		return PersonalAccessToken{}, fmt.Errorf("Failed to retrieve token: %w", db.Error)
+	}
+
+	return token, nil
+}
+
+func CreateToken(ctx context.Context, conn *gorm.DB, req PersonalAccessToken) (PersonalAccessToken, error) {
+	var token PersonalAccessToken
+
+	if req.UserID == uuid.Nil {
+		return PersonalAccessToken{}, status.Error(codes.InvalidArgument, "Invalid or empty userID")
+	}
+	if req.Hash == "" {
+		return PersonalAccessToken{}, status.Error(codes.InvalidArgument, "Token hash required")
+	}
+	if req.Name == "" {
+		return PersonalAccessToken{}, status.Error(codes.InvalidArgument, "Token name required")
+	}
+	if req.ExpirationTime.IsZero() {
+		return PersonalAccessToken{}, status.Error(codes.InvalidArgument, "Expiration time required")
+	}
+
+	req.CreatedAt = time.Now().UTC()
+
+	db := conn.WithContext(ctx).Create(req)
+	if db.Error != nil {
+		return PersonalAccessToken{}, fmt.Errorf("Failed to create token for user %s", req.UserID)
+	}
+
+	return token, nil
+}

components/common-go/go.mod

@@ -36,6 +36,7 @@ require (
 
 require (
 	github.com/go-sql-driver/mysql v1.6.0
+	github.com/google/uuid v1.1.2
 	github.com/relvacode/iso8601 v1.1.0
 	gorm.io/driver/mysql v1.4.4
 	gorm.io/gorm v1.24.1