README
¶
Platform
Cross-domain packages shared by SubmitQueue, Stovepipe, and other services in this repository. Nothing under platform/ may depend on domain folders (submitqueue/, stovepipe/).
Packages
- errs/ — Error classification (
errstypes, classifiers, MySQL/generic helpers). - metrics/ — Tally helpers with error-aware tagging via
platform/errs. - consumer/ — Queue consumer framework (
consumer.Controller, registry, DLQ wiring). - http/ — Small HTTP client helpers (e.g. base-URL
RoundTripper). Go import path:github.com/uber/submitqueue/platform/http; package name ishttp. Callers that also importnet/httpshould import this package with an alias (for examplephttp "github.com/uber/submitqueue/platform/http") and usephttp.NewClient. - buildkite/, githubactions/ — Vendor CI clients over
platform/http: the REST calls and provider-specific vocabulary (state strings, id encoding) shared by every domain'sBuildRunnerbackend. They deliberately define no interface, so they are plumbing rather than extensions — each domain keeps its ownBuildRunnercontract under{domain}/extension/buildrunnerand adapts these clients to it. - base/ — Shared domain entities (
change,messagequeue, and related subpackages). Root packagebaseis documentation-only. - extension/ — Shared extension interfaces and implementations reused across domains (
counter,messagequeue, and backends such asmysql). A package belongs here only if it defines a behavioral interface with itsConfigandFactoryinterface; a vendor client with no interface belongs directly underplatform/.
Domain-scoped infrastructure and extensions stay under each domain (for example submitqueue/core/, submitqueue/extension/).
Directories
¶
| Path | Synopsis |
|---|---|
|
Package base is the root of shared domain entities used across SubmitQueue, Stovepipe, and other repo-local services.
|
Package base is the root of shared domain entities used across SubmitQueue, Stovepipe, and other repo-local services. |
|
change
Package change holds the shared code-change identity used across SubmitQueue, Stovepipe, and other repo-local domains.
|
Package change holds the shared code-change identity used across SubmitQueue, Stovepipe, and other repo-local domains. |
|
change/changeutil
Package changeutil holds small helpers shared across the entity/change provider subpackages (github, git, ...).
|
Package changeutil holds small helpers shared across the entity/change provider subpackages (github, git, ...). |
|
change/git
Package git parses change IDs that use the git:// URI scheme.
|
Package git parses change IDs that use the git:// URI scheme. |
|
failure
Package failure holds the shared description of why processing failed: a human-readable message, the entities the failure is about, and free-form detail.
|
Package failure holds the shared description of why processing failed: a human-readable message, the entities the failure is about, and free-form detail. |
|
mergestrategy
Package mergestrategy holds the shared source-control integration strategy used across SubmitQueue, runway, and other repo-local domains.
|
Package mergestrategy holds the shared source-control integration strategy used across SubmitQueue, runway, and other repo-local domains. |
|
page
Package page defines a generic, cursor-paginated result envelope shared across domains.
|
Package page defines a generic, cursor-paginated result envelope shared across domains. |
|
Package buildkite provides the HTTP client and Buildkite-specific facts (build state vocabulary, the env-var metadata round-trip convention, and build number id encoding) shared by every domain's Buildkite-backed BuildRunner.
|
Package buildkite provides the HTTP client and Buildkite-specific facts (build state vocabulary, the env-var metadata round-trip convention, and build number id encoding) shared by every domain's Buildkite-backed BuildRunner. |
|
mock
Package mock is a generated GoMock package.
|
Package mock is a generated GoMock package. |
|
generic
Package generic provides an errs.Classifier for errors that are not tied to any particular backend.
|
Package generic provides an errs.Classifier for errors that are not tied to any particular backend. |
|
http
Package http provides an errs.Classifier for failures returned by HTTP clients: a rejected status code (platform/http.StatusError) and a transport failure (*url.Error, which is what http.Client.Do returns).
|
Package http provides an errs.Classifier for failures returned by HTTP clients: a rejected status code (platform/http.StatusError) and a transport failure (*url.Error, which is what http.Client.Do returns). |
|
mysql
Package mysql provides an errs.Classifier for errors originating from the go-sql-driver/mysql driver and the standard database/sql + net packages commonly seen when talking to a MySQL backend.
|
Package mysql provides an errs.Classifier for errors originating from the go-sql-driver/mysql driver and the standard database/sql + net packages commonly seen when talking to a MySQL backend. |
|
Package extension holds extension interfaces and implementations shared across SubmitQueue, Stovepipe, and other repo-local services.
|
Package extension holds extension interfaces and implementations shared across SubmitQueue, Stovepipe, and other repo-local services. |
|
consumergate
Package consumergate defines the consumer-gate extension: runtime stop/start of individual queue controllers without stopping the service that hosts them.
|
Package consumergate defines the consumer-gate extension: runtime stop/start of individual queue controllers without stopping the service that hosts them. |
|
consumergate/file
Package file implements the consumergate contract with plain files in a shared directory.
|
Package file implements the consumergate contract with plain files in a shared directory. |
|
consumergate/mock
Package mock is a generated GoMock package.
|
Package mock is a generated GoMock package. |
|
consumergate/noop
Package noop provides a no-op consumergate.Gate that admits every delivery immediately.
|
Package noop provides a no-op consumergate.Gate that admits every delivery immediately. |
|
counter/mock
Package mock is a generated GoMock package.
|
Package mock is a generated GoMock package. |
|
messagequeue/mock
Package mock is a generated GoMock package.
|
Package mock is a generated GoMock package. |
|
messagequeue/mysql
Package mysql is a generated GoMock package.
|
Package mysql is a generated GoMock package. |
|
messagequeue/mysql/ctl
command
|
|
|
Package fakemarker holds the shared "sq-fake=<token>" change-URI marker convention used by the extension fakes to inject failures from a request payload.
|
Package fakemarker holds the shared "sq-fake=<token>" change-URI marker convention used by the extension fakes to inject failures from a request payload. |
|
Package githubactions provides the HTTP client and GitHub Actions-specific facts (run status/conclusion vocabulary and run id encoding) shared by every domain's GitHub Actions-backed BuildRunner.
|
Package githubactions provides the HTTP client and GitHub Actions-specific facts (run status/conclusion vocabulary and run id encoding) shared by every domain's GitHub Actions-backed BuildRunner. |
|
Package http provides shared HTTP client helpers (e.g.
|
Package http provides shared HTTP client helpers (e.g. |
|
Package lifecycle provides the Component interface and Group type for managing ordered start/stop lifecycles.
|
Package lifecycle provides the Component interface and Group type for managing ordered start/stop lifecycles. |
|
Package pipeline provides a typed engine for assembling queue-driven service pipelines from declarative data.
|
Package pipeline provides a typed engine for assembling queue-driven service pipelines from declarative data. |
|
Package publish sends a message to the queue behind a topic key.
|
Package publish sends a message to the queue behind a topic key. |
Click to show internal directories.
Click to hide internal directories.