platform-go

module
v9.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 2, 2026 License: AGPL-3.0

README

platform-go

Go Reference codecov

A Go library providing infrastructure abstractions for cloud-native services. Each package defines a stable interface with one or more provider implementations, selected at runtime via config. Layers that touch the network — HTTP, gRPC, database, messaging — instrument with OpenTelemetry.

Module: github.com/primandproper/platform-go/v9 Go: 1.26

Project Status & Stability

main is not a release channel. Anything on main that has not been cut into a tagged release is considered under active development — alpha/beta, unstable, and unsupported. Treat it as such.

This repository follows a deliberately conservative release model:

  • Only tagged releases are supported. If it isn't behind a version tag, it can change or break without notice, and no support or compatibility is promised for it.
  • main moves ahead of the latest release. New work — including breaking changes — lands on main well before it is deemed release-worthy. The current major module path is /v9, and the latest supported release is v8.0.0. /v9 is unreleased: everything on main is subject to change until it is tagged.
  • Semantic Versioning, enforced by Go's module paths. Breaking changes increment the major version and the module import path (/v8 → /v9), so a major bump can never silently break a consumer that hasn't opted in.
  • No stability guarantees on unreleased APIs. Interfaces, config shapes, and package boundaries on main are subject to change until they ship in a release.

If you depend on this library, pin to a released tag. If you want to track upcoming work, main is fair game — just don't expect it to hold still.

Installation

go get github.com/primandproper/platform-go/v9@latest

Because breaking changes ride the major-version import path, upgrading across majors is an explicit, opt-in edit to your import paths — never a surprise from go get -u.

Design Patterns

Interface + implementations. Every major concern is defined as an interface (e.g., cache.Cache[T], logging.Logger, secrets.SecretSource), with provider implementations in subpackages. Swap implementations via config without touching call sites. Most packages ship a noop implementation for tests and for cleanly disabling a concern.

Config structs. Each package has a config subpackage with env:-tagged structs and ValidateWithContext() (via go-ozzo/ozzo-validation). Configuration is the seam that selects an implementation. Most, but not all, also have EnsureDefaults() — packages whose defaults are expressible as envDefault: tags use those instead.

Selecting an implementation is deliberate: an unrecognized provider name returns errors.ErrUnknownProvider rather than a working-looking noop, because a typo that silently discards every message or never limits a request is a production incident that looks like a healthy process. Where a noop is genuinely wanted it has to be asked for by name.

OpenTelemetry throughout. HTTP, gRPC, database, and messaging layers emit traces and metrics. Observability primitives (logging, tracing, metrics, profiling) live under observability/.

Error handling. Uses cockroachdb/errors for rich, wrapped error context. Platform-level sentinel errors live in errors/, conventionally imported as platformerrors. Transport mappings live in errors/http and errors/grpc, which import the packages whose sentinels they map — so nothing in those packages may import them back.

Package Catalog

Implementations are listed in parentheses; most concerns also provide a noop.

Data & storage
Package Purpose Implementations
database SQL access + instrumentation postgres, mysql, sqlite
cache Generic key/value cache (Cache[T]) redis, memory
uploads Blob/object storage & image handling objectstorage (S3-compatible), images
files Filesystem & streaming helpers —
secrets Secret sourcing env, gcp, ssm, kubernetes
Messaging & events
Package Purpose Implementations
messagequeue Publish/subscribe & queues kafka, pubsub, redis, sqs
outbox Transactional outbox postgres, mysql, sqlite
eventstream Server push to clients sse, websocket
notifications User notifications async, mobile
jobs Queue workers & periodic jobs —
email Transactional email mailgun, mailjet, postmark, resend, sendgrid, ses
Web & transport
Package Purpose Implementations
server Service servers grpc, http
routing HTTP router abstraction chi, stdlib, httprouter, gin
httpclient Instrumented HTTP client —
cookies Cookie management —
encoding Content encoding/decoding —
compression Payload compression —
ratelimiting Request rate limiting redis
circuitbreaking Circuit breaker —
retry Retry with backoff —
idempotency At-most-once effect for retried requests http, grpc (server + client)
Observability & operations
Package Purpose Implementations
observability Logging, tracing, metrics, profiling logging (slog, zap, zerolog); OTel tracing/metrics
healthcheck Health/readiness checks —
version Build/version metadata —
metering Durable usage metering & quotas postgres, mysql, sqlite
webhooks Outbound webhook delivery postgres, mysql, sqlite
clock Injectable time —
config Config loading & env parsing —
Auth & security
Package Purpose Implementations
authentication Password hashing, TOTP, tokens argon2, totp, tokens
authorization Role/permission policy, enforcement static (default), database
audit Tamper-evident audit log postgres, mysql, sqlite
cryptography Cryptographic primitives —
random Secure randomness —
identifiers ID generation —
dataprivacy Subject access & erasure requests postgres, mysql, sqlite
AI, ML & product
Package Purpose Implementations
llm Large language model clients anthropic, openai
embeddings Embedding generation —
search Vector / text search vector, text
analytics Product analytics posthog, segment, multisource
featureflags Feature flagging launchdarkly, posthog
Domain & coordination
Package Purpose Implementations
capitalism Payments stripe
saga Linear durable sagas with compensations postgres, mysql, sqlite
distributedlock Distributed locking memory, postgres, redis
filtering Query filters / pagination —
qrcodes QR code generation —
artifacts Artifact handling —
eventcapture Recording domain events —
Utilities

errors, pointer, numbers, bitmask, reflection, panicking, testutils, fake.

Development

make setup          # Install dev tools and vendor deps
make format         # Format all Go code (imports, field/tag alignment, gofmt)
make lint           # Run golangci-lint (Docker) + shellcheck
make test           # Run tests (race detector, shuffle, failfast)
make build          # Build all packages
make generate       # Regenerate moq mocks after changing a mocked interface
make bench          # Run benchmarks
make revendor       # Clean and re-vendor dependencies

Formatting runs locally with gci, goimports, betteralign, tagalign, and gofmt. Linting runs in Docker against the golangci/golangci-lint image (42+ linters, golangci-lint v2 format).

Testing conventions
  • stretchr/testify is banned (assert, require, and mock), enforced by depguard. Use shoenig/test for assertions (test for non-fatal, must for fatal) and matryer/moq for mocks.
  • Tests run in parallel by default and use subtests throughout.
  • Container-backed tests use testcontainers-go, live in-package (typically containers_test.go), and gate on RUN_CONTAINER_TESTS=true.
  • make test runs CGO_ENABLED=1 go test -shuffle=on -race -vet=all -failfast ./... across every package. .scripts/test.sh false runs the suite without container tests.

Contributing

Because main is a development channel and only tagged releases are supported, changes land on main freely and are stabilized before release. Follow the existing package layout (interface + config subpackage + provider implementations + noop), match the surrounding code, and keep make format lint test green.

Directories

Path Synopsis
Package analytics provides an event reporting interface for collecting and tracking customer data and events.
 Package analytics provides an event reporting interface for collecting and tracking customer data and events.
config
mock
Package analyticsmock provides moq-generated mocks for the analytics package.
 Package analyticsmock provides moq-generated mocks for the analytics package.
multisource
noop
posthog
segment
Package audit is the durable, queryable, tamper-evident record of who did what to which resource.
 Package audit is the durable, queryable, tamper-evident record of who did what to which resource.
config
Package auditcfg assembles the audit log from environment configuration: the Recorder applications write through, the Reader they query and verify with, and the Sweeper that enforces retention.
 Package auditcfg assembles the audit log from environment configuration: the Recorder applications write through, the Reader they query and verify with, and the Sweeper that enforces retention.
migrations
Package migrations supplies the audit tables' DDL, rendered for a dialect and table prefix.
 Package migrations supplies the audit tables' DDL, rendered for a dialect and table prefix.
mock
Package auditmock provides moq-generated mock implementations of interfaces in the audit package.
 Package auditmock provides moq-generated mock implementations of interfaces in the audit package.
Package authentication defines interfaces for password hashing and credential verification.
 Package authentication defines interfaces for password hashing and credential verification.
argon2
tokens
tokens/config
tokens/jwt
tokens/mock
Package tokensmock provides moq-generated mock implementations of interfaces in the tokens package.
 Package tokensmock provides moq-generated mock implementations of interfaces in the tokens package.
tokens/paseto
totp
Package totp provides a TOTP (RFC 6238) second-factor verifier.
 Package totp provides a TOTP (RFC 6238) second-factor verifier.
totp/mock
Package totpmock provides moq-generated mock implementations of interfaces in the totp package.
 Package totpmock provides moq-generated mock implementations of interfaces in the totp package.
Package authorization answers "may this principal do this thing".
 Package authorization answers "may this principal do this thing".
cached
Package cached wraps any authorization.PolicyResolver in a cache.
 Package cached wraps any authorization.PolicyResolver in a cache.
config
Package authorizationcfg selects and builds an authorization.PolicyResolver from configuration.
 Package authorizationcfg selects and builds an authorization.PolicyResolver from configuration.
database
Package database stores authorization policy in SQL tables.
 Package database stores authorization policy in SQL tables.
database/migrations
Package migrations supplies the authorization policy tables' DDL, rendered for a dialect and table prefix.
 Package migrations supplies the authorization policy tables' DDL, rendered for a dialect and table prefix.
grpc
Package grpc enforces authorization on gRPC methods.
 Package grpc enforces authorization on gRPC methods.
