refactor: rename FreshContext.req to FreshContext.request

docs/canary/concepts/context.md

@@ -39,9 +39,9 @@ Contains the incoming
 
 ```ts
 app.get("/", (ctx) => {
-  console.log("Request: ", ctx.req);
+  console.log("Request: ", ctx.request);
 
-  if (ctx.req.headers.has("X-Foo")) {
+  if (ctx.request.headers.has("X-Foo")) {
     // do something
   }
 

docs/canary/examples/migration-guide.md

@@ -187,7 +187,7 @@ have a trailing slash at the end or that they will never have one.
 
 Middleware, handler and route component signatures have been unified to all look
 the same. Instead of receiving two arguments, they receive one. The `Request`
-object is stored on the context object as `ctx.req`.
+object is stored on the context object as `ctx.request`.
 
 ```diff middleware.ts
 - const middleware = (req, ctx) => new Response("ok");

packages/fresh/src/context.ts

@@ -69,7 +69,9 @@ export class Context<State> {
    * certain search parameters are set.
    */
   readonly url: URL;
-  /** The original incoming {@linkcode Request} object. */
+  /** The original incoming `Request` object` */
+  readonly request: Request;
+  /** @deprecated This is an alias for internal use only. Use {@linkcode FreshContext[request]} instead. */
   readonly req: Request;
   /** The matched route pattern. */
   readonly route: string | null;
@@ -126,7 +128,7 @@ export class Context<State> {
   }
 
   constructor(
-    req: Request,
+    request: Request,
     url: URL,
     info: Deno.ServeHandlerInfo,
     route: string | null,
@@ -136,7 +138,8 @@ export class Context<State> {
     buildCache: BuildCache<State>,
   ) {
     this.url = url;
-    this.req = req;
+    this.request = request;
+    this.req = request;
     this.info = info;
     this.params = params;
     this.route = route;

packages/fresh/src/dev/builder.ts

@@ -192,7 +192,7 @@ export class Builder<State = any> {
         await this.#ready.promise;
         return ctx.next();
       })
-      .all("*", (ctx) => appHandler(ctx.req, ctx.info));
+      .all("*", (ctx) => appHandler(ctx.request, ctx.info));
 
     devApp.config.root = this.config.root;
     devApp.config.mode = "development";

packages/fresh/src/dev/middlewares/automatic_workspace_folders.ts

@@ -40,7 +40,7 @@ export function automaticWorkspaceFolders<T>(root: string): Middleware<T> {
     content ??= JSON.stringify({ workspace: { root, uuid } }, undefined, 2);
     etag ??= await eTag(content);
 
-    const noneMatchValue = ctx.req.headers.get("if-none-match");
+    const noneMatchValue = ctx.request.headers.get("if-none-match");
     if (!ifNoneMatch(noneMatchValue, etag)) {
       return new Response(undefined, { status: 304, headers: { etag } });
     }

packages/fresh/src/dev/middlewares/error_overlay/middleware.tsx

@@ -14,7 +14,7 @@ export function devErrorOverlay<T>(): Middleware<T> {
     try {
       return await ctx.next();
     } catch (err) {
-      if (ctx.req.headers.get("accept")?.includes("text/html")) {
+      if (ctx.request.headers.get("accept")?.includes("text/html")) {
         let init: ResponseInit | undefined;
         if (err instanceof HttpError) {
           if (err.status < 500) throw err;

packages/fresh/src/dev/middlewares/live_reload.ts

@@ -6,12 +6,12 @@ export function liveReload<T>(): Middleware<T> {
   const revision = Date.now();
 
   return (ctx) => {
-    const { config, req, url } = ctx;
+    const { config, request, url } = ctx;
 
     const aliveUrl = config.basePath + ALIVE_URL;
 
     if (url.pathname === aliveUrl) {
-      if (req.headers.get("upgrade") !== "websocket") {
+      if (request.headers.get("upgrade") !== "websocket") {
         return new Response(null, { status: 501 });
       }
 
@@ -20,7 +20,7 @@ export function liveReload<T>(): Middleware<T> {
       // the client to know when the server is back up. Once we
       // have HMR we'll actively start sending messages back
       // and forth.
-      const { response, socket } = Deno.upgradeWebSocket(req);
+      const { response, socket } = Deno.upgradeWebSocket(request);
 
       socket.addEventListener("open", () => {
         socket.send(

packages/fresh/src/handlers.ts

@@ -89,7 +89,7 @@ export function page<T>(data?: T, options?: {
  *
  * ```ts
  * export const handlers = define.handlers((ctx) => {
- *   return new Response(`Hello from a ${ctx.req.method} request!`);
+ *   return new Response(`Hello from a ${ctx.request.method} request!`);
  * });
  * ```
  */

packages/fresh/src/middlewares/cors.ts

@@ -94,7 +94,7 @@ export function cors<State>(options?: CORSOptions<State>): Middleware<State> {
   const optsOrigin = opts.origin;
 
   return async (ctx) => {
-    const requestOrigin = ctx.req.headers.get("origin") || "";
+    const requestOrigin = ctx.request.headers.get("origin") || "";
 
     let allowOrigin: string | null = null;
     if (typeof optsOrigin === "string") {
@@ -115,7 +115,7 @@ export function cors<State>(options?: CORSOptions<State>): Middleware<State> {
       vary.add("Origin");
     }
 
-    if (ctx.req.method === "OPTIONS") {
+    if (ctx.request.method === "OPTIONS") {
       const headers = new Headers();
 
       addHeaderProperties(
@@ -137,7 +137,7 @@ export function cors<State>(options?: CORSOptions<State>): Middleware<State> {
 
       let allowHeaders = opts.allowHeaders;
       if (!allowHeaders?.length) {
-        const reqHeaders = ctx.req.headers.get(
+        const reqHeaders = ctx.request.headers.get(
           "Access-Control-Request-Headers",
         );
         if (reqHeaders) {

packages/fresh/src/middlewares/csrf.ts

@@ -78,7 +78,7 @@ export function csrf<State>(
   };
 
   return async (ctx) => {
-    const { method, headers } = ctx.req;
+    const { method, headers } = ctx.request;
 
     // Safe methods
     if (method === "GET" || method === "HEAD" || method === "OPTIONS") {

packages/fresh/src/middlewares/mod.ts

@@ -42,7 +42,7 @@ import { recordSpanError, tracer } from "../otel.ts";
  * // checking and code completion. It does not register the middleware with the
  * // app.
  * const loggerMiddleware = define.middleware((ctx) => {
- *   console.log(`${ctx.req.method} ${ctx.req.url}`);
+ *   console.log(`${ctx.request.method} ${ctx.request.url}`);
  *   // Call the next middleware
  *   return ctx.next();
  * });

packages/fresh/src/middlewares/static_files.ts

@@ -13,7 +13,7 @@ import { getBuildCache } from "../context.ts";
  */
 export function staticFiles<T>(): Middleware<T> {
   return async function freshServeStaticFiles(ctx) {
-    const { req, url, config } = ctx;
+    const { request, url, config } = ctx;
 
     const buildCache = getBuildCache(ctx);
     if (buildCache === null) return await ctx.next();
@@ -36,7 +36,7 @@ export function staticFiles<T>(): Middleware<T> {
       return await ctx.next();
     }
 
-    if (req.method !== "GET" && req.method !== "HEAD") {
+    if (request.method !== "GET" && request.method !== "HEAD") {
       file.close();
       return new Response("Method Not Allowed", { status: 405 });
     }
@@ -68,7 +68,7 @@ export function staticFiles<T>(): Middleware<T> {
         vary: "If-None-Match",
       });
 
-      const ifNoneMatch = req.headers.get("If-None-Match");
+      const ifNoneMatch = request.headers.get("If-None-Match");
       if (
         ifNoneMatch !== null &&
         (ifNoneMatch === etag || ifNoneMatch === `W/"${etag}"`)
@@ -98,7 +98,7 @@ export function staticFiles<T>(): Middleware<T> {
       }
 
       headers.set("Content-Length", String(file.size));
-      if (req.method === "HEAD") {
+      if (request.method === "HEAD") {
         file.close();
         return new Response(null, { status: 200, headers });
       }

packages/fresh/src/render.ts

@@ -82,7 +82,7 @@ export async function renderRouteComponent<State>(
     info: ctx.info,
     isPartial: ctx.isPartial,
     params: ctx.params,
-    req: ctx.req,
+    req: ctx.request,
     state: ctx.state,
     url: ctx.url,
   };

packages/fresh/src/segments.ts

@@ -153,7 +153,7 @@ export async function renderRoute<State>(
     internals.layouts = [];
   }
 
-  const method = ctx.req.method as Method;
+  const method = ctx.request.method as Method;
 
   const handlers = route.handler;
   if (handlers === undefined) {

packages/fresh/tests/partials_test.tsx

@@ -1774,7 +1774,7 @@ Deno.test({
   fn: async () => {
     const app = testApp()
       .post("/partial", async (ctx) => {
-        const data = await ctx.req.formData();
+        const data = await ctx.request.formData();
         const name = data.get("name");
         const submitter = data.get("submitter");
         return ctx.render(
@@ -1875,7 +1875,7 @@ Deno.test({
         );
       })
       .post("/partial", async (ctx) => {
-        const data = await ctx.req.formData();
+        const data = await ctx.request.formData();
         const name = String(data.get("name"));
 
         return new Response(null, {
@@ -1920,7 +1920,7 @@ Deno.test({
   fn: async () => {
     const app = testApp()
       .post("/partial", async (ctx) => {
-        const data = await ctx.req.formData();
+        const data = await ctx.request.formData();
         const name = data.get("name");
         const submitter = data.get("submitter");
         return ctx.render(
@@ -1979,7 +1979,7 @@ Deno.test({
   fn: async () => {
     const app = testApp()
       .post("/partial", async (ctx) => {
-        const data = await ctx.req.formData();
+        const data = await ctx.request.formData();
         const name = data.get("name");
         const submitter = data.get("submitter");
         return ctx.render(
@@ -2040,7 +2040,7 @@ Deno.test({
   fn: async () => {
     const app = testApp()
       .post("/partial", async (ctx) => {
-        const data = await ctx.req.formData();
+        const data = await ctx.request.formData();
         const name = data.get("name");
         const submitter = data.get("submitter");
         return ctx.render(

packages/init/src/init.ts

@@ -401,7 +401,7 @@ app.get("/api2/:name", (ctx) => {
 
 // this can also be defined via a file. feel free to delete this!
 const exampleLoggerMiddleware = define.middleware((ctx) => {
-  console.log(\`\${ctx.req.method} \${ctx.req.url}\`);
+  console.log(\`\${ctx.request.method} \${ctx.request.url}\`);
   return ctx.next();
 });
 app.use(exampleLoggerMiddleware);

packages/update/src/update.ts

@@ -531,7 +531,7 @@ function maybePrependReqVar(
         declarationKind: tsmorph.VariableDeclarationKind.Const,
         declarations: [{
           name: paramName,
-          initializer: "ctx.req",
+          initializer: "ctx.request",
         }],
       });
     }