Skip to content

docs(integrations): rewrite go-integration.md for gRPC streams#604

Merged
osvaldoandrade merged 1 commit into
mainfrom
docs/go-integration-grpc-rewrite
May 18, 2026
Merged

docs(integrations): rewrite go-integration.md for gRPC streams#604
osvaldoandrade merged 1 commit into
mainfrom
docs/go-integration-grpc-rewrite

Conversation

@osvaldoandrade

Copy link
Copy Markdown
Owner

Summary

Rewrites docs/integrations/go-integration.md to use the official gRPC streaming clients (pkg/producerclient + pkg/workerclient) instead of the deleted REST sdks/go client.

Why

PR #600 deleted sdks/go/ (REST-based Go SDK). This integration guide was the last surviving doc that still referenced the deleted import path github.com/osvaldoandrade/codeq/sdks/go and its NewClient/CreateTask/ClaimTask/SubmitResult API. PR #603 (U7 docs surgery) flagged it as out-of-scope follow-up.

Changes

  • Architecture diagram: HTTP → gRPC streams on :9091 / :9092.
  • Installation: go get github.com/osvaldoandrade/codeq (no separate sub-module).
  • Producer examples (stdlib + Gin): producerclient.NewConnectProduce with copy-pasteable handlers.
  • Worker examples (basic + batched): workerclient.NewRun(ctx, handler) returning Completed / Failed / Nack / Abandon.
  • Best practices: share one Client per process, Result constructor reference table, Concurrency + BatchSize tuning guidance, producer pipelining note.
  • Troubleshooting: gRPC-specific errors (connection refused on :9092, hello rejection, context deadline, idle worker diagnostics).

Test plan

  • grep -nE 'sdks/(go|java|python|nodejs)|NewClient\b|ClaimTask\b|SubmitResult\b' — no hits
  • go build ./... — clean
  • Visual review of code snippets against pkg/producerclient/client.go and pkg/workerclient/client.go API surface

Merge order

Independent of PRs #596-#603. Can merge any time after #600 (which deletes sdks/go/).

🤖 Generated with Claude Code

The previous version documented the REST-based sdks/go client that
PR #600 deleted. Rewritten to use the official gRPC clients:
pkg/producerclient (Connect → Produce per session) and pkg/workerclient
(Run with Handler returning Completed/Failed/Nack/Abandon).

Sections preserved: stdlib HTTP, Gin, dedicated worker process, best
practices, troubleshooting. Code examples are now copy-paste-runnable
against the current API surface.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@osvaldoandrade osvaldoandrade merged commit 41812fe into main May 18, 2026
@osvaldoandrade osvaldoandrade deleted the docs/go-integration-grpc-rewrite branch May 18, 2026 19:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant