mirror of
https://github.com/supabase/supabase.git
synced 2026-06-10 13:01:16 +08:00
## I have read the [CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md) file. YES ## What kind of change does this PR introduce? - Noticing our code we have many patterns of calling localstorage and handling those errors - We should add those in a single well tested file - Handle those errors in the singleton which makes it easier for us to debug customer issues. Logger is outputing local storage warnings for feature we expose - Side effect of this is random crashes on studio when local storage isn't available or handled correctly <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Refactor** * Improved browser storage handling across the app for more reliable persistence and graceful behavior in restricted or non-browser environments (settings, previews, charts, tabs, sign-in/session flows, integrations, and UI state). * **New Features** * Introduced a safe storage layer to standardize and harden local/session persistence. * **Tests** * Added comprehensive tests covering the new safe storage behavior. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
111 lines
3.7 KiB
TypeScript
111 lines
3.7 KiB
TypeScript
import { SupportCategories } from '@supabase/shared-types/out/constants'
|
|
import { safeLocalStorage, safeSessionStorage } from 'common'
|
|
import { ExternalLink } from 'lucide-react'
|
|
import { useRouter } from 'next/router'
|
|
import { Button, cn } from 'ui'
|
|
import { Admonition } from 'ui-patterns'
|
|
|
|
import CopyButton from '../CopyButton'
|
|
import { InlineLinkClassName } from '../InlineLink'
|
|
import { SupportLink } from '@/components/interfaces/Support/SupportLink'
|
|
|
|
interface ClientSideExceptionHandlerProps {
|
|
message: string
|
|
sentryIssueId: string
|
|
urlMessage: string
|
|
resetErrorBoundary: () => void
|
|
}
|
|
|
|
export const ClientSideExceptionHandler = ({
|
|
message,
|
|
sentryIssueId,
|
|
urlMessage,
|
|
resetErrorBoundary,
|
|
}: ClientSideExceptionHandlerProps) => {
|
|
const router = useRouter()
|
|
|
|
const isProduction = process.env.NEXT_PUBLIC_ENVIRONMENT !== 'prod'
|
|
|
|
const handleClearStorage = () => {
|
|
safeLocalStorage.clear()
|
|
safeSessionStorage.clear()
|
|
window.location.reload()
|
|
}
|
|
|
|
return (
|
|
<>
|
|
<div className="flex flex-col gap-y-1 text-left py-2 w-full">
|
|
<div className="flex items-center justify-between mb-3">
|
|
<p className="text-lg font-bold">Sorry! An unexpected error occurred.</p>
|
|
<CopyButton type="outline" text={message} copyLabel="Copy error" />
|
|
</div>
|
|
<p className="text-sm">
|
|
Application error: a client-side exception has occurred (see browser console for more
|
|
information)
|
|
</p>
|
|
<p className="text-foreground-light text-sm">{message}</p>
|
|
</div>
|
|
<Admonition type="note" showIcon={false} title="We recommend trying the following:">
|
|
<ul className="list-disc mt-1.5 pl-2 list-inside text-sm space-y-1">
|
|
<li>
|
|
<span
|
|
className={cn(InlineLinkClassName, 'cursor-pointer')}
|
|
onClick={() => window.location.reload()}
|
|
>
|
|
Refresh
|
|
</span>{' '}
|
|
the page
|
|
</li>
|
|
<li>
|
|
<span
|
|
className={cn(InlineLinkClassName, 'cursor-pointer')}
|
|
onClick={() => router.push('/logout')}
|
|
>
|
|
Sign out
|
|
</span>{' '}
|
|
and sign back in
|
|
</li>
|
|
<li>
|
|
<span
|
|
className={cn(InlineLinkClassName, 'cursor-pointer')}
|
|
onClick={handleClearStorage}
|
|
>
|
|
Clear your browser storage
|
|
</span>{' '}
|
|
to clean potentially outdated data
|
|
</li>
|
|
<li>Disable browser extensions that might modify page content (e.g. Google Translate)</li>
|
|
<li>If the problem persists, please contact support for assistance</li>
|
|
</ul>
|
|
</Admonition>
|
|
|
|
<div className={cn('w-full mx-auto grid gap-2', 'grid-cols-2 sm:w-1/2')}>
|
|
<Button asChild type="default" icon={<ExternalLink />}>
|
|
<SupportLink
|
|
queryParams={{
|
|
category: SupportCategories.DASHBOARD_BUG,
|
|
subject: 'Client side exception occurred on dashboard',
|
|
sid: sentryIssueId,
|
|
error: urlMessage,
|
|
}}
|
|
>
|
|
Contact support
|
|
</SupportLink>
|
|
</Button>
|
|
|
|
{/* [Joshen] For local and staging, allow us to escape the error boundary */}
|
|
{/* We could actually investigate how to make this available on prod, but without being able to reliably test this, I'm not keen to do it now */}
|
|
{isProduction ? (
|
|
<Button type="outline" onClick={() => router.reload()}>
|
|
Reload dashboard
|
|
</Button>
|
|
) : (
|
|
<Button type="outline" onClick={() => resetErrorBoundary()}>
|
|
Return to dashboard
|
|
</Button>
|
|
)}
|
|
</div>
|
|
</>
|
|
)
|
|
}
|