rename onUnhandledError - > handleError

remix-run · Jun 2, 2023 · aacb7e1 · aacb7e1
1 parent 70cc627
commit aacb7e1
Show file tree

Hide file tree

Showing 13 changed files with 19 additions and 19 deletions.
diff --git a/.changeset/on-unhandled-error.md → .changeset/handle-error.md b/.changeset/on-unhandled-error.md → .changeset/handle-error.md
@@ -2,11 +2,11 @@
 "@remix-run/server-runtime": minor
 ---
 
-Add optional `onUnhandledError` export for custom server-side error processing. This is a new optional export from your `entry.server.tsx` that will be called with any encountered error on the Remix server (loader, action, or render error):
+Add optional `handleError` export for custom server-side error processing. This is a new optional export from your `entry.server.tsx` that will be called with any encountered error on the Remix server (loader, action, or render error):
 
 ```ts
 // entry.server.tsx
-export function onUnhandledError(
+export function handleError(
   error: unknown,
   { request, params, context }: DataFunctionArgs
 ): void {

diff --git a/docs/file-conventions/entry.server.md b/docs/file-conventions/entry.server.md
@@ -23,12 +23,12 @@ export function handleDataRequest(
 }
 ```
 
-## `onUnhandledError`
+## `handleError`
 
-By default, Remix will log encountered server-side errors to the console. If you'd like more control over the logging, or would like to also report these errors to an external service, then you can export an optional `onUnhandledError` function which will give you control (and will disable the built-in error logging).
+By default, Remix will log encountered server-side errors to the console. If you'd like more control over the logging, or would like to also report these errors to an external service, then you can export an optional `handleError` function which will give you control (and will disable the built-in error logging).
 
 ```tsx
-export function onUnhandledError(
+export function handleError(
   error: unknown,
   { request, params, context }: DataFunctionArgs
 ) {
@@ -39,7 +39,7 @@ export function onUnhandledError(
 
 ### Streaming Rendering Errors
 
-When you are streaming your HTML responses via [`renderToPipeableStream`][rendertopipeablestream] or [`renderToReadableStream`][rendertoreadablestream], your own `onUnhandledError` implementation will only handle errors encountered uring the initial shell render. If you encounter a rendering error during subsequent streamed rendering you will need handle these errors manually since the Remix server has already sent the Response by that point.
+When you are streaming your HTML responses via [`renderToPipeableStream`][rendertopipeablestream] or [`renderToReadableStream`][rendertoreadablestream], your own `handleError` implementation will only handle errors encountered uring the initial shell render. If you encounter a rendering error during subsequent streamed rendering you will need handle these errors manually since the Remix server has already sent the Response by that point.
 
 - For `renderToPipeableStream`, you can handle these errors in the `onError` callback function. You will need to toggle a boolean when the in `onShellReady` so you know if the error was a shell rendering error (and can be ignored) or an async rendering error (and must be handled).
   - For an exmaple, please see the default [`entry.server.tsx`][node-streaming-entry-server] for Node.

diff --git a/integration/error-sanitization-test.ts b/integration/error-sanitization-test.ts
@@ -430,7 +430,7 @@ test.describe("Error Sanitization", () => {
     });
   });
 
-  test.describe("serverMode=production (user-provided onUnhandledError)", () => {
+  test.describe("serverMode=production (user-provided handleError)", () => {
     test.beforeAll(async () => {
       fixture = await createFixture(
         {
@@ -463,7 +463,7 @@ test.describe("Error Sanitization", () => {
                 });
               }
 
-              export function onUnhandledError(
+              export function handleError(
                 error: unknown,
                 { request }: { request: Request },
               ) {

diff --git a/packages/remix-cloudflare/index.ts b/packages/remix-cloudflare/index.ts
@@ -68,7 +68,7 @@ export type {
   MemoryUploadHandlerOptions,
   MetaDescriptor,
   MetaFunction,
-  OnUnhandledErrorFunction,
+  HandleErrorFunction,
   PageLinkDescriptor,
   RequestHandler,
   RouteComponent,

diff --git a/packages/remix-deno/index.ts b/packages/remix-deno/index.ts
@@ -56,7 +56,7 @@ export type {
   MemoryUploadHandlerOptions,
   MetaDescriptor,
   MetaFunction,
-  OnUnhandledErrorFunction,
+  HandleErrorFunction,
   PageLinkDescriptor,
   RequestHandler,
   RouteComponent,

diff --git a/packages/remix-dev/codemod/replace-remix-magic-imports/utils/export.ts b/packages/remix-dev/codemod/replace-remix-magic-imports/utils/export.ts
@@ -68,7 +68,7 @@ const defaultRuntimeExports: ExportNames = {
     "MemoryUploadHandlerOptions",
     "MetaDescriptor",
     "MetaFunction",
-    "OnUnhandledErrorFunction",
+    "HandleErrorFunction",
     "PageLinkDescriptor",
     "RequestHandler",
     "RouteComponent",

diff --git a/packages/remix-eslint-config/rules/packageExports.js b/packages/remix-eslint-config/rules/packageExports.js
@@ -46,7 +46,7 @@ const defaultRuntimeExports = {
     "MemoryUploadHandlerOptions",
     "MetaDescriptor",
     "MetaFunction",
-    "OnUnhandledErrorFunction",
+    "HandleErrorFunction",
     "PageLinkDescriptor",
     "RequestHandler",
     "RouteComponent",

diff --git a/packages/remix-node/index.ts b/packages/remix-node/index.ts
@@ -79,7 +79,7 @@ export type {
   MemoryUploadHandlerOptions,
   MetaDescriptor,
   MetaFunction,
-  OnUnhandledErrorFunction,
+  HandleErrorFunction,
   PageLinkDescriptor,
   RequestHandler,
   RouteComponent,

diff --git a/packages/remix-server-runtime/build.ts b/packages/remix-server-runtime/build.ts
@@ -32,7 +32,7 @@ export interface HandleDataRequestFunction {
   (response: Response, args: DataFunctionArgs): Promise<Response> | Response;
 }
 
-export interface OnUnhandledErrorFunction {
+export interface HandleErrorFunction {
   (error: unknown, args: DataFunctionArgs): void;
 }
 
@@ -43,5 +43,5 @@ export interface OnUnhandledErrorFunction {
 export interface ServerEntryModule {
   default: HandleDocumentRequestFunction;
   handleDataRequest?: HandleDataRequestFunction;
-  onUnhandledError?: OnUnhandledErrorFunction;
+  handleError?: HandleErrorFunction;
 }
diff --git a/packages/remix-server-runtime/index.ts b/packages/remix-server-runtime/index.ts
@@ -60,7 +60,7 @@ export type {
   MemoryUploadHandlerOptions,
   MetaDescriptor,
   MetaFunction,
-  OnUnhandledErrorFunction,
+  HandleErrorFunction,
   PageLinkDescriptor,
   RequestHandler,
   RouteComponent,

diff --git a/packages/remix-server-runtime/reexport.ts b/packages/remix-server-runtime/reexport.ts
@@ -1,7 +1,7 @@
 export type {
   HandleDataRequestFunction,
   HandleDocumentRequestFunction,
-  OnUnhandledErrorFunction,
+  HandleErrorFunction,
   ServerBuild,
   ServerEntryModule,
 } from "./build";

diff --git a/packages/remix-server-runtime/server.ts b/packages/remix-server-runtime/server.ts
@@ -50,7 +50,7 @@ export const createRequestHandler: CreateRequestHandlerFunction = (
   let staticHandler = createStaticHandler(dataRoutes);
 
   let errorHandler =
-    build.entry.module.onUnhandledError ||
+    build.entry.module.handleError ||
     ((error, { request }) => {
       if (serverMode !== ServerMode.Test && !request.signal.aborted) {
         console.error(error);

diff --git a/rollup.utils.js b/rollup.utils.js
@@ -358,7 +358,7 @@ function getMagicExports(packageName) {
         "LoaderFunction",
         "MetaDescriptor",
         "MetaFunction",
-        "OnUnhandledErrorFunction",
+        "HandleErrorFunction",
         "PageLinkDescriptor",
         "RequestHandler",
         "RouteComponent",