Repository navigation
chore(drizzle): fail loudly when DATABASE_URL is missing + document migrate workflow - #25
Merged
Merged
Conversation
…orkflow When DATABASE_URL was unset, drizzle-kit migrate would pass `undefined` to the driver (the `process.env.DATABASE_URL!` non-null bang was a fiction) and hang with a spinner instead of erroring. Caught while applying #22 against a prod DB whose .env was stale. - drizzle.config.ts: throw explicitly if DATABASE_URL is missing, with an actionable message pointing at the local/prod paths. Drop the misleading non-null assertion. - Add apps/web/README.md with the local-dev + prod migrate workflows, including the vercel env pull pattern and what to do if __drizzle_migrations drifts out of sync with the file system. Closes #24
There was a problem hiding this comment.
Pull request overview
This PR tightens the Drizzle migration workflow for apps/web by failing fast when DATABASE_URL is missing and adding a dedicated apps/web README that documents local and production migration procedures (addressing the workflow gap described in issue #24).
Changes:
- Add an explicit runtime guard in
apps/web/drizzle.config.tsto throw whenDATABASE_URLis unset (instead of relying on a non-null assertion). - Add
apps/web/README.mddocumenting local dev Postgres setup and a production-safe migration workflow (including guidance fordrizzle.__drizzle_migrationsdrift).
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
| apps/web/drizzle.config.ts | Adds a DATABASE_URL presence check and uses the validated value in dbCredentials. |
| apps/web/README.md | New documentation for local dev DB setup, migration generation/apply workflow, and production env handling. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Copilot review on #25 flagged six real doc bugs: - pnpm db:* scripts are in apps/web/package.json, not root — three examples told readers to run them from repo root which would fail with 'missing script'. Rewrite all invocations to use `pnpm --filter @repo/web <script>` (or `cd apps/web` where a multi-line flow reads better), and add a note at the top. - Step 1 mentioned "schema.ts for pro-only tables" — there is no pro overlay in this repo, so drop the misleading parenthetical and point at schema-core.ts only. - `node --env-file=` requires Node 20.6+, not just Node 20 — note the version and document the `pnpm dlx dotenv-cli` fallback. - The error message in drizzle.config.ts said `vercel env pull` but without `--environment=production`, which defaults to development and would point the migrator at the wrong DB.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Round-two review feedback on #25: - The previous commit's guard threw at config-load for *all* drizzle- kit commands, breaking `db:generate` for anyone without DATABASE_URL set (generate is a file-only op that doesn't hit the DB). Gate the throw on `process.argv` matching a connection- requiring subcommand (migrate, push, pull, studio, introspect). - Local-dev README used `echo ... >> apps/web/.env`, which accretes duplicate lines on repeat runs. Switch to a numbered list with a human instruction to create/edit the file and set DATABASE_URL.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Round-three review feedback on #25: the backfill snippet wrote `apps/web/drizzle/<tag>.sql` while the production migrate workflow just above it has readers run from `apps/web`. Switch to relative `drizzle/<tag>.sql` and explicitly anchor the backfill to the same CWD.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Round-four review feedback on #25: README claimed '.env*.local is gitignored' but the repo's .gitignore has '.env*' with an exception for '.env.example'. Update the wording to match so readers don't assume only *.local variants are safe.
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
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.
Closes #24.
Context
Part 1 of #24 — back-filling
drizzle.__drizzle_migrationsfor the existing production DB — has been done out of band (the tracking table now has rows for0000_goofy_sally_floydand0001_scans_repo_status_created_idx, verified by a follow-updrizzle-kit migraterun that completed with zero new statements applied). This PR addresses part 2: the workflow gap that caused us to apply #23 manually in the first place.Summary
drizzle.config.ts: throw an explicit error whenDATABASE_URLis missing, with an actionable message. Drop the!non-null assertion that was making a missing var silently fall through to the driver.apps/web/README.md(new): document the local-dev + prod migrate workflows, including thevercel env pullpattern and a note on what to do if__drizzle_migrationsdrifts out of sync with the file system.Why
When
DATABASE_URLwas unset,drizzle-kit migratewould passundefinedto the driver and hang on the "applying migrations..." spinner instead of erroring. No feedback, no exit. The fake non-null assertion didn't help.The README gives anyone running the migrator an explicit, copy-pasteable path for both dev and prod so the next person doesn't end up staring at a silent spinner.
Test plan
pnpm turbo typecheckpassespnpm turbo testpassesenv -u DATABASE_URL node node_modules/.bin/drizzle-kit migrateprints the guard message and exits non-zeropnpm db:migrateagainst a dev DB still works unchangedOut of scope
db:migrate:prodetc.). Kept this repo deployment-agnostic; the README walks through the pattern.