Repository navigation
feat(appkit-ui): call named database operations from the client and hooks - #691
Conversation
📦 Bundle size reportCompared against
|
| dist | raw | gzip |
|---|---|---|
| JS (runtime) | 1.4 MB (+214 B) | 499 KB (+20 B) |
| Type declarations | 483 KB | 174 KB (-2 B) |
| Source maps | 2.7 MB (+33 B) | 928 KB (+24 B) |
| Other | 11 KB | 3.7 KB |
| Total | 4.6 MB (+247 B) | 1.6 MB (+42 B) |
Per-entry composition (own code — deps external (as shipped))
| Entry | Initial (gz) | Lazy (gz) | Total (gz) | node_modules (min) | Own code (min) |
|---|---|---|---|---|---|
. |
118 KB (-1 B) | 2.4 KB (+1 B) | 121 KB | external | 378 KB |
./beta |
115 KB | 484 B | 115 KB | external | 341 KB |
./testing |
47 KB (-1 B) | 38 KB (-1 B) | 85 KB (-2 B) | external | 246 KB |
./tsdown |
520 B | 0 B | 520 B | external | 813 B |
./type-generator |
31 KB | 0 B | 31 KB | external | 90 KB |
Chunks:
| Entry | Chunk | Load | Size (gz) |
|---|---|---|---|
. |
index.js |
initial | 114 KB |
. |
utils.js |
initial | 4.6 KB |
. |
remote-tunnel-manager.js |
lazy | 2.4 KB |
./beta |
beta.js |
initial | 95 KB |
./beta |
modular.js |
initial | 6.1 KB |
./beta |
stream-manager.js |
initial | 5.9 KB |
./beta |
service-context.js |
initial | 4.3 KB |
./beta |
databricks.js |
initial | 3.3 KB |
./beta |
client.js |
initial | 646 B |
./beta |
index.js |
initial | 20 B |
./beta |
supervisor-api.js |
lazy | 192 B |
./beta |
databricks.js |
lazy | 178 B |
./beta |
index.js |
lazy | 114 B |
./testing |
manifest.js |
initial | 33 KB |
./testing |
index.js |
initial | 10 KB |
./testing |
wide-event-emitter.js |
initial | 2.9 KB |
./testing |
index.js |
lazy | 34 KB |
./testing |
remote-tunnel-manager.js |
lazy | 2.4 KB |
./testing |
utils.js |
lazy | 1.8 KB |
./tsdown |
index.js |
initial | 520 B |
./type-generator |
index.js |
initial | 31 KB |
@databricks/appkit-ui
npm tarball (packed): 428 KB (+2 B) — gzipped download (dist + bin; excludes release-only docs/NOTICE).
| dist | raw | gzip |
|---|---|---|
| JS (runtime) | 457 KB | 157 KB |
| Type declarations | 281 KB | 104 KB |
| Source maps | 906 KB | 306 KB |
| CSS | 16 KB | 3.2 KB |
| Total | 1.6 MB | 571 KB |
Per-entry composition (consumer bundle — deps bundled, peerDeps external)
| Entry | Initial (gz) | Lazy (gz) | Total (gz) | node_modules (min) | Own code (min) |
|---|---|---|---|---|---|
./js |
5.3 KB | 49 KB | 55 KB | 208 KB | 14 KB |
./js/beta |
3.5 KB | 0 B | 3.5 KB | 0 B | 9.4 KB |
./react |
441 KB | 49 KB | 489 KB | 1.4 MB | 179 KB |
./react/beta |
16 KB | 0 B | 16 KB | 25 KB | 22 KB |
Chunks:
| Entry | Chunk | Load | Size (gz) |
|---|---|---|---|
./js |
index.js |
initial | 5.2 KB |
./js |
chunk |
initial | 120 B |
./js |
apache-arrow |
lazy | 49 KB |
./js/beta |
beta.js |
initial | 3.5 KB |
./react |
index.js |
initial | 439 KB |
./react |
tslib |
initial | 2.1 KB |
./react |
apache-arrow |
lazy | 49 KB |
./react/beta |
beta.js |
initial | 16 KB |
🤖 AppKit PR bot🔬 Run evalsStart an eval for this PR from the evals-monitor app: Go to Evals Monitor → 📦 Try this PR's app templateScaffolds a new app from this PR's SDK build. Run it in any folder (requires the GitHub CLI — gh run download 44775546445 -R databricks/appkit -n appkit-template-0.101.0-pr.d624068-stack-database-stable-05-client-operations-691 -D appkit-pr-691 \
&& unzip -o "appkit-pr-691/appkit-template-0.101.0-pr.d624068-stack-database-stable-05-client-operations-691.zip" -d "appkit-pr-691" \
&& databricks apps init --template "appkit-pr-691"The template pins |
ac81ca5 to
7ff200e
Compare
7ff200e to
e654d2b
Compare
e654d2b to
e1dec02
Compare
e1dec02 to
c442046
Compare
c442046 to
f56ee2f
Compare
f56ee2f to
6474069
Compare
6474069 to
974befb
Compare
974befb to
cec215f
Compare
cec215f to
8c6e079
Compare
8c75b12 to
1a24e9b
Compare
MarioCadenas
left a comment
There was a problem hiding this comment.
Read through the client, session and hook changes and ran it locally. I found 2 things worth fixing, both in the session handling.
What I ran on 8c75b12 (secrets unset): pnpm install --frozen-lockfile, pnpm run check, pnpm run knip, pnpm build, pnpm run typecheck, pnpm vitest run --changed <merge-base>. All pass, 10 test files and 219 tests. I also wrote a small Node script that runs the compiled useDatabaseMutation, send and session code with fetch stubbed out, to reproduce the two cases below.
-
The mutation can show user A's write result after the session has moved to user B (
use-database-mutation.ts:119, inline).send()checks the ticket's epoch afterJSON.parse, butsettlestamps the state with whatever epoch is current when theawaitresumes, not the epoch the reply was accepted in. If B's reply opens a new epoch in that gap, A's data gets stamped with B's epoch and the hook shows it. In my script the hook ended on epoch 1 withdata: { owner: 'a', secret: 'A secret' }. The window is small (a microtask), but the PR says a changed caller clears hook state, and here it doesn't.useDatabaseQuerydoesn't have this problem because it stamps with the epoch from the render. Stamping a success withstartedwould close it: if the epoch moved, the hook already hides it. -
A 401 that was in flight before sign-in still reaches the new session (
session.ts:51, inline). After A gets a 401,actorisnull. When B signs in, null to B doesn't open an epoch (opensEpoch = actor !== null). So a read sent while signed out, whose 401 body is still streaming, passesisCurrentDatabaseRequestafter B's reply and comes back asUNAUTHENTICATEDinstead ofSESSION_CHANGED. In my script that's exactly what happened. Since no epoch opens, the query showing that error doesn't restart either, so the screen says "sign in" while B is signed in until something refetches. Low impact, but it's the same promise the PR makes.
Nothing to flag on security: no new dependencies, no CI changes, and nothing user-controlled ends up in URLs beyond the published operation names.
1f9f4a2 to
ef7daae
Compare
ef7daae to
9f5069b
Compare
c639c1e to
cfe276f
Compare
cfe276f to
6a7c25d
Compare
6a7c25d to
fd3a0c8
Compare
…ooks Add databaseApi.execute, useDatabaseQuery, and useDatabaseMutation. A name the server did not publish fails with NOT_EXPOSED and sends nothing. Answers carry the actor discriminator, so a changed session clears every query, and a mutation restarts mounted queries. The entity client and hooks stay until the plugin serves operations. Signed-off-by: ditadi <victordperd@gmail.com>
Signed-off-by: ditadi <victordperd@gmail.com>
Signed-off-by: ditadi <victordperd@gmail.com>
… write failures as unknown An error or unusable body that finished arriving after the session moved now rejects with SESSION_CHANGED instead of settling the old session's error. A write answered 5xx without the actor header is OUTCOME_UNKNOWN, not TRANSIENT. Co-authored-by: Isaac <no-reply@databricks.com> Signed-off-by: ditadi <victordperd@gmail.com>
…pted it A write's reply can be accepted for actor A and then, before the hook resumes, a later reply naming actor B opens a new session. The hook stamped the outcome with the session current at that moment, so it showed A's answer or error to B. Sweep B's reply across the microtasks around the write's reply and require the hook to end idle every time. Also pin that a write whose own reply opens the session shows its answer there. Co-authored-by: Isaac <no-reply@databricks.com> Signed-off-by: ditadi <victordperd@gmail.com>
… was accepted in The hook read the session epoch after its await resumed, so a later reply that opened another actor's session in that gap made the old actor's answer or error show in the new session. The operation call now exposes the epoch its latest send belongs to, which only the request's own reply can move, and the hook stamps every outcome with it. A write whose own reply opens the session still shows there. Co-authored-by: Isaac <no-reply@databricks.com> Signed-off-by: ditadi <victordperd@gmail.com>
After a 401 the session recorded no actor, as before any reply, so the next actor's first reply opened no epoch. A read sent while signed out whose 401 body was still arriving then rejected UNAUTHENTICATED in the new session, and queries showing that error never asked again. Pin that the sign-in opens a session, refuses that body, and restarts those queries, and that the page's first reply still opens none. Co-authored-by: Isaac <no-reply@databricks.com> Signed-off-by: ditadi <victordperd@gmail.com>
The session used null both before any reply and after a 401, so the first actor to sign in after a 401 opened no epoch. A 401 body from the signed-out session could then reach the new one, and queries showing UNAUTHENTICATED kept showing it. Keep "no reply yet" apart from "a 401 was seen", so any change of who is signed in opens an epoch once some reply was observed, while the page's first reply still opens none. Co-authored-by: Isaac <no-reply@databricks.com> Signed-off-by: ditadi <victordperd@gmail.com>
Mark "no reply observed yet" with an unexported UNOBSERVED sentinel and test for the first reply by name, so the actor's three states read from the code. Rename DatabaseOperationCall's epoch getter to latestRequestEpoch and drop the comments that explained the old names. Co-authored-by: Isaac <no-reply@databricks.com> Signed-off-by: ditadi <victordperd@gmail.com>
Rename the race helper's delay to microtasksBeforeActorB and the filtered outcomes to acceptedBeforeSessionChange, and drop the comments those names replace. Co-authored-by: Isaac <no-reply@databricks.com> Signed-off-by: ditadi <victordperd@gmail.com>
… baseline The operation client and hooks ship next to the entity client until the next PR removes it, so the packed tarball grows by about 21 KB (5.3%). Only the appkit-ui entry is regenerated. Co-authored-by: Isaac <no-reply@databricks.com> Signed-off-by: ditadi <victordperd@gmail.com>
fd3a0c8 to
81bd7c8
Compare
What did you change, and why?
Why: Browser code needs to call operations by name with generated types, and its state must not outlive a session.
Change (additive):
databaseApi.execute,useDatabaseQueryfor GET operations, anduseDatabaseMutationfor writes. Parameterless operations supportexecute(name),useDatabaseQuery(name), andmutate(). Parameterized operations still require their schema-derived input.undefinedin the input position when supplying options; option positions stay consistent.NOT_EXPOSEDwithout a request. A changed caller or a 401 clears hook state, and a late answer fails withSESSION_CHANGED. A write without a usable answer reportsOUTCOME_UNKNOWN. A mutation never retries and restarts the mounted queries.skipToken, exported from the React beta entry, holds a dependent query idle until valid input exists. It sends nothing, aborts an old read, clears its displayed state, and makesrefetch()a no-op. The token is accepted only by query hooks, never by imperative calls or mutations.entity-client.tsis the previousclient.ts, moved verbatim, and the entity hooks import it from there.databaseApikeeps its entity calls until the next PR.bundle-size-baseline.jsonaccepts the appkit-ui growth, about 21 KB packed (5.3%), because the entity client stays until the next PR removes it. Only the appkit-ui entry changes.Interface
New in
@databricks/appkit-ui/js/betaand@databricks/appkit-ui/react/beta. Names, inputs, and outputs come from the generatedDatabricksAppKitDatabaseOperations.Example, as the playground uses it in the last PR of this stack:
How do you know it works?
Testing: The named-operation client, HTTP, query/mutation hook, and compiler-probe suites pass (104 tests at the final stack tip), and appkit-ui typecheck passes. Coverage includes parameterless calls, required schema-derived inputs, dependent queries, cancellation and late responses, operation-name switches including A → B → A, session changes, and unknown write outcomes. Type probes reject
skipTokenin imperative calls and mutations. The entity APIs remain intact at this layer until the cutover PR.Stack
#683 → #687 → #688 → #689 → #690 → #691 → #692
Design: #683. Previous layer: #690. Next layer: #692.
Restacked onto the updated design without changing this layer's implementation patch.
Review feedback (round 2):
fix(appkit-ui): recheck the session on failed replies and treat proxy write failures as unknown.SESSION_CHANGED. It is never settled into the new session.OUTCOME_UNKNOWN, not a retryable error. That reply came from a proxy, not the handler.Stack created with GitHub Stacks CLI • Give Feedback 💬