chore(loo-4788): --debug flag (#29)

notnmeyer · web-flow · commit 702577c38e40 · 2026-03-24T07:35:21.000-07:00
diff --git a/cmd/api_key.go b/cmd/api_key.go
@@ -9,7 +9,7 @@ import (
 )
 
 func runAPIKey(cfg *config.Config) (*api.APIKeyResponse, error) {
-	return api.NewClient(cfg.EndpointURL, cfg.APIKey).GetAPIKey()
+	return api.NewClient(cfg.EndpointURL, cfg.APIKey, cfg.Debug).GetAPIKey()
 }
 
 var apiKeyCmd = &cobra.Command{
diff --git a/cmd/auth_login.go b/cmd/auth_login.go
@@ -51,7 +51,7 @@ func runAuthLogin(apiKey, name string) (*api.APIKeyResponse, error) {
 	if name == "" {
 		return nil, errors.New("use --name to give this key a name")
 	}
-	result, err := api.NewClient(config.EndpointURL(), apiKey).GetAPIKey()
+	result, err := api.NewClient(config.EndpointURL(), apiKey, debugFlag).GetAPIKey()
 	if err != nil {
 		return nil, fmt.Errorf("API key verification failed: %w", err)
 	}
diff --git a/cmd/auth_status.go b/cmd/auth_status.go
@@ -47,7 +47,7 @@ func runAuthStatus() (*config.Config, *api.APIKeyResponse, *config.PersistentCon
 	if err != nil {
 		return nil, nil, nil, err
 	}
-	keyResp, err := api.NewClient(cfg.EndpointURL, cfg.APIKey).GetAPIKey()
+	keyResp, err := api.NewClient(cfg.EndpointURL, cfg.APIKey, cfg.Debug).GetAPIKey()
 	if err != nil {
 		return nil, nil, nil, fmt.Errorf("API key verification failed: %w", err)
 	}
diff --git a/cmd/contact_properties.go b/cmd/contact_properties.go
@@ -9,11 +9,11 @@ import (
 )
 
 func runContactPropertiesList(cfg *config.Config, customOnly bool) ([]api.ContactProperty, error) {
-	return api.NewClient(cfg.EndpointURL, cfg.APIKey).ListContactProperties(customOnly)
+	return api.NewClient(cfg.EndpointURL, cfg.APIKey, cfg.Debug).ListContactProperties(customOnly)
 }
 
 func runContactPropertiesCreate(cfg *config.Config, name, propType string) error {
-	return api.NewClient(cfg.EndpointURL, cfg.APIKey).CreateContactProperty(name, propType)
+	return api.NewClient(cfg.EndpointURL, cfg.APIKey, cfg.Debug).CreateContactProperty(name, propType)
 }
 
 var contactPropertiesCmd = &cobra.Command{
diff --git a/cmd/contacts.go b/cmd/contacts.go
@@ -77,7 +77,7 @@ func contactFieldParamsFromCmd(cmd *cobra.Command) (contactFieldParams, error) {
 // find
 
 func runContactsFind(cfg *config.Config, email, userID string) ([]api.Contact, error) {
-	return api.NewClient(cfg.EndpointURL, cfg.APIKey).FindContacts(api.FindContactParams{
+	return api.NewClient(cfg.EndpointURL, cfg.APIKey, cfg.Debug).FindContacts(api.FindContactParams{
 		Email:  email,
 		UserID: userID,
 	})
@@ -149,7 +149,7 @@ type contactCreateResult struct {
 }
 
 func runContactsCreate(cfg *config.Config, req api.CreateContactRequest) (string, error) {
-	return api.NewClient(cfg.EndpointURL, cfg.APIKey).CreateContact(req)
+	return api.NewClient(cfg.EndpointURL, cfg.APIKey, cfg.Debug).CreateContact(req)
 }
 
 var contactsCreateCmd = &cobra.Command{
@@ -196,7 +196,7 @@ var contactsCreateCmd = &cobra.Command{
 // update
 
 func runContactsUpdate(cfg *config.Config, req api.UpdateContactRequest) error {
-	return api.NewClient(cfg.EndpointURL, cfg.APIKey).UpdateContact(req)
+	return api.NewClient(cfg.EndpointURL, cfg.APIKey, cfg.Debug).UpdateContact(req)
 }
 
 var contactsUpdateCmd = &cobra.Command{
@@ -244,7 +244,7 @@ var contactsUpdateCmd = &cobra.Command{
 // delete
 
 func runContactsDelete(cfg *config.Config, email, userID string) error {
-	return api.NewClient(cfg.EndpointURL, cfg.APIKey).DeleteContact(email, userID)
+	return api.NewClient(cfg.EndpointURL, cfg.APIKey, cfg.Debug).DeleteContact(email, userID)
 }
 
 var contactsDeleteCmd = &cobra.Command{
diff --git a/cmd/events.go b/cmd/events.go
@@ -35,7 +35,7 @@ func parseMailingLists(pairs []string) (map[string]bool, error) {
 }
 
 func runEventsSend(cfg *config.Config, req api.SendEventRequest) error {
-	return api.NewClient(cfg.EndpointURL, cfg.APIKey).SendEvent(req)
+	return api.NewClient(cfg.EndpointURL, cfg.APIKey, cfg.Debug).SendEvent(req)
 }
 
 var eventsCmd = &cobra.Command{
diff --git a/cmd/lists.go b/cmd/lists.go
@@ -9,7 +9,7 @@ import (
 )
 
 func runListsList(cfg *config.Config) ([]api.MailingList, error) {
-	return api.NewClient(cfg.EndpointURL, cfg.APIKey).ListMailingLists()
+	return api.NewClient(cfg.EndpointURL, cfg.APIKey, cfg.Debug).ListMailingLists()
 }
 
 var listsCmd = &cobra.Command{
diff --git a/cmd/root.go b/cmd/root.go
@@ -13,9 +13,15 @@ import (
 
 var outputFormat outputFlag = "text"
 var teamFlag string
+var debugFlag bool
 
 func loadConfig() (*config.Config, error) {
-	return config.Load(teamFlag)
+	cfg, err := config.Load(teamFlag)
+	if err != nil {
+		return nil, err
+	}
+	cfg.Debug = debugFlag
+	return cfg, nil
 }
 
 var rootCmd = &cobra.Command{
@@ -66,4 +72,5 @@ func init() {
 	// when this action is called directly.
 	rootCmd.PersistentFlags().VarP(&outputFormat, "output", "o", "Output format (text, json)")
 	rootCmd.PersistentFlags().StringVarP(&teamFlag, "team", "t", "", "Team key name to use")
+	rootCmd.PersistentFlags().BoolVar(&debugFlag, "debug", false, "Print API request details before sending")
 }
diff --git a/cmd/transactional.go b/cmd/transactional.go
@@ -64,7 +64,7 @@ func attachmentFromPath(path string) (api.Attachment, error) {
 }
 
 func runTransactionalList(cfg *config.Config, params api.PaginationParams) ([]api.TransactionalEmail, error) {
-	client := api.NewClient(cfg.EndpointURL, cfg.APIKey)
+	client := api.NewClient(cfg.EndpointURL, cfg.APIKey, cfg.Debug)
 	if params.Cursor != "" {
 		emails, _, err := client.ListTransactional(params)
 		return emails, err
@@ -78,7 +78,7 @@ func runTransactionalList(cfg *config.Config, params api.PaginationParams) ([]ap
 }
 
 func runTransactionalSend(cfg *config.Config, req api.SendTransactionalRequest) error {
-	return api.NewClient(cfg.EndpointURL, cfg.APIKey).SendTransactional(req)
+	return api.NewClient(cfg.EndpointURL, cfg.APIKey, cfg.Debug).SendTransactional(req)
 }
 
 var transactionalCmd = &cobra.Command{
diff --git a/internal/api/api_key_test.go b/internal/api/api_key_test.go
@@ -51,7 +51,7 @@ func TestGetAPIKey(t *testing.T) {
 			}))
 			defer server.Close()
 
-			client := NewClient(server.URL, "test-key")
+			client := NewClient(server.URL, "test-key", false)
 			result, err := client.GetAPIKey()
 
 			if tt.wantAPIErr != nil {
diff --git a/internal/api/client.go b/internal/api/client.go
@@ -1,11 +1,13 @@
 package api
 
 import (
+	"bytes"
 	"encoding/json"
 	"fmt"
 	"io"
 	"math/rand/v2"
 	"net/http"
+	"os"
 	"time"
 )
 
@@ -33,13 +35,15 @@ type Client struct {
 	baseURL    string
 	apiKey     string
 	httpClient *http.Client
+	debug      bool
 }
 
-func NewClient(baseURL, apiKey string) *Client {
+func NewClient(baseURL, apiKey string, debug bool) *Client {
 	return &Client{
 		baseURL:    baseURL,
 		apiKey:     apiKey,
 		httpClient: &http.Client{Timeout: 5 * time.Second},
+		debug:      debug,
 	}
 }
 
@@ -99,6 +103,17 @@ func (c *Client) do(req *http.Request) (*http.Response, error) {
 
 func (c *Client) newRequest(method, path string, body io.Reader) (*http.Request, error) {
 	url := fmt.Sprintf("%s%s", c.baseURL, path)
+
+	var bodyBytes []byte
+	if body != nil && c.debug {
+		var err error
+		bodyBytes, err = io.ReadAll(body)
+		if err != nil {
+			return nil, fmt.Errorf("failed to read request body: %w", err)
+		}
+		body = bytes.NewReader(bodyBytes)
+	}
+
 	req, err := http.NewRequest(method, url, body)
 	if err != nil {
 		return nil, err
@@ -107,5 +122,22 @@ func (c *Client) newRequest(method, path string, body io.Reader) (*http.Request,
 	if body != nil {
 		req.Header.Set("Content-Type", "application/json")
 	}
+
+	if c.debug {
+		fmt.Fprintf(os.Stderr, "[debug] %s %s\n", method, url)
+		fmt.Fprintf(os.Stderr, "[debug] Authorization: Bearer [REDACTED]\n")
+		if req.Header.Get("Content-Type") != "" {
+			fmt.Fprintf(os.Stderr, "[debug] Content-Type: %s\n", req.Header.Get("Content-Type"))
+		}
+		if len(bodyBytes) > 0 {
+			var pretty bytes.Buffer
+			if json.Indent(&pretty, bodyBytes, "", "  ") == nil {
+				fmt.Fprintf(os.Stderr, "[debug] Body:\n%s\n", pretty.String())
+			} else {
+				fmt.Fprintf(os.Stderr, "[debug] Body: %s\n", bodyBytes)
+			}
+		}
+	}
+
 	return req, nil
 }
diff --git a/internal/api/client_test.go b/internal/api/client_test.go
@@ -29,7 +29,7 @@ func TestDo_RetryResetsBody(t *testing.T) {
 	}))
 	defer server.Close()
 
-	client := NewClient(server.URL, "test-key")
+	client := NewClient(server.URL, "test-key", false)
 	req, _ := client.newRequest(http.MethodPost, "/", bytes.NewReader([]byte(`{"hello":"world"}`)))
 	resp, err := client.do(req)
 	if err != nil {
@@ -48,7 +48,7 @@ func TestDo_RetryResetsBody(t *testing.T) {
 }
 
 func TestNewRequest(t *testing.T) {
-	client := NewClient("https://example.com/api/v1", "test-key")
+	client := NewClient("https://example.com/api/v1", "test-key", false)
 
 	tests := []struct {
 		name   string
@@ -84,7 +84,7 @@ func TestNewRequest(t *testing.T) {
 }
 
 func TestNewRequest_InvalidURL(t *testing.T) {
-	client := NewClient("://bad-url", "test-key")
+	client := NewClient("://bad-url", "test-key", false)
 	_, err := client.newRequest(http.MethodGet, "/path", nil)
 	if err == nil {
 		t.Error("expected error for invalid URL, got nil")
@@ -206,7 +206,7 @@ func TestDo_Retries(t *testing.T) {
 			}))
 			defer server.Close()
 
-			client := NewClient(server.URL, "test-key")
+			client := NewClient(server.URL, "test-key", false)
 			req, _ := client.newRequest(http.MethodGet, "/", nil)
 			resp, err := client.do(req)
 			if err != nil {
diff --git a/internal/api/contact_properties_test.go b/internal/api/contact_properties_test.go
@@ -68,7 +68,7 @@ func TestListContactProperties(t *testing.T) {
 			}))
 			defer server.Close()
 
-			client := NewClient(server.URL, "test-key")
+			client := NewClient(server.URL, "test-key", false)
 			props, err := client.ListContactProperties(tt.customOnly)
 
 			if tt.wantQuery != "" && gotQuery != tt.wantQuery {
@@ -147,7 +147,7 @@ func TestCreateContactProperty(t *testing.T) {
 			}))
 			defer server.Close()
 
-			client := NewClient(server.URL, "test-key")
+			client := NewClient(server.URL, "test-key", false)
 			err := client.CreateContactProperty("age", "number")
 
 			if tt.wantBody != nil {
@@ -186,7 +186,7 @@ func TestListContactProperties_ResponseData(t *testing.T) {
 	}))
 	defer server.Close()
 
-	client := NewClient(server.URL, "test-key")
+	client := NewClient(server.URL, "test-key", false)
 	props, err := client.ListContactProperties(false)
 	if err != nil {
 		t.Fatalf("unexpected error: %v", err)
diff --git a/internal/api/contacts_test.go b/internal/api/contacts_test.go
@@ -115,7 +115,7 @@ func TestCreateContact(t *testing.T) {
 			}))
 			defer server.Close()
 
-			client := NewClient(server.URL, "test-key")
+			client := NewClient(server.URL, "test-key", false)
 			id, err := client.CreateContact(tt.req)
 
 			if tt.wantBody != nil {
@@ -210,7 +210,7 @@ func TestDeleteContact(t *testing.T) {
 			}))
 			defer server.Close()
 
-			client := NewClient(server.URL, "test-key")
+			client := NewClient(server.URL, "test-key", false)
 			err := client.DeleteContact(tt.email, tt.userID)
 
 			if tt.wantBody != nil {
@@ -323,7 +323,7 @@ func TestUpdateContact(t *testing.T) {
 			}))
 			defer server.Close()
 
-			client := NewClient(server.URL, "test-key")
+			client := NewClient(server.URL, "test-key", false)
 			err := client.UpdateContact(tt.req)
 
 			if tt.wantBody != nil {
@@ -425,7 +425,7 @@ func TestFindContacts(t *testing.T) {
 			}))
 			defer server.Close()
 
-			client := NewClient(server.URL, "test-key")
+			client := NewClient(server.URL, "test-key", false)
 			contacts, err := client.FindContacts(tt.params)
 
 			if tt.wantQuery != "" && gotQuery != tt.wantQuery {
diff --git a/internal/api/events_test.go b/internal/api/events_test.go
@@ -49,7 +49,7 @@ func TestSendEvent(t *testing.T) {
 			}))
 			defer server.Close()
 
-			client := NewClient(server.URL, "test-key")
+			client := NewClient(server.URL, "test-key", false)
 			err := client.SendEvent(SendEventRequest{
 				Email:     "test@example.com",
 				EventName: "signup",
@@ -176,7 +176,7 @@ func TestSendEvent_RequestBody(t *testing.T) {
 			}))
 			defer server.Close()
 
-			client := NewClient(server.URL, "test-key")
+			client := NewClient(server.URL, "test-key", false)
 			client.SendEvent(tt.req)
 
 			for key, want := range tt.wantPresent {
@@ -258,7 +258,7 @@ func TestSendEvent_IdempotencyKey(t *testing.T) {
 			}))
 			defer server.Close()
 
-			client := NewClient(server.URL, "test-key")
+			client := NewClient(server.URL, "test-key", false)
 			client.SendEvent(SendEventRequest{
 				Email:          "a@b.com",
 				EventName:      "click",
diff --git a/internal/api/lists_test.go b/internal/api/lists_test.go
@@ -51,7 +51,7 @@ func TestListMailingLists(t *testing.T) {
 			}))
 			defer server.Close()
 
-			client := NewClient(server.URL, "test-key")
+			client := NewClient(server.URL, "test-key", false)
 			lists, err := client.ListMailingLists()
 
 			if tt.wantAPIErr != nil {
@@ -95,7 +95,7 @@ func TestListMailingLists_ResponseData(t *testing.T) {
 	}))
 	defer server.Close()
 
-	client := NewClient(server.URL, "test-key")
+	client := NewClient(server.URL, "test-key", false)
 	lists, err := client.ListMailingLists()
 	if err != nil {
 		t.Fatalf("unexpected error: %v", err)
diff --git a/internal/api/transactional_test.go b/internal/api/transactional_test.go
diff --git a/internal/config/config.go b/internal/config/config.go

Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ import (`
`9`	`9`	`)`
`10`	`10`
`11`	`11`	`func runAPIKey(cfg config.Config) (api.APIKeyResponse, error) {`
`12`		`- return api.NewClient(cfg.EndpointURL, cfg.APIKey).GetAPIKey()`
	`12`	`+ return api.NewClient(cfg.EndpointURL, cfg.APIKey, cfg.Debug).GetAPIKey()`
`13`	`13`	`}`
`14`	`14`
`15`	`15`	`var apiKeyCmd = &cobra.Command{`
Original file line number	Diff line number	Diff line change
`@@ -51,7 +51,7 @@ func runAuthLogin(apiKey, name string) (*api.APIKeyResponse, error) {`
`51`	`51`	`if name == "" {`
`52`	`52`	`return nil, errors.New("use --name to give this key a name")`
`53`	`53`	`}`
`54`		`- result, err := api.NewClient(config.EndpointURL(), apiKey).GetAPIKey()`
	`54`	`+ result, err := api.NewClient(config.EndpointURL(), apiKey, debugFlag).GetAPIKey()`
`55`	`55`	`if err != nil {`
`56`	`56`	`return nil, fmt.Errorf("API key verification failed: %w", err)`
`57`	`57`	`}`
Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ func runAuthStatus() (config.Config, api.APIKeyResponse, *config.PersistentCon`
`47`	`47`	`if err != nil {`
`48`	`48`	`return nil, nil, nil, err`
`49`	`49`	`}`
`50`		`- keyResp, err := api.NewClient(cfg.EndpointURL, cfg.APIKey).GetAPIKey()`
	`50`	`+ keyResp, err := api.NewClient(cfg.EndpointURL, cfg.APIKey, cfg.Debug).GetAPIKey()`
`51`	`51`	`if err != nil {`
`52`	`52`	`return nil, nil, nil, fmt.Errorf("API key verification failed: %w", err)`
`53`	`53`	`}`
Original file line number	Diff line number	Diff line change
`@@ -9,11 +9,11 @@ import (`
`9`	`9`	`)`
`10`	`10`
`11`	`11`	`func runContactPropertiesList(cfg *config.Config, customOnly bool) ([]api.ContactProperty, error) {`
`12`		`- return api.NewClient(cfg.EndpointURL, cfg.APIKey).ListContactProperties(customOnly)`
	`12`	`+ return api.NewClient(cfg.EndpointURL, cfg.APIKey, cfg.Debug).ListContactProperties(customOnly)`
`13`	`13`	`}`
`14`	`14`
`15`	`15`	`func runContactPropertiesCreate(cfg *config.Config, name, propType string) error {`
`16`		`- return api.NewClient(cfg.EndpointURL, cfg.APIKey).CreateContactProperty(name, propType)`
	`16`	`+ return api.NewClient(cfg.EndpointURL, cfg.APIKey, cfg.Debug).CreateContactProperty(name, propType)`
`17`	`17`	`}`
`18`	`18`
`19`	`19`	`var contactPropertiesCmd = &cobra.Command{`
Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ func parseMailingLists(pairs []string) (map[string]bool, error) {`
`35`	`35`	`}`
`36`	`36`
`37`	`37`	`func runEventsSend(cfg *config.Config, req api.SendEventRequest) error {`
`38`		`- return api.NewClient(cfg.EndpointURL, cfg.APIKey).SendEvent(req)`
	`38`	`+ return api.NewClient(cfg.EndpointURL, cfg.APIKey, cfg.Debug).SendEvent(req)`
`39`	`39`	`}`
`40`	`40`
`41`	`41`	`var eventsCmd = &cobra.Command{`
Original file line number	Diff line number	Diff line change
`@@ -64,7 +64,7 @@ func attachmentFromPath(path string) (api.Attachment, error) {`
`64`	`64`	`}`
`65`	`65`
`66`	`66`	`func runTransactionalList(cfg *config.Config, params api.PaginationParams) ([]api.TransactionalEmail, error) {`
`67`		`- client := api.NewClient(cfg.EndpointURL, cfg.APIKey)`
	`67`	`+ client := api.NewClient(cfg.EndpointURL, cfg.APIKey, cfg.Debug)`
`68`	`68`	`if params.Cursor != "" {`
`69`	`69`	`emails, _, err := client.ListTransactional(params)`
`70`	`70`	`return emails, err`
`@@ -78,7 +78,7 @@ func runTransactionalList(cfg *config.Config, params api.PaginationParams) ([]ap`
`78`	`78`	`}`
`79`	`79`
`80`	`80`	`func runTransactionalSend(cfg *config.Config, req api.SendTransactionalRequest) error {`
`81`		`- return api.NewClient(cfg.EndpointURL, cfg.APIKey).SendTransactional(req)`
	`81`	`+ return api.NewClient(cfg.EndpointURL, cfg.APIKey, cfg.Debug).SendTransactional(req)`
`82`	`82`	`}`
`83`	`83`
`84`	`84`	`var transactionalCmd = &cobra.Command{`