http
Package http enforces authorization on HTTP routes.
 Package http enforces authorization on HTTP routes.
mock
Package authorizationmock provides moq-generated mock implementations of interfaces in the authorization package.
 Package authorizationmock provides moq-generated mock implementations of interfaces in the authorization package.
static
Package static provides an authorization.PolicyResolver whose policy is fixed at construction.
 Package static provides an authorization.PolicyResolver whose policy is fixed at construction.
Package bitmask provides a generic, immutable bitmask type with set operations for unsigned integer types.
 Package bitmask provides a generic, immutable bitmask type with set operations for unsigned integer types.
Package cache provides a generic caching interface with support for multiple backend implementations including Redis and in-memory stores.
 Package cache provides a generic caching interface with support for multiple backend implementations including Redis and in-memory stores.
config
memory
mock
Package cachemock provides moq-generated mock implementations of interfaces in the cache package.
 Package cachemock provides moq-generated mock implementations of interfaces in the cache package.
noop
redis
redis/slots
Package slots produces Redis Cluster keys whose slots are pre-planned to distribute evenly across the cluster's nodes.
 Package slots produces Redis Cluster keys whose slots are pre-planned to distribute evenly across the cluster's nodes.
Package capitalism provides a payment management interface for handling subscription plans and payment provider webhooks.
 Package capitalism provides a payment management interface for handling subscription plans and payment provider webhooks.
config
mock
Package capitalismmock provides mock implementations of the capitalism package's interfaces.
 Package capitalismmock provides mock implementations of the capitalism package's interfaces.
noop
stripe
Package stripe provides Stripe functionality.
 Package stripe provides Stripe functionality.
Package circuitbreaking implements the circuit breaker pattern for managing service availability and preventing cascading failures.
 Package circuitbreaking implements the circuit breaker pattern for managing service availability and preventing cascading failures.
config
mock
Package circuitbreakingmock provides moq-generated mock implementations of the circuitbreaking package's interfaces.
 Package circuitbreakingmock provides moq-generated mock implementations of the circuitbreaking package's interfaces.
noop
partitioned
Package partitioned provides a circuit breaker that is partitioned by key.
 Package partitioned provides a circuit breaker that is partitioned by key.
partitioned/config
partitioned/mock
Package partitionedmock provides a moq-generated mock implementation of the partitioned package's KeyedCircuitBreaker interface.
 Package partitionedmock provides a moq-generated mock implementation of the partitioned package's KeyedCircuitBreaker interface.
partitioned/noop
Package clock provides an injectable source of time so components that stamp, pace, or schedule work can be tested deterministically.
 Package clock provides an injectable source of time so components that stamp, pace, or schedule work can be tested deterministically.
mock
Package clockmock provides moq-generated mock implementations of the clock package's interfaces.
 Package clockmock provides moq-generated mock implementations of the clock package's interfaces.
Package compression provides data compression and decompression using Zstd and S2 algorithms.
 Package compression provides data compression and decompression using Zstd and S2 algorithms.
Package config provides helpers for populating configuration structs from environment variables, .env files, and JSON files.
 Package config provides helpers for populating configuration structs from environment variables, .env files, and JSON files.
config
cryptography
encryption
Package encryption contains the interfaces and implementations for encrypting and decrypting data.
 Package encryption contains the interfaces and implementations for encrypting and decrypting data.
encryption/aes
Package aes contains the interfaces and implementations for encrypting and decrypting data.
 Package aes contains the interfaces and implementations for encrypting and decrypting data.
encryption/config
encryption/mock
Package encryptionmock provides moq-generated mock implementations of the encryption package's interfaces.
 Package encryptionmock provides moq-generated mock implementations of the encryption package's interfaces.
encryption/salsa20
Package salsa20 contains the interfaces and implementations for encrypting and decrypting data.
 Package salsa20 contains the interfaces and implementations for encrypting and decrypting data.
hashing
hashing/adler32
Package adler32 implements hashing.Hasher using the Adler-32 checksum.
 Package adler32 implements hashing.Hasher using the Adler-32 checksum.
hashing/canonical
Package canonical hashes Go values by content, producing the same digest for semantically identical values regardless of which process built them, in what order, or how their types declare fields.
 Package canonical hashes Go values by content, producing the same digest for semantically identical values regardless of which process built them, in what order, or how their types declare fields.
hashing/crc64
Package crc64 implements hashing.Hasher using the CRC-64 (ISO) checksum, and exposes ChecksumISO for callers that want the checksum as the integer it natively is.
 Package crc64 implements hashing.Hasher using the CRC-64 (ISO) checksum, and exposes ChecksumISO for callers that want the checksum as the integer it natively is.
