refactor(stovepipe): collapse to a single Ping-only service#271
Merged
Conversation
behinddwalls
force-pushed
the
stovepipe
branch
2 times, most recently
from
07e9b09 to
9acd7e3
Compare
## Summary
### Why?
Stovepipe was scaffolded with the full two-service shape (gateway + orchestrator) plus entities, storage extensions, and queue/topic wiring copied from SubmitQueue. None of that is exercised yet — the only working surface is the `Ping` health check. Carrying the unused gateway/orchestrator split, entities, extensions, and pipeline plumbing adds maintenance cost (mocks, schemas, compose stacks, build targets) with no behavior behind it.
### What?
Reduce Stovepipe to a single Ping-only service and promote its packages to the domain top level:
- Wire contract: replace `api/stovepipe/{gateway,orchestrator}/` with a single `api/stovepipe/proto/stovepipe.proto` (service `uber.submitqueue.stovepipe.Stovepipe`, `Ping` only) and regenerated `api/stovepipe/protopb/`. The `change` import and `Ingest` RPC are dropped.
- Domain: promote the controller to `stovepipe/controller/` (`ServiceName: "stovepipe"`). Remove `stovepipe/{gateway,orchestrator,entity,extension,core}/`.
- Example: collapse to one `example/stovepipe/server` + `example/stovepipe/client` and a single-service `docker-compose.yml` with no MySQL/queue dependency (default gRPC port `:8083`, `:8080` in Docker).
- Integration test: `test/integration/stovepipe/` now exercises Ping only (no MySQL/schema), context `svc-stovepipe`.
- Wiring: single `api_stovepipe` codegen target in `tool/proto`, one `# gazelle:resolve` for `api/stovepipe/protopb`, and Makefile targets consolidated to `build-stovepipe-linux` / `local-stovepipe-start|stop|logs` / `run-client-stovepipe`.
- Docs: `stovepipe/README.md`, `example/README.md`, and `doc/howto/TESTING.md` updated to the single-service layout.
Entities, extensions, and the orchestration pipeline can be reintroduced incrementally as Stovepipe grows real behavior.
## Test Plan
- ✅ `make proto` && `make gazelle` && `make tidy` (no unexpected churn)
- ✅ `make build` (230 targets)
- ✅ `make test` (59 tests, incl. `//stovepipe/controller:controller_test`)
- ✅ `make fmt`, `make lint-license`
- ✅ `bazel build //test/integration/stovepipe:stovepipe_test` and all `//{api,example,}/stovepipe/...`
roychying
approved these changes
Jun 25, 2026
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
2 participants
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.
Summary
Why?
Stovepipe was scaffolded with the full two-service shape (gateway + orchestrator) plus entities, storage extensions, and queue/topic wiring copied from SubmitQueue. None of that is exercised yet — the only working surface is the
Pinghealth check. Carrying the unused gateway/orchestrator split, entities, extensions, and pipeline plumbing adds maintenance cost (mocks, schemas, compose stacks, build targets) with no behavior behind it.What?
Reduce Stovepipe to a single Ping-only service and promote its packages to the domain top level:
api/stovepipe/{gateway,orchestrator}/with a singleapi/stovepipe/proto/stovepipe.proto(serviceuber.submitqueue.stovepipe.Stovepipe,Pingonly) and regeneratedapi/stovepipe/protopb/. Thechangeimport andIngestRPC are dropped.stovepipe/controller/(ServiceName: "stovepipe"). Removestovepipe/{gateway,orchestrator,entity,extension,core}/.example/stovepipe/server+example/stovepipe/clientand a single-servicedocker-compose.ymlwith no MySQL/queue dependency (default gRPC port:8083,:8080in Docker).test/integration/stovepipe/now exercises Ping only (no MySQL/schema), contextsvc-stovepipe.api_stovepipecodegen target intool/proto, one# gazelle:resolveforapi/stovepipe/protopb, and Makefile targets consolidated tobuild-stovepipe-linux/local-stovepipe-start|stop|logs/run-client-stovepipe.stovepipe/README.md,example/README.md, anddoc/howto/TESTING.mdupdated to the single-service layout.Entities, extensions, and the orchestration pipeline can be reintroduced incrementally as Stovepipe grows real behavior.
Test Plan
make proto&&make gazelle&&make tidy(no unexpected churn)make build(230 targets)make test(59 tests, incl.//stovepipe/controller:controller_test)make fmt,make lint-licensebazel build //test/integration/stovepipe:stovepipe_testand all//{api,example,}/stovepipe/...