feat(orb): auto-register the brokered self-host's relay URL on boot - #1355
Merged
Conversation
Closes the brokered self-host loop (#1255): the container now self-registers its public relay URL with the central Orb on startup, so the Orb forwards this install's events to it — no manual curl. The container computes its relay URL from PUBLIC_API_ORIGIN + /v1/orb/relay and POSTs it to the broker with its enrollment secret. registerOrbRelayTarget (src/orb/broker-client.ts) is BEST-EFFORT + fire-and-forget: skipped unless broker mode + PUBLIC_API_ORIGIN are set, and any failure (Orb down, install not registered yet, non-public origin rejected by the Orb's SSRF check) just means no relay until the next boot — it never throws or blocks startup. Wired into the selfhost boot alongside the orb-export hook (server.ts, the codecov-ignored process entry). End-to-end now: install Orb App → self-enroll (admin-verified, #1348) → broker tokens (#1341) → boot auto-registers relay (this) → Orb forwards events (#1352) → relay receiver verifies + enqueues (#1354) → review + act. Advances #1255.
Contributor
|
Superagent didn't find any vulnerabilities or security issues in this PR. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1355 +/- ##
=======================================
Coverage 95.31% 95.31%
=======================================
Files 189 189
Lines 20491 20499 +8
Branches 7394 7398 +4
=======================================
+ Hits 19530 19538 +8
Misses 378 378
Partials 583 583
🚀 New features to boost your workflow:
|
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
1 participant
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
Closes the brokered self-host loop (#1255). The container now self-registers its public relay URL with the central Orb on startup — no manual curl — so the Orb forwards this install's events to it. The container computes its relay URL from
PUBLIC_API_ORIGIN+/v1/orb/relayand POSTs it to the broker with its enrollment secret.registerOrbRelayTarget(src/orb/broker-client.ts) is best-effort + fire-and-forget: skipped unless broker mode +PUBLIC_API_ORIGINare set, and any failure (Orb down, install not registered yet, non-public origin rejected by the Orb's SSRF check) just means no relay until the next boot — it never throws or blocks startup. Wired into the selfhost boot alongside the orb-export hook (server.ts, the codecov-ignored process entry).The brokered self-host is now end-to-end
install Orb App → self-enroll (admin-verified, #1348) → broker tokens (#1341) → boot auto-registers relay (this) → Orb forwards events (#1352) → relay receiver verifies + enqueues (#1354) → review + act. Setup-wizard recognizes brokered mode (#1346). All flag-gated; byte-identical for cloud + non-brokered self-hosts.
Validation
npm run test:cigreen; 100% branch coverage onbroker-client.tsdiff — skip arms (not broker mode / no origin), the POST (URL + relayUrl + Bearer, trailing-slash strip), default broker base, failed (non-ok + thrown). Theserver.tsboot wiring is in the codecov-ignored entry (exercised by the Docker boot smoke test).Advances #1255.