Repository navigation
feat(appkit): generate the database operation registry and browser contracts - #690
Conversation
📦 Bundle size reportCompared against
|
| dist | raw | gzip |
|---|---|---|
| JS (runtime) | 1.4 MB (+28 KB) | 499 KB (+10 KB) |
| Type declarations | 483 KB (+2.5 KB) | 174 KB (+1.1 KB) |
| Source maps | 2.7 MB (+53 KB) | 928 KB (+18 KB) |
| Other | 11 KB | 3.7 KB |
| Total | 4.6 MB (+84 KB) | 1.6 MB (+29 KB) |
Per-entry composition (own code — deps external (as shipped))
| Entry | Initial (gz) | Lazy (gz) | Total (gz) | node_modules (min) | Own code (min) |
|---|---|---|---|---|---|
. |
118 KB (+4.2 KB) | 2.4 KB | 121 KB (+4.2 KB) | external | 378 KB (+12 KB) |
./beta |
115 KB (+346 B) | 484 B | 115 KB (+346 B) | external | 341 KB (+936 B) |
./testing |
47 KB (+266 B) | 38 KB (+4.0 KB) | 85 KB (+4.2 KB) | external | 246 KB (+12 KB) |
./tsdown |
520 B | 0 B | 520 B | external | 813 B |
./type-generator |
31 KB (+3.9 KB) | 0 B | 31 KB (+3.9 KB) | external | 90 KB (+11 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 | 647 B |
./beta |
index.js |
initial | 20 B |
./beta |
supervisor-api.js |
lazy | 191 B |
./beta |
databricks.js |
lazy | 178 B |
./beta |
index.js |
lazy | 115 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): 406 KB (+43 B) — gzipped download (dist + bin; excludes release-only docs/NOTICE).
| dist | raw | gzip |
|---|---|---|
| JS (runtime) | 438 KB (+25 B) | 150 KB (+13 B) |
| Type declarations | 271 KB (+20 B) | 100 KB (+11 B) |
| Source maps | 865 KB (+64 B) | 291 KB (+21 B) |
| CSS | 16 KB | 3.2 KB |
| Total | 1.6 MB (+109 B) | 545 KB (+45 B) |
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 |
2.1 KB (+15 B) | 0 B | 2.1 KB (+15 B) | 0 B | 5.0 KB (+22 B) |
./react |
441 KB | 49 KB | 489 KB | 1.4 MB | 179 KB |
./react/beta |
14 KB (+16 B) | 0 B | 14 KB (+16 B) | 25 KB | 15 KB (+22 B) |
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 | 2.1 KB |
./react |
index.js |
initial | 439 KB |
./react |
tslib |
initial | 2.1 KB |
./react |
apache-arrow |
lazy | 49 KB |
./react/beta |
beta.js |
initial | 14 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 44753715212 -R databricks/appkit -n appkit-template-0.98.0-pr.32b1dee-stack-database-stable-04-operation-generation-690 -D appkit-pr-690 \
&& unzip -o "appkit-pr-690/appkit-template-0.98.0-pr.32b1dee-stack-database-stable-04-operation-generation-690.zip" -d "appkit-pr-690" \
&& databricks apps init --template "appkit-pr-690"The template pins |
faf1728 to
c679be4
Compare
c679be4 to
c6b8418
Compare
c6b8418 to
ad8c8e0
Compare
ad8c8e0 to
1ea5e57
Compare
151e6e8 to
da12ac4
Compare
da12ac4 to
435a876
Compare
435a876 to
12a3a3d
Compare
b8df200 to
3a1b9f5
Compare
MarioCadenas
left a comment
There was a problem hiding this comment.
Found 2 P2 bugs, reported inline. Each was independently upheld by all three verifiers.
Reviewed commit 3a1b9f581de4c36e09c624aebf8d2410f49c8935 against the merge base with stack/database-stable/03-operation-authorization, including the PR description, all changed files, and the relevant generator, validator, and CLI callers.
Verification:
- Executed the actual operation renderer with Zod 4.6.7 and compiled its output with TypeScript 5.9.3: nested readonly arrays fail type equality (TS2344); readonly on both levels emits invalid syntax (TS1354).
- Executed the extracted CLI orchestration with an injected schema-generation failure: exit status 1, zero operation-generator calls, and existing operation contracts preserved. This was a control-flow check with generator doubles, not a full CLI integration run.
- Security review found no substantiated security issues.
- Full repository checks could not run:
pnpm install --frozen-lockfilefailed to download dependencies from registry.npmjs.org (ECONNREFUSED). A subsequentpnpm run checkalso attempted installation and could not reach linting. Knip, build, typecheck, changed tests, and the source-less bundle check therefore remain unverified. There is no visual UI change requiring screenshots.
3a1b9f5 to
9f3c462
Compare
9f3c462 to
a31c2c8
Compare
MarioCadenas
left a comment
There was a problem hiding this comment.
One issue inline: the template's production build can drop an operation without saying so. Reviewed at a31c2c8.
a31c2c8 to
a30a485
Compare
a30a485 to
3d90ff2
Compare
699d057 to
bee37e6
Compare
…ntracts Scan server/database/routes/*.ts and write a lazy routes.gen.ts registry and the exact JSON contract of each operation. The Vite plugin and appkit generate-types run it, strictly in production. An app without that directory generates nothing new. CI checks the built declarations and a server bundle that loads its operations without sources. Signed-off-by: ditadi <victordperd@gmail.com>
Signed-off-by: ditadi <victordperd@gmail.com>
Signed-off-by: ditadi <victordperd@gmail.com>
Signed-off-by: ditadi <victordperd@gmail.com>
…put schema The contract generator renders an omitted output slot as void, the way it already renders an omitted input, instead of deriving a row type from the operation's table. Operation generation still loads the schema, so a schema that cannot be imported fails it and neutralizes the contracts on its own. Co-authored-by: Isaac <no-reply@databricks.com> Signed-off-by: ditadi <victordperd@gmail.com>
Main moved to zod 4.6, whose JSON Schema writes a nullable scalar as `type: ["string", "null"]` rather than `anyOf`. [#tern:skip] Co-authored-by: Isaac <no-reply@databricks.com> Signed-off-by: ditadi <victordperd@gmail.com>
generate-types reports any failure itself and exits once its work, lock release, and output are done, so a route module that keeps a timer open cannot hang the CLI or its worker. Route discovery skips dotfiles and dangling symlinks and fails through the path that neutralizes the contracts. The registry is removed once both the schema and the routes are gone, since it imports the schema. Co-authored-by: Isaac <no-reply@databricks.com> Signed-off-by: ditadi <victordperd@gmail.com>
`readonly` binds looser than `[]`, so a readonly array inside an array printed as `readonly string[][]` (modifier on the wrong dimension) or `readonly readonly string[][]` (TS1354). Group it like a union element. Co-authored-by: Isaac <no-reply@databricks.com> Signed-off-by: ditadi <victordperd@gmail.com>
A schema failure threw before the operations pass, so the previous database-operations.d.ts kept advertising operations a failed run should neutralize. Run both passes and report the first failure, as the Vite plugin does. Co-authored-by: Isaac <no-reply@databricks.com> Signed-off-by: ditadi <victordperd@gmail.com>
Co-authored-by: Isaac <no-reply@databricks.com> Signed-off-by: ditadi <victordperd@gmail.com>
The template's prebuild ran generate-types without NODE_ENV, so typegen ran non-strict. A build then skipped an operation without authorization with only a warning, and the deployed app did not serve it. Run the prebuild's typegen with NODE_ENV=production so that operation fails the build. Co-authored-by: Isaac <no-reply@databricks.com> Signed-off-by: ditadi <victordperd@gmail.com>
The test skipped unless `dist` existed, so a CI step after the build ran its whole file just for it. The playground's database typecheck and the bundle check already exercise the built output. Co-authored-by: Isaac <no-reply@databricks.com> Signed-off-by: ditadi <victordperd@gmail.com>
bee37e6 to
ae612fd
Compare
What did you change, and why?
Why: A compiled server has no TypeScript sources to scan, and the browser needs operation types without importing server code.
Change (build time only):
server/database/routes/*.tsand writesserver/database/routes.gen.ts, a lazy-import registry thatsatisfies DatabaseRoutes, andshared/appkit-types/database-operations.d.ts, the exact JSON contract of each operation.appkit generate-typesrun it. WithNODE_ENV=production, an operation without authorization fails generation. An unsupported Zod schema fails with the operation and the slot it came from.input: void, regardless of HTTP method, primary keys, or writable columns. Explicit input schemas still render their exact wire types. Operations without an output schema generateoutput: void, and explicit output schemas render their exact wire types.server/database/, including row schemas and policies. Generated.gen.tsand.d.tsfiles are excluded to prevent generation loops.Interface
Generation scans the
*.tsfiles directly inserver/database/routes/(skipping*.test.ts,*.d.ts, and*.gen.ts) and writes two files that apps commit. For the playground of the last PR of this stack:config/database/orserver/database/change, including shared schemas and policies. Generated outputs do not trigger another run.appkit generate-typesruns it from the CLI.authorizeis skipped with a warning naming itsfile#export. WithNODE_ENV=production, it fails generation instead.z.date(), tuples,z.json(), output transforms, coercion, and preprocessing. A failed run writes an empty interface.How do you know it works?
Testing: Operation generation, generated wire-type equality, and Vite integration pass with the rest of the type generator (626 tests at this layer). A schema that throws on import fails generation and neutralizes the contracts. Coverage includes shared schema/policy add/change/unlink events, ignored generated files, schema-only bootstrapping, final route deletion, strict mode, and explicit/omitted input contracts. The source-less production bundle check loads all three operations under plain Node after TypeScript sources are removed. Repository build, docs, lint/format, and recursive typechecks pass.
Stack
#683 → #687 → #688 → #689 → #690 → #691 → #692
Design: #683. Previous layer: #689. Next layer: #691.
Review feedback:
refactor(appkit): generate void outputs for operations without an output schemadrops the entity check and the default output type, and keeps loading the schema so a broken import still neutralizes the contracts.Review feedback (round 2):
fix(appkit): exit after generating types and skip stray route files.generate-typesreports any failure itself and exits after its output is flushed, so a route module that keeps a timer open cannot hang the CLI or its worker.A handle opened at import can still keep
vite buildalive; the guide in #692 says route modules must not open one.Restack:
fix(appkit): render the type lists zod 4.6 writes for nullable valuesfollows main's zod 4.6.7 upgrade.Stack created with GitHub Stacks CLI • Give Feedback 💬