Fix typings for response in LoaderFunctonArgs/ActionFunctionArgs (#9254)

remix-run · Apr 18, 2024 · b75afdf · b75afdf
1 parent 2d7e704
commit b75afdf
Show file tree

Hide file tree

Showing 4 changed files with 30 additions and 13 deletions.
diff --git a/.changeset/nice-beds-sneeze.md b/.changeset/nice-beds-sneeze.md
@@ -0,0 +1,5 @@
+---
+"@remix-run/server-runtime": patch
+---
+
+[REMOVE] Fix typings for response in LoaderFunctonArgs/ActionFunctionArgs
diff --git a/packages/remix-server-runtime/routeModules.ts b/packages/remix-server-runtime/routeModules.ts
@@ -40,6 +40,9 @@ export type ResponseStubOperation = [
 export type ResponseStub = {
   status: number | undefined;
   headers: Headers;
+};
+
+export type ResponseStubImpl = ResponseStub & {
   [ResponseStubOperationsSymbol]: ResponseStubOperation[];
 };
 

diff --git a/packages/remix-server-runtime/routes.ts b/packages/remix-server-runtime/routes.ts
@@ -6,7 +6,8 @@ import type {
 
 import { callRouteAction, callRouteLoader } from "./data";
 import type { FutureConfig } from "./entry";
-import type { ResponseStub, ServerRouteModule } from "./routeModules";
+import type { ServerRouteModule } from "./routeModules";
+import type { DataStrategyCtx } from "./single-fetch";
 
 export interface RouteManifest<Route> {
   [routeId: string]: Route;
@@ -100,9 +101,8 @@ export function createStaticHandlerDataRoutes(
               loader: route.module.loader!,
               routeId: route.id,
               singleFetch: future.unstable_singleFetch === true,
-              response: (
-                dataStrategyCtx as unknown as { response: ResponseStub }
-              )?.response,
+              response: (dataStrategyCtx as DataStrategyCtx | undefined)
+                ?.response,
             })
         : undefined,
       action: route.module.action
@@ -114,9 +114,8 @@ export function createStaticHandlerDataRoutes(
               action: route.module.action!,
               routeId: route.id,
               singleFetch: future.unstable_singleFetch === true,
-              response: (
-                dataStrategyCtx as unknown as { response: ResponseStub }
-              )?.response,
+              response: (dataStrategyCtx as DataStrategyCtx | undefined)
+                ?.response,
             })
         : undefined,
       handle: route.module.handle,

diff --git a/packages/remix-server-runtime/single-fetch.ts b/packages/remix-server-runtime/single-fetch.ts
@@ -12,7 +12,11 @@ import { encode } from "turbo-stream";
 import type { AppLoadContext } from "./data";
 import { sanitizeError, sanitizeErrors } from "./errors";
 import { ServerMode } from "./mode";
-import type { ResponseStub, ResponseStubOperation } from "./routeModules";
+import type {
+  ResponseStub,
+  ResponseStubImpl,
+  ResponseStubOperation,
+} from "./routeModules";
 import { ResponseStubOperationsSymbol } from "./routeModules";
 import { isDeferredData, isRedirectStatusCode, isResponse } from "./responses";
 
@@ -35,6 +39,10 @@ export type SingleFetchResults = {
   [SingleFetchRedirectSymbol]?: SingleFetchRedirectResult;
 };
 
+export type DataStrategyCtx = {
+  response: ResponseStub;
+};
+
 export function getSingleFetchDataStrategy(
   responseStubs: ReturnType<typeof getResponseStubs>,
   {
@@ -54,19 +62,21 @@ export function getSingleFetchDataStrategy(
 
     let results = await Promise.all(
       matches.map(async (match) => {
-        let responseStub: ResponseStub | undefined;
+        let responseStub: ResponseStubImpl | undefined;
         if (request.method !== "GET") {
           responseStub = responseStubs[ResponseStubActionSymbol];
         } else {
           responseStub = responseStubs[match.route.id];
         }
 
         let result = await match.resolve(async (handler) => {
+          // Cast `ResponseStubImpl -> ResponseStub` to hide the symbol in userland
+          let ctx: DataStrategyCtx = { response: responseStub as ResponseStub };
           // Only run opt-in loaders when fine-grained revalidation is enabled
           let data =
             loadRouteIds && !loadRouteIds.includes(match.route.id)
               ? null
-              : await handler({ response: responseStub });
+              : await handler(ctx);
           return { type: "data", result: data };
         });
 
@@ -282,7 +292,7 @@ export async function singleFetchLoaders(
   }
 }
 
-export function isResponseStub(value: any): value is ResponseStub {
+export function isResponseStub(value: any): value is ResponseStubImpl {
   return (
     value && typeof value === "object" && ResponseStubOperationsSymbol in value
   );
@@ -310,7 +320,7 @@ function getResponseStub(status?: number) {
 }
 
 export function getResponseStubs() {
-  return new Proxy({} as Record<string | symbol, ResponseStub>, {
+  return new Proxy({} as Record<string | symbol, ResponseStubImpl>, {
     get(responseStubCache, prop) {
       let cached = responseStubCache[prop];
       if (!cached) {
@@ -324,7 +334,7 @@ export function getResponseStubs() {
 function proxyResponseToResponseStub(
   status: number | undefined,
   headers: Headers,
-  responseStub: ResponseStub
+  responseStub: ResponseStubImpl
 ) {
   if (status != null && responseStub.status == null) {
     responseStub.status = status;