Skip to content

docs(apps): never override the @databricks/appkit or @databricks/appkit-ui version in package.json#69

Merged
keugenek merged 1 commit intomainfrom
evgenii.kniazev/skill-codegen-quality
May 7, 2026
Merged

docs(apps): never override the @databricks/appkit or @databricks/appkit-ui version in package.json#69
keugenek merged 1 commit intomainfrom
evgenii.kniazev/skill-codegen-quality

Conversation

@keugenek
Copy link
Copy Markdown
Contributor

@keugenek keugenek commented May 7, 2026

Summary

AppKit version pinning (LKB-12614): never override @databricks/appkit version in package.jsondatabricks apps init sets the correct version. Agent was writing stale versions from training data (0.11.0 when latest is 0.31.0).

Plus: smoke-test selector guidance (use Playwright locator APIs, not React Testing Library), data-size cap for analytics payloads.

Supersedes PR #65 (which covered only the TypeScript-casts bullet). Mario Cadenas's review feedback from #65 is incorporated (auto-gen queryKey files carve-out, warehouse-unavailable unknown case).

Documentation safety checklist

  • Examples use least-privilege permissions
  • Elevated permissions explicitly called out where required
  • Sensitive values are obfuscated
  • No insecure patterns introduced

Co-authored-by: Isaac

@keugenek keugenek requested a review from a team as a code owner May 7, 2026 15:49
@keugenek
Copy link
Copy Markdown
Contributor Author

keugenek commented May 7, 2026

isaac-bot pull master and resolve any conflicts.

@keugenek keugenek force-pushed the evgenii.kniazev/skill-codegen-quality branch from 5403014 to 9daafd7 Compare May 7, 2026 16:07
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
@keugenek keugenek force-pushed the evgenii.kniazev/skill-codegen-quality branch from 9daafd7 to d21bb9a Compare May 7, 2026 16:16
@keugenek keugenek merged commit d21d74e into main May 7, 2026
1 check passed
@keugenek keugenek changed the title docs(apps): codegen quality guidelines — AppKit API, type casts, version pinning (LKB-12428, LKB-12465, LKB-12614) docs(apps): never override the @databricks/appkit or @databricks/appkit-ui version in package.json May 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants