fix: display the correct response for coder list (#16547)

evgeniy-scherbina · web-flow · commit 981cf8c33354 · 2025-02-13T10:13:20.000-05:00
Closes #16312 We intend to modify the behavior of the CLI handler based on the specified output format. However, the output format is currently only accessible within the `OutputFormatter` structure. Therefore, I propose extending `OutputFormatter` by introducing a public `FormatID` method, which will allow us to retrieve the format identifier and use it to customize the behavior of the CLI handler accordingly.
diff --git a/cli/cliui/output.go b/cli/cliui/output.go
@@ -83,6 +83,12 @@ func (f *OutputFormatter) Format(ctx context.Context, data any) (string, error)
 	return "", xerrors.Errorf("unknown output format %q", f.formatID)
 }
 
+// FormatID will return the ID of the format selected by `--output`.
+// If no flag is present, it returns the 'default' formatter.
+func (f *OutputFormatter) FormatID() string {
+	return f.formatID
+}
+
 type tableFormat struct {
 	defaultColumns []string
 	allColumns     []string
diff --git a/cli/list.go b/cli/list.go
@@ -112,7 +112,7 @@ func (r *RootCmd) list() *serpent.Command {
 				return err
 			}
 
-			if len(res) == 0 {
+			if len(res) == 0 && formatter.FormatID() != cliui.JSONFormat().ID() {
 				pretty.Fprintf(inv.Stderr, cliui.DefaultStyles.Prompt, "No workspaces found! Create one:\n")
 				_, _ = fmt.Fprintln(inv.Stderr)
 				_, _ = fmt.Fprintln(inv.Stderr, "  "+pretty.Sprint(cliui.DefaultStyles.Code, "coder create <name>"))
diff --git a/cli/list_test.go b/cli/list_test.go
@@ -74,4 +74,30 @@ func TestList(t *testing.T) {
 		require.NoError(t, json.Unmarshal(out.Bytes(), &workspaces))
 		require.Len(t, workspaces, 1)
 	})
+
+	t.Run("NoWorkspacesJSON", func(t *testing.T) {
+		t.Parallel()
+		client := coderdtest.New(t, nil)
+		owner := coderdtest.CreateFirstUser(t, client)
+		member, _ := coderdtest.CreateAnotherUser(t, client, owner.OrganizationID)
+
+		inv, root := clitest.New(t, "list", "--output=json")
+		clitest.SetupConfig(t, member, root)
+
+		ctx, cancelFunc := context.WithTimeout(context.Background(), testutil.WaitLong)
+		defer cancelFunc()
+
+		stdout := bytes.NewBuffer(nil)
+		stderr := bytes.NewBuffer(nil)
+		inv.Stdout = stdout
+		inv.Stderr = stderr
+		err := inv.WithContext(ctx).Run()
+		require.NoError(t, err)
+
+		var workspaces []codersdk.Workspace
+		require.NoError(t, json.Unmarshal(stdout.Bytes(), &workspaces))
+		require.Len(t, workspaces, 0)
+
+		require.Len(t, stderr.Bytes(), 0)
+	})
 }

Original file line number	Diff line number	Diff line change
`@@ -112,7 +112,7 @@ func (r RootCmd) list() serpent.Command {`
`112`	`112`	`return err`
`113`	`113`	`}`
`114`	`114`
`115`		`- if len(res) == 0 {`
	`115`	`+ if len(res) == 0 && formatter.FormatID() != cliui.JSONFormat().ID() {`
`116`	`116`	`pretty.Fprintf(inv.Stderr, cliui.DefaultStyles.Prompt, "No workspaces found! Create one:\n")`
`117`	`117`	`_, _ = fmt.Fprintln(inv.Stderr)`
`118`	`118`	`_, _ = fmt.Fprintln(inv.Stderr, " "+pretty.Sprint(cliui.DefaultStyles.Code, "coder create <name>"))`