README
¶
Order integration reference
This package demonstrates business-transaction safety around Webhook Redrive. It is source to adapt inside your application, not another required service.
Createcommits an order and immutable outbox bytes together.NewPublisherandPublishOnesubmit pending rows with a stable idempotency key and persist acceptance.Receiververifies signatures, then commits a business receipt and order-total update together.ReceiverWithKeysaccepts old and new keys during a coordinated signing rotation. Follow the retirement procedure before removing the old key.
Use a dedicated schema for schema.sql. Credentials stay outside the outbox. The API principal must have ingest; endpoint registration is a separate administrative step.
Run the complete producer-to-receiver demo from the repository root with a local TEST_DATABASE_URL:
go test -race -count=1 -v ./internal/integration -run '^TestOutboxToReceiverDemo$'
The integration guide covers setup, blocked outbox rows, credential rotation, receipt retention, and the wire format. The demo asserts one business action after duplicate delivery; it does not promise exactly-once external side effects.
Documentation
¶
Overview ¶
Package orders is a reference integration, not a service dependency or SDK.
Index ¶
- Variables
- func Create(ctx context.Context, pool *pgxpool.Pool, event Created, endpointID string, ...) error
- func Receiver(pool *pgxpool.Pool, secret []byte, now func() time.Time) http.Handler
- func ReceiverWithKeys(pool *pgxpool.Pool, keys [][]byte, now func() time.Time) http.Handler
- type Created
- type Publisher
Constants ¶
This section is empty.
Variables ¶
var ErrBusinessConflict = errors.New("business event identity conflicts with processed body")
var ErrPublish = errors.New("outbox submission not acknowledged")
var Schema string
Schema belongs to the example application, never the delivery schema.
Functions ¶
func Create ¶
func Create(ctx context.Context, pool *pgxpool.Pool, event Created, endpointID string, now time.Time) error
Create commits the business change and immutable outgoing bytes together. Generate the two UUIDs once before calling; persist no credentials in outbox.
Types ¶
type Publisher ¶
type Publisher struct {
// contains filtered or unexported fields
}
func NewPublisher ¶
NewPublisher accepts a deployment-controlled API origin, never event input. Call PublishOne periodically. A five-second persisted delay bounds retries.
func (*Publisher) PublishOne ¶
PublishOne sends one pending row without holding a transaction across HTTP. Concurrent publishers can submit the same row: API idempotency makes that safe. This deliberately favors a small reference over a second queue engine.
Source Files