refactor(sanity): rename onStudioError to onUncaughtError

sanity-io · Oct 7, 2024 · f498039 · f498039
1 parent c186d7c
commit f498039
Show file tree

Hide file tree

Showing 8 changed files with 27 additions and 27 deletions.
diff --git a/dev/test-studio/sanity.config.ts b/dev/test-studio/sanity.config.ts
@@ -154,7 +154,7 @@ const defaultWorkspace = {
   dataset: 'test',
   plugins: [sharedSettings()],
 
-  onStudioError: (error, errorInfo) => {
+  onUncaughtError: (error, errorInfo) => {
     // eslint-disable-next-line no-console
     console.log(error)
     // eslint-disable-next-line no-console
@@ -253,7 +253,7 @@ export default defineConfig([
     dataset: 'test',
     plugins: [sharedSettings(), studioComponentsPlugin(), formComponentsPlugin()],
     basePath: '/custom-components',
-    onStudioError: (error, errorInfo) => {
+    onUncaughtError: (error, errorInfo) => {
       // eslint-disable-next-line no-console
       console.log(error)
       // eslint-disable-next-line no-console

diff --git a/packages/sanity/src/core/config/configPropertyReducers.ts b/packages/sanity/src/core/config/configPropertyReducers.ts
@@ -310,7 +310,7 @@ export const documentCommentsEnabledReducer = (opts: {
   return result
 }
 
-export const onStudioErrorResolver = (opts: {
+export const onUncaughtErrorResolver = (opts: {
   config: PluginOptions
   context: {error: Error; errorInfo: ErrorInfo}
 }) => {
@@ -320,13 +320,13 @@ export const onStudioErrorResolver = (opts: {
     // There is no concept of 'previous value' in this API. We only care about the final value.
     // That is, if a plugin returns true, but the next plugin returns false, the result will be false.
     // The last plugin 'wins'.
-    const resolver = pluginConfig.onStudioError
+    const resolver = pluginConfig.onUncaughtError
 
     if (typeof resolver === 'function') return resolver(context.error, context.errorInfo)
     if (!resolver) return undefined
 
     throw new Error(
-      `Expected \`document.onStudioError\` to be a a function, but received ${getPrintableType(
+      `Expected \`document.onUncaughtError\` to be a a function, but received ${getPrintableType(
         resolver,
       )}`,
     )

diff --git a/packages/sanity/src/core/config/prepareConfig.ts b/packages/sanity/src/core/config/prepareConfig.ts
@@ -38,7 +38,7 @@ import {
   internalTasksReducer,
   legacySearchEnabledReducer,
   newDocumentOptionsResolver,
-  onStudioErrorResolver,
+  onUncaughtErrorResolver,
   partialIndexingEnabledReducer,
   resolveProductionUrlReducer,
   schemaTemplatesReducer,
@@ -633,8 +633,8 @@ function resolveSource({
       staticInitialValueTemplateItems,
       options: config,
     },
-    onStudioError: (error: Error, errorInfo: ErrorInfo) => {
-      return onStudioErrorResolver({
+    onUncaughtError: (error: Error, errorInfo: ErrorInfo) => {
+      return onUncaughtErrorResolver({
         config,
         context: {
           error: error,

diff --git a/packages/sanity/src/core/config/types.ts b/packages/sanity/src/core/config/types.ts
@@ -393,9 +393,9 @@ export interface PluginOptions {
    */
   beta?: BetaFeatures
   /** Configuration for error handling.
-   * @internal
+   * @beta
    */
-  onStudioError?: (error: Error, errorInfo: ErrorInfo) => void
+  onUncaughtError?: (error: Error, errorInfo: ErrorInfo) => void
 }
 
 /** @internal */
@@ -788,7 +788,7 @@ export interface Source {
   /** Configuration for error handling.
    * @internal
    */
-  onStudioError?: (error: Error, errorInfo: ErrorInfo) => void
+  onUncaughtError?: (error: Error, errorInfo: ErrorInfo) => void
 }
 
 /** @internal */

diff --git a/packages/sanity/src/core/form/studio/FormBuilderInputErrorBoundary.test.tsx b/packages/sanity/src/core/form/studio/FormBuilderInputErrorBoundary.test.tsx
@@ -25,8 +25,8 @@ describe('FormBuilderInputErrorBoundary', () => {
     expect(screen.getByTestId('child')).toBeInTheDocument()
   })
 
-  it('calls onStudioError when an error is caught', async () => {
-    const onStudioError = jest.fn()
+  it('calls onUncaughtError when an error is caught', async () => {
+    const onUncaughtError = jest.fn()
 
     const ThrowErrorComponent = () => {
       throw new Error('An EXPECTED, testing error occurred!')
@@ -40,7 +40,7 @@ describe('FormBuilderInputErrorBoundary', () => {
         name: 'default',
         projectId: 'test',
         dataset: 'test',
-        onStudioError,
+        onUncaughtError,
       },
     })
 
@@ -52,6 +52,6 @@ describe('FormBuilderInputErrorBoundary', () => {
       </TestProvider>,
     )
 
-    expect(onStudioError).toHaveBeenCalledTimes(1)
+    expect(onUncaughtError).toHaveBeenCalledTimes(1)
   })
 })
diff --git a/packages/sanity/src/core/studio/workspaceLoader/WorkspaceRouterProvider.test.tsx b/packages/sanity/src/core/studio/workspaceLoader/WorkspaceRouterProvider.test.tsx
@@ -69,8 +69,8 @@ describe('WorkspaceRouterProvider', () => {
     expect(screen.getByText('Children')).toBeInTheDocument()
   })
 
-  it('calls onStudioError when an error is caught', async () => {
-    const onStudioError = jest.fn()
+  it('calls onUncaughtError when an error is caught', async () => {
+    const onUncaughtError = jest.fn()
 
     const ThrowErrorComponent = () => {
       throw new Error('An EXPECTED, testing error occurred!')
@@ -84,7 +84,7 @@ describe('WorkspaceRouterProvider', () => {
         name: 'default',
         projectId: 'test',
         dataset: 'test',
-        onStudioError,
+        onUncaughtError,
       },
     })
 
@@ -98,7 +98,7 @@ describe('WorkspaceRouterProvider', () => {
         </TestProvider>,
       )
     } catch {
-      expect(onStudioError).toHaveBeenCalledTimes(1)
+      expect(onUncaughtError).toHaveBeenCalledTimes(1)
     }
   })
 })
diff --git a/packages/sanity/src/ui-components/errorBoundary/ErrorBoundary.tsx b/packages/sanity/src/ui-components/errorBoundary/ErrorBoundary.tsx
@@ -10,7 +10,7 @@ import {SourceContext} from '../../_singletons'
 export type ErrorBoundaryProps = UIErrorBoundaryProps
 
 /**
- * ErrorBoundary component that catches errors and uses onStudioError config property
+ * ErrorBoundary component that catches errors and uses onUncaughtError config property
  * It also calls the onCatch prop if it exists.
  */
 export function ErrorBoundary({onCatch, ...rest}: ErrorBoundaryProps): JSX.Element {
@@ -19,8 +19,8 @@ export function ErrorBoundary({onCatch, ...rest}: ErrorBoundaryProps): JSX.Eleme
 
   const handleCatch = useCallback(
     ({error: caughtError, info: caughtInfo}: {error: Error; info: React.ErrorInfo}) => {
-      // Send the error to the source if it has an onStudioError method
-      source?.onStudioError?.(caughtError, caughtInfo)
+      // Send the error to the source if it has an onUncaughtError method
+      source?.onUncaughtError?.(caughtError, caughtInfo)
 
       // Call the onCatch prop if it exists
       onCatch?.({error: caughtError, info: caughtInfo})

diff --git a/packages/sanity/src/ui-components/errorBoundary/__test__/ErrorBoundary.test.tsx b/packages/sanity/src/ui-components/errorBoundary/__test__/ErrorBoundary.test.tsx
@@ -14,8 +14,8 @@ describe('ErrorBoundary', () => {
     jest.clearAllMocks()
   })
 
-  it('calls onStudioError when an error is caught', async () => {
-    const onStudioError = jest.fn()
+  it('calls onUncaughtError when an error is caught', async () => {
+    const onUncaughtError = jest.fn()
     const onCatch = jest.fn()
 
     const ThrowErrorComponent = () => {
@@ -30,7 +30,7 @@ describe('ErrorBoundary', () => {
         name: 'default',
         projectId: 'test',
         dataset: 'test',
-        onStudioError,
+        onUncaughtError,
       },
     })
 
@@ -42,10 +42,10 @@ describe('ErrorBoundary', () => {
       </TestProvider>,
     )
 
-    expect(onStudioError).toHaveBeenCalledTimes(1)
+    expect(onUncaughtError).toHaveBeenCalledTimes(1)
   })
 
-  it('calls onCatch prop when an error is caught when no onStudioError exists', () => {
+  it('calls onCatch prop when an error is caught when no onUncaughtError exists', () => {
     const onCatch = jest.fn()
 
     const WrapperWithoutError = ({children}: {children: React.ReactNode}) => {