Sebuf

Phase 3 Plan 3: Go Client Consistency Audit Summary

Go client verified consistent with HTTP server across query encoding, Content-Type, error handling, path params, headers, and unwrap serialization - added golden file coverage for complex features

Performance#

  • Duration: 3 min
  • Started: 2026-02-05T21:13:37Z
  • Completed: 2026-02-05T21:16:11Z
  • Tasks: 2
  • Files modified: 5 (2 symlinks, 2 golden files, 1 test file)

Accomplishments#

  • Added symlinked test protos for unwrap.proto and complex_features.proto in clientgen testdata
  • Generated golden files for all unwrap variants (root map, root repeated, map-value, combined)
  • Completed systematic audit of Go client vs server for 6 key consistency areas
  • Verified all query parameter scalar types roundtrip correctly
  • Confirmed error handling, Content-Type handling, and header handling match server expectations

Task Commits#

Each task was committed atomically:

  1. Task 1: Add missing test proto coverage for Go client - 569f9d3 (feat)
  2. Task 2: Audit and fix Go client consistency with server - No commit (audit verified consistency, no changes needed)

Plan metadata: Pending

Files Created/Modified#

  • internal/clientgen/testdata/proto/unwrap.proto - Symlink to shared unwrap test proto
  • internal/clientgen/testdata/proto/complex_features.proto - Symlink to tsclientgen complex features proto
  • internal/clientgen/testdata/golden/unwrap_client.pb.go - Golden file for unwrap client generation
  • internal/clientgen/testdata/golden/complex_features_client.pb.go - Golden file for complex features client
  • internal/clientgen/golden_test.go - Added test cases for new protos

Decisions Made#

D-03-03-01: Go client already consistent with server - no fixes needed

Systematic audit of 6 areas found complete consistency:

  1. Query param encoding: fmt.Sprint() output is parseable by server's strconv.Parse* functions
  2. Content-Type handling: Both default to JSON for unknown types, matching the 03-02 server fix
  3. Error handling: Client parses ValidationError (400) and Error (other) exactly as server produces
  4. Path param encoding: url.PathEscape() is correct for URL path segments
  5. Header handling: Header names match, HTTP lookup is case-insensitive as expected
  6. Response deserialization: Both use json.Marshaler/Unmarshaler for unwrap, protojson/proto otherwise

Deviations from Plan#

None - plan executed exactly as written. The audit task was designed to find and fix inconsistencies, but none were found.

Issues Encountered#

None - the Go client generator was already correctly implemented and consistent with the HTTP server.

Next Phase Readiness#

  • Go client fully verified as reference implementation
  • TypeScript client review (plan 03-04) can proceed using Go client as consistency target
  • OpenAPI review (plan 03-05/06) can proceed with confidence in server serialization

Phase: 03-existing-client-review Completed: 2026-02-05