fix(remix): Lighten vendored types

Author: onurtemizkan

packages/remix/package.json

@@ -78,6 +78,7 @@
   "devDependencies": {
     "@remix-run/node": "^2.15.2",
     "@remix-run/react": "^2.15.2",
+    "@remix-run/server-runtime": "^2.15.2",
     "@types/express": "^4.17.14",
     "vite": "^5.4.11"
   },

packages/remix/src/server/errors.ts

@@ -4,6 +4,7 @@ import type {
   HandleDocumentRequestFunction,
   LoaderFunctionArgs,
 } from '@remix-run/node';
+import type { ActionFunction, LoaderFunction } from '@remix-run/server-runtime';
 import type { RequestEventData, Span } from '@sentry/core';
 import {
   addExceptionMechanism,
@@ -18,7 +19,8 @@ import { DEBUG_BUILD } from '../utils/debug-build';
 import type { RemixOptions } from '../utils/remixOptions';
 import { storeFormDataKeys } from '../utils/utils';
 import { extractData, isResponse, isRouteErrorResponse } from '../utils/vendor/response';
-import type { DataFunction, RemixRequest } from '../utils/vendor/types';
+
+type DataFunction = LoaderFunction | ActionFunction;
 
 /**
  * Captures an exception happened in the Remix server.
@@ -87,7 +89,7 @@ export function errorHandleDocumentRequestFunction(
   this: unknown,
   origDocumentRequestFunction: HandleDocumentRequestFunction,
   requestContext: {
-    request: RemixRequest;
+    request: Request;
     responseStatusCode: number;
     responseHeaders: Headers;
     context: EntryContext;

packages/remix/src/server/instrumentServer.ts

@@ -1,4 +1,16 @@
 /* eslint-disable max-lines */
+import type {
+  ActionFunction,
+  ActionFunctionArgs,
+  AppLoadContext,
+  CreateRequestHandlerFunction,
+  EntryContext,
+  HandleDocumentRequestFunction,
+  LoaderFunction,
+  LoaderFunctionArgs,
+  RequestHandler,
+  ServerBuild,
+} from '@remix-run/server-runtime';
 import type { RequestEventData, Span, TransactionSource, WrappedFunction } from '@sentry/core';
 import {
   continueTrace,
@@ -21,24 +33,14 @@ import {
   withIsolationScope,
 } from '@sentry/core';
 import { DEBUG_BUILD } from '../utils/debug-build';
+import type { DeferredData, Route, ServerRouteManifest } from '../utils/types';
 import { createRoutes, getTransactionName } from '../utils/utils';
 import { extractData, isDeferredData, isResponse, isRouteErrorResponse, json } from '../utils/vendor/response';
-import type {
-  AppData,
-  AppLoadContext,
-  CreateRequestHandlerFunction,
-  DataFunction,
-  DataFunctionArgs,
-  EntryContext,
-  HandleDocumentRequestFunction,
-  RemixRequest,
-  RequestHandler,
-  ServerBuild,
-  ServerRoute,
-  ServerRouteManifest,
-} from '../utils/vendor/types';
 import { captureRemixServerException, errorHandleDataFunction, errorHandleDocumentRequestFunction } from './errors';
 
+type DataFunction = LoaderFunction | ActionFunction;
+type DataFunctionArgs = LoaderFunctionArgs | ActionFunctionArgs;
+
 const redirectStatusCodes = new Set([301, 302, 303, 307, 308]);
 function isRedirectResponse(response: Response): boolean {
   return redirectStatusCodes.has(response.status);
@@ -163,7 +165,7 @@ function makeWrappedDataFunction(
   name: 'action' | 'loader',
   instrumentTracing?: boolean,
 ): DataFunction {
-  return async function (this: unknown, args: DataFunctionArgs): Promise<Response | AppData> {
+  return async function (this: unknown, args: DataFunctionArgs): Promise<Response> {
     if (instrumentTracing) {
       return startSpan(
         {
@@ -198,7 +200,7 @@ const makeWrappedLoader =
 
 function makeWrappedRootLoader() {
   return function (origLoader: DataFunction): DataFunction {
-    return async function (this: unknown, args: DataFunctionArgs): Promise<Response | AppData> {
+    return async function (this: unknown, args: DataFunctionArgs): Promise<Response | DeferredData> {
       const res = await origLoader.call(this, args);
       const traceAndBaggage = getTraceAndBaggage();
 
@@ -254,14 +256,14 @@ function wrapRequestHandler(
   let name: string;
   let source: TransactionSource;
 
-  return async function (this: unknown, request: RemixRequest, loadContext?: AppLoadContext): Promise<Response> {
+  return async function (this: unknown, request: Request, loadContext?: AppLoadContext): Promise<Response> {
     const upperCaseMethod = request.method.toUpperCase();
     // We don't want to wrap OPTIONS and HEAD requests
     if (upperCaseMethod === 'OPTIONS' || upperCaseMethod === 'HEAD') {
       return origRequestHandler.call(this, request, loadContext);
     }
 
-    let resolvedRoutes: ServerRoute[] | undefined;
+    let resolvedRoutes: Route[] | undefined;
 
     if (options?.instrumentTracing) {
       if (typeof build === 'function') {
@@ -428,7 +430,7 @@ export const makeWrappedCreateRequestHandler = (options?: { instrumentTracing?:
   function (origCreateRequestHandler: CreateRequestHandlerFunction): CreateRequestHandlerFunction {
     return function (
       this: unknown,
-      build: ServerBuild | (() => Promise<ServerBuild>),
+      build: ServerBuild | (() => ServerBuild | Promise<ServerBuild>),
       ...args: unknown[]
     ): RequestHandler {
       const newBuild = instrumentBuild(build, options);

packages/remix/src/utils/types.ts

@@ -4,3 +4,29 @@ export type SentryMetaArgs<MetaFN extends (...args: any) => any> = Parameters<Me
     sentryBaggage: string;
   };
 };
+
+export type DeferredData = {
+  data: Record<string, unknown>;
+  deferredKeys: string[];
+  subscribe(fn: (aborted: boolean, settledKey?: string) => void): () => boolean;
+  cancel(): void;
+  resolveData(signal: AbortSignal): Promise<boolean>;
+};
+
+export interface RouteManifest<Route> {
+  [routeId: string]: Route;
+}
+
+export type ServerRouteManifest = RouteManifest<Omit<ServerRoute, 'children'>>;
+export interface ServerRoute extends Route {
+  children: ServerRoute[];
+  module: any;
+}
+
+export interface Route {
+  index?: boolean;
+  caseSensitive?: boolean;
+  id: string;
+  parentId?: string;
+  path?: string;
+}

packages/remix/src/utils/utils.ts

@@ -2,8 +2,8 @@ import type { ActionFunctionArgs, LoaderFunctionArgs } from '@remix-run/node';
 import type { Span, TransactionSource } from '@sentry/core';
 import { logger } from '@sentry/core';
 import { DEBUG_BUILD } from './debug-build';
+import type { Route, ServerRouteManifest } from './types';
 import { getRequestMatch, matchServerRoutes } from './vendor/response';
-import type { ServerRoute, ServerRouteManifest } from './vendor/types';
 
 /**
  *
@@ -29,7 +29,7 @@ export async function storeFormDataKeys(args: LoaderFunctionArgs | ActionFunctio
 /**
  * Get transaction name from routes and url
  */
-export function getTransactionName(routes: ServerRoute[], url: URL): [string, TransactionSource] {
+export function getTransactionName(routes: Route[], url: URL): [string, TransactionSource] {
   const matches = matchServerRoutes(routes, url.pathname);
   const match = matches && getRequestMatch(url, matches);
   return match === null ? [url.pathname, 'url'] : [match.route.id || 'no-route-id', 'route'];
@@ -41,7 +41,7 @@ export function getTransactionName(routes: ServerRoute[], url: URL): [string, Tr
  * @param manifest
  * @param parentId
  */
-export function createRoutes(manifest: ServerRouteManifest, parentId?: string): ServerRoute[] {
+export function createRoutes(manifest: ServerRouteManifest, parentId?: string): Route[] {
   return Object.entries(manifest)
     .filter(([, route]) => route.parentId === parentId)
     .map(([id, route]) => ({

packages/remix/src/utils/vendor/response.ts

@@ -6,9 +6,9 @@
 //
 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
-import type { AgnosticRouteMatch, AgnosticRouteObject } from '@remix-run/router';
+import type { AgnosticRouteMatch, AgnosticRouteObject, ErrorResponse } from '@remix-run/router';
 import { matchRoutes } from '@remix-run/router';
-import type { DeferredData, ErrorResponse, ServerRoute } from './types';
+import type { DeferredData, Route } from '../types';
 
 /**
  * Based on Remix Implementation
@@ -76,7 +76,7 @@ export const json: JsonFunction = (data, init = {}) => {
  * Changed so that `matchRoutes` function is passed in.
  */
 export function matchServerRoutes(
-  routes: ServerRoute[],
+  routes: Route[],
   pathname: string,
 ): AgnosticRouteMatch<string, AgnosticRouteObject>[] | null {
   const matches = matchRoutes(routes, pathname);
@@ -151,7 +151,9 @@ export function isDeferredData(value: any): value is DeferredData {
  */
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export function isRouteErrorResponse(value: any): value is ErrorResponse {
-  const error: ErrorResponse = value;
+  const error: ErrorResponse & {
+    internal: boolean;
+  } = value;
 
   return (
     error != null &&