hashing/fnv
Package fnv implements hashing.Hasher using the FNV-1a hash, and exposes Sum64a and Sum128a for callers that want the hash as the integer it natively is.
 Package fnv implements hashing.Hasher using the FNV-1a hash, and exposes Sum64a and Sum128a for callers that want the hash as the integer it natively is.
hashing/hmac
Package hmac provides keyed hashing.Hasher implementations, for the cases where a digest has to prove who computed it rather than only what was computed.
 Package hmac provides keyed hashing.Hasher implementations, for the cases where a digest has to prove who computed it rather than only what was computed.
hashing/sha256
hashing/sha512
Package database provides interface abstractions for interacting with relational data stores
 Package database provides interface abstractions for interacting with relational data stores
config
ddl
Package ddl renders a package's embedded schema against a dialect and a table prefix, and vets the prefix against every identifier the schema would create.
 Package ddl renders a package's embedded schema against a dialect and a table prefix, and vets the prefix against every identifier the schema would create.
dialect
Package dialect names the SQL dialects the module's SQL-emitting packages support, and carries the small helpers every one of them otherwise reimplements: bind-marker rendering, identifier vetting, and DDL statement splitting.
 Package dialect names the SQL dialects the module's SQL-emitting packages support, and carries the small helpers every one of them otherwise reimplements: bind-marker rendering, identifier vetting, and DDL statement splitting.
migrate
Package migrate provides the platform's standard database.Migrator: embedded SQL migrations with the operational discipline consumers otherwise hand-roll — an instance-based provider (no global goose state, so parallel tests never race), and on Postgres a session advisory lock that serializes concurrently booting replicas, with probe timeouts tightened so a waiting replica notices the winner promptly instead of goose's leisurely default.
 Package migrate provides the platform's standard database.Migrator: embedded SQL migrations with the operational discipline consumers otherwise hand-roll — an instance-based provider (no global goose state, so parallel tests never race), and on Postgres a session advisory lock that serializes concurrently booting replicas, with probe timeouts tightened so a waiting replica notices the winner promptly instead of goose's leisurely default.
mock
Package databasemock provides moq-generated mocks for the database package.
 Package databasemock provides moq-generated mocks for the database package.
mysql
Package mysql provides an interface for writing to a MySQL instance.
 Package mysql provides an interface for writing to a MySQL instance.
mysql/tableaccess
postgres
Package postgres provides an interface for writing to a Postgres instance.
 Package postgres provides an interface for writing to a Postgres instance.
postgres/tableaccess
sqlite
Package sqlite provides an interface for writing to a SQLite database.
 Package sqlite provides an interface for writing to a SQLite database.
sqlite/tableaccess
Package dataprivacy fulfills GDPR and CCPA subject access and erasure requests as durable, auditable jobs.
 Package dataprivacy fulfills GDPR and CCPA subject access and erasure requests as durable, auditable jobs.
auditerasure
Package auditerasure supplies a dataprivacy.Eraser for the audit log.
 Package auditerasure supplies a dataprivacy.Eraser for the audit log.
config
Package dataprivacycfg assembles the data privacy machinery from environment configuration: the Store every part shares, the Service applications submit through, the Worker that fulfills, and the Sweeper that expires.
 Package dataprivacycfg assembles the data privacy machinery from environment configuration: the Store every part shares, the Service applications submit through, the Worker that fulfills, and the Sweeper that expires.
migrations
Package migrations supplies the data-privacy request table's DDL, rendered for a dialect and table prefix.
 Package migrations supplies the data-privacy request table's DDL, rendered for a dialect and table prefix.
mock
Package dataprivacymock provides moq-generated mock implementations of interfaces in the dataprivacy package.
 Package dataprivacymock provides moq-generated mock implementations of interfaces in the dataprivacy package.
Package distributedlock provides a pessimistic mutual-exclusion atom for coordinating exclusive access to a named resource across processes.
 Package distributedlock provides a pessimistic mutual-exclusion atom for coordinating exclusive access to a named resource across processes.
config
memory
mock
Package distributedlockmock provides moq-generated mock implementations of the distributedlock package's interfaces.
 Package distributedlockmock provides moq-generated mock implementations of the distributedlock package's interfaces.
noop
postgres
Package postgres implements distributedlock.Locker against PostgreSQL session- scoped advisory locks (pg_try_advisory_lock).
 Package postgres implements distributedlock.Locker against PostgreSQL session- scoped advisory locks (pg_try_advisory_lock).
redis
Package email provides an interface for sending emails, with implementations for Mailgun, Mailjet, Postmark, Resend, and SendGrid.
 Package email provides an interface for sending emails, with implementations for Mailgun, Mailjet, Postmark, Resend, and SendGrid.
config
mailgun
mailjet
mock
Package emailmock provides moq-generated mock implementations of the email package's interfaces.
 Package emailmock provides moq-generated mock implementations of the email package's interfaces.
