Files
supabase/apps/studio/components/ui/ProjectUpgradeFailedBanner.tsx
Alaister YoungandAlaister Young ca2b50a0a7 chore(ui-patterns): collapse the admonition shim into ui-patterns/Admonition (#48377)
Follow-up to #48344: collapses the two resolution paths for the
Admonition module into one.

`src/admonition.tsx` was a back-compat shim re-exporting
`src/Admonition/`. Two ways to resolve one module is exactly what
produced the macOS self-import bug fixed in #48344, and the local
typecheck errors that #48374 worked around. This removes the shim and
standardizes on the PascalCase subpath, matching every other export in
the package.

**Changed:**

- Codemodded all 246 `ui-patterns/admonition` imports to
`ui-patterns/Admonition` (240 `.tsx`, 5 `.mdx`, 1 `.ts` across studio,
docs, www, design-system, and lite-studio)
- Pointed the 5 internal `'../admonition'` imports back at the
`'../Admonition'` directory

**Removed:**

- `packages/ui-patterns/src/admonition.tsx`, and its `./admonition`
entry in the exports map (regenerated with `pnpm gen:exports`)

## To test

- `grep -r "ui-patterns/admonition" --include='*.ts*'` → no hits
- `pnpm test:case-hazards` → passes
- `pnpm typecheck` → all 15 tasks green
- `pnpm --filter studio run lint:ratchet` → passes
- `pnpm --filter ui-patterns vitest run src/Admonition` → 11 tests pass

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

* **Bug Fixes**
* Standardized Admonition component imports across the application and
documentation.
* Improved compatibility with case-sensitive environments by using the
canonical component path.
  * Removed the legacy Admonition import entry point.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Alaister Young <10985857+alaister@users.noreply.github.com>
2026-07-29 00:48:56 +08:00

100 lines
3.6 KiB
TypeScript

import { SupportCategories } from '@supabase/shared-types/out/constants'
import { DatabaseUpgradeStatus } from '@supabase/shared-types/out/events'
import { LOCAL_STORAGE_KEYS, useParams } from 'common'
import dayjs from 'dayjs'
import { X } from 'lucide-react'
import { Button } from 'ui'
import { Admonition } from 'ui-patterns/Admonition'
import { ButtonTooltip } from './ButtonTooltip'
import { InlineLink } from './InlineLink'
import { SupportLink } from '@/components/interfaces/Support/SupportLink'
import { useProjectUpgradingStatusQuery } from '@/data/config/project-upgrade-status-query'
import { useLocalStorageQuery } from '@/hooks/misc/useLocalStorage'
import { useShowPostgresUpgradeLogs } from '@/hooks/misc/useShowPostgresUpgradeLogs'
import { IS_PLATFORM } from '@/lib/constants'
import { guessLocalTimezone } from '@/lib/dayjs'
// [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 showPostgresUpgradeLogs = useShowPostgresUpgradeLogs()
const [dismissedAt, setDismissedAt] = useLocalStorageQuery<string | null>(
LOCAL_STORAGE_KEYS.PROJECT_UPGRADE_FAILED_BANNER_DISMISSED_AT(ref ?? 'unknown'),
null
)
const isFailed = status === DatabaseUpgradeStatus.Failed && initiated_at !== dismissedAt
const initiatedAt = dayjs
.utc(initiated_at ?? 0)
.tz(guessLocalTimezone())
.format('DD MMM YYYY HH:mm:ss')
const subject = 'Upgrade failed for project'
const message = `Upgrade information:\n• Initiated at: ${initiated_at}\n• 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}`
if (!isFailed) return null
return (
<div className="max-w-7xl">
<Admonition
type="warning"
title={`Postgres version upgrade was not successful (Initiated at ${initiatedAt})`}
actions={
<>
<Button asChild variant="default">
<SupportLink
queryParams={{
category: SupportCategories.DATABASE_UNRESPONSIVE,
projectRef: ref,
subject,
message,
}}
>
Contact support
</SupportLink>
</Button>
<ButtonTooltip
icon={<X />}
variant="text"
className="w-6"
tooltip={{ content: { side: 'bottom', text: 'Dismiss' } }}
aria-label="Dismiss upgrade failed banner"
onClick={() => setDismissedAt(initiated_at ?? null)}
/>
</>
}
>
<div>
Your project and its data are not affected. Please reach out to us via our support form
for assistance with the upgrade.
</div>
{showPostgresUpgradeLogs && (
<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>
)}
</Admonition>
</div>
)
}