docs: fix README + examples/service inconsistencies (RUK-136) - #19
Merged
Conversation
Three small papercuts found in TD-6 audit: - README's "Task Healer" section claimed the healer is registered by `internal.NewGoque()` — that's a private package no consumer can import. The actual public constructor is `goque.NewGoque()`, which is what the quick-start code blocks already use. Aligned the prose with reality. - examples/service ValidateTaskType switch was missing TaskTypeOrderConfirmation, added by the outbox demo. The outbox handler bypasses the validator so nothing was broken in practice, but a user POSTing to /api/tasks with this type would get "invalid task type" — example code should be exemplary, fixed. - examples/service/internal/worker/generate_test.go is a load generator that POSTs 1000 tasks to localhost:8080 — running it through plain `go test ./...` always fails because no server is up. Moved behind `//go:build loadtest` so it's opt-in: `go test -tags=loadtest ./examples/service/internal/worker/`. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Three small papercuts found in TD-6 audit:
README's "Task Healer" section claimed the healer is registered
by
internal.NewGoque()— that's a private package no consumercan import. The actual public constructor is
goque.NewGoque(),which is what the quick-start code blocks already use. Aligned
the prose with reality.
examples/service ValidateTaskType switch was missing
TaskTypeOrderConfirmation, added by the outbox demo. The
outbox handler bypasses the validator so nothing was broken
in practice, but a user POSTing to /api/tasks with this type
would get "invalid task type" — example code should be
exemplary, fixed.
examples/service/internal/worker/generate_test.go is a load
generator that POSTs 1000 tasks to localhost:8080 — running
it through plain
go test ./...always fails because noserver is up. Moved behind
//go:build loadtestso it'sopt-in:
go test -tags=loadtest ./examples/service/internal/worker/.Co-Authored-By: Claude Opus 4.7 noreply@anthropic.com