noop
postmark
resend
sendgrid
ses
Package embeddings provides a vector embedding interface with implementations for OpenAI, Ollama, and Cohere providers.
 Package embeddings provides a vector embedding interface with implementations for OpenAI, Ollama, and Cohere providers.
cohere
config
mock
Package embeddingsmock provides moq-generated mock implementations of the embeddings package's interfaces.
 Package embeddingsmock provides moq-generated mock implementations of the embeddings package's interfaces.
noop
ollama
openai
Package encoding turns values into bytes and back, in a content type chosen by configuration rather than by the call site.
 Package encoding turns values into bytes and back, in a content type chosen by configuration rather than by the call site.
mock
Package encodingmock provides moq-generated mocks for the encoding package.
 Package encodingmock provides moq-generated mocks for the encoding package.
Package errors re-exports cockroachdb/errors utilities and defines platform-level sentinel error values and HTTP/gRPC error conversion helpers.
 Package errors re-exports cockroachdb/errors utilities and defines platform-level sentinel error values and HTTP/gRPC error conversion helpers.
grpc
http
Package eventcapture records high-volume operational events for offline analysis — model training data, usage matrices, replayable traces — without ever slowing the request path that produces them.
 Package eventcapture records high-volume operational events for offline analysis — model training data, usage matrices, replayable traces — without ever slowing the request path that produces them.
jsonl
Package jsonl implements eventcapture.Sink as an append-only, size-rotated, newline-delimited JSON file.
 Package jsonl implements eventcapture.Sink as an append-only, size-rotated, newline-delimited JSON file.
mock
Package eventcapturemock provides moq-generated mock implementations of the eventcapture package's interfaces.
 Package eventcapturemock provides moq-generated mock implementations of the eventcapture package's interfaces.
noop
Package noop provides a no-op eventcapture.Sink, for deployments with capture wired but disabled.
 Package noop provides a no-op eventcapture.Sink, for deployments with capture wired but disabled.
Package eventstream provides event streaming abstractions for server-to-client and bidirectional communication over HTTP, with implementations for SSE and WebSocket.
 Package eventstream provides event streaming abstractions for server-to-client and bidirectional communication over HTTP, with implementations for SSE and WebSocket.
config
noop
sse
websocket
Package fake provides generic test data generation utilities for creating fake instances of any type.
 Package fake provides generic test data generation utilities for creating fake instances of any type.
Package featureflags provides a feature flag evaluation interface for controlling feature availability per user, with implementations for LaunchDarkly and PostHog.
 Package featureflags provides a feature flag evaluation interface for controlling feature availability per user, with implementations for LaunchDarkly and PostHog.
config
launchdarkly
mock
Package featureflagsmock provides mock implementations of the featureflags package's interfaces.
 Package featureflagsmock provides mock implementations of the featureflags package's interfaces.
noop
posthog
Package files provides ergonomic helpers for reading text files: iterating line by line or in fixed-size chunks, streaming chunks asynchronously off large files, slicing a window of lines, and decoding a structured file into a typed value via the encoding package.
 Package files provides ergonomic helpers for reading text files: iterating line by line or in fixed-size chunks, streaming chunks asynchronously off large files, slicing a window of lines, and decoding a structured file into a typed value via the encoding package.
Package healthcheck provides health check monitoring for service components with status tracking and aggregation via a registry pattern.
 Package healthcheck provides health check monitoring for service components with status tracking and aggregation via a registry pattern.
Package httpclient constructs HTTP clients with optional OpenTelemetry tracing instrumentation.
 Package httpclient constructs HTTP clients with optional OpenTelemetry tracing instrumentation.
Package idempotency runs work at most once per client-supplied key.
 Package idempotency runs work at most once per client-supplied key.
config
grpc
Package grpc adapts idempotency to gRPC, on both sides of the wire.
 Package grpc adapts idempotency to gRPC, on both sides of the wire.
http
Package http adapts idempotency to HTTP, on both sides of the wire.
 Package http adapts idempotency to HTTP, on both sides of the wire.
Package identifiers is a handy place to request a new string identifier from.
 Package identifiers is a handy place to request a new string identifier from.
internal
cfgnorm
Package cfgnorm holds the normalization a config performs on itself before its own validation runs.
 Package cfgnorm holds the normalization a config performs on itself before its own validation runs.
cmd/benchtable command
Command benchtable turns raw `go test -bench` output into a markdown reference table.
 Command benchtable turns raw `go test -bench` output into a markdown reference table.
injection
Package injection holds the samber/do helpers shared by this module's do.Provide registrations.
 Package injection holds the samber/do helpers shared by this module's do.Provide registrations.
