@netlify/dev 4.0.2 → 4.1.0

package/README.md

@@ -15,12 +15,13 @@ Functions, Blobs, Static files, and Redirects.
 | Feature                | Supported |
 | ---------------------- | --------- |
 | Functions              | ✅ Yes    |
-| Edge Functions         | ❌ No     |
+| Edge Functions         | ✅ Yes    |
 | Blobs                  | ✅ Yes    |
 | Cache API              | ✅ Yes    |
 | Redirects and Rewrites | ✅ Yes    |
-| Headers                | ❌ No     |
+| Headers                | ✅ Yes    |
 | Environment Variables  | ✅ Yes    |
+| Image CDN              | ❌ No     |
 
 > Note: Missing features will be added incrementally. This module is **not** intended to be a full replacement for the
 > Netlify CLI.
@@ -45,15 +46,32 @@ You can use `@netlify/dev` to emulate the Netlify runtime in your own developmen
 import { NetlifyDev } from '@netlify/dev'
 
 const devServer = new NetlifyDev({
-  functions: { enabled: true },
   blobs: { enabled: true },
+  edgeFunctions: { enabled: true },
+  environmentVariables: { enabled: true },
+  functions: { enabled: true },
   redirects: { enabled: true },
-  staticFiles: { enabled: true },
+  staticFiles: {
+    enabled: true,
+    // OPTIONAL: additional directories containing static files to serve
+    // Your `projectRoot` (see below) and your site's `publish` dir are served by default
+    directories: ['public'],
+  },
+
+  // OPTIONAL: base dir (https://docs.netlify.com/configure-builds/overview/#definitions)
+  // Defaults to current working directory
+  projectRoot: 'site',
+  // OPTIONAL: if your local dev setup has its own HTTP server (e.g. Vite), set its address here
+  serverAddress: 'http://localhost:1234',
 })
 
 await devServer.start()
 
-const response = await devServer.handle(new Request('http://localhost:8888/path'))
+const response = await devServer.handle(new Request('http://localhost:8888/path'), {
+  // An optional callback that will be called with every header (key and value) coming from header rules.
+  // See https://docs.netlify.com/routing/headers/
+  headersCollector: (key: string, value: string) => console.log(key, value),
+})
 
 console.log(await response.text())
 

package/dist/main.cjs

@@ -197,6 +197,46 @@ var isFile = async (path3) => {
   return false;
 };
 
+// src/lib/reqres.ts
+var import_node_stream = require("stream");
+var normalizeHeaders = (headers) => {
+  const result = [];
+  for (const [key, value] of Object.entries(headers)) {
+    if (Array.isArray(value)) {
+      result.push([key, value.join(",")]);
+    } else if (typeof value === "string") {
+      result.push([key, value]);
+    }
+  }
+  return result;
+};
+var getNormalizedRequest = (input, requestID, removeBody) => {
+  const method = input.method.toUpperCase();
+  const headers = input.headers;
+  headers.set("x-nf-request-id", requestID);
+  return new Request(input.url, {
+    body: method === "GET" || method === "HEAD" || removeBody ? null : input.body,
+    // @ts-expect-error Not typed!
+    duplex: "half",
+    headers,
+    method
+  });
+};
+var getNormalizedRequestFromNodeRequest = (input, requestID, removeBody) => {
+  const { headers, url = "" } = input;
+  const origin = `http://${headers.host ?? "localhost"}`;
+  const fullUrl = new URL(url, origin);
+  const method = input.method?.toUpperCase() ?? "GET";
+  const body = input.method === "GET" || input.method === "HEAD" || removeBody ? null : import_node_stream.Readable.toWeb(input);
+  return new Request(fullUrl, {
+    body,
+    // @ts-expect-error Not typed!
+    duplex: "half",
+    headers: normalizeHeaders({ ...input.headers, "x-nf-request-id": requestID }),
+    method
+  });
+};
+
 // src/lib/request_id.ts
 var import_ulid = require("ulid");
 var generateRequestID = () => (0, import_ulid.ulid)();
@@ -305,31 +345,37 @@ var NetlifyDev = class {
     this.#projectRoot = projectRoot;
     this.#staticHandlerAdditionalDirectories = options.staticFiles?.directories ?? [];
   }
