Skip to content

fix(cli): show full IDs in human output #221

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

Merged
arjunkomath merged 1 commit into from
Jul 28, 2026
Merged

fix(cli): show full IDs in human output #221

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
27 changes: 8 additions & 19 deletions cli/internal/cli/app.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -594,7 +594,7 @@ func (a *App) deployCommand() *cobra.Command {
output.Field(a.Out, "Operation", result.Operation)
output.Field(a.Out, "Status", output.Status(result.Status))
if result.RolloutID != nil && *result.RolloutID != "" {
output.Field(a.Out, "Rollout", output.ShortID(*result.RolloutID))
output.Field(a.Out, "Rollout", *result.RolloutID)
}
if result.Operation == "build" {
output.Field(a.Out, "Next", "build queued; a rollout starts after it succeeds")
Expand Down Expand Up @@ -1338,7 +1338,7 @@ func (a *App) runAuthLogin(ctx context.Context, host string) error {
output.Field(a.Out, "Host", host)
key := "created"
if exchange.KeyID != "" {
key = output.ShortID(exchange.KeyID)
key = exchange.KeyID
}
output.Field(a.Out, "Key", key)
return nil
Expand Down Expand Up @@ -1472,7 +1472,7 @@ func printApplyResult(w io.Writer, result applyResponse) {
func printStatus(w io.Writer, value manifest.Manifest, status statusResponse) {
fmt.Fprintf(w, "%s/%s/%s\n", value.Project.Slug, value.Environment.Name, value.Service.Name)
output.Section(w, "Service")
output.Field(w, "ID", output.ShortID(status.Service.ID))
output.Field(w, "ID", status.Service.ID)
if status.Service.Source.Type == "image" {
output.Field(w, "Source", status.Service.Source.Image)
} else {
Expand Down Expand Up @@ -1550,8 +1550,6 @@ func printBuilds(w io.Writer, result map[string]any) {
continue
}
switch field.key {
case "id", "commitSha":
value = output.ShortID(value)
case "status":
value = output.Status(value)
case "startedAt", "completedAt", "createdAt":
Expand Down Expand Up @@ -1602,8 +1600,8 @@ func printConfiguration(w io.Writer, result map[string]any) {
printSchedules(w, current["schedules"])

output.Section(w, "Deployment")
printOptionalField(w, "Revision", shortIDValue(result["activeRevisionId"]))
printOptionalField(w, "Deployment", shortIDValue(result["activeDeploymentId"]))
printOptionalField(w, "Revision", result["activeRevisionId"])
printOptionalField(w, "Deployment", result["activeDeploymentId"])
printOptionalField(w, "Pending", result["hasPendingChanges"])
changes, _ := result["changes"].([]any)
if len(changes) > 0 {
Expand Down Expand Up @@ -1675,13 +1673,6 @@ func printOptionalField(w io.Writer, label string, value any) {
}
}

func shortIDValue(value any) any {
if id, ok := value.(string); ok && id != "" {
return output.ShortID(id)
}
return nil
}

func printPlacements(w io.Writer, value any) {
placements, _ := value.([]any)
output.Field(w, "Placements", len(placements))
Expand All @@ -1692,7 +1683,7 @@ func printPlacements(w io.Writer, value any) {
}
server := placement["serverName"]
if server == nil {
server = shortIDValue(placement["serverId"])
server = placement["serverId"]
}
fmt.Fprintf(w, " * %v: %v replica(s)\n", server, placement["count"])
}
Expand Down Expand Up @@ -1886,7 +1877,7 @@ func printRevisions(w io.Writer, result map[string]any) {
fmt.Fprintln(w)
}
if id, ok := revision["id"].(string); ok {
output.Field(w, "ID", output.ShortID(id))
output.Field(w, "ID", id)
}
if createdAt, ok := revision["createdAt"].(string); ok {
output.Field(w, "Created", output.Timestamp(createdAt))
Expand All @@ -1897,7 +1888,7 @@ func printRevisions(w io.Writer, result map[string]any) {
if rollout, ok := revision["rollout"].(map[string]any); ok {
id, _ := rollout["id"].(string)
status, _ := rollout["status"].(string)
value := output.ShortID(id)
value := id
if status != "" {
value += " (" + output.Status(status) + ")"
}
Expand Down Expand Up @@ -1956,8 +1947,6 @@ func printRolloutFields(w io.Writer, rollout map[string]any) {
continue
}
switch field.key {
case "id":
value = output.ShortID(value)
case "status", "currentStage":
value = output.Status(value)
case "createdAt", "completedAt":
Expand Down
33 changes: 22 additions & 11 deletions cli/internal/cli/app_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ func TestAuthDeviceExchangeCreatesAPIKeyAndWhoamiUsesIt(t *testing.T) {
if body["name"] == "" || body["metadata"] == nil {
t.Errorf("exchange body = %#v", body)
}
w.Write([]byte(`{"apiKey":"new-secret","keyId":"key-id","name":"CLI test"}`))
w.Write([]byte(`{"apiKey":"new-secret","keyId":"0400075c-69aa-46c2-bccc-fc172b8c6b28","name":"CLI test"}`))
case "/api/v1/me":
if r.Header.Get("X-API-Key") != "new-secret" {
t.Errorf("X-API-Key = %q", r.Header.Get("X-API-Key"))
Expand All @@ -99,9 +99,10 @@ func TestAuthDeviceExchangeCreatesAPIKeyAndWhoamiUsesIt(t *testing.T) {
t.Fatal(err)
}
cfg, _ := auth.NewConfigStore("test").ReadConfig()
if polls != 1 || cfg == nil || cfg.APIKey != "new-secret" || cfg.KeyID != "key-id" {
if polls != 1 || cfg == nil || cfg.APIKey != "new-secret" || cfg.KeyID != "0400075c-69aa-46c2-bccc-fc172b8c6b28" {
t.Fatalf("polls=%d config=%#v", polls, cfg)
}
assertHumanOutput(t, out.String(), "Key", "0400075c-69aa-46c2-bccc-fc172b8c6b28")
out.Reset()
if err := execute(app, "auth", "whoami"); err != nil {
t.Fatal(err)
Expand Down Expand Up @@ -451,18 +452,20 @@ func TestDeploySourceNeutralAndMismatch(t *testing.T) {
return
}
posts++
w.Write([]byte(`{"operation":"rollout","status":"queued"}`))
w.Write([]byte(`{"operation":"rollout","status":"queued","rolloutId":"2c917d90-4bc1-4274-b3bf-34fed009fc12"}`))
}))
defer s.Close()
writeConfig(t, s.URL)
app, _ := testApp(t, d, s.Client())
app, out := testApp(t, d, s.Client())
err := execute(app, "deploy")
if tc.mismatch {
if err == nil || !strings.Contains(err.Error(), "tc apply") || posts != 0 {
t.Fatalf("err=%v posts=%d", err, posts)
}
} else if err != nil || posts != 1 {
t.Fatalf("err=%v posts=%d", err, posts)
} else {
assertHumanOutput(t, out.String(), "Rollout", "2c917d90-4bc1-4274-b3bf-34fed009fc12")
}
})
}
Expand All @@ -487,7 +490,7 @@ func TestStatusAndResourceRoutesAndOutput(t *testing.T) {
var gotPath, gotQuery string
s := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
gotPath, gotQuery = r.URL.Path, r.URL.RawQuery
w.Write([]byte(`{"service":{"id":"s","name":"web","source":{"type":"image","image":"nginx"}},"latestBuild":null,"latestRollout":null,"deployments":[],"items":[]}`))
w.Write([]byte(`{"service":{"id":"0400075c-69aa-46c2-bccc-fc172b8c6b28","name":"web","source":{"type":"image","image":"nginx"}},"latestBuild":null,"latestRollout":null,"deployments":[],"items":[]}`))
}))
defer s.Close()
writeConfig(t, s.URL)
Expand All @@ -503,6 +506,14 @@ func TestStatusAndResourceRoutesAndOutput(t *testing.T) {
t.Fatalf("invalid JSON: %s", out.String())
}
}
if tc.args[0] == "status" {
app, out := testApp(t, t.TempDir(), s.Client())
args := append(tc.args, "--project", "p", "--environment", "e", "--service", "s")
if err := execute(app, args...); err != nil {
t.Fatal(err)
}
assertHumanOutput(t, out.String(), "ID", "0400075c-69aa-46c2-bccc-fc172b8c6b28")
}
base := "/api/v1/projects/p/environments/e/services/s"
if gotPath != base+tc.path || gotQuery != tc.query {
t.Fatalf("got %s?%s", gotPath, gotQuery)
Expand All @@ -525,7 +536,7 @@ func TestBuildsHumanOutputIsFormatted(t *testing.T) {
{
name: "github source",
response: `{"supported":true,"builds":[{"id":"0400075c-69aa-46c2-bccc-fc172b8c6b28","status":"in_progress","branch":"main","commitSha":"abcdef1234567890abcdef1234567890abcdef12","createdAt":"2026-01-01T00:00:00.820Z"}],"nextCursor":"next-page"}`,
want: []string{"Builds (1)", "ID", "0400075c...6b28", "Status", "in progress", "Branch", "main", "Commit", "abcdef12...ef12", "Created", "2026-01-01T00:00:00.82Z", "next-page"},
want: []string{"Builds (1)", "ID", "0400075c-69aa-46c2-bccc-fc172b8c6b28", "Status", "in progress", "Branch", "main", "Commit", "abcdef1234567890abcdef1234567890abcdef12", "Created", "2026-01-01T00:00:00.82Z", "next-page"},
},
} {
t.Run(tc.name, func(t *testing.T) {
Expand All @@ -543,15 +554,15 @@ func TestBuildsHumanOutputIsFormatted(t *testing.T) {
}

func TestConfigurationHumanOutputIsFormatted(t *testing.T) {
s := responseServer(t, `{"current":{"source":{"type":"github","repository":"https://github.com/acme/app","branch":"main","rootDir":"cmd/api"},"hostname":"api.example.com","stateful":true,"replicas":2,"placements":[{"serverId":"server-1","serverName":"ubuntu-2","count":2}],"healthCheck":{"cmd":"curl localhost:3000","interval":10,"timeout":5,"retries":3,"startPeriod":30},"startCommand":"npm start","resources":{"cpuCores":2,"memoryMb":512},"ports":[{"containerPort":3000,"public":true,"domain":"api.example.com","protocol":"http","externalPort":null}],"volumes":[{"name":"data","containerPath":"/data"}],"serverless":{"enabled":false,"sleepAfterSeconds":300,"wakeTimeoutSeconds":30},"schedules":{"deployment":null,"backup":{"enabled":false,"schedule":null}}},"active":null,"activeRevisionId":"0400075c-69aa-46c2-bccc-fc172b8c6b28","activeDeploymentId":"2c917d90-4bc1-4274-b3bf-34fed009fc12","hasPendingChanges":true,"changes":[{"field":"replicas","from":"active revision","to":"current configuration"}],"management":{"patchable":true,"blockers":[]}}`)
s := responseServer(t, `{"current":{"source":{"type":"github","repository":"https://github.com/acme/app","branch":"main","rootDir":"cmd/api"},"hostname":"api.example.com","stateful":true,"replicas":2,"placements":[{"serverId":"server-1","serverName":"ubuntu-2","count":2},{"serverId":"a868807a-42ee-4a40-99fe-cd8303036b02","count":1}],"healthCheck":{"cmd":"curl localhost:3000","interval":10,"timeout":5,"retries":3,"startPeriod":30},"startCommand":"npm start","resources":{"cpuCores":2,"memoryMb":512},"ports":[{"containerPort":3000,"public":true,"domain":"api.example.com","protocol":"http","externalPort":null}],"volumes":[{"name":"data","containerPath":"/data"}],"serverless":{"enabled":false,"sleepAfterSeconds":300,"wakeTimeoutSeconds":30},"schedules":{"deployment":null,"backup":{"enabled":false,"schedule":null}}},"active":null,"activeRevisionId":"0400075c-69aa-46c2-bccc-fc172b8c6b28","activeDeploymentId":"2c917d90-4bc1-4274-b3bf-34fed009fc12","hasPendingChanges":true,"changes":[{"field":"replicas","from":"active revision","to":"current configuration"}],"management":{"patchable":true,"blockers":[]}}`)
writeConfig(t, s.URL)

app, out := testApp(t, t.TempDir(), s.Client())
err := execute(app, "config", "--project", "p", "--environment", "e", "--service", "s")
if err != nil {
t.Fatal(err)
}
assertHumanOutput(t, out.String(), "Configuration", "https://github.com/acme/app @ main (cmd/api)", "api.example.com", "ubuntu-2: 2 replica(s)", "3000/http public", "data: /data", "curl localhost:3000", "Deployment", "0400075c...6b28", "replicas: active revision -> current configuration", "Management", "Patchable", "yes")
assertHumanOutput(t, out.String(), "Configuration", "https://github.com/acme/app @ main (cmd/api)", "api.example.com", "ubuntu-2: 2 replica(s)", "a868807a-42ee-4a40-99fe-cd8303036b02: 1 replica(s)", "3000/http public", "data: /data", "curl localhost:3000", "Deployment", "0400075c-69aa-46c2-bccc-fc172b8c6b28", "2c917d90-4bc1-4274-b3bf-34fed009fc12", "replicas: active revision -> current configuration", "Management", "Patchable", "yes")
}

func TestMetricsHumanOutputIsFormatted(t *testing.T) {
Expand Down Expand Up @@ -590,7 +601,7 @@ func TestRevisionsHumanOutputIsFormatted(t *testing.T) {
if err != nil {
t.Fatal(err)
}
assertHumanOutput(t, out.String(), "Revisions (2)", "0400075c...6b28", "Arjun Komath", "in progress", "Image: app:v1 -> app:v2", "3f9293e9...b056", "@octocat", "initial revision", "next-page")
assertHumanOutput(t, out.String(), "Revisions (2)", "0400075c-69aa-46c2-bccc-fc172b8c6b28", "2c917d90-4bc1-4274-b3bf-34fed009fc12", "Arjun Komath", "in progress", "Image: app:v1 -> app:v2", "3f9293e9-d4d8-4b72-8ae4-94b3737ab056", "@octocat", "initial revision", "next-page")
}

func TestRolloutHumanOutputIsFormatted(t *testing.T) {
Expand All @@ -613,8 +624,8 @@ func TestRolloutHumanOutputIsFormatted(t *testing.T) {
args []string
want []string
}{
{[]string{"rollouts"}, []string{"Rollouts (1)", "2c917d90...fc12", "in progress", "health check", "ubuntu-2: running, healthy", "next-page"}},
{[]string{"rollout", "r1"}, []string{"Rollout", "2c917d90...fc12", "completed", "2026-07-21T11:05:30Z"}},
{[]string{"rollouts"}, []string{"Rollouts (1)", "2c917d90-4bc1-4274-b3bf-34fed009fc12", "in progress", "health check", "ubuntu-2: running, healthy", "next-page"}},
{[]string{"rollout", "r1"}, []string{"Rollout", "2c917d90-4bc1-4274-b3bf-34fed009fc12", "completed", "2026-07-21T11:05:30Z"}},
{[]string{"rollout", "logs", "r1"}, []string{"Rollout logs (2)", "[preparing]", "Rollout started", "[health check]", "Starting container"}},
} {
app, out := testApp(t, t.TempDir(), s.Client())
Expand Down
7 changes: 0 additions & 7 deletions cli/internal/output/output.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,13 +45,6 @@ func Next(w io.Writer, command string) {
Field(w, "Run", command)
}

func ShortID(id string) string {
if len(id) <= 16 {
return id
}
return id[:8] + "..." + id[len(id)-4:]
}

func Status(value string) string {
return strings.ReplaceAll(value, "_", " ")
}
Expand Down