Package jobs supplies the lifecycle around background work: a bounded pool of workers consuming a queue, and a scheduler that runs periodic work once across a fleet.
 Package jobs supplies the lifecycle around background work: a bounded pool of workers consuming a queue, and a scheduler that runs periodic work once across a fleet.
config
Package jobscfg assembles the jobs package from environment configuration: a Pool bound to a messagequeue consumer, and a Scheduler holding its periodic executions under a distributed lock.
 Package jobscfg assembles the jobs package from environment configuration: a Pool bound to a messagequeue consumer, and a Scheduler holding its periodic executions under a distributed lock.
llm
Package llm is the platform's interface to language models: content blocks, tool calling, streaming, structured output, and token accounting, over Anthropic and OpenAI.
 Package llm is the platform's interface to language models: content blocks, tool calling, streaming, structured output, and token accounting, over Anthropic and OpenAI.
anthropic
config
internal/bridge
Package bridge translates between the platform's llm types and any-llm-go's.
 Package bridge translates between the platform's llm types and any-llm-go's.
mock
Package llmmock provides mock implementations of the llm package's interfaces.
 Package llmmock provides mock implementations of the llm package's interfaces.
noop
openai
Package messagequeue provides message queue publisher and consumer interfaces with implementations for Google Pub/Sub, Redis, and Amazon SQS.
 Package messagequeue provides message queue publisher and consumer interfaces with implementations for Google Pub/Sub, Redis, and Amazon SQS.
config
kafka
mock
Package messagequeuemock provides moq-generated mocks for the messagequeue package's Publisher, PublisherProvider, Consumer, and ConsumerProvider interfaces.
 Package messagequeuemock provides moq-generated mocks for the messagequeue package's Publisher, PublisherProvider, Consumer, and ConsumerProvider interfaces.
noop
pubsub
redis
sqs
Package metering counts what customers consume and enforces what they are allowed to, durably enough to invoice from.
 Package metering counts what customers consume and enforces what they are allowed to, durably enough to invoice from.
config
Package meteringcfg assembles the usage metering machinery from environment configuration: the Store every part shares, the Recorder usage arrives through, the Enforcer quotas are checked against, and the Flusher that posts to the billing provider.
 Package meteringcfg assembles the usage metering machinery from environment configuration: the Store every part shares, the Recorder usage arrives through, the Enforcer quotas are checked against, and the Flusher that posts to the billing provider.
migrations
Package migrations supplies the usage metering tables' DDL, rendered for a dialect and table prefix.
 Package migrations supplies the usage metering tables' DDL, rendered for a dialect and table prefix.
mock
Package meteringmock provides moq-generated mock implementations of interfaces in the metering package.
 Package meteringmock provides moq-generated mock implementations of interfaces in the metering package.
notifications
async
Package async provides a channel-based async event delivery interface with implementations for WebSocket, SSE, Pusher, and Ably.
 Package async provides a channel-based async event delivery interface with implementations for WebSocket, SSE, Pusher, and Ably.
async/ably
async/config
async/noop
async/pusher
async/sse
async/websocket
mobile
Package mobile provides a push notification sending interface with implementations for APNs and FCM.
 Package mobile provides a push notification sending interface with implementations for APNs and FCM.
mobile/apns
mobile/config
mobile/fcm
mobile/noop
Package numbers provides numeric types, utilities, and range abstractions for rounding, scaling, and yield adjustment calculations.
 Package numbers provides numeric types, utilities, and range abstractions for rounding, scaling, and yield adjustment calculations.
Package observability provides unified configuration and initialization for the four observability pillars: logging, metrics, tracing, and profiling.
 Package observability provides unified configuration and initialization for the four observability pillars: logging, metrics, tracing, and profiling.
keys
logging
logging/config
logging/noop
logging/otelgrpc
logging/slog
logging/zap
logging/zerolog
metrics
Package metrics provides a metrics-tracking implementation for the service.
 Package metrics provides a metrics-tracking implementation for the service.
metrics/config
metrics/metricstest
Package metricstest provides metric instruments for tests.
 Package metricstest provides metric instruments for tests.
metrics/mock
Package metricsmock provides moq-generated mocks for the metrics package.
 Package metricsmock provides moq-generated mocks for the metrics package.
metrics/noop
metrics/otelgrpc
profiling
profiling/config
profiling/noop
profiling/pprof
profiling/pyroscope
tracing
Package tracing provides distributed tracing utilities.
 Package tracing provides distributed tracing utilities.
tracing/cloudtrace
Package cloudtrace provides common functions for attaching values to trace spans
 Package cloudtrace provides common functions for attaching values to trace spans
tracing/config
tracing/noop
tracing/oteltrace
Package oteltrace provides common functions for attaching values to trace spans
 Package oteltrace provides common functions for attaching values to trace spans
utils
Package o11yutils offers observability utility functions.
 Package o11yutils offers observability utility functions.
