Merge pull request #218 from hookdeck/fix/pagination-cursor-display

leggetter · web-flow · commit e22ecda2224e · 2026-02-24T17:40:15.000Z
fix: display pagination cursors in all list commands
diff --git a/.github/workflows/test-acceptance.yml b/.github/workflows/test-acceptance.yml
@@ -21,4 +21,4 @@ jobs:
           go-version: "1.24.9"
 
       - name: Run Go Acceptance Tests
-        run: go test ./test/acceptance/... -v -timeout 10m
+        run: go test ./test/acceptance/... -v -timeout 20m
diff --git a/.gitignore b/.gitignore
@@ -20,3 +20,6 @@ test-scripts/.install-test/
 
 # Temporary OpenAPI spec download (large; do not commit)
 .plans/openapi-2025-07-01.json
+
+# Claude Code temporary worktrees
+.claude/worktrees/
diff --git a/pkg/cmd/attempt_list.go b/pkg/cmd/attempt_list.go
@@ -2,7 +2,6 @@ package cmd
 
 import (
 	"context"
-	"encoding/json"
 	"fmt"
 	"os"
 	"strconv"
@@ -81,11 +80,7 @@ func (ac *attemptListCmd) runAttemptListCmd(cmd *cobra.Command, args []string) e
 	}
 
 	if ac.output == "json" {
-		if len(resp.Models) == 0 {
-			fmt.Println("[]")
-			return nil
-		}
-		jsonBytes, err := json.MarshalIndent(resp.Models, "", "  ")
+		jsonBytes, err := marshalListResponseWithPagination(resp.Models, resp.Pagination)
 		if err != nil {
 			return fmt.Errorf("failed to marshal attempts to json: %w", err)
 		}
@@ -106,5 +101,10 @@ func (ac *attemptListCmd) runAttemptListCmd(cmd *cobra.Command, args []string) e
 		}
 		fmt.Printf("%s #%d%s %s\n", color.Green(a.ID), a.AttemptNumber, status, a.Status)
 	}
+
+	// Display pagination info
+	commandExample := "hookdeck gateway attempt list"
+	printPaginationInfo(resp.Pagination, commandExample)
+
 	return nil
 }
