Skip to content

The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.

Simplify logic in NoticeBanner by using useLocalStorageQuery (#41890)

Joshen Lim9dbc4fc85193
diff --git a/apps/studio/components/interfaces/App/AppBannerWrapperContext.tsx b/apps/studio/components/interfaces/App/AppBannerWrapperContext.tsx
deleted file mode 100644
index 30f005b9ac9..00000000000
--- a/apps/studio/components/interfaces/App/AppBannerWrapperContext.tsx
+++ /dev/null
@@ -1,50 +0,0 @@
-import { LOCAL_STORAGE_KEYS } from 'common'
-import { noop } from 'lodash'
-import { PropsWithChildren, createContext, useContext, useEffect, useState } from 'react'
-
-const MAINTENANCE_WINDOW_BANNER_KEY = LOCAL_STORAGE_KEYS.MAINTENANCE_WINDOW_BANNER
-
-// [Joshen] This file is meant to be dynamic - update this as and when we need to use the NoticeBanner
-
-type AppBannerContextType = {
- maintenanceWindowBannerAcknowledged: boolean
- onUpdateAcknowledged: (key: typeof MAINTENANCE_WINDOW_BANNER_KEY) => void
-}
-
-const AppBannerContext = createContext<AppBannerContextType>({
- maintenanceWindowBannerAcknowledged: false,
- onUpdateAcknowledged: noop,
-})
-
-export const useAppBannerContext = () => useContext(AppBannerContext)
-
-export const AppBannerContextProvider = ({ children }: PropsWithChildren<{}>) => {
- const [maintenanceWindowBannerAcknowledged, setMaintenanceWindowBannerAcknowledged] =
- useState<boolean>(false)
-
- useEffect(() => {
- if (typeof window !== 'undefined') {
- const maintenanceAcknowledged = localStorage.getItem(MAINTENANCE_WINDOW_BANNER_KEY) === 'true'
- setMaintenanceWindowBannerAcknowledged(maintenanceAcknowledged)
- }
- }, [])
-
- const value = {
- maintenanceWindowBannerAcknowledged,
- onUpdateAcknowledged: (key: typeof MAINTENANCE_WINDOW_BANNER_KEY) => {
- if (key === MAINTENANCE_WINDOW_BANNER_KEY) {
- if (typeof window !== 'undefined') {
- window.localStorage.setItem(MAINTENANCE_WINDOW_BANNER_KEY, 'true')
- }
- setMaintenanceWindowBannerAcknowledged(true)
- }
- },
- }
-
- return <AppBannerContext.Provider value={value}>{children}</AppBannerContext.Provider>
-}
-
-export const useIsNoticeBannerShown = () => {
- const { maintenanceWindowBannerAcknowledged } = useAppBannerContext()
- return maintenanceWindowBannerAcknowledged
-}
diff --git a/apps/studio/components/layouts/AppLayout/NoticeBanner.tsx b/apps/studio/components/layouts/AppLayout/NoticeBanner.tsx
index bb6d96794a5..3b9cd6c2c1d 100644
--- a/apps/studio/components/layouts/AppLayout/NoticeBanner.tsx
+++ b/apps/studio/components/layouts/AppLayout/NoticeBanner.tsx
@@ -1,20 +1,23 @@
import { useRouter } from 'next/router'
-import { useAppBannerContext } from 'components/interfaces/App/AppBannerWrapperContext'
+import { useLocalStorageQuery } from '@/hooks/misc/useLocalStorage'
+import { LOCAL_STORAGE_KEYS } from 'common'
import { HeaderBanner } from 'components/interfaces/Organization/HeaderBanner'
import { InlineLink } from 'components/ui/InlineLink'
import { TimestampInfo } from 'ui-patterns'
/**
* Used to display urgent notices that apply for all users, such as maintenance windows.
- * This file, like AppBannerWrapperContext.tsx, is meant to be dynamic.
- * Update this as and when we need to use the NoticeBanner.
*/
export const NoticeBanner = () => {
const router = useRouter()
- const { maintenanceWindowBannerAcknowledged, onUpdateAcknowledged } = useAppBannerContext()
- if (router.pathname.includes('sign-in') || maintenanceWindowBannerAcknowledged) {
+ const [bannerAcknowledged, setBannerAcknowledge, { isSuccess }] = useLocalStorageQuery(
+ LOCAL_STORAGE_KEYS.MAINTENANCE_WINDOW_BANNER,
+ false
+ )
+
+ if (router.pathname.includes('sign-in') || !isSuccess || bannerAcknowledged) {
return null
}
@@ -35,7 +38,7 @@ export const NoticeBanner = () => {
</InlineLink>
</>
}
- onDismiss={() => onUpdateAcknowledged('maintenance-window-banner-2026-01-16')}
+ onDismiss={() => setBannerAcknowledge(true)}
/>
)
}
diff --git a/apps/studio/components/layouts/AuthenticationLayout.tsx b/apps/studio/components/layouts/AuthenticationLayout.tsx
index 6ba3373faca..077a1d1fefe 100644
--- a/apps/studio/components/layouts/AuthenticationLayout.tsx
+++ b/apps/studio/components/layouts/AuthenticationLayout.tsx
@@ -1,17 +1,14 @@
import { PropsWithChildren } from 'react'
import { AppBannerWrapper } from 'components/interfaces/App/AppBannerWrapper'
-import { AppBannerContextProvider } from 'components/interfaces/App/AppBannerWrapperContext'
export const AuthenticationLayout = ({ children }: PropsWithChildren<{}>) => {
return (
- <AppBannerContextProvider>
- <div className="flex flex-col min-h-screen w-screen">
- <AppBannerWrapper />
- <div className="flex flex-1 w-full overflow-y-hidden">
- <div className="flex-grow h-full overflow-y-auto">{children}</div>
- </div>
+ <div className="flex flex-col min-h-screen w-screen">
+ <AppBannerWrapper />
+ <div className="flex flex-1 w-full overflow-y-hidden">
+ <div className="flex-grow h-full overflow-y-auto">{children}</div>
</div>
- </AppBannerContextProvider>
+ </div>
)
}
diff --git a/apps/studio/components/layouts/DefaultLayout.tsx b/apps/studio/components/layouts/DefaultLayout.tsx
index 09685490fd8..3b838766968 100644
--- a/apps/studio/components/layouts/DefaultLayout.tsx
+++ b/apps/studio/components/layouts/DefaultLayout.tsx
@@ -3,7 +3,6 @@ import { PropsWithChildren } from 'react'
import { LOCAL_STORAGE_KEYS, useParams } from 'common'
import { AppBannerWrapper } from 'components/interfaces/App/AppBannerWrapper'
-import { AppBannerContextProvider } from 'components/interfaces/App/AppBannerWrapperContext'
import { Sidebar } from 'components/interfaces/Sidebar'
import { useLocalStorageQuery } from 'hooks/misc/useLocalStorage'
import { useCheckLatestDeploy } from 'hooks/use-check-latest-deploy'
@@ -61,50 +60,48 @@ export const DefaultLayout = ({
<SidebarProvider defaultOpen={false}>
<LayoutSidebarProvider>
<ProjectContextProvider projectRef={ref}>
- <AppBannerContextProvider>
- <div className="flex flex-col h-screen w-screen">
- {/* Top Banner */}
- <AppBannerWrapper />
- <div className="flex-shrink-0">
- <MobileNavigationBar hideMobileMenu={hideMobileMenu} />
- <LayoutHeader
- showProductMenu={showProductMenu}
- headerTitle={headerTitle}
- backToDashboardURL={
- router.pathname.startsWith('/account') ? backToDashboardURL : undefined
- }
- />
- </div>
- {/* Main Content Area */}
- <div className="flex flex-1 w-full overflow-y-hidden">
- {/* Sidebar - Only show for project pages, not account pages */}
- {!router.pathname.startsWith('/account') && <Sidebar />}
- {/* Main Content with Layout Sidebar */}
- <ResizablePanelGroup
- direction="horizontal"
- className="h-full w-full overflow-x-hidden flex-1 flex flex-row gap-0"
- autoSaveId="default-layout-content"
+ <div className="flex flex-col h-screen w-screen">
+ {/* Top Banner */}
+ <AppBannerWrapper />
+ <div className="flex-shrink-0">
+ <MobileNavigationBar hideMobileMenu={hideMobileMenu} />
+ <LayoutHeader
+ showProductMenu={showProductMenu}
+ headerTitle={headerTitle}
+ backToDashboardURL={
+ router.pathname.startsWith('/account') ? backToDashboardURL : undefined
+ }
+ />
+ </div>
+ {/* Main Content Area */}
+ <div className="flex flex-1 w-full overflow-y-hidden">
+ {/* Sidebar - Only show for project pages, not account pages */}
+ {!router.pathname.startsWith('/account') && <Sidebar />}
+ {/* Main Content with Layout Sidebar */}
+ <ResizablePanelGroup
+ direction="horizontal"
+ className="h-full w-full overflow-x-hidden flex-1 flex flex-row gap-0"
+ autoSaveId="default-layout-content"
+ >
+ <ResizablePanel
+ id="panel-content"
+ order={1}
+ className="w-full"
+ minSize={contentMinSizePercentage}
+ maxSize={contentMaxSizePercentage}
+ defaultSize={contentMaxSizePercentage}
>
- <ResizablePanel
- id="panel-content"
- order={1}
- className="w-full"
- minSize={contentMinSizePercentage}
- maxSize={contentMaxSizePercentage}
- defaultSize={contentMaxSizePercentage}
- >
- <div className="h-full overflow-y-auto">{children}</div>
- </ResizablePanel>
- <LayoutSidebar
- order={2}
- minSize={100 - contentMaxSizePercentage}
- maxSize={100 - contentMinSizePercentage}
- defaultSize={100 - contentMaxSizePercentage}
- />
- </ResizablePanelGroup>
- </div>
+ <div className="h-full overflow-y-auto">{children}</div>
+ </ResizablePanel>
+ <LayoutSidebar
+ order={2}
+ minSize={100 - contentMaxSizePercentage}
+ maxSize={100 - contentMinSizePercentage}
+ defaultSize={100 - contentMaxSizePercentage}
+ />
+ </ResizablePanelGroup>
</div>
- </AppBannerContextProvider>
+ </div>
</ProjectContextProvider>
</LayoutSidebarProvider>
</SidebarProvider>
diff --git a/apps/studio/pages/_app.tsx b/apps/studio/pages/_app.tsx
index c5e43132a0d..a132b4b30cd 100644
--- a/apps/studio/pages/_app.tsx
+++ b/apps/studio/pages/_app.tsx
@@ -42,7 +42,6 @@ import {
useThemeSandbox,
} from 'common'
import MetaFaviconsPagesRouter from 'common/MetaFavicons/pages-router'
-import { AppBannerContextProvider } from 'components/interfaces/App/AppBannerWrapperContext'
import { StudioCommandMenu } from 'components/interfaces/App/CommandMenu'
import { StudioCommandProvider as CommandProvider } from 'components/interfaces/App/CommandMenu/StudioCommandProvider'
import { FeaturePreviewContextProvider } from 'components/interfaces/App/FeaturePreview/FeaturePreviewContext'
@@ -61,7 +60,6 @@ import { Telemetry } from 'lib/telemetry'
import { AiAssistantStateContextProvider } from 'state/ai-assistant-state'
import type { AppPropsWithLayout } from 'types'
import { SonnerToaster, TooltipProvider } from 'ui'
-import { ToastErrorTracker } from 'lib/toast-errors'
dayjs.extend(customParseFormat)
dayjs.extend(utc)
@@ -161,21 +159,19 @@ function CustomApp({ Component, pageProps }: AppPropsWithLayout) {
enableSystem
disableTransitionOnChange
>
- <AppBannerContextProvider>
- <AiAssistantStateContextProvider>
- <CommandProvider>
- <FeaturePreviewContextProvider>
- <MainScrollContainerProvider>
- {getLayout(<Component {...pageProps} />)}
- </MainScrollContainerProvider>
- <StudioCommandMenu />
- <FeaturePreviewModal />
- </FeaturePreviewContextProvider>
- <SonnerToaster position="top-right" />
- <MonacoThemeProvider />
- </CommandProvider>
- </AiAssistantStateContextProvider>
- </AppBannerContextProvider>
+ <AiAssistantStateContextProvider>
+ <CommandProvider>
+ <FeaturePreviewContextProvider>
+ <MainScrollContainerProvider>
+ {getLayout(<Component {...pageProps} />)}
+ </MainScrollContainerProvider>
+ <StudioCommandMenu />
+ <FeaturePreviewModal />
+ </FeaturePreviewContextProvider>
+ <SonnerToaster position="top-right" />
+ <MonacoThemeProvider />
+ </CommandProvider>
+ </AiAssistantStateContextProvider>
</ThemeProvider>
</RouteValidationWrapper>
</TooltipProvider>