Skip to content

Follow Composer 0.32.0, and list the DEV error codes so their docs links resolve - #356

Open
wmadden-electric wants to merge 2 commits into
mainfrom
chore/composer-0.32.0
Open

wmadden-electric wants to merge 2 commits into
mainfrom
chore/composer-0.32.0

Conversation

@wmadden-electric

Copy link
Copy Markdown
Contributor

At a glance

$ prisma dev stop
✔ Stopped shop. Its data and ports are kept for the next `prisma dev`.
$ prisma dev stop
ℹ Nothing of shop was running.

$ prisma dev url gateway
✖ [DEV.NOT_RUNNING] The service "gateway" is stopped.
  `prisma dev stop`, `prisma dev` ending, and running another app in this directory all stop an app's services and database servers, and a stopped node has no URL that answers.
  Docs: https://www.prisma.io/docs/cli/error-reference/DEV.NOT_RUNNING

The CLI now ships Composer 0.32.0. Composer's own release notes cover what changed in its commands, such as the second prisma dev stop above. The docs link in the error now leads to an entry: until this PR, the CLI's error reference had no DEV.* entries, so every docs link in a prisma dev url, prisma dev stop or prisma emulator list error led to a missing page.

The decision

  1. The pins for @prisma/composer-cli and @prisma/composer move from 0.31.0 to 0.32.0. I used the repository's own script for following product releases (scripts/update-product-versions.mjs --channel release).
  2. docs/reference/error-reference.md gains a DEV section with the codes these commands raise:
    • DEV.ADDRESS_UNKNOWN
    • DEV.EMULATOR_FAILED
    • DEV.EMULATOR_UNREACHABLE
    • DEV.EMULATORS_DIR_INVALID
    • DEV.NOT_RUNNING
    • DEV.NOT_STARTED_HERE

Why Composer's codes belong on this page

The page already says it lists every code the CLI can emit, and the hosted error reference is built from it. Composer's errors carry docs links into that hosted reference.

What kept family codes off the page is the completeness check. pnpm check:error-reference scans only this repository's source, so it never asked for them.

The page's introduction now says both things:

  • Codes from the command families the CLI mounts are listed too.
  • The check does not verify them, so they are updated by hand when the CLI moves to a new release of a family.

Each entry follows the page's existing format. It says when the code is raised, what the error's why and fix say, and which meta fields it carries. The wording is taken from what Composer 0.32.0 prints.

The section opens by defining the words the entries rely on:

  • A node is one service, database or bucket in your app.
  • Its address is its name in the app, with dots for a nested node.
  • An emulator is the program on this machine that runs a node in place of Prisma Cloud.

Tests

  • CLI tests, typecheck, check:grammar, check:error-reference (131 codes), check:skill-packaging and Biome pass.
  • check:conformance passes with its existing allowed exceptions: Composer 0.32.0 and the ORM toolchain still peer CLI engine 0.7.0, while the shell ships 0.9.0.

Not in this PR

Composer raises other DEV.* codes from prisma dev itself, such as DEV.CONVERGE_FAILED and DEV.PLATFORM_UNSUPPORTED, and COMPOSE.* codes from deploy and dev. The ORM family's codes are not listed either. Those links lead to a missing page today too. This PR covers the codes of the commands #355 added.

Agent: attila-51

🤖 Generated with Claude Code

wmadden-electric and others added 2 commits October 19, 2026 18:28
…> 0.32.0; @prisma/composer 0.31.0 -> 0.32.0

Moved with scripts/update-product-versions.mjs.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: willbot <w.a.madden+machine@gmail.com>
Signed-off-by: Will Madden <madden@prisma.io>
…r list raise

Composer's errors link to the hosted error reference, which is built
from this page, and the page had no DEV entries, so those links led
nowhere. It now lists DEV.ADDRESS_UNKNOWN, DEV.EMULATOR_FAILED,
DEV.EMULATOR_UNREACHABLE, DEV.EMULATORS_DIR_INVALID, DEV.NOT_RUNNING
and DEV.NOT_STARTED_HERE, with the summary, why and fix each command
prints in Composer 0.32.0.

