TML-3071: error-reference page for all 221 codes + CI completeness check - #1027
Conversation
…eness check Add docs/reference/error-reference.md — the canonical source for the hosted error reference at docs.prisma.io/docs/orm/next/reference/error-reference — with an entry for every published NAMESPACE.SUBCODE code: what produces it, during which operation, and its meta keys. Wire check:error-reference (list-error-codes.mjs --verify) into the Lint job so a PR that adds a code without documenting it fails CI. Link the page from the docs index and Error Handling. Refs: TML-3071 Signed-off-by: willbot <w.a.madden+machine@gmail.com> Signed-off-by: Will Madden <madden@prisma.io>
|
Warning Review limit reached
Next review available in: 13 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Path: .coderabbit.yml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (5)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
size-limit report 📦
|
@prisma-next/extension-author-tools
@prisma-next/mongo-runtime
@prisma-next/family-mongo
@prisma-next/sql-runtime
@prisma-next/family-sql
@prisma-next/extension-arktype-json
@prisma-next/middleware-cache
@prisma-next/mongo
@prisma-next/extension-paradedb
@prisma-next/extension-pgvector
@prisma-next/extension-postgis
@prisma-next/postgres
@prisma-next/sql-orm-client
@prisma-next/sqlite
@prisma-next/extension-supabase
@prisma-next/target-mongo
@prisma-next/adapter-mongo
@prisma-next/driver-mongo
@prisma-next/contract
@prisma-next/utils
@prisma-next/config
@prisma-next/errors
@prisma-next/framework-components
@prisma-next/operations
@prisma-next/ts-render
@prisma-next/contract-authoring
@prisma-next/ids
@prisma-next/psl-parser
@prisma-next/psl-printer
@prisma-next/cli
@prisma-next/cli-telemetry
@prisma-next/config-loader
@prisma-next/emitter
@prisma-next/language-server
@prisma-next/migration-tools
prisma-next
@prisma-next/vite-plugin-contract-emit
@prisma-next/mongo-codec
@prisma-next/mongo-contract
@prisma-next/mongo-value
@prisma-next/mongo-contract-psl
@prisma-next/mongo-contract-ts
@prisma-next/mongo-emitter
@prisma-next/mongo-schema-ir
@prisma-next/mongo-query-ast
@prisma-next/mongo-orm
@prisma-next/mongo-query-builder
@prisma-next/mongo-lowering
@prisma-next/mongo-wire
@prisma-next/sql-contract
@prisma-next/sql-errors
@prisma-next/sql-operations
@prisma-next/sql-schema-ir
@prisma-next/sql-contract-psl
@prisma-next/sql-contract-ts
@prisma-next/sql-contract-emitter
@prisma-next/sql-lane-query-builder
@prisma-next/sql-relational-core
@prisma-next/sql-builder
@prisma-next/target-postgres
@prisma-next/target-sqlite
@prisma-next/adapter-postgres
@prisma-next/adapter-sqlite
@prisma-next/driver-postgres
@prisma-next/driver-sqlite
commit: |
Linked issue
Refs TML-3071. Error-consolidation follow-through of TML-3067 / PR #1016 (ADR 239): shipped error messages already print
docs.prisma.io/.../error-reference#<CODE>URLs; this makes the page real and provably complete before RC (Jul 31).At a glance
One such entry now exists for every one of the 221 published codes, and CI fails any PR that adds a code without one:
Decision
isStructuredError+code), the reserved exit codes, a pointer to the ADR 239 crosswalk, and a namespace overview table, then lists all 221 codes grouped by namespace with###headings (so each code is an anchor). Every entry says what condition produces the error, during which command or API, and its notablemetakeys. Three factory-declared codes with no production call site are documented as "Reserved".pnpm check:error-reference(wired into the Lint job) runsscripts/list-error-codes.mjs --verifyagainst the page and fails listing any code in production source the page omits.Reviewer notes
--rootflag.RUNTIME.DECODE_FAILED's three carriers) and severity nuances (LINT.SELECT_STARwarns on the AST path, errors on raw SQL;CONTRACT.MARKER_MISSINGis a hard failure from verify commands but a warning at runtime startup).list-error-codes.mjsand its tests already existed (from TML-3067: all error codes become dotted NAMESPACE.SUBCODE (ADR 239) #1016); this PR only adds the page, thecheck:error-referencescript entry, the CI step, and two doc links.Testing performed
pnpm check:error-reference— lists all 221 known codes.pnpm test:scripts— 206/206 (the one initial red was a workspace-link install-state issue from TML-3072: fold ref-paired snapshots into the content-addressed store #1024's new test, fixed bypnpm install, no code change).pnpm lint:workflows,pnpm lint:docs— clean.Follow-ups
--verify --rootcheck in that repo's build) happens in the docs repo; thenext→v8URL-segment flip is the one-tokenDOCS_ERRORS_VERSIONchange at RC.Alternatives considered
--verifymode keeps the hand-written page honest instead.Checklist
git commit -s) per the DCO.TML-NNNN: <sentence-case title>form.examples/orpackages/3-extensions/files touched, so no upgrade-recipe entry is required.