diff --git a/.beads/issues.jsonl b/.beads/issues.jsonl index c86ed13..3514b67 100644 --- a/.beads/issues.jsonl +++ b/.beads/issues.jsonl @@ -13,6 +13,7 @@ {"id":"checkvist-api-8q3","title":"Set up Mage build targets","description":"Create magefiles/magefile.go with:\n- Test() - run go test -v ./...\n- Coverage() - run go test -coverprofile=coverage.out ./...\n- Lint() - run staticcheck ./...\n- Fmt() - run gofmt -w .\n- Check() - run all quality checks (fmt, vet, staticcheck, test)\nEnsure magefiles has its own go.mod importing magefile.org/mage","status":"closed","priority":0,"issue_type":"task","owner":"mail@oliverjakoubek.de","created_at":"2026-01-14T12:31:09.228450637+01:00","created_by":"Oliver Jakoubek","updated_at":"2026-01-14T13:33:08.511791793+01:00","closed_at":"2026-01-14T13:33:08.511791793+01:00","close_reason":"Closed","dependencies":[{"issue_id":"checkvist-api-8q3","depends_on_id":"checkvist-api-5wr","type":"blocks","created_at":"2026-01-14T12:32:48.556022687+01:00","created_by":"Oliver Jakoubek"}]} {"id":"checkvist-api-8u6","title":"Implement HTTP request helper with retry logic","description":"Add internal HTTP helper to client.go:\n- doRequest(ctx, method, path, body) helper for all API calls\n- Automatic authentication check before requests\n- JSON marshaling/unmarshaling\n- Exponential backoff retry for:\n - HTTP 429 (Too Many Requests)\n - HTTP 5xx (Server Errors)\n - Network errors (timeout, connection reset)\n- Respect context cancellation\n- Optional debug logging of requests/responses via slog","status":"closed","priority":0,"issue_type":"task","owner":"mail@oliverjakoubek.de","created_at":"2026-01-14T12:31:08.780244392+01:00","created_by":"Oliver Jakoubek","updated_at":"2026-01-14T13:27:52.914675409+01:00","closed_at":"2026-01-14T13:27:52.914675409+01:00","close_reason":"Closed","dependencies":[{"issue_id":"checkvist-api-8u6","depends_on_id":"checkvist-api-ymg","type":"blocks","created_at":"2026-01-14T12:32:47.973194416+01:00","created_by":"Oliver Jakoubek"},{"issue_id":"checkvist-api-8u6","depends_on_id":"checkvist-api-mnh","type":"blocks","created_at":"2026-01-14T12:32:48.268500727+01:00","created_by":"Oliver Jakoubek"}]} {"id":"checkvist-api-93m","title":"Create CHANGELOG","description":"Create CHANGELOG.md following Keep a Changelog format:\n- [Unreleased] section for ongoing work\n- Initial release preparation notes\n- Document all features implemented","status":"closed","priority":0,"issue_type":"task","owner":"mail@oliverjakoubek.de","created_at":"2026-01-14T12:31:39.009748936+01:00","created_by":"Oliver Jakoubek","updated_at":"2026-01-14T13:37:00.644317886+01:00","closed_at":"2026-01-14T13:37:00.644317886+01:00","close_reason":"Closed"} +{"id":"checkvist-api-awg","title":"Fix Notes.Create API parameter format","description":"## Problem\n\nThe `NoteService.Create` method fails with a 400 Bad Request error:\n\n```\ncheckvist API error (status 400): {\"message\":\"comment[comment] parameter is required\"}\n```\n\n## Root Cause\n\nThe Checkvist API expects nested parameters in the format `comment[comment]`, but the current implementation sends a flat JSON structure:\n\n**Current (incorrect):**\n```json\n{\"comment\": \"Note text\"}\n```\n\n**Expected by API:**\n```json\n{\"comment\": {\"comment\": \"Note text\"}}\n```\n\n## Affected Code\n\n`notes.go` lines 37-51:\n```go\ntype createNoteRequest struct {\n Comment string `json:\"comment\"`\n}\n\nfunc (s *NoteService) Create(ctx context.Context, comment string) (*Note, error) {\n path := fmt.Sprintf(\"/checklists/%d/tasks/%d/comments.json\", s.checklistID, s.taskID)\n body := createNoteRequest{Comment: comment}\n // ...\n}\n```\n\n## Solution\n\nChange `createNoteRequest` to use nested structure:\n\n```go\ntype createNoteRequest struct {\n Comment struct {\n Comment string `json:\"comment\"`\n } `json:\"comment\"`\n}\n```\n\nOr create a wrapper struct for clarity.\n\n## Likely Affected Methods\n\n- `NoteService.Create` - confirmed broken\n- `NoteService.Update` - likely same issue (uses `updateNoteRequest`)\n\n## Reproduction\n\n```go\nnote, err := client.Notes(checklistID, taskID).Create(ctx, \"Test note\")\n// Returns: API error 400, \"comment[comment] parameter is required\"\n```","status":"open","priority":1,"issue_type":"bug","owner":"mail@oliverjakoubek.de","created_at":"2026-01-14T18:12:27.03448075+01:00","created_by":"Oliver Jakoubek","updated_at":"2026-01-14T18:12:27.03448075+01:00"} {"id":"checkvist-api-bbx","title":"Write unit tests for Notes","description":"Create notes_test.go with tests:\n- TestNotes_List\n- TestNotes_Create\n- TestNotes_Update\n- TestNotes_Delete\nUse table-driven tests. Create testdata/notes/ fixtures.","status":"closed","priority":0,"issue_type":"task","owner":"mail@oliverjakoubek.de","created_at":"2026-01-14T12:31:37.829382141+01:00","created_by":"Oliver Jakoubek","updated_at":"2026-01-14T13:47:17.141162679+01:00","closed_at":"2026-01-14T13:47:17.141162679+01:00","close_reason":"Closed","dependencies":[{"issue_id":"checkvist-api-bbx","depends_on_id":"checkvist-api-5ab","type":"blocks","created_at":"2026-01-14T12:33:14.119755191+01:00","created_by":"Oliver Jakoubek"}]} {"id":"checkvist-api-br3","title":"Core API Operations","description":"Phase 2: Implement CRUD operations for Checklists, Tasks, and Notes. All P0 (must-have) features for the library.","status":"closed","priority":0,"issue_type":"epic","owner":"mail@oliverjakoubek.de","created_at":"2026-01-14T12:30:53.20627925+01:00","created_by":"Oliver Jakoubek","updated_at":"2026-01-14T14:29:26.991139668+01:00","closed_at":"2026-01-14T14:29:26.991139668+01:00","close_reason":"Alle zugehörigen Tasks abgeschlossen"} {"id":"checkvist-api-c2k","title":"Implement Checklist operations","description":"Create checklists.go with ChecklistService:\n- client.Checklists() returns ChecklistService\n- List(ctx) ([]Checklist, error) - GET /checklists.json\n- Get(ctx, id) (*Checklist, error) - GET /checklists/{id}.json\n- Create(ctx, name) (*Checklist, error) - POST /checklists.json\n- Update(ctx, id, name) (*Checklist, error) - PUT /checklists/{id}.json\n- Delete(ctx, id) error - DELETE /checklists/{id}.json\n- Support archived filter in List\nContext support for all methods.","status":"closed","priority":0,"issue_type":"feature","owner":"mail@oliverjakoubek.de","created_at":"2026-01-14T12:30:53.566197933+01:00","created_by":"Oliver Jakoubek","updated_at":"2026-01-14T13:38:06.162666425+01:00","closed_at":"2026-01-14T13:38:06.162666425+01:00","close_reason":"Closed","dependencies":[{"issue_id":"checkvist-api-c2k","depends_on_id":"checkvist-api-8u6","type":"blocks","created_at":"2026-01-14T12:32:54.533462004+01:00","created_by":"Oliver Jakoubek"},{"issue_id":"checkvist-api-c2k","depends_on_id":"checkvist-api-lpn","type":"blocks","created_at":"2026-01-14T12:32:54.859645166+01:00","created_by":"Oliver Jakoubek"}]} diff --git a/notes_test.go b/notes_test.go index 7167a2b..70877e0 100644 --- a/notes_test.go +++ b/notes_test.go @@ -170,3 +170,157 @@ func TestNotes_Delete(t *testing.T) { t.Error("expected DELETE to be called") } } + +// TestNotes_Create_RealAPIFormat tests that the client sends the correct +// nested parameter format expected by the real Checkvist API. +// The API expects: {"comment": {"comment": "text"}} +// Not the flat format: {"comment": "text"} +// +// This test documents the current FAILING behavior - it should pass once +// the parameter format is fixed. +func TestNotes_Create_RealAPIFormat(t *testing.T) { + server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + w.Header().Set("Content-Type", "application/json") + + switch r.URL.Path { + case "/auth/login.json": + json.NewEncoder(w).Encode(map[string]string{"token": "test-token"}) + case "/checklists/1/tasks/101/comments.json": + if r.Method != http.MethodPost { + t.Errorf("expected POST, got %s", r.Method) + } + + // Parse the request body as raw JSON to check structure + var rawBody map[string]interface{} + if err := json.NewDecoder(r.Body).Decode(&rawBody); err != nil { + t.Fatalf("failed to decode request: %v", err) + } + + // The real API expects nested format: {"comment": {"comment": "text"}} + commentField, ok := rawBody["comment"] + if !ok { + w.WriteHeader(http.StatusBadRequest) + w.Write([]byte(`{"message":"comment[comment] parameter is required"}`)) + return + } + + // Check if it's the nested format (map) or flat format (string) + switch v := commentField.(type) { + case map[string]interface{}: + // Correct nested format: {"comment": {"comment": "text"}} + innerComment, ok := v["comment"].(string) + if !ok || innerComment == "" { + w.WriteHeader(http.StatusBadRequest) + w.Write([]byte(`{"message":"comment[comment] parameter is required"}`)) + return + } + // Success - return created note + response := Note{ + ID: 600, + TaskID: 101, + Comment: innerComment, + CreatedAt: NewAPITime(time.Now()), + UpdatedAt: NewAPITime(time.Now()), + } + json.NewEncoder(w).Encode(response) + case string: + // Wrong flat format: {"comment": "text"} - this is what the current code sends + w.WriteHeader(http.StatusBadRequest) + w.Write([]byte(`{"message":"comment[comment] parameter is required"}`)) + default: + w.WriteHeader(http.StatusBadRequest) + w.Write([]byte(`{"message":"comment[comment] parameter is required"}`)) + } + default: + t.Errorf("unexpected path: %s", r.URL.Path) + } + })) + defer server.Close() + + client := NewClient("user@example.com", "api-key", WithBaseURL(server.URL)) + note, err := client.Notes(1, 101).Create(context.Background(), "Test note content") + + // Currently this FAILS because the code sends flat format {"comment": "text"} + // but the API expects nested format {"comment": {"comment": "text"}} + if err != nil { + if apiErr, ok := err.(*APIError); ok && apiErr.StatusCode == 400 { + t.Skipf("KNOWN BUG: Notes.Create sends wrong parameter format: %v", err) + } + t.Fatalf("unexpected error: %v", err) + } + + if note.ID != 600 { + t.Errorf("expected ID 600, got %d", note.ID) + } + if note.Comment != "Test note content" { + t.Errorf("expected comment 'Test note content', got %s", note.Comment) + } +} + +// TestNotes_Update_RealAPIFormat tests that Update also uses the correct nested format. +func TestNotes_Update_RealAPIFormat(t *testing.T) { + server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + w.Header().Set("Content-Type", "application/json") + + switch r.URL.Path { + case "/auth/login.json": + json.NewEncoder(w).Encode(map[string]string{"token": "test-token"}) + case "/checklists/1/tasks/101/comments/501.json": + if r.Method != http.MethodPut { + t.Errorf("expected PUT, got %s", r.Method) + } + + var rawBody map[string]interface{} + if err := json.NewDecoder(r.Body).Decode(&rawBody); err != nil { + t.Fatalf("failed to decode request: %v", err) + } + + commentField, ok := rawBody["comment"] + if !ok { + w.WriteHeader(http.StatusBadRequest) + w.Write([]byte(`{"message":"comment[comment] parameter is required"}`)) + return + } + + switch v := commentField.(type) { + case map[string]interface{}: + innerComment, ok := v["comment"].(string) + if !ok || innerComment == "" { + w.WriteHeader(http.StatusBadRequest) + w.Write([]byte(`{"message":"comment[comment] parameter is required"}`)) + return + } + response := Note{ + ID: 501, + TaskID: 101, + Comment: innerComment, + UpdatedAt: NewAPITime(time.Now()), + } + json.NewEncoder(w).Encode(response) + case string: + w.WriteHeader(http.StatusBadRequest) + w.Write([]byte(`{"message":"comment[comment] parameter is required"}`)) + default: + w.WriteHeader(http.StatusBadRequest) + w.Write([]byte(`{"message":"comment[comment] parameter is required"}`)) + } + default: + t.Errorf("unexpected path: %s", r.URL.Path) + } + })) + defer server.Close() + + client := NewClient("user@example.com", "api-key", WithBaseURL(server.URL)) + note, err := client.Notes(1, 101).Update(context.Background(), 501, "Updated content") + + if err != nil { + if apiErr, ok := err.(*APIError); ok && apiErr.StatusCode == 400 { + t.Skipf("KNOWN BUG: Notes.Update sends wrong parameter format: %v", err) + } + t.Fatalf("unexpected error: %v", err) + } + + if note.Comment != "Updated content" { + t.Errorf("expected comment 'Updated content', got %s", note.Comment) + } +}