Skip to content

[cli] Throw explicit error when vercel.ts routes conversion creates a conflict#14709

Merged
MatthewStanciu merged 26 commits intomainfrom
matthew/explicit-error
Jan 24, 2026
Merged

[cli] Throw explicit error when vercel.ts routes conversion creates a conflict#14709
MatthewStanciu merged 26 commits intomainfrom
matthew/explicit-error

Conversation

@MatthewStanciu
Copy link
Copy Markdown
Contributor

@MatthewStanciu MatthewStanciu commented Jan 23, 2026

#14705 fixes this use case of vercel.ts:

// ✅ fixed
export const config: VercelConfig = {
  routes: [
    routes.rewrite('/test-header', 'https://httpbin.org/headers', {
      requestHeaders: {
        authorization: `Bearer token`,
      },
    }),
    routes.redirect('/test-build', 'https://httpbin.org/headers'),
  ]
};

But the user can still have a confusing experience if they do this:

// ❌ not fixed
export const config: VercelConfig = {
  rewrites: [
    routes.rewrite('/test-env', 'https://httpbin.org/headers', {
      requestHeaders: {
        authorization: `Bearer ${deploymentEnv('API_TOKEN')}`,
      },
    }),
    routes.rewrite('/test-rewrite-regular', 'https://httpbin.org/headers')
  ],
  redirects: [
    routes.redirect('/test-build', 'https://httpbin.org/headers'),
  ]
};

This will fail with the error message:

Error: If `rewrites`, `redirects`, `headers`, `cleanUrls` or `trailingSlash` are used, then `routes` cannot be present.

But that's not clear because from the user's perspective they separated their rewrites and redirects like the docs say, so where is routes coming from?

We're not going to compile the redirects to routes (#14679), so we need the error message to be clearer.

This PR fails the build during config compilation if after normalization (AKA compiling anything to routes that needs this transformation) there's still a conflict. In this case, since it has the full context of what just happened (unlike the generic vercel.json error it currently throws) it can throw a more descriptive error message with clear instructions for what to do.

Screenshot 2026-01-23 at 5 12 34 PM

@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented Jan 23, 2026

🦋 Changeset detected

Latest commit: 05c3d1d

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
vercel Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@MatthewStanciu MatthewStanciu changed the base branch from main to matthew/refactor-compile-vercel-config January 23, 2026 01:02
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Jan 23, 2026

📦 CLI Tarball Ready

The Vercel CLI tarball for this PR is now available!

Quick Test

You can test this PR's CLI directly by running:

npx https://vercel-or2ad969i.vercel.sh/tarballs/vercel.tgz --help

Use in vercel.json

To use this CLI version in your project builds, add to your vercel.json:

{
  "build": {
    "env": {
      "VERCEL_CLI_VERSION": "vercel@https://vercel-or2ad969i.vercel.sh/tarballs/vercel.tgz"
    }
  }
}

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Jan 23, 2026

🧪 Unit Test Strategy

Comparing: db9ec7c05c3d1d (view diff)

Strategy: Affected packages only

✅ Only testing packages that have been modified or depend on modified packages.

Affected packages - 1 (2%)
  1. vercel
Unaffected packages - 40 (98%)
  1. @vercel-internals/get-package-json
  2. @vercel/backends
  3. @vercel/build-utils
  4. @vercel/cervel
  5. @vercel/cli-auth
  6. @vercel/client
  7. @vercel/config
  8. @vercel/detect-agent
  9. @vercel/edge
  10. @vercel/elysia
  11. @vercel/error-utils
  12. @vercel/express
  13. @vercel/fastify
  14. @vercel/firewall
  15. @vercel/frameworks
  16. @vercel/fs-detectors
  17. @vercel/functions
  18. @vercel/gatsby-plugin-vercel-builder
  19. @vercel/go
  20. @vercel/h3
  21. @vercel/hono
  22. @vercel/hydrogen
  23. @vercel/introspection
  24. @vercel/koa
  25. @vercel/nestjs
  26. @vercel/next
  27. @vercel/node
  28. @vercel/oidc
  29. @vercel/oidc-aws-credentials-provider
  30. @vercel/python
  31. @vercel/python-analysis
  32. @vercel/redwood
  33. @vercel/related-projects
  34. @vercel/remix-builder
  35. @vercel/routing-utils
  36. @vercel/ruby
  37. @vercel/rust
  38. @vercel/static-build
  39. @vercel/static-config
  40. examples

Results

  • Unit tests: Only affected packages will run unit tests
  • E2E tests: Handled separately (Version Packages PRs or run-e2e-tests label)
  • Type checks: Only affected packages will run type checks

This comment is automatically generated based on the affected testing strategy

@MatthewStanciu MatthewStanciu marked this pull request as ready for review January 23, 2026 01:08
@MatthewStanciu MatthewStanciu requested a review from a team as a code owner January 23, 2026 01:08
Copy link
Copy Markdown
Contributor

@vercel vercel bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Additional Suggestion:

toRouteFormat is called with 2 parameters but only accepts 1, and undefined isRouteFormat function is called

Fix on Vercel

Base automatically changed from matthew/refactor-compile-vercel-config to main January 24, 2026 01:08
Copy link
Copy Markdown
Contributor

@vercel vercel bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Additional Suggestion:

Test 'should produce invalid config when rewrites have transforms but redirects do not' expects no error but normalizeConfig throws when arrays have conflicting conversion requirements

Fix on Vercel

@MatthewStanciu MatthewStanciu merged commit 7944bdd into main Jan 24, 2026
226 of 228 checks passed
@MatthewStanciu MatthewStanciu deleted the matthew/explicit-error branch January 24, 2026 01:50
ecklf pushed a commit that referenced this pull request Jan 26, 2026
This PR was opened by the [Changesets
release](https://github.com/changesets/action) GitHub action. When
you're ready to do a release, you can merge this and the packages will
be published to npm automatically. If you're not ready to do a release
yet, that's fine, whenever you add more changesets to main, this PR will
be updated.


# Releases
## vercel@50.5.1

### Patch Changes

- Mild refactor of compile-vercel-config
([#14707](#14707))

- Throw explicit error when vercel.ts routes compilation creates a
conflict ([#14709](#14709))

- vercel.ts: normalize items in `routes` array to routes format
([#14705](#14705))

- Improvements to vercel api command. Better ls, and help output
([#14720](#14720))

- Updated dependencies
\[[`e0e7e3cdd180eb1e07e2ebaba809a2486b546b5d`](e0e7e3c)]:
    -   @vercel/rust@1.0.5

## @vercel/config@0.0.27

### Patch Changes

- Remove references to nonexistent `redirects` property
([#14708](#14708))

## @vercel/rust@1.0.5

### Patch Changes

- Do not allow production prebuilt deployments on Windows
([#14724](#14724))

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
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