Uh oh!
There was an error while loading. Please reload this page.
feat(datasource): DatasourceConnectionService + declared auto-connect (ADR-0062 Phase 1) - #2198
Merged
Merged
Conversation
… (ADR-0062 Phase 1) Declare an external datasource → it auto-connects to a live ObjectQL driver and its federated objects are queryable with ZERO app code (no onEnable). Implements ADR-0062 Phase 1 (D1/D2/D5) toward epic #2163. D1 — one connect path: new DatasourceConnectionService owns the single "definition → live driver" path (factory build → credentialsRef resolve → connect → registerDriver under the datasource name → registerDatasourceDef → DDL-free syncObjectSchema per bound object). The runtime-admin registerPool now delegates to it; AppPlugin auto-connects code-defined datasources. Exposed as the 'datasource-connection' kernel service. D2 — opt-in-safe gate: connect only when external, an object explicitly binds via object.datasource, or autoConnect:true. Managed datasources referenced only by a datasourceMapping rule (e.g. app-crm's :memory: datasources) stay metadata-only — existing apps byte-for-byte unchanged. Adds datasource.autoConnect to the spec. D5 — lifecycle/ordering/policy: connect in AppPlugin.start() before the kernel:ready validation gate (init-all-then-start-all). Fail-fast for declared external + onMismatch:'fail'; degrade otherwise (always for runtime-admin/ rehydrate). New host-injectable DatasourceConnectPolicy (open-core default allows; multi-tenant host binds a stricter fail-closed policy) consulted before connect. Tests: 15 connection-service unit tests + 5 runtime integration tests (auto-connect, managed-unrouted stays metadata-only, queryable end-to-end, deny policy). onEnable + ctx.drivers.register remains a supported, idempotent escape hatch. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
📓 Docs Drift CheckThis PR changes 3 package(s): 98 hand-written doc(s) reference the affected code and may need an implementation-accuracy re-verification:
|
…TS build)
The context logger interface types error(message, error?: Error) — passing a meta
object {appId, error} tripped the tsup DTS build (TS2353) even though tsc --noEmit
passed. Switch to a single interpolated message; the rethrow still surfaces the
real cause to the kernel.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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 freeto 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.
ADR-0062 Phase 1 —
DatasourceConnectionService+ declared-datasource auto-connect (D1/D2/D5)First PR of epic #2163. Declare an external datasource → it auto-connects to a live ObjectQL driver and its federated objects are queryable with zero app code — no
onEnabledriver wiring.What changed
D1 — one connect path. New
DatasourceConnectionService(@objectstack/service-datasource) owns the single "definition → live driver" path: build via the injected driver factory → resolveexternal.credentialsRefvia theSecretBinder→connect()→engine.registerDriverunder the datasource name →registerDatasourceDef→ DDL-freesyncObjectSchemafor each bound federated object. Both origins converge on it — the runtime-adminregisterPoolnow delegates here, andAppPluginauto-connects code-defined datasources. Exposed as the'datasource-connection'kernel service.D2 — opt-in-safe gate. A declared datasource auto-connects only when it is
external, an object explicitly binds viaobject.datasource, or it sets the newautoConnect: trueflag. A managed datasource that nothing explicitly binds — including one referenced only by adatasourceMappingrule, e.g.examples/app-crm's:memory:datasources — stays metadata-only. Existing apps are byte-for-byte unchanged.D5 — lifecycle, ordering & policy. Connect runs in
AppPlugin.start()(before thekernel:readyvalidation gate; relies on the kernel's init-all→start-all ordering, so the connection service registered in the admin plugin'sinit()is available). Fail-fast for a declaredexternaldatasource withvalidation.onMismatch:'fail'; degrade-with-warning otherwise (and always for runtime-admin/rehydrate, so a UI action or replica blip never bricks the server). Adds a host-injectableDatasourceConnectPolicy(epic #2163 seam): open-core default allows (subject to the D2 gate); a multi-tenant host binds a stricter, fail-closed policy for egress isolation — one connect path, no cloud fork.Tests
datasource-connection-service.test.ts— 15 unit tests: D2 gate (incl. app-crm cases), build/connect/name-stamp/register,credentialsRefresolution, idempotency vs. a pre-registeredonEnabledriver, policy deny + throw-as-deny, no-infra degrade, fail-fast vs. degrade per trigger,connectDeclaredgating.datasource-autoconnect.test.ts(runtime) — 5 integration tests with the real driver factory: auto-connects the declared external datasource, leaves a managed+unrouted one metadata-only, keeps both visible, federated object queryable end-to-end, deny-policy leaves it unconnected-but-visible.service-datasource80,runtime409,spec6604.Scope / not in this PR
default-driver bootstrap refactor onto the shared service is deferred to a final follow-up PR (per ADR risk guidance: land auto-connect first, refactordefaultlast behind the dogfood gate).examples/app-showcaseonEnablebridge is kept here (idempotent vs. auto-connect) and removed in Phase 4 (D8).credentialsRefresolve hook is already wired through the shared service.Closes (partially) #2163 — Phase 1.
🤖 Generated with Claude Code