docs(apps): three codegen-quality guidelines for AppKit / smoke tests#67
Merged
docs(apps): three codegen-quality guidelines for AppKit / smoke tests#67
Conversation
Three additions to the databricks-apps Generic Guidelines, each pinned to
a real failure pattern observed in the apps-mcp-evals nightly:
1. **AppKit API — consult `appkit docs` first.** Mode-D fingerprint:
tonight's prod nightly (run 456555456546311) had 14 catastrophic
build flips; 12/14 were cb_* (cookbook) prompts and the failures were
typecheck errors against AppKit 0.20.3 (`createApp({setup:...})` when
the real config doesn't accept `setup`, etc.). Tracked in LKB-12465.
2. **Playwright APIs — use only documented ones.** Mode-C smoke fixture:
`serving_chat` smoke spec called `page.getByLabelText` (React Testing
Library, not Playwright) → `TypeError: ... is not a function`. Validate
step fails before any UI assertion. Easy nudge.
3. **Smoke query payload size.** `price_prediction_tool` smoke failed with
`Event exceeds max size of 1048576 bytes` + `ERR_ABORTED` because the
underlying analytics query returned a multi-MB row dump. Smoke specs
then can't find the elements that were never rendered. LIMIT 500 or
aggregate.
Each guideline is short and quotes the exact failure signature so the
agent can pattern-match in future generations.
Co-authored-by: Isaac
pkosiec
approved these changes
May 7, 2026
…tpicks Subsumes PR #65 (TypeScript casts). Reorders smoke-test bullets together, trims AppKit API bullet to avoid duplicating the Frameworks section, and tightens wording per nitpicker review. Co-authored-by: Isaac
4 tasks
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
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.
Summary
Consolidates PR #65 and adds four codegen-quality guidelines to the AppKit skill:
npx @databricks/appkit docsbefore writing call sites — avoids invented signatures that failtsc --noEmitduring validateas unknown as <T>double-assertions —appkit lintenforcesno-double-type-assertion(from PR docs(apps): forbidas unknown asdouble type assertions #65)getByLabel(Playwright) notgetByLabelText(React Testing Library) — wrong API throwsTypeErrorat runtimenet::ERR_ABORTEDand missing UI elementsAddresses nitpicker review feedback: reordered smoke-test bullets together, trimmed AppKit API bullet to avoid duplicating the Frameworks section, replaced magic
LIMIT 500with genericLIMIT, concrete aggregation example, Zod narrowing listed first.Supersedes #65.
Test plan
skills.py validatepassesThis pull request and its description were written by Isaac.