Package outbox makes "write a row and publish an event" atomic.
 Package outbox makes "write a row and publish an event" atomic.
config
Package outboxcfg assembles the outbox from environment configuration: a Writer for the transactional side and a Relay, with its publisher provider, for the delivery side.
 Package outboxcfg assembles the outbox from environment configuration: a Writer for the transactional side and a Relay, with its publisher provider, for the delivery side.
migrations
Package migrations supplies the outbox table's DDL, rendered for a dialect and table prefix.
 Package migrations supplies the outbox table's DDL, rendered for a dialect and table prefix.
Package panicking provides an abstraction over panic behavior, enabling testing and mocking of panic-inducing code paths.
 Package panicking provides an abstraction over panic behavior, enabling testing and mocking of panic-inducing code paths.
mock
Package panickingmock provides moq-generated mock implementations of the panicking package's interfaces.
 Package panickingmock provides moq-generated mock implementations of the panicking package's interfaces.
Package pointer provides generic utility functions for creating pointers to values and dereferencing pointer values and slices.
 Package pointer provides generic utility functions for creating pointers to values and dereferencing pointer values and slices.
Package qrcodes provides QR code generation for TOTP two-factor authentication setup.
 Package qrcodes provides QR code generation for TOTP two-factor authentication setup.
noop
Package random provides cryptographically secure random string generation in hex, base32, and base64 encodings.
 Package random provides cryptographically secure random string generation in hex, base32, and base64 encodings.
mock
Package randommock provides moq-generated mock implementations of the random package's interfaces.
 Package randommock provides moq-generated mock implementations of the random package's interfaces.
noop
Package ratelimiting provides a per-key rate limiter interface using the token bucket algorithm.
 Package ratelimiting provides a per-key rate limiter interface using the token bucket algorithm.
config
noop
redis
Package reflection provides utilities for struct field inspection, tag extraction, and dynamic method introspection.
 Package reflection provides utilities for struct field inspection, tag extraction, and dynamic method introspection.
ast
Package retry provides retry policies for resilient operation execution.
 Package retry provides retry policies for resilient operation execution.
config
noop
Package routing provides a declarative, type-safe HTTP router that generates an OpenAPI 3 specification as routes are registered.
 Package routing provides a declarative, type-safe HTTP router that generates an OpenAPI 3 specification as routes are registered.
backends/chi
backends/gin
Package gin provides a routing.Backend built on gin-gonic/gin.
 Package gin provides a routing.Backend built on gin-gonic/gin.
backends/httprouter
Package httprouter provides a routing.Backend built on julienschmidt/httprouter, a fast radix-tree router.
 Package httprouter provides a routing.Backend built on julienschmidt/httprouter, a fast radix-tree router.
backends/internal/httpmw
Package httpmw holds the plain net/http middleware stack shared by the non-chi routing backends (stdlib, httprouter, gin).
 Package httpmw holds the plain net/http middleware stack shared by the non-chi routing backends (stdlib, httprouter, gin).
backends/stdlib
Package stdlib provides a routing.Backend built on the standard library's net/http.ServeMux.
 Package stdlib provides a routing.Backend built on the standard library's net/http.ServeMux.
config
mock
Package routingmock provides mock implementations of the routing package's interfaces (currently the Backend seam), for testing routers without a real mux library.
 Package routingmock provides mock implementations of the routing package's interfaces (currently the Backend seam), for testing routers without a real mux library.
Package saga runs a linear sequence of steps durably, and unwinds it when a step fails.
 Package saga runs a linear sequence of steps durably, and unwinds it when a step fails.
config
Package sagacfg assembles the saga machinery from environment configuration: the Store the runner and the worker share, and the Worker that advances instances.
 Package sagacfg assembles the saga machinery from environment configuration: the Store the runner and the worker share, and the Worker that advances instances.
migrations
Package migrations supplies the saga instance table's DDL, rendered for a dialect and table prefix.
 Package migrations supplies the saga instance table's DDL, rendered for a dialect and table prefix.
mock
Package sagamock provides moq-generated mock implementations of interfaces in the saga package.
 Package sagamock provides moq-generated mock implementations of interfaces in the saga package.
search
text
Package textsearch defines an interface for a search index management structure
 Package textsearch defines an interface for a search index management structure
text/algolia
Package algolia provides an interface-compatible wrapper around the algolia indexer
 Package algolia provides an interface-compatible wrapper around the algolia indexer
text/config
text/elasticsearch
Package elasticsearch provides an interface-compatible wrapper around the elasticsearch indexer
 Package elasticsearch provides an interface-compatible wrapper around the elasticsearch indexer
text/indexing
text/mock
Package textsearchmock provides moq-generated mocks for the search/text package.
 Package textsearchmock provides moq-generated mocks for the search/text package.
