Add support for "_middleware.{js,ts}" to `vercel dev` #6880

gdborton · 2021-10-22T18:46:18Z

Related Issues

This adds support for running _middleware.{js,ts} in the vc dev command.

📋 Checklist

Tests

The code changed/added as part of this PR has been covered with tests
All tests pass locally with yarn test-unit

Code Review

This PR has a concise title and thorough description useful to a reviewer
Issue from task tracker has a link to this PR

TooTallNate · 2021-10-29T18:20:50Z

packages/middleware/src/index.ts

@@ -37,25 +49,26 @@ async function getMiddlewareFile() {
  return middlewareFiles[0];
 }

-export async function build() {
-  const middlewareFile = await getMiddlewareFile();
+export async function build({ workPath }: BuildOptions) {


I was trying to avoid having to specify workPath explicitly since it should be able to be inferred from cwd. But let's leave it since it'll make writing tests easier (makes the function more "pure").

Using BuildOptions interface though isn't quite correct, since that's the interface for the Runtimes' build() function, not the Plugins' build() function. So far, this workPath is the only prop that needs to be passed in to the Plugin build fn.

packages/middleware/src/index.ts

* [cli] Fix tracing for `vc build` * Ignore object when there are no changes * Make Next < 12 work with FS API w/ nft * Update packages/cli/src/commands/build.ts Co-authored-by: Nathan Rajlich <n@n8.io> * Document how Next.js processing works in build * [cli] Fix static assets (#6906) * Make sure output path is .next * Fix up require-server-files for processing * Fix typo * Move static * Update static rename Co-authored-by: Andy Bitz <artzbitz@gmail.com> Co-authored-by: Nathan Rajlich <n@n8.io> Co-authored-by: Andy <AndyBitz@users.noreply.github.com>

- vercel@23.1.3-canary.17 - @vercel/client@10.2.3-canary.15 - @vercel/static-config@0.0.1-canary.0

- vercel@23.1.3-canary.18

The new plugin architecture doesn't pass a full BuildOptions object, previous to this commit it wasn't passing any options at all. I've added workingPath to support running dev/build from directories other than the project root.

This allows vercel build to continue working for projects that are not using frameworks, but use package.json to manage dependencies.

Next js PR w/ the header fix: vercel/next.js#30560

…into edge-function-exploration

TooTallNate · 2021-10-29T19:40:49Z

packages/cli/src/commands/build.ts

-    result = true;
-  }
-
-  if (!result) {


We removed this error message because it's possible you have a package.json and no build script defined (i.e. I want to have deps in my middleware or API file).

…ploration

* Add initial `vercel-plugin-middleware` * Ignore `entries.js` from ESLint * Add `runDevMiddleware()` stub * Add test * Add support for "_middleware.{js,ts}" to `vercel dev` (#6880) * Add websandbox from next.js codebase. * Use node-fetch instead of next's polyfilled fetch. * Handle middleware rewrites. * Add response, headers, and request to websandbox context. * Move websandbox dependency to middleware plugin. * Add integration tests, update websandbox to support ts files and json imports. * commit yarn.lock changes after rebasing * Clean up left over console.logs, fix some tsc issues, and rebase issue. * Fix failing test and eslint. * Fix middleware test on windows. * [examples] Update Vercel Next.js example template to 12.0.1 (#6905) * Mark the Plugins as external to CLI's ncc build * [cli] Improve tracing in vc build (#6898) * [cli] Fix tracing for `vc build` * Ignore object when there are no changes * Make Next < 12 work with FS API w/ nft * Update packages/cli/src/commands/build.ts Co-authored-by: Nathan Rajlich <n@n8.io> * Document how Next.js processing works in build * [cli] Fix static assets (#6906) * Make sure output path is .next * Fix up require-server-files for processing * Fix typo * Move static * Update static rename Co-authored-by: Andy Bitz <artzbitz@gmail.com> Co-authored-by: Nathan Rajlich <n@n8.io> Co-authored-by: Andy <AndyBitz@users.noreply.github.com> * Publish Canary - vercel@23.1.3-canary.17 - @vercel/client@10.2.3-canary.15 - @vercel/static-config@0.0.1-canary.0 * [cli] Ignore `.env` and `.gitignore` in "vc build" (#6910) * Publish Canary - vercel@23.1.3-canary.18 * Pass workPath to plugins. The new plugin architecture doesn't pass a full BuildOptions object, previous to this commit it wasn't passing any options at all. I've added workingPath to support running dev/build from directories other than the project root. * Remove error state when package.json exists, but no build script This allows vercel build to continue working for projects that are not using frameworks, but use package.json to manage dependencies. * Fix types, pull in middleware header fix from next.js Next js PR w/ the header fix: vercel/next.js#30560 * Fix missing entries file for vc build. * Update call signature of middleware when using vc build. Co-authored-by: Drew Bredvick <dbredvick@gmail.com> Co-authored-by: Nathan Rajlich <n@n8.io> Co-authored-by: Jared Palmer <jared@jaredpalmer.com> Co-authored-by: Andy Bitz <artzbitz@gmail.com> Co-authored-by: Andy <AndyBitz@users.noreply.github.com> Co-authored-by: Gary Borton <gdborton@gmail.com> Co-authored-by: Drew Bredvick <dbredvick@gmail.com> Co-authored-by: Jared Palmer <jared@jaredpalmer.com> Co-authored-by: Andy Bitz <artzbitz@gmail.com> Co-authored-by: Andy <AndyBitz@users.noreply.github.com>

gdborton requested a review from TooTallNate October 22, 2021 18:46

vercel bot deployed to Preview October 26, 2021 21:40 View deployment

gdborton force-pushed the edge-function-exploration branch from 25711b1 to 7c81a16 Compare October 26, 2021 21:41

vercel bot deployed to Preview October 26, 2021 21:42 View deployment

gdborton force-pushed the edge-function-exploration branch from 7c81a16 to 2859cb1 Compare October 27, 2021 03:01

vercel bot deployed to Preview October 27, 2021 03:01 View deployment

gdborton force-pushed the edge-function-exploration branch from 2859cb1 to df1a48e Compare October 27, 2021 03:02

vercel bot deployed to Preview October 27, 2021 03:03 View deployment

vercel bot deployed to Preview October 27, 2021 04:49 View deployment

gdborton force-pushed the edge-function-exploration branch from d678e55 to e19bd58 Compare October 27, 2021 05:12

vercel bot deployed to Preview October 27, 2021 05:12 View deployment

gdborton force-pushed the edge-function-exploration branch from e19bd58 to 8f8b8fc Compare October 27, 2021 16:55

vercel bot deployed to Preview October 27, 2021 16:55 View deployment

gdborton force-pushed the edge-function-exploration branch from 8f8b8fc to cf0e9b6 Compare October 27, 2021 17:03

vercel bot deployed to Preview October 27, 2021 17:03 View deployment

gdborton force-pushed the edge-function-exploration branch from cf0e9b6 to 336ead9 Compare October 28, 2021 00:06

vercel bot deployed to Preview October 28, 2021 00:06 View deployment

gdborton force-pushed the edge-function-exploration branch from 336ead9 to c156146 Compare October 28, 2021 16:16

vercel bot deployed to Preview October 28, 2021 16:16 View deployment

vercel bot deployed to Preview October 28, 2021 19:28 View deployment

gdborton force-pushed the edge-function-exploration branch from 7c48ca9 to fac1e24 Compare October 28, 2021 19:42

vercel bot deployed to Preview October 28, 2021 19:42 View deployment

gdborton changed the title ~~wip~~ Add support for _middleware.{js,ts} to vercel dev. Oct 28, 2021

vercel bot deployed to Preview October 28, 2021 20:00 View deployment

gdborton changed the base branch from main to add/vercel-plugin-middleware October 28, 2021 20:02

gdborton force-pushed the edge-function-exploration branch from 46b0ed5 to 4aebe94 Compare October 28, 2021 20:11

vercel bot deployed to Preview October 28, 2021 20:11 View deployment

gdborton added 3 commits October 28, 2021 13:14

Add websandbox from next.js codebase.

a22c0a3

Use node-fetch instead of next's polyfilled fetch.

c447f0d

Handle middleware rewrites.

bf70376

vercel bot deployed to Preview October 29, 2021 06:03 View deployment

Fix middleware test on windows.

90f15c3

gdborton force-pushed the edge-function-exploration branch from c4fd8db to 90f15c3 Compare October 29, 2021 06:56

vercel bot deployed to Preview October 29, 2021 06:56 View deployment

[examples] Update Vercel Next.js example template to 12.0.1 (#6905)

1a9419b

TooTallNate reviewed Oct 29, 2021

View reviewed changes

packages/middleware/src/index.ts Outdated Show resolved Hide resolved

TooTallNate reviewed Oct 29, 2021

View reviewed changes

packages/middleware/src/index.ts Outdated Show resolved Hide resolved

Mark the Plugins as external to CLI's ncc build

555d1b5

vercel bot deployed to Preview October 29, 2021 18:49 View deployment

jaredpalmer and others added 8 commits October 29, 2021 20:49

Publish Canary

a3fc3c1

- vercel@23.1.3-canary.17 - @vercel/client@10.2.3-canary.15 - @vercel/static-config@0.0.1-canary.0

[cli] Ignore .env and .gitignore in "vc build" (#6910)

8a6869b

Publish Canary

df9a4af

- vercel@23.1.3-canary.18

Pass workPath to plugins.

ebdd4c7

The new plugin architecture doesn't pass a full BuildOptions object, previous to this commit it wasn't passing any options at all. I've added workingPath to support running dev/build from directories other than the project root.

Remove error state when package.json exists, but no build script

c0be550

This allows vercel build to continue working for projects that are not using frameworks, but use package.json to manage dependencies.

Fix types, pull in middleware header fix from next.js

a38b0bc

Next js PR w/ the header fix: vercel/next.js#30560

Merge branch 'edge-function-exploration' of github.com:vercel/vercel …

63fd484

…into edge-function-exploration

vercel bot deployed to Preview October 29, 2021 19:25 View deployment

TooTallNate reviewed Oct 29, 2021

View reviewed changes

gdborton added 3 commits October 29, 2021 13:14

Fix missing entries file for vc build.

afcfe3e

Merge branch 'main' of github.com:vercel/vercel into edge-function-ex…

6fcbb5e

…ploration

Update call signature of middleware when using vc build.

fe26ca0

gdborton requested review from Timer and timneutkens as code owners October 29, 2021 21:03

vercel bot deployed to Preview October 29, 2021 21:03 View deployment

TooTallNate changed the title ~~Add support for _middleware.{js,ts} to vercel dev.~~ Add support for "_middleware.{js,ts}" to vercel dev Oct 29, 2021

TooTallNate merged commit 8b11318 into add/vercel-plugin-middleware Oct 29, 2021

TooTallNate deleted the edge-function-exploration branch October 29, 2021 22:18

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for "_middleware.{js,ts}" to `vercel dev` #6880

Add support for "_middleware.{js,ts}" to `vercel dev` #6880

gdborton commented Oct 22, 2021 •

edited

TooTallNate Oct 29, 2021

TooTallNate Oct 29, 2021

Add support for "_middleware.{js,ts}" to vercel dev #6880

Add support for "_middleware.{js,ts}" to vercel dev #6880

Conversation

gdborton commented Oct 22, 2021 • edited

Related Issues

📋 Checklist

Tests

Code Review

TooTallNate Oct 29, 2021

Choose a reason for hiding this comment

TooTallNate Oct 29, 2021

Choose a reason for hiding this comment

Add support for "_middleware.{js,ts}" to `vercel dev` #6880

Add support for "_middleware.{js,ts}" to `vercel dev` #6880

gdborton commented Oct 22, 2021 •

edited