The page already says it lists every code the CLI can emit, so a
mounted family's codes belong here. The intro now says so, and says
check:error-reference verifies only this repository's codes, so a
family's entries are updated by hand with each release.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: willbot <w.a.madden+machine@gmail.com>
Signed-off-by: Will Madden <madden@prisma.io>
@pkg-pr-new

pkg-pr-new Bot commented Oct 19, 2026

Copy link
Copy Markdown

Open in StackBlitz

npx https://pkg.pr.new/@prisma/cli@356
npx https://pkg.pr.new/@prisma/cli-engine@356

commit: d2a5888

@coderabbitai

coderabbitai Bot commented Oct 19, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Organization UI
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: f63771d1-aa01-473e-aa8d-adf67b780763
📥 Commits

Reviewing files that changed from the base of the PR and between 52c518f and d2a5888.

⛔ Files ignored due to path filters: 1
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing: 3
  • docs/reference/error-reference.md
  • packages/cli/package.json
  • packages/prisma/package.json

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

Summary by CodeRabbit

  • Documentation
    • Added reference documentation for Composer address lookup, emulator, connectivity, directory configuration, stopped-node, and command-location errors.
    • Clarified that hosted references include errors from mounted command families and that those entries require manual updates when a family release changes.
  • Chores
    • Updated the Composer packages used by the CLI and Prisma to version 0.32.0.

Walkthrough

The CLI and Prisma packages update Composer dependencies from version 0.31.0 to 0.32.0. The error reference explains that repository checks cover source error codes, while mounted command-family entries require manual maintenance. It adds the DEV namespace and documents six Composer errors and their command contexts.

Priority: ⬇️ Low

Merge Risk: ⚪ Minimal · up to d2a58

The dependency update and DEV reference are ready to merge after normal checks; no outstanding issue is established.

### Architecture Summary

Architecture risk: 🔵 Low · up to d2a58

The change affects 3 systems.

Changed systems: docs, packages/cli, packages/prisma

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — docs (service) was modified; 1 changed file maps to changed impact.
  • observed — packages/cli (library) was modified; 1 changed file maps to changed impact.
  • observed — packages/prisma (library) was modified; 1 changed file maps to changed impact.

Before / after behavior

  • observed — Modified behavior in docs/reference/error-reference.md: Adds the distinction between mounted command-family codes and repository-source codes: the hosted reference includes both, but the completeness check verifies only repository codes, leaving family entries to manual maintenance across releases.
  • observed — Modified behavior in docs/reference/error-reference.md: Adds the DEV namespace for commands that run apps locally with Composer, including prisma dev, its URL and stop subcommands, and emulator listing.
  • observed — Modified behavior in docs/reference/error-reference.md: Adds the DEV section and six Composer error entries: unknown app addresses include recorded addresses; emulator request failures are errors for dev, dev url, and dev stop, but diagnostics in emulator list preserve exit 0; unreachable emulators distinguish a stopped process from one that is alive but not accepting connections; relative PRISMA_COMPOSER_EMULATORS_DIR values are invalid, with an unset variable defaulting to ~/.prisma-composer/emulators; non-running nodes cover stopped, exited/restarting, and missing-emulator states; and URL or stop commands fail when run outside a directory recorded by prisma dev.
  • observed — Modified behavior in packages/cli/package.json: The @prisma/composer-cli dependency changes from version 0.31.0 to 0.32.0.
Pre-merge checks: Passed 5
Check name Status Explanation
Title check Passed The title clearly summarizes the main changes: updating Composer to 0.32.0 and documenting DEV error codes.
Description check Passed The description directly explains the dependency updates, added DEV error documentation, rationale, scope, and reported checks.
Docstring Coverage Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (3 skipped: 3 unsupported.)

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
✨ Simplify code
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Comment @coderabbitai help to get the list of available commands.

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