added flag for name

coder · Kira-Pilot · Mar 2, 2023 · Feb 23, 2023 · Feb 23, 2023 · Feb 23, 2023
commit ef09103d62a93dd2859a7c0b06cd8041facb5136
diff --git a/cli/tokens.go b/cli/tokens.go
@@ -49,18 +49,22 @@ func tokens() *cobra.Command {
 }
 
 func createToken() *cobra.Command {
-	var tokenLifetime time.Duration
+	var (
+		tokenLifetime time.Duration
+		name          string
+	)
 	cmd := &cobra.Command{
 		Use:   "create",
-		Short: "Create a tokens",
+		Short: "Create a token",
 		RunE: func(cmd *cobra.Command, args []string) error {
 			client, err := CreateClient(cmd)
 			if err != nil {
 				return xerrors.Errorf("create codersdk client: %w", err)
 			}
 
 			res, err := client.CreateToken(cmd.Context(), codersdk.Me, codersdk.CreateTokenRequest{
-				Lifetime: tokenLifetime,
+				Lifetime:  tokenLifetime,
+				TokenName: name,
 			})
 			if err != nil {
 				return xerrors.Errorf("create tokens: %w", err)
@@ -81,6 +85,7 @@ func createToken() *cobra.Command {
 	}
 
 	cliflag.DurationVarP(cmd.Flags(), &tokenLifetime, "lifetime", "", "CODER_TOKEN_LIFETIME", 30*24*time.Hour, "Specify a duration for the lifetime of the token.")
+	cmd.Flags().StringVarP(&name, "name", "n", "", "Specify a human-readable name.")
 
 	return cmd
 }
@@ -92,6 +97,7 @@ type tokenListRow struct {
 
 	// For table format:
 	ID        string    `json:"-" table:"id,default_sort"`
+	TokenName string    `json:"token_name" table:"name"`
 	LastUsed  time.Time `json:"-" table:"last used"`
 	ExpiresAt time.Time `json:"-" table:"expires at"`
 	CreatedAt time.Time `json:"-" table:"created at"`
@@ -102,6 +108,7 @@ func tokenListRowFromToken(token codersdk.ConvertedAPIKey) tokenListRow {
 	return tokenListRow{
 		APIKey:    token.APIKey,
 		ID:        token.ID,
+		TokenName: token.TokenName,
 		LastUsed:  token.LastUsed,
 		ExpiresAt: token.ExpiresAt,
 		CreatedAt: token.CreatedAt,
@@ -111,7 +118,7 @@ func tokenListRowFromToken(token codersdk.ConvertedAPIKey) tokenListRow {
 
 func listTokens() *cobra.Command {
 	// we only display the 'owner' column if the --all argument is passed in
-	defaultCols := []string{"id", "last used", "expires at", "created at"}
+	defaultCols := []string{"id", "name", "last used", "expires at", "created at"}
 	if slices.Contains(os.Args, "-a") || slices.Contains(os.Args, "--all") {
 		defaultCols = append(defaultCols, "owner")
 	}

diff --git a/coderd/apidoc/docs.go b/coderd/apidoc/docs.go
diff --git a/coderd/apidoc/swagger.json b/coderd/apidoc/swagger.json
diff --git a/coderd/apikey.go b/coderd/apikey.go
@@ -9,10 +9,12 @@ import (
 	"net"
 	"net/http"
 	"strconv"
+	"strings"
 	"time"
 
 	"github.com/go-chi/chi/v5"
 	"github.com/google/uuid"
+	"github.com/moby/moby/pkg/namesgenerator"
 	"github.com/tabbed/pqtype"
 	"golang.org/x/xerrors"
 
@@ -62,6 +64,12 @@ func (api *API) postToken(rw http.ResponseWriter, r *http.Request) {
 		lifeTime = createToken.Lifetime
 	}
 
+	tokenName := namesgenerator.GetRandomName(1)
+
+	if len(createToken.TokenName) != 0 {
+		tokenName = createToken.TokenName
+	}
+
 	err := api.validateAPIKeyLifetime(lifeTime)
 	if err != nil {
 		httpapi.Write(ctx, rw, http.StatusBadRequest, codersdk.Response{
@@ -77,8 +85,18 @@ func (api *API) postToken(rw http.ResponseWriter, r *http.Request) {
 		ExpiresAt:       database.Now().Add(lifeTime),
 		Scope:           scope,
 		LifetimeSeconds: int64(lifeTime.Seconds()),
+		TokenName:       tokenName,
 	})
 	if err != nil {
+		if strings.Contains(err.Error(), "duplicate key value violates unique constraint") {
+			httpapi.Write(ctx, rw, http.StatusConflict, codersdk.Response{
+				Message: fmt.Sprintf("A token with name %q already exists.", tokenName),
+				Validations: []codersdk.ValidationError{{
+					Field:  "name",
+					Detail: "This value is already in use and should be unique.",
+				}},
+			})
+		}
 		httpapi.Write(ctx, rw, http.StatusInternalServerError, codersdk.Response{
 			Message: "Failed to create API key.",
 			Detail:  err.Error(),
@@ -295,6 +313,7 @@ type createAPIKeyParams struct {
 	ExpiresAt       time.Time
 	LifetimeSeconds int64
 	Scope           database.APIKeyScope
+	TokenName       string
 }
 
 func (api *API) validateAPIKeyLifetime(lifetime time.Duration) error {
@@ -364,6 +383,7 @@ func (api *API) createAPIKey(ctx context.Context, params createAPIKeyParams) (*h
 		HashedSecret: hashed[:],
 		LoginType:    params.LoginType,
 		Scope:        scope,
+		TokenName:    params.TokenName,
 	})
 	if err != nil {
 		return nil, nil, xerrors.Errorf("insert API key: %w", err)

diff --git a/coderd/database/dump.sql b/coderd/database/dump.sql
diff --git a/coderd/database/migrations/000100_add_apikey_name.down.sql b/coderd/database/migrations/000100_add_apikey_name.down.sql
@@ -0,0 +1,2 @@
+ALTER TABLE ONLY api_keys
+  DROP COLUMN IF EXISTS token_name,
diff --git a/coderd/database/migrations/000100_add_apikey_name.up.sql b/coderd/database/migrations/000100_add_apikey_name.up.sql
@@ -0,0 +1,3 @@
+ALTER TABLE ONLY api_keys
+  ADD COLUMN IF NOT EXISTS token_name text NOT NULL UNIQUE DEFAULT '';
+
diff --git a/coderd/database/models.go b/coderd/database/models.go
diff --git a/coderd/database/queries.sql.go b/coderd/database/queries.sql.go
diff --git a/coderd/database/queries/apikeys.sql b/coderd/database/queries/apikeys.sql
@@ -30,7 +30,8 @@ INSERT INTO
 		created_at,
 		updated_at,
 		login_type,
-		scope
+		scope,
+		token_name
 	)
 VALUES
 	(@id,
@@ -39,7 +40,7 @@ VALUES
 	     WHEN 0 THEN 86400
 		 ELSE @lifetime_seconds::bigint
 	 END
-	 , @hashed_secret, @ip_address, @user_id, @last_used, @expires_at, @created_at, @updated_at, @login_type, @scope) RETURNING *;
+	 , @hashed_secret, @ip_address, @user_id, @last_used, @expires_at, @created_at, @updated_at, @login_type, @scope, @token_name) RETURNING *;
 
 -- name: UpdateAPIKeyByID :exec
 UPDATE

diff --git a/coderd/database/unique_constraint.go b/coderd/database/unique_constraint.go
diff --git a/coderd/users.go b/coderd/users.go
@@ -1231,5 +1231,6 @@ func convertAPIKey(k database.APIKey) codersdk.APIKey {
 		LoginType:       codersdk.LoginType(k.LoginType),
 		Scope:           codersdk.APIKeyScope(k.Scope),
 		LifetimeSeconds: k.LifetimeSeconds,
+		TokenName:       k.TokenName,
 	}
 }
diff --git a/codersdk/apikey.go b/codersdk/apikey.go
@@ -20,6 +20,7 @@ type APIKey struct {
 	UpdatedAt       time.Time   `json:"updated_at" validate:"required" format:"date-time"`
 	LoginType       LoginType   `json:"login_type" validate:"required" enums:"password,github,oidc,token"`
 	Scope           APIKeyScope `json:"scope" validate:"required" enums:"all,application_connect"`
+	TokenName       string      `json:"token_name" validate:"required"`
 	LifetimeSeconds int64       `json:"lifetime_seconds" validate:"required"`
 }
 
@@ -44,8 +45,9 @@ const (
 )
 
 type CreateTokenRequest struct {
-	Lifetime time.Duration `json:"lifetime"`
-	Scope    APIKeyScope   `json:"scope" enums:"all,application_connect"`
+	Lifetime  time.Duration `json:"lifetime"`
+	Scope     APIKeyScope   `json:"scope" enums:"all,application_connect"`
+	TokenName string        `json:"token_name"`
 }
 
 // GenerateAPIKeyResponse contains an API key for a user.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		ALTER TABLE ONLY api_keys
		DROP COLUMN IF EXISTS token_name,
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		ALTER TABLE ONLY api_keys
		ADD COLUMN IF NOT EXISTS token_name text NOT NULL UNIQUE DEFAULT '';