text/noop
vector
Package vectorsearch provides a generic interface for vector (nearest-neighbor) search backends, parallel to the textsearch package under search/text.
 Package vectorsearch provides a generic interface for vector (nearest-neighbor) search backends, parallel to the textsearch package under search/text.
vector/config
vector/mock
Package vectorsearchmock provides moq-generated mocks for the search/vector package.
 Package vectorsearchmock provides moq-generated mocks for the search/vector package.
vector/noop
vector/pgvector
Package pgvector implements vectorsearch.Index against a PostgreSQL database running the pgvector extension.
 Package pgvector implements vectorsearch.Index against a PostgreSQL database running the pgvector extension.
vector/qdrant
Package qdrant implements vectorsearch.Index against a Qdrant vector database over its REST API.
 Package qdrant implements vectorsearch.Index against a Qdrant vector database over its REST API.
Package secrets provides a secret retrieval interface with implementations for environment variables, GCP Secret Manager, and AWS SSM Parameter Store.
 Package secrets provides a secret retrieval interface with implementations for environment variables, GCP Secret Manager, and AWS SSM Parameter Store.
config
env
gcp
kubernetes
Package kubernetes sources secrets from the Kubernetes Secrets API.
 Package kubernetes sources secrets from the Kubernetes Secrets API.
noop
ssm
server
grpc
http
Package http provides an HTTP server comprised of multiple HTTP services
 Package http provides an HTTP server comprised of multiple HTTP services
Package testutils contains common functions for integration/load tests
 Package testutils contains common functions for integration/load tests
containers
Package containers provides shared helpers for starting testcontainers with uniform retry behavior.
 Package containers provides shared helpers for starting testcontainers with uniform retry behavior.
containers/mysqltest
Package mysqltest provides the MySQL testcontainer setup that every MySQL-backed suite in this repo would otherwise hand-roll: start the container with the shared retry policy and wait strategy, open a go-sql-driver pool against it, ping it, and tear all of it down afterwards.
 Package mysqltest provides the MySQL testcontainer setup that every MySQL-backed suite in this repo would otherwise hand-roll: start the container with the shared retry policy and wait strategy, open a go-sql-driver pool against it, ping it, and tear all of it down afterwards.
containers/pgtest
Package pgtest provides the postgres testcontainer setup that every postgres-backed suite in this repo would otherwise hand-roll: start the container with the shared retry policy and wait strategy, open a pgx-backed *sql.DB against it, ping it, and tear all of it down afterwards.
 Package pgtest provides the postgres testcontainer setup that every postgres-backed suite in this repo would otherwise hand-roll: start the container with the shared retry policy and wait strategy, open a pgx-backed *sql.DB against it, ping it, and tear all of it down afterwards.
containers/redistest
Package redistest provides a single source of truth for the redis testcontainer setup that the redis-backed test suites in this repo all duplicate.
 Package redistest provides a single source of truth for the redis testcontainer setup that the redis-backed test suites in this repo all duplicate.
Package uploads provides an object storage abstraction for saving and reading files, with implementations backed by S3, GCS, Cloudflare R2, Backblaze B2, the local filesystem, and an in-memory provider (see the objectstorage subpackage).
 Package uploads provides an object storage abstraction for saving and reading files, with implementations backed by S3, GCS, Cloudflare R2, Backblaze B2, the local filesystem, and an in-memory provider (see the objectstorage subpackage).
config
images
Package images provides small, pure helpers for validating, encoding, and thumbnailing images.
 Package images provides small, pure helpers for validating, encoding, and thumbnailing images.
mock
Package uploadsmock provides moq-generated mock implementations of the uploads package interfaces (UploadManager and the optional capability interfaces) for use in tests.
 Package uploadsmock provides moq-generated mock implementations of the uploads package interfaces (UploadManager and the optional capability interfaces) for use in tests.
noop
objectstorage
Package version manages build-time version and VCS metadata injection via linker flags.
 Package version manages build-time version and VCS metadata injection via linker flags.
Package webhooks delivers outbound webhooks: signed, retried, ordered, and replayable.
 Package webhooks delivers outbound webhooks: signed, retried, ordered, and replayable.
config
Package webhookscfg assembles the webhook machinery from environment configuration: the Store both halves share, the Dispatcher applications write through, and the Worker that delivers.
 Package webhookscfg assembles the webhook machinery from environment configuration: the Store both halves share, the Dispatcher applications write through, and the Worker that delivers.
migrations
Package migrations supplies the webhook tables' DDL, rendered for a dialect and table prefix.
 Package migrations supplies the webhook tables' DDL, rendered for a dialect and table prefix.
mock
Package webhooksmock provides moq-generated mock implementations of interfaces in the webhooks package.
 Package webhooksmock provides moq-generated mock implementations of interfaces in the webhooks package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.