Skip to content

feat(api/runway): add external message queue contract as JSON Schema#260

Draft
behinddwalls wants to merge 3 commits into
messagequeue-rfcfrom
preetam/messagequeue-runway
Draft

feat(api/runway): add external message queue contract as JSON Schema#260
behinddwalls wants to merge 3 commits into
messagequeue-rfcfrom
preetam/messagequeue-runway

Conversation

@behinddwalls

@behinddwalls behinddwalls commented Jun 17, 2026

Copy link
Copy Markdown
Collaborator

Summary

Establish the message queue contract pattern from the RFC, using runway's
merge queues as the reference. Move the MergeRequest/MergeResult Go bindings
from runway/entity into api/runway/messagequeue, co-located with hand-authored
merge_request/merge_result JSON Schemas (draft 2020-12). Each schema declares
its wire topics via x-topics; the Go binding go:embeds its schema. A drift test
validates the marshaled entities against the embedded schemas and asserts every
runway topic key is bound by exactly one schema.

Adds the santhosh-tekuri/jsonschema/v6 validator dependency and codifies the
model in CLAUDE.md.

Co-authored-by: Cursor cursoragent@cursor.com

Test Plan

Issues

Stack

  1. refactor: consolidate shared code under platform/ #257
  2. refactor(proto): move protos to top-level api/ tree by domain/service #258
  3. docs(rfc): add message queue contract RFC #259
  4. @ feat(api/runway): add external message queue contract as JSON Schema #260

behinddwalls added a commit that referenced this pull request Jun 17, 2026
## Summary
Move the cross-domain shared trees out of the repo root into a single
`platform/` umbrella. Domain-scoped trees (`submitqueue/`, `stovepipe/`,
`runway/`) keep their own `core/`, `entity/`, `extension/`.

| From | To |
|------|----|
| `core/{errs,metrics,consumer}` | `platform/{errs,metrics,consumer}` |
| `core/httpclient` | `platform/http` |
| `entity/*` (`change`, `mergestrategy`, `messagequeue`) |
`platform/base/*` |
| `extension/*` (`counter`, `messagequeue`) | `platform/extension/*` |

Details:
- `platform/http`: package renamed `httpclient` -> `http`; `net/http`
aliased as `nethttp` inside the package; callers that also import
`net/http` use a `phttp` alias.
- `platform/base`: root doc package renamed `entity` -> `base`; `change`
/ `mergestrategy` / `messagequeue` preserved as subpackages.
- Rewrites all Go import paths and Bazel labels; updates `Makefile`
schema/admin paths and `go:generate` roots.
- Docs refreshed to the `platform/` layout (`CLAUDE.md`, package
READMEs, RFCs), documenting current state only.

> Stacked on #256 (hermetic Go SDK). Review/merge that first.

## Test plan
- [x] `make gazelle` clean (BUILD files in sync)
- [x] `make build` — 201 targets build (hermetic)
- [x] `make test` — 54/54 unit tests pass

Made with [Cursor](https://cursor.com)

## Test Plan


## Issues


## Stack
1. @ #257
1. #258
1. #259
1. #260

---------

Co-authored-by: Cursor <cursoragent@cursor.com>
@behinddwalls behinddwalls force-pushed the preetam/messagequeue-runway branch from 35e8531 to cee7fb5 Compare June 17, 2026 18:00
behinddwalls and others added 3 commits June 17, 2026 11:33
Establish the message queue contract pattern from the RFC, using runway's
merge queues as the reference. Move the MergeRequest/MergeResult Go bindings
from runway/entity into api/runway/messagequeue, co-located with hand-authored
merge_request/merge_result JSON Schemas (draft 2020-12). Each schema declares
its wire topics via x-topics; the Go binding go:embeds its schema. A drift test
validates the marshaled entities against the embedded schemas and asserts every
runway topic key is bound by exactly one schema.

Adds the santhosh-tekuri/jsonschema/v6 validator dependency and codifies the
model in CLAUDE.md.

Co-authored-by: Cursor <cursoragent@cursor.com>
Runway's merge topic keys are an external, cross-domain contract (other
domains publish to them) and are the same strings the schemas list in
x-topics, so they belong with the contract rather than in runway/core, which
is for domain-internal infra. Move them into api/runway/messagequeue, which
now fully owns Runway's merge queues. This empties runway/, which had no other
code.

Co-authored-by: Cursor <cursoragent@cursor.com>
Drop the redundant "for non-Go clients" qualifier and the published-contract
rationale from the package doc (it lives in the RFC), keeping the doc focused.

