Skip to content

Normalize API key display formatting #172

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
IlyaasK wants to merge 1 commit into from
Closed

Normalize API key display formatting #172

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
86 changes: 60 additions & 26 deletions cmd/api_keys.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,14 +126,15 @@ func (c APIKeysCmd) List(ctx context.Context, in APIKeysListInput) error {

table := pterm.TableData{{"ID", "Name", "Scope", "Project", "Masked Key", "Expires At", "Created At"}}
for _, key := range keys {
display := newAPIKeyDisplay(key)
table = append(table, []string{
key.ID,
key.Name,
formatAPIKeyScope(key),
formatAPIKeyProject(key),
key.MaskedKey,
formatAPIKeyExpiresAt(key),
util.FormatLocal(key.CreatedAt),
display.ID,
display.Name,
display.Scope,
display.Project,
display.MaskedKey,
display.ExpiresAt,
display.CreatedAt,
})
}
PrintTableNoPad(table, true)
Expand Down Expand Up @@ -201,36 +202,69 @@ func (c APIKeysCmd) Delete(ctx context.Context, in APIKeysDeleteInput) error {
return nil
}

type apiKeyDisplay struct {
ID string
Name string
PlaintextKey string
Scope string
Project string
MaskedKey string
CreatedBy string
ExpiresAt string
CreatedAt string
}

func renderCreatedAPIKey(key *kernel.CreatedAPIKey) {
display := newCreatedAPIKeyDisplay(key)
rows := pterm.TableData{
{"Field", "Value"},
{"ID", key.ID},
{"Name", key.Name},
{"Key", key.Key},
{"Scope", formatAPIKeyScope(key.APIKey)},
{"Project", formatAPIKeyProject(key.APIKey)},
{"Masked Key", key.MaskedKey},
{"Expires At", formatAPIKeyExpiresAt(key.APIKey)},
{"ID", display.ID},
{"Name", display.Name},
{"Key", display.PlaintextKey},
{"Scope", display.Scope},
{"Project", display.Project},
{"Masked Key", display.MaskedKey},
{"Expires At", display.ExpiresAt},
}
PrintTableNoPad(rows, true)
}

func renderAPIKeyDetails(key *kernel.APIKey) {
display := newAPIKeyDisplay(*key)
rows := pterm.TableData{
{"Field", "Value"},
{"ID", key.ID},
{"Name", key.Name},
{"Scope", formatAPIKeyScope(*key)},
{"Project", formatAPIKeyProject(*key)},
{"Masked Key", key.MaskedKey},
{"Created By", formatAPIKeyCreator(*key)},
{"Expires At", formatAPIKeyExpiresAt(*key)},
{"Created At", util.FormatLocal(key.CreatedAt)},
{"ID", display.ID},
{"Name", display.Name},
{"Scope", display.Scope},
{"Project", display.Project},
{"Masked Key", display.MaskedKey},
{"Created By", display.CreatedBy},
{"Expires At", display.ExpiresAt},
{"Created At", display.CreatedAt},
}
PrintTableNoPad(rows, true)
}

func formatAPIKeyProject(key kernel.APIKey) string {
func newCreatedAPIKeyDisplay(key *kernel.CreatedAPIKey) apiKeyDisplay {
display := newAPIKeyDisplay(key.APIKey)
display.PlaintextKey = key.Key
return display
}

func newAPIKeyDisplay(key kernel.APIKey) apiKeyDisplay {
return apiKeyDisplay{
ID: key.ID,
Name: key.Name,
Scope: apiKeyScope(key),
Project: apiKeyProject(key),
MaskedKey: key.MaskedKey,
CreatedBy: apiKeyCreator(key),
ExpiresAt: apiKeyExpiresAt(key),
CreatedAt: util.FormatLocal(key.CreatedAt),
}
}

func apiKeyProject(key kernel.APIKey) string {
if key.JSON.ProjectName.Valid() && key.ProjectName != "" {
return key.ProjectName
}
Expand All @@ -240,14 +274,14 @@ func formatAPIKeyProject(key kernel.APIKey) string {
return "-"
}

func formatAPIKeyScope(key kernel.APIKey) string {
func apiKeyScope(key kernel.APIKey) string {
if key.JSON.ProjectID.Valid() && key.ProjectID != "" {
return "Project"
}
return "Org"
}

func formatAPIKeyCreator(key kernel.APIKey) string {
func apiKeyCreator(key kernel.APIKey) string {
if key.CreatedBy.JSON.Name.Valid() && key.CreatedBy.Name != "" {
return key.CreatedBy.Name
}
Expand All @@ -257,7 +291,7 @@ func formatAPIKeyCreator(key kernel.APIKey) string {
return "-"
}

func formatAPIKeyExpiresAt(key kernel.APIKey) string {
func apiKeyExpiresAt(key kernel.APIKey) string {
if !key.JSON.ExpiresAt.Valid() {
return "Never"
}
Expand Down
27 changes: 27 additions & 0 deletions cmd/api_keys_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import (
"net/http"
"testing"

"github.com/kernel/cli/pkg/util"
"github.com/kernel/kernel-go-sdk"
"github.com/kernel/kernel-go-sdk/option"
"github.com/kernel/kernel-go-sdk/packages/pagination"
Expand Down Expand Up @@ -196,6 +197,32 @@ func TestAPIKeysListPassesPaginationAndRendersRows(t *testing.T) {
assert.Contains(t, out, "Never")
}

func TestAPIKeyDisplayNormalizesSDKFields(t *testing.T) {
key := apiKeyFromJSON(`{"id":"key_123","name":"ci","masked_key":"sk_...123","created_at":"2026-05-27T12:00:00Z","created_by":{"id":"user_123","email":"dev@example.com","name":"Dev"},"expires_at":"2026-06-27T12:00:00Z","project_id":"proj_123","project_name":"Prod"}`)

display := newAPIKeyDisplay(*key)

assert.Equal(t, "key_123", display.ID)
assert.Equal(t, "ci", display.Name)
assert.Equal(t, "Project", display.Scope)
assert.Equal(t, "Prod", display.Project)
assert.Equal(t, "sk_...123", display.MaskedKey)
assert.Equal(t, "Dev", display.CreatedBy)
assert.Equal(t, util.FormatLocal(key.ExpiresAt), display.ExpiresAt)
assert.Equal(t, util.FormatLocal(key.CreatedAt), display.CreatedAt)
}

func TestAPIKeyDisplayFallsBackForAbsentOptionalFields(t *testing.T) {
key := apiKeyFromJSON(`{"id":"key_123","name":"ci","masked_key":"sk_...123","created_at":"2026-05-27T12:00:00Z","created_by":{"id":"user_123","email":"dev@example.com","name":null},"expires_at":null,"project_id":null,"project_name":null}`)

display := newAPIKeyDisplay(*key)

assert.Equal(t, "Org", display.Scope)
assert.Equal(t, "-", display.Project)
assert.Equal(t, "dev@example.com", display.CreatedBy)
assert.Equal(t, "Never", display.ExpiresAt)
}

func TestAPIKeysUpdateRequiresName(t *testing.T) {
c := APIKeysCmd{apiKeys: &FakeAPIKeysService{}}
err := c.Update(context.Background(), APIKeysUpdateInput{ID: "key_123"})
Expand Down
Loading