diff --git a/pkg/cmd/connection_list.go b/pkg/cmd/connection_list.go
@@ -2,7 +2,6 @@ package cmd
 
 import (
 	"context"
-	"encoding/json"
 	"fmt"
 	"os"
 	"strconv"
@@ -113,12 +112,7 @@ func (cc *connectionListCmd) runConnectionListCmd(cmd *cobra.Command, args []str
 	}
 
 	if cc.output == "json" {
-		if len(response.Models) == 0 {
-			// Print an empty JSON array
-			fmt.Println("[]")
-			return nil
-		}
-		jsonBytes, err := json.MarshalIndent(response.Models, "", "  ")
+		jsonBytes, err := marshalListResponseWithPagination(response.Models, response.Pagination)
 		if err != nil {
 			return fmt.Errorf("failed to marshal connections to json: %w", err)
 		}
@@ -175,5 +169,9 @@ func (cc *connectionListCmd) runConnectionListCmd(cmd *cobra.Command, args []str
 		fmt.Println()
 	}
 
+	// Display pagination info
+	commandExample := "hookdeck gateway connection list"
+	printPaginationInfo(response.Pagination, commandExample)
+
 	return nil
 }
diff --git a/pkg/cmd/destination_list.go b/pkg/cmd/destination_list.go
@@ -2,7 +2,6 @@ package cmd
 
 import (
 	"context"
-	"encoding/json"
 	"fmt"
 	"os"
 	"strconv"
@@ -77,11 +76,7 @@ func (dc *destinationListCmd) runDestinationListCmd(cmd *cobra.Command, args []s
 	}
 
 	if dc.output == "json" {
-		if len(resp.Models) == 0 {
-			fmt.Println("[]")
-			return nil
-		}
-		jsonBytes, err := json.MarshalIndent(resp.Models, "", "  ")
+		jsonBytes, err := marshalListResponseWithPagination(resp.Models, resp.Pagination)
 		if err != nil {
 			return fmt.Errorf("failed to marshal destinations to json: %w", err)
 		}
@@ -111,5 +106,9 @@ func (dc *destinationListCmd) runDestinationListCmd(cmd *cobra.Command, args []s
 		fmt.Println()
 	}
 
+	// Display pagination info
+	commandExample := "hookdeck gateway destination list"
+	printPaginationInfo(resp.Pagination, commandExample)
+
 	return nil
 }
diff --git a/pkg/cmd/event_list.go b/pkg/cmd/event_list.go
@@ -2,7 +2,6 @@ package cmd
 
 import (
 	"context"
-	"encoding/json"
 	"fmt"
 	"os"
 	"strconv"
@@ -177,11 +176,7 @@ func (ec *eventListCmd) runEventListCmd(cmd *cobra.Command, args []string) error
 	}
 
 	if ec.output == "json" {
-		if len(resp.Models) == 0 {
-			fmt.Println("[]")
-			return nil
-		}
-		jsonBytes, err := json.MarshalIndent(resp.Models, "", "  ")
+		jsonBytes, err := marshalListResponseWithPagination(resp.Models, resp.Pagination)
 		if err != nil {
 			return fmt.Errorf("failed to marshal events to json: %w", err)
 		}
@@ -198,5 +193,10 @@ func (ec *eventListCmd) runEventListCmd(cmd *cobra.Command, args []string) error
 	for _, e := range resp.Models {
 		fmt.Printf("%s  Status: %s  Connection: %s\n", color.Green(e.ID), e.Status, e.WebhookID)
 	}
+
+	// Display pagination info
+	commandExample := "hookdeck gateway event list"
+	printPaginationInfo(resp.Pagination, commandExample)
+
 	return nil
 }
diff --git a/pkg/cmd/pagination_output.go b/pkg/cmd/pagination_output.go
@@ -0,0 +1,39 @@
+package cmd
+
+import (
+	"encoding/json"
+	"fmt"
+
+	"github.com/hookdeck/hookdeck-cli/pkg/hookdeck"
+)
+
+// printPaginationInfo displays pagination cursors for text output
+func printPaginationInfo(pagination hookdeck.PaginationResponse, commandExample string) {
+	if pagination.Next == nil && pagination.Prev == nil {
+		return
+	}
+
+	fmt.Println()
+	fmt.Println("Pagination:")
+	if pagination.Prev != nil {
+		fmt.Printf("  Prev: %s\n", *pagination.Prev)
+	}
+	if pagination.Next != nil {
+		fmt.Printf("  Next: %s\n", *pagination.Next)
+	}
+
+	if pagination.Next != nil {
+		fmt.Println()
+		fmt.Println("To get the next page:")
+		fmt.Printf("  %s --next %s\n", commandExample, *pagination.Next)
+	}
+}
+
+// marshalListResponseWithPagination marshals a list response including pagination
+func marshalListResponseWithPagination(models interface{}, pagination hookdeck.PaginationResponse) ([]byte, error) {
+	response := map[string]interface{}{
+		"models":     models,
+		"pagination": pagination,
+	}
+	return json.MarshalIndent(response, "", "  ")
+}
diff --git a/pkg/cmd/request_list.go b/pkg/cmd/request_list.go
@@ -2,7 +2,6 @@ package cmd
 
 import (
 	"context"
-	"encoding/json"
 	"fmt"
 	"os"
 	"strconv"
@@ -141,11 +140,7 @@ func (rc *requestListCmd) runRequestListCmd(cmd *cobra.Command, args []string) e
 	}
 
 	if rc.output == "json" {
-		if len(resp.Models) == 0 {
-			fmt.Println("[]")
-			return nil
-		}
-		jsonBytes, err := json.MarshalIndent(resp.Models, "", "  ")
+		jsonBytes, err := marshalListResponseWithPagination(resp.Models, resp.Pagination)
 		if err != nil {
 			return fmt.Errorf("failed to marshal requests to json: %w", err)
 		}
@@ -162,5 +157,10 @@ func (rc *requestListCmd) runRequestListCmd(cmd *cobra.Command, args []string) e
 	for _, r := range resp.Models {
 		fmt.Printf("%s %s (events: %d)\n", color.Green(r.ID), r.SourceID, r.EventsCount)
 	}
+
+	// Display pagination info
+	commandExample := "hookdeck gateway request list"
+	printPaginationInfo(resp.Pagination, commandExample)
+
 	return nil
 }
diff --git a/pkg/cmd/source_list.go b/pkg/cmd/source_list.go
@@ -2,7 +2,6 @@ package cmd
 
 import (
 	"context"
-	"encoding/json"
 	"fmt"
 	"os"
 	"strconv"
@@ -77,11 +76,7 @@ func (sc *sourceListCmd) runSourceListCmd(cmd *cobra.Command, args []string) err
 	}
 
 	if sc.output == "json" {
-		if len(resp.Models) == 0 {
-			fmt.Println("[]")
-			return nil
-		}
-		jsonBytes, err := json.MarshalIndent(resp.Models, "", "  ")
+		jsonBytes, err := marshalListResponseWithPagination(resp.Models, resp.Pagination)
 		if err != nil {
 			return fmt.Errorf("failed to marshal sources to json: %w", err)
 		}
@@ -109,5 +104,9 @@ func (sc *sourceListCmd) runSourceListCmd(cmd *cobra.Command, args []string) err
 		fmt.Println()
 	}
 
+	// Display pagination info
+	commandExample := "hookdeck gateway source list"
+	printPaginationInfo(resp.Pagination, commandExample)
+
 	return nil
 }
diff --git a/pkg/cmd/transformation_executions.go b/pkg/cmd/transformation_executions.go
@@ -112,11 +112,7 @@ func (tc *transformationExecutionsListCmd) run(cmd *cobra.Command, args []string
 	}
 
 	if tc.output == "json" {
-		if len(resp.Models) == 0 {
-			fmt.Println("[]")
-			return nil
-		}
-		jsonBytes, err := json.MarshalIndent(resp.Models, "", "  ")
+		jsonBytes, err := marshalListResponseWithPagination(resp.Models, resp.Pagination)
 		if err != nil {
 			return fmt.Errorf("failed to marshal executions to json: %w", err)
 		}
@@ -133,6 +129,11 @@ func (tc *transformationExecutionsListCmd) run(cmd *cobra.Command, args []string
 	for _, e := range resp.Models {
 		fmt.Printf("%s %s\n", color.Green(e.ID), e.CreatedAt.Format("2006-01-02 15:04:05"))
 	}
+
+	// Display pagination info
+	commandExample := "hookdeck gateway transformation executions list"
+	printPaginationInfo(resp.Pagination, commandExample)
+
 	return nil
 }
 
diff --git a/pkg/cmd/transformation_list.go b/pkg/cmd/transformation_list.go
@@ -2,7 +2,6 @@ package cmd
 
 import (
 	"context"
-	"encoding/json"
 	"fmt"
 	"os"
 	"strconv"
@@ -88,11 +87,7 @@ func (tc *transformationListCmd) runTransformationListCmd(cmd *cobra.Command, ar
 	}
 
 	if tc.output == "json" {
-		if len(resp.Models) == 0 {
-			fmt.Println("[]")
-			return nil
-		}
-		jsonBytes, err := json.MarshalIndent(resp.Models, "", "  ")
+		jsonBytes, err := marshalListResponseWithPagination(resp.Models, resp.Pagination)
 		if err != nil {
 			return fmt.Errorf("failed to marshal transformations to json: %w", err)
 		}
@@ -109,5 +104,10 @@ func (tc *transformationListCmd) runTransformationListCmd(cmd *cobra.Command, ar
 	for _, t := range resp.Models {
 		fmt.Printf("%s %s\n", color.Green(t.Name), t.ID)
 	}
+
+	// Display pagination info
+	commandExample := "hookdeck gateway transformation list"
+	printPaginationInfo(resp.Pagination, commandExample)
+
 	return nil
 }
diff --git a/test/acceptance/attempt_test.go b/test/acceptance/attempt_test.go
@@ -2,8 +2,10 @@ package acceptance
 
 import (
 	"testing"
+	"time"
 
 	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
 )
 
 func TestAttemptList(t *testing.T) {
@@ -105,3 +107,59 @@ func TestAttemptListWithPrev(t *testing.T) {
 		assert.Contains(t, err.Error(), "exit status")
 	}
 }
+
+func TestAttemptListPaginationWorkflow(t *testing.T) {
+	if testing.Short() {
+		t.Skip("Skipping acceptance test in short mode")
+	}
+
+	cli := NewCLIRunner(t)
+	connID, eventID := createConnectionAndTriggerEvent(t, cli)
+	t.Cleanup(func() { deleteConnection(t, cli, connID) })
+
+	// Retry the event multiple times to create multiple attempts
+	for i := 0; i < 3; i++ {
+		cli.RunExpectSuccess("gateway", "event", "retry", eventID)
+		time.Sleep(2 * time.Second) // Wait for retry to be processed
+	}
+
+	// Poll for attempts to ensure we have multiple
+	attempts := pollForAttemptsByEventID(t, cli, eventID)
+	require.GreaterOrEqual(t, len(attempts), 2, "Need at least 2 attempts for pagination test")
+
+	// Test 1: JSON output includes pagination metadata
+	type AttemptListResponse struct {
+		Models     []Attempt              `json:"models"`
+		Pagination map[string]interface{} `json:"pagination"`
+	}
+	var firstPageResp AttemptListResponse
+	require.NoError(t, cli.RunJSON(&firstPageResp, "gateway", "attempt", "list", "--event-id", eventID, "--limit", "2"))
+	assert.NotEmpty(t, firstPageResp.Models, "First page should have attempts")
+	assert.NotNil(t, firstPageResp.Pagination, "JSON response should include pagination metadata")
+	assert.Contains(t, firstPageResp.Pagination, "limit")
+	assert.Equal(t, float64(2), firstPageResp.Pagination["limit"])
+
+	// Test 2: Text output includes pagination info when next cursor exists
+	if len(firstPageResp.Models) == 2 && firstPageResp.Pagination["next"] != nil {
+		stdout := cli.RunExpectSuccess("gateway", "attempt", "list", "--event-id", eventID, "--limit", "2")
+		assert.Contains(t, stdout, "Pagination:")
+		assert.Contains(t, stdout, "Next:")
+		assert.Contains(t, stdout, "To get the next page:")
+		assert.Contains(t, stdout, "--next")
+
+		// Test 3: Use next cursor to get second page
+		nextCursor := firstPageResp.Pagination["next"].(string)
+		var secondPageResp AttemptListResponse
+		require.NoError(t, cli.RunJSON(&secondPageResp, "gateway", "attempt", "list", "--event-id", eventID, "--limit", "2", "--next", nextCursor))
+		assert.NotEmpty(t, secondPageResp.Models, "Second page should have attempts")
+
+		// Verify pages contain different attempts
+		firstPageIDs := make(map[string]bool)
+		for _, a := range firstPageResp.Models {
+			firstPageIDs[a.ID] = true
+		}
+		for _, a := range secondPageResp.Models {
+			assert.False(t, firstPageIDs[a.ID], "Second page should not contain attempts from first page")
+		}
+	}
+}
diff --git a/test/acceptance/connection_list_test.go b/test/acceptance/connection_list_test.go
diff --git a/test/acceptance/event_test.go b/test/acceptance/event_test.go
diff --git a/test/acceptance/gateway_test.go b/test/acceptance/gateway_test.go
diff --git a/test/acceptance/helpers.go b/test/acceptance/helpers.go
diff --git a/test/acceptance/request_test.go b/test/acceptance/request_test.go
diff --git a/test/acceptance/transformation_test.go b/test/acceptance/transformation_test.go

Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,6 @@ package cmd`
`2`	`2`
`3`	`3`	`import (`
`4`	`4`	`"context"`
`5`		`- "encoding/json"`
`6`	`5`	`"fmt"`
`7`	`6`	`"os"`
`8`	`7`	`"strconv"`
`@@ -81,11 +80,7 @@ func (ac attemptListCmd) runAttemptListCmd(cmd cobra.Command, args []string) e`
`81`	`80`	`}`
`82`	`81`
`83`	`82`	`if ac.output == "json" {`
`84`		`- if len(resp.Models) == 0 {`
`85`		`- fmt.Println("[]")`
`86`		`- return nil`
`87`		`- }`
`88`		`- jsonBytes, err := json.MarshalIndent(resp.Models, "", " ")`
	`83`	`+ jsonBytes, err := marshalListResponseWithPagination(resp.Models, resp.Pagination)`
`89`	`84`	`if err != nil {`
`90`	`85`	`return fmt.Errorf("failed to marshal attempts to json: %w", err)`
`91`	`86`	`}`
`@@ -106,5 +101,10 @@ func (ac attemptListCmd) runAttemptListCmd(cmd cobra.Command, args []string) e`
`106`	`101`	`}`
`107`	`102`	`fmt.Printf("%s #%d%s %s\n", color.Green(a.ID), a.AttemptNumber, status, a.Status)`
`108`	`103`	`}`
	`104`	`+`
	`105`	`+ // Display pagination info`
	`106`	`+ commandExample := "hookdeck gateway attempt list"`
	`107`	`+ printPaginationInfo(resp.Pagination, commandExample)`
	`108`	`+`
`109`	`109`	`return nil`
`110`	`110`	`}`
Original file line number	Diff line number	Diff line change
`@@ -112,11 +112,7 @@ func (tc transformationExecutionsListCmd) run(cmd cobra.Command, args []string`
`112`	`112`	`}`
`113`	`113`
`114`	`114`	`if tc.output == "json" {`
`115`		`- if len(resp.Models) == 0 {`
`116`		`- fmt.Println("[]")`
`117`		`- return nil`
`118`		`- }`
`119`		`- jsonBytes, err := json.MarshalIndent(resp.Models, "", " ")`
	`115`	`+ jsonBytes, err := marshalListResponseWithPagination(resp.Models, resp.Pagination)`
`120`	`116`	`if err != nil {`
`121`	`117`	`return fmt.Errorf("failed to marshal executions to json: %w", err)`
`122`	`118`	`}`
`@@ -133,6 +129,11 @@ func (tc transformationExecutionsListCmd) run(cmd cobra.Command, args []string`
`133`	`129`	`for _, e := range resp.Models {`
`134`	`130`	`fmt.Printf("%s %s\n", color.Green(e.ID), e.CreatedAt.Format("2006-01-02 15:04:05"))`
`135`	`131`	`}`
	`132`	`+`
	`133`	`+ // Display pagination info`
	`134`	`+ commandExample := "hookdeck gateway transformation executions list"`
	`135`	`+ printPaginationInfo(resp.Pagination, commandExample)`
	`136`	`+`
`136`	`137`	`return nil`
`137`	`138`	`}`
`138`	`139`