-  async handleInEphemeralDirectory(request, destPath, options = {}) {
-    const edgeFunctionResponse = await this.#edgeFunctionsHandler?.handle(request.clone());
-    if (edgeFunctionResponse) {
-      return { response: edgeFunctionResponse, type: "edge-function" };
+  async handleInEphemeralDirectory(matchRequest, getHandleRequest, destPath, options = {}) {
+    const edgeFunctionMatch = await this.#edgeFunctionsHandler?.match(matchRequest);
+    if (edgeFunctionMatch) {
+      return {
+        response: await edgeFunctionMatch.handle(getHandleRequest()),
+        type: "edge-function"
+      };
     }
-    const functionMatch = await this.#functionsHandler?.match(request, destPath);
+    const functionMatch = await this.#functionsHandler?.match(matchRequest, destPath);
     if (functionMatch) {
       if (functionMatch.preferStatic) {
-        const staticMatch2 = await this.#staticHandler?.match(request);
+        const staticMatch2 = await this.#staticHandler?.match(matchRequest);
         if (staticMatch2) {
           const response = await staticMatch2.handle();
-          await this.#headersHandler?.apply(request, response, options.headersCollector);
+          await this.#headersHandler?.apply(matchRequest, response, options.headersCollector);
           return { response, type: "static" };
         }
       }
-      return { response: await functionMatch.handle(request), type: "function" };
+      return { response: await functionMatch.handle(getHandleRequest()), type: "function" };
     }
-    const redirectMatch = await this.#redirectsHandler?.match(request);
+    const redirectMatch = await this.#redirectsHandler?.match(matchRequest);
     if (redirectMatch) {
       const functionMatch2 = await this.#functionsHandler?.match(new Request(redirectMatch.target), destPath);
       if (functionMatch2 && !functionMatch2.preferStatic) {
-        return { response: await functionMatch2.handle(request), type: "function" };
+        return {
+          response: await functionMatch2.handle(getHandleRequest()),
+          type: "function"
+        };
       }
       const response = await this.#redirectsHandler?.handle(
-        request,
+        getHandleRequest(),
         redirectMatch,
         async (maybeStaticFile) => {
           const staticMatch2 = await this.#staticHandler?.match(maybeStaticFile);
@@ -347,17 +393,17 @@ var NetlifyDev = class {
         return { response, type: "redirect" };
       }
     }
-    const { pathname } = new URL(request.url);
+    const { pathname } = new URL(matchRequest.url);
     if (pathname.startsWith("/.netlify/images")) {
       this.#logger.error(
         "The Netlify Image CDN is currently only supported in the Netlify CLI. Run `npx netlify dev` to get started."
       );
       return;
     }
-    const staticMatch = await this.#staticHandler?.match(request);
+    const staticMatch = await this.#staticHandler?.match(matchRequest);
     if (staticMatch) {
       const response = await staticMatch.handle();
-      await this.#headersHandler?.apply(request, response, options.headersCollector);
+      await this.#headersHandler?.apply(matchRequest, response, options.headersCollector);
       return { response, type: "static" };
     }
   }
@@ -383,12 +429,28 @@ var NetlifyDev = class {
     return result?.response;
   }
   async handleAndIntrospect(request, options = {}) {
+    await import_node_fs2.promises.mkdir(this.#functionsServePath, { recursive: true });
+    const destPath = await import_node_fs2.promises.mkdtemp(import_node_path2.default.join(this.#functionsServePath, `_`));
     const requestID = generateRequestID();
-    request.headers.set("x-nf-request-id", requestID);
+    const matchRequest = getNormalizedRequest(request, requestID, true);
+    const getHandleRequest = () => getNormalizedRequest(request, requestID, false);
+    try {
+      return await this.handleInEphemeralDirectory(matchRequest, getHandleRequest, destPath, options);
+    } finally {
+      try {
+        await import_node_fs2.promises.rm(destPath, { force: true, recursive: true });
+      } catch {
+      }
+    }
+  }
+  async handleAndIntrospectNodeRequest(request, options = {}) {
     await import_node_fs2.promises.mkdir(this.#functionsServePath, { recursive: true });
-    const destPath = await import_node_fs2.promises.mkdtemp(import_node_path2.default.join(this.#functionsServePath, `${requestID}_`));
+    const destPath = await import_node_fs2.promises.mkdtemp(import_node_path2.default.join(this.#functionsServePath, `_`));
+    const requestID = generateRequestID();
+    const matchRequest = getNormalizedRequestFromNodeRequest(request, requestID, true);
+    const getHandleRequest = () => getNormalizedRequestFromNodeRequest(request, requestID, false);
     try {
-      return await this.handleInEphemeralDirectory(request, destPath, options);
+      return await this.handleInEphemeralDirectory(matchRequest, getHandleRequest, destPath, options);
     } finally {
       try {
         await import_node_fs2.promises.rm(destPath, { force: true, recursive: true });

package/dist/main.d.cts

@@ -1,3 +1,4 @@
+import { IncomingMessage } from 'node:http';
 import { Logger } from '@netlify/dev-utils';
 import { HeadersCollector } from '@netlify/headers';
 
@@ -93,6 +94,10 @@ declare class NetlifyDev {
         response: Response;
         type: ResponseType;
     } | undefined>;
+    handleAndIntrospectNodeRequest(request: IncomingMessage, options?: HandleOptions): Promise<{
+        response: Response;
+        type: ResponseType;
+    } | undefined>;
     get siteIsLinked(): boolean;
     start(): Promise<{
         serverAddress: string | undefined;

package/dist/main.d.ts

@@ -1,3 +1,4 @@
+import { IncomingMessage } from 'node:http';
 import { Logger } from '@netlify/dev-utils';
 import { HeadersCollector } from '@netlify/headers';
 
@@ -93,6 +94,10 @@ declare class NetlifyDev {
         response: Response;
         type: ResponseType;
     } | undefined>;
+    handleAndIntrospectNodeRequest(request: IncomingMessage, options?: HandleOptions): Promise<{
+        response: Response;
+        type: ResponseType;
+    } | undefined>;
     get siteIsLinked(): boolean;
     start(): Promise<{
         serverAddress: string | undefined;

package/dist/main.js

@@ -163,6 +163,46 @@ var isFile = async (path3) => {
   return false;
 };
 
+// src/lib/reqres.ts
+import { Readable } from "stream";
+var normalizeHeaders = (headers) => {
+  const result = [];
+  for (const [key, value] of Object.entries(headers)) {
+    if (Array.isArray(value)) {
+      result.push([key, value.join(",")]);
+    } else if (typeof value === "string") {
+      result.push([key, value]);
+    }
+  }
+  return result;
+};
+var getNormalizedRequest = (input, requestID, removeBody) => {
+  const method = input.method.toUpperCase();
+  const headers = input.headers;
+  headers.set("x-nf-request-id", requestID);
+  return new Request(input.url, {
+    body: method === "GET" || method === "HEAD" || removeBody ? null : input.body,
+    // @ts-expect-error Not typed!
+    duplex: "half",
+    headers,
+    method
+  });
+};
+var getNormalizedRequestFromNodeRequest = (input, requestID, removeBody) => {
+  const { headers, url = "" } = input;
+  const origin = `http://${headers.host ?? "localhost"}`;
+  const fullUrl = new URL(url, origin);
+  const method = input.method?.toUpperCase() ?? "GET";
+  const body = input.method === "GET" || input.method === "HEAD" || removeBody ? null : Readable.toWeb(input);
+  return new Request(fullUrl, {
+    body,
+    // @ts-expect-error Not typed!
+    duplex: "half",
+    headers: normalizeHeaders({ ...input.headers, "x-nf-request-id": requestID }),
+    method
+  });
+};
+
 // src/lib/request_id.ts
 import { ulid } from "ulid";
 var generateRequestID = () => ulid();
@@ -271,31 +311,37 @@ var NetlifyDev = class {
     this.#projectRoot = projectRoot;
     this.#staticHandlerAdditionalDirectories = options.staticFiles?.directories ?? [];
   }
-  async handleInEphemeralDirectory(request, destPath, options = {}) {
-    const edgeFunctionResponse = await this.#edgeFunctionsHandler?.handle(request.clone());
-    if (edgeFunctionResponse) {
-      return { response: edgeFunctionResponse, type: "edge-function" };
+  async handleInEphemeralDirectory(matchRequest, getHandleRequest, destPath, options = {}) {
+    const edgeFunctionMatch = await this.#edgeFunctionsHandler?.match(matchRequest);
+    if (edgeFunctionMatch) {
+      return {
+        response: await edgeFunctionMatch.handle(getHandleRequest()),
+        type: "edge-function"
+      };
     }
-    const functionMatch = await this.#functionsHandler?.match(request, destPath);
+    const functionMatch = await this.#functionsHandler?.match(matchRequest, destPath);
     if (functionMatch) {
       if (functionMatch.preferStatic) {
-        const staticMatch2 = await this.#staticHandler?.match(request);
+        const staticMatch2 = await this.#staticHandler?.match(matchRequest);
         if (staticMatch2) {
           const response = await staticMatch2.handle();
-          await this.#headersHandler?.apply(request, response, options.headersCollector);
+          await this.#headersHandler?.apply(matchRequest, response, options.headersCollector);
           return { response, type: "static" };
         }
       }
-      return { response: await functionMatch.handle(request), type: "function" };
+      return { response: await functionMatch.handle(getHandleRequest()), type: "function" };
     }
-    const redirectMatch = await this.#redirectsHandler?.match(request);
+    const redirectMatch = await this.#redirectsHandler?.match(matchRequest);
     if (redirectMatch) {
       const functionMatch2 = await this.#functionsHandler?.match(new Request(redirectMatch.target), destPath);
       if (functionMatch2 && !functionMatch2.preferStatic) {
-        return { response: await functionMatch2.handle(request), type: "function" };
+        return {
+          response: await functionMatch2.handle(getHandleRequest()),
+          type: "function"
+        };
       }
       const response = await this.#redirectsHandler?.handle(
-        request,
+        getHandleRequest(),
         redirectMatch,
         async (maybeStaticFile) => {
           const staticMatch2 = await this.#staticHandler?.match(maybeStaticFile);
@@ -313,17 +359,17 @@ var NetlifyDev = class {
         return { response, type: "redirect" };
       }
     }
-    const { pathname } = new URL(request.url);
+    const { pathname } = new URL(matchRequest.url);
     if (pathname.startsWith("/.netlify/images")) {
       this.#logger.error(
         "The Netlify Image CDN is currently only supported in the Netlify CLI. Run `npx netlify dev` to get started."
       );
       return;
     }
-    const staticMatch = await this.#staticHandler?.match(request);
+    const staticMatch = await this.#staticHandler?.match(matchRequest);
     if (staticMatch) {
       const response = await staticMatch.handle();
-      await this.#headersHandler?.apply(request, response, options.headersCollector);
+      await this.#headersHandler?.apply(matchRequest, response, options.headersCollector);
       return { response, type: "static" };
     }
   }
@@ -349,12 +395,28 @@ var NetlifyDev = class {
     return result?.response;
   }
   async handleAndIntrospect(request, options = {}) {
+    await fs2.mkdir(this.#functionsServePath, { recursive: true });
+    const destPath = await fs2.mkdtemp(path2.join(this.#functionsServePath, `_`));
     const requestID = generateRequestID();
-    request.headers.set("x-nf-request-id", requestID);
+    const matchRequest = getNormalizedRequest(request, requestID, true);
+    const getHandleRequest = () => getNormalizedRequest(request, requestID, false);
+    try {
+      return await this.handleInEphemeralDirectory(matchRequest, getHandleRequest, destPath, options);
+    } finally {
+      try {
+        await fs2.rm(destPath, { force: true, recursive: true });
+      } catch {
+      }
+    }
+  }
+  async handleAndIntrospectNodeRequest(request, options = {}) {
     await fs2.mkdir(this.#functionsServePath, { recursive: true });
-    const destPath = await fs2.mkdtemp(path2.join(this.#functionsServePath, `${requestID}_`));
+    const destPath = await fs2.mkdtemp(path2.join(this.#functionsServePath, `_`));
+    const requestID = generateRequestID();
+    const matchRequest = getNormalizedRequestFromNodeRequest(request, requestID, true);
+    const getHandleRequest = () => getNormalizedRequestFromNodeRequest(request, requestID, false);
     try {
-      return await this.handleInEphemeralDirectory(request, destPath, options);
+      return await this.handleInEphemeralDirectory(matchRequest, getHandleRequest, destPath, options);
     } finally {
       try {
         await fs2.rm(destPath, { force: true, recursive: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@netlify/dev",
-  "version": "4.0.2",
+  "version": "4.1.0",
   "description": "Emulation of the Netlify environment for local development",
   "type": "module",
   "engines": {
@@ -55,7 +55,7 @@
     "@netlify/blobs": "9.1.4",
     "@netlify/config": "^23.0.8",
     "@netlify/dev-utils": "3.1.0",
-    "@netlify/edge-functions": "2.13.2",
+    "@netlify/edge-functions": "2.14.0",
     "@netlify/functions": "4.1.0",
     "@netlify/headers": "2.0.0",
     "@netlify/redirects": "3.0.0",