Files
supabase/apps/studio/components/ui/ProjectUpgradeFailedBanner.tsx
T
CharisandJoshen Lim d8f7cc0d57 feat(support form): attach dashboard logs (#39539)
* o11y: mirror and sanitize breadcrumbs

Mirror Sentry breadcrumbs as the basis for our own support logging. Also
adds more sanitization to breadcrumbs.

* feat(support form): toggle for attaching dashboard  logs

Add a toggle to the support form when the category is "Dashboard bug",
to attach recent dashboard logs. Users can preview the attached logs and
opt out.

* feat(support links): dedicated support link component

Add a new component for support links, which:
- Uses the serializer for support link params to ensure
serialization/deserialization pairs correctly
- Snapshots breadcrumbs so the attached log on the support form will be
cut off at the support link click (otherwise we will get support form
actions cluttering up the log)

* tests(support form): extend timeout on flaky test

* Minor clean up

* fix(support form): allow url to specifically indicate no specified project

* minor nits

* Fix tests

* Fix tests

---------

Co-authored-by: Joshen Lim <joshenlimek@gmail.com>
2025-10-22 08:57:49 -04:00

99 lines
3.2 KiB
TypeScript

import { DatabaseUpgradeStatus } from '@supabase/shared-types/out/events'
import dayjs from 'dayjs'
import { X } from 'lucide-react'
import { useEffect, useState } from 'react'
import { SupportCategories } from '@supabase/shared-types/out/constants'
import { useParams } from 'common'
import { SupportLink } from 'components/interfaces/Support/SupportLink'
import { useProjectUpgradingStatusQuery } from 'data/config/project-upgrade-status-query'
import { IS_PLATFORM } from 'lib/constants'
import { Alert, Button } from 'ui'
import { InlineLink } from './InlineLink'
// [Joshen] Think twice about the category though - it doesn't correspond
export const ProjectUpgradeFailedBanner = () => {
const { ref } = useParams()
const { data } = useProjectUpgradingStatusQuery({ projectRef: ref }, { enabled: IS_PLATFORM })
const { status, initiated_at, latest_status_at, error } = data?.databaseUpgradeStatus ?? {}
const key = `supabase-upgrade-${ref}-${initiated_at}`
const [hasDismissed, setHasDismissed] = useState(false)
useEffect(() => {
setHasDismissed(localStorage?.getItem(key) === 'true')
}, [key])
const isFailed = status === DatabaseUpgradeStatus.Failed
const initiatedAt = dayjs
.utc(initiated_at ?? 0)
.tz(dayjs.tz.guess())
.format('DD MMM YYYY HH:mm:ss')
const subject = 'Upgrade%20failed%20for%20project'
const message = `Upgrade information:%0A• Initiated at: ${initiated_at}%0A• Error: ${error}`
const initiatedAtEncoded = encodeURIComponent(
dayjs.utc(initiated_at ?? 0).format('YYYY-MM-DDTHH:mm:ss')
)
const latestStatusAtEncoded = encodeURIComponent(
dayjs
.utc(latest_status_at ?? 0)
.utcOffset(0)
.format('YYYY-MM-DDTHH:mm:ss')
)
const timestampFilter = `its=${initiatedAtEncoded}&ite=${latestStatusAtEncoded}`
const acknowledgeMessage = () => {
setHasDismissed(true)
localStorage.setItem(key, 'true')
}
if (!isFailed || hasDismissed) return null
return (
<div className="max-w-7xl">
<Alert
withIcon
variant={'warning'}
title={`Postgres version upgrade was not successful (Initiated at ${initiatedAt})`}
actions={
<div className="flex items-center h-full space-x-4">
<Button asChild type="default">
<SupportLink
queryParams={{
category: SupportCategories.DATABASE_UNRESPONSIVE,
projectRef: ref,
subject,
message,
}}
>
Contact support
</SupportLink>
</Button>
<Button
type="text"
className="px-1"
icon={<X size={16} strokeWidth={1.5} />}
onClick={() => acknowledgeMessage()}
/>
</div>
}
>
<div>
Your project and its data are not affected. Please reach out to us via our support form
for assistance with the upgrade.
</div>
<div>
You may also view logs related to the failed upgrade in your{' '}
<InlineLink href={`/project/${ref}/logs/pg-upgrade-logs?${timestampFilter}`}>
project's logs
</InlineLink>
.
</div>
</Alert>
</div>
)
}