Co-authored-by: Cursor <cursoragent@cursor.com>
@behinddwalls behinddwalls force-pushed the preetam/messagequeue-runway branch from cee7fb5 to 5c1798d Compare June 17, 2026 18:34
behinddwalls added a commit that referenced this pull request Jun 17, 2026
## Summary

### Why?

The "Rebase Stacked PRs" job silently no-ops when the repo's "Automatically delete head branches" setting is on. On merge, GitHub deletes the merged head branch, which auto-retargets every child PR's base from the merged head branch to the merged base (e.g. main) *before* the job runs. The job discovers children via `gh pr list --base <merged-head>`, which then returns nothing — so it rebases nothing, force-pushes nothing, and still reports success. Run #257 (and #256 before it) did exactly this, leaving the downstream stack (#258/#259/#260) with doubled diffs that had to be rebased by hand.

The fix is to keep "Automatically delete head branches" off (now done at the repo level) and let this workflow own head-branch cleanup. With the setting off, GitHub leaves child bases untouched, the lookup finds them, and the job rebases the stack and then deletes the merged branch itself — for both stacked and non-stacked PRs.

### What?

- Document the hard requirement that "Automatically delete head branches" stays off, with the retarget-race rationale, in the workflow header.
- Log a clear line when a merge has no child PRs instead of returning silently.
- Clarify the branch-deletion step: it runs on every merged PR (stacked or not) and is skipped only when a child rebase failed; fix the misleading "All stacked PRs rebased successfully" message that printed even on no-op runs.

No behavior change on the happy path — the job already deleted the merged branch on success; this makes the intent explicit and the logs legible.

## Test Plan

- ✅ `python3 -c "import yaml; yaml.safe_load(open('.github/workflows/rebase-stack.yml'))"` — YAML parses.
- Confirmed `delete_branch_on_merge` is `false` via `gh api repos/uber/submitqueue`.
- Post-merge: the next Rebase Stack run should log child rebases or "No open child PRs … nothing to rebase", then "Deleting merged branch …" and actually remove it.

Co-authored-by: Cursor <cursoragent@cursor.com>
behinddwalls added a commit that referenced this pull request Jun 17, 2026
## Summary

### Why?

The "Rebase Stacked PRs" job was silently no-opping: with the repo's
"Automatically delete head branches" setting on, GitHub deleted the
merged head branch on merge, which auto-retargeted every child PR's base
from the merged head branch to the merged base (e.g. `main`) *before*
the job ran. Its child lookup (`gh pr list --base <merged-head>`) then
found nothing, so it rebased nothing and still went green. Run #257 (and
#256 before it) did exactly this, leaving #258/#259/#260 with doubled
diffs that had to be rebased by hand.

The repo setting is now off, making this workflow the sole owner of
head-branch cleanup. But that exposed a second gap: the job only deleted
the merged branch at the end of its own run. When a child rebase
conflicts, the run intentionally keeps the merged branch (the child
still bases on it) and never fires again — so after the author manually
rebases and retargets the child, nothing ever deletes the orphaned
merged branch.

### What?

- Document the hard requirement that "Automatically delete head
branches" stays **off**, with the retarget-race rationale, in the
workflow header.
- Replace the outcome-gated single-branch delete with an invariant-based
sweep, `cleanup_orphaned_merged_branches`, that runs on every
invocation: for each recently merged PR whose head branch still exists,
delete it **iff** no open PR references it as a base or head. This:
- deletes the just-merged branch on a clean run (children retargeted
away),
- **keeps** it when an immediate child rebase failed (that child still
bases on it — deleting it would retarget the child to `main` and
recreate the broken diff),
- reaps branches stranded by an earlier conflicted run on the next
merge, once their children were manually fixed.
- Branch existence is snapshotted in one `git ls-remote`; the merged
base (e.g. `main`) is never touched. Conflicted runs also emit a
`::warning::` for visibility while still exiting non-fatally, and
no-stack merges log a clear line.

## Test Plan

- ✅ `yaml.safe_load` parses the workflow.
- ✅ `bash -n` on the extracted `run:` script.
- ✅ Simulated the sweep loop with mock data (dedup, skip-gone,
skip-base, consider-delete all behave correctly).
- Post-merge: the next Rebase Stack run should log child rebases (or "No
open child PRs … nothing to rebase"), then a sweep that deletes the
merged branch when nothing depends on it.

---------

Co-authored-by: Cursor <cursoragent@cursor.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant