mirror of
https://github.com/supabase/supabase.git
synced 2026-07-05 02:24:20 +08:00
Migrates client SDK References to App Router. (Management and CLI API references aren't migrated yet, nor are self-hosting config references.) Some notes: Big changes to the way crawler pages are built and individual section URLs (e.g., javascript/select) are served. All of these used to be SSG-generated pages, but the number of heavy pages was just too much to handle -- slow as molasses and my laptop sounded like it was taking off, and CI sometimes refuses to build it all at all. Tried various tricks with caching and pre-generating data but no dice. So I changed to only building one copy of each SDK+version page, then serving the sub-URLs through a response rewrite. That's for the actual user-visible pages. For the bot pages, each sub-URL needs to be its own page, but prebuilding it doesn't work, and rendering on demand from React components is too slow (looking for super-fast response here for SEO). Instead I changed to using an API route that serves very minimal, hand-crafted HTML. It looks ugly, but it's purely for the search bots. You can test what bots see by running curl --user-agent "Mozilla/5.0 (iPhone; CPU iPhone OS 6_0 like Mac OS X) AppleWebKit/536.26 (KHTML, like Gecko) Version/6.0 Mobile/10A5376e Safari/8536.25 (compatible; Googlebot/2.1; +http://www.google.com/bot.html)" <URL_OF_PAGE> Also added some smoke tests to run against prod for the crawler routes, since we don't keep an eye on those regularly, and Vercel config changes could surprise-break them. Tested the meta images on Open Graph and all seems to work fine. With this approach, full production builds are really fast: ~5 minutes Starts using the new type spec handling, which is better at finding params automatically, so I could remove some of the manually written ones from the spec files.
248 lines
5.2 KiB
TypeScript
248 lines
5.2 KiB
TypeScript
import { memo } from 'react'
|
|
|
|
import NavigationMenuGuideList from './NavigationMenuGuideList'
|
|
import NavigationMenuRefList from './NavigationMenuRefList'
|
|
import { useCloseMenuOnRouteChange } from './NavigationMenu.utils'
|
|
|
|
enum MenuId {
|
|
GettingStarted = 'gettingstarted',
|
|
Database = 'database',
|
|
Api = 'api',
|
|
Graphql = 'graphql',
|
|
Auth = 'auth',
|
|
Functions = 'functions',
|
|
Realtime = 'realtime',
|
|
Storage = 'storage',
|
|
Ai = 'ai',
|
|
Platform = 'platform',
|
|
Resources = 'resources',
|
|
SelfHosting = 'self_hosting',
|
|
Integrations = 'integrations',
|
|
Cli = 'supabase_cli',
|
|
RefJavaScriptV1 = 'reference_javascript_v1',
|
|
RefJavaScriptV2 = 'reference_javascript_v2',
|
|
RefDartV1 = 'reference_dart_v1',
|
|
RefDartV2 = 'reference_dart_v2',
|
|
RefCSharpV0 = 'reference_csharp_v0',
|
|
RefCSharpV1 = 'reference_csharp_v1',
|
|
RefPythonV2 = 'reference_python_v2',
|
|
RefSwiftV1 = 'reference_swift_v1',
|
|
RefSwiftV2 = 'reference_swift_v2',
|
|
RefKotlinV1 = 'reference_kotlin_v1',
|
|
RefKotlinV2 = 'reference_kotlin_v2',
|
|
RefCli = 'reference_cli',
|
|
RefApi = 'reference_api',
|
|
SelfHostingAuth = 'reference_self_hosting_auth',
|
|
SelfHostingStorage = 'reference_self_hosting_storage',
|
|
SelfHostingRealtime = 'reference_self_hosting_realtime',
|
|
SelfHostingAnalytics = 'reference_self_hosting_analytics',
|
|
SelfHostingFunctions = 'reference_self_hosting_functions',
|
|
}
|
|
|
|
interface BaseMenu {
|
|
id: MenuId
|
|
type: string
|
|
}
|
|
|
|
interface GuideMenu extends BaseMenu {
|
|
type: 'guide'
|
|
}
|
|
|
|
interface ReferenceMenu extends BaseMenu {
|
|
type: 'reference'
|
|
path: string
|
|
commonSectionsFile?: string
|
|
}
|
|
|
|
type Menu = GuideMenu | ReferenceMenu
|
|
|
|
const menus: Menu[] = [
|
|
{
|
|
id: MenuId.GettingStarted,
|
|
type: 'guide',
|
|
},
|
|
{
|
|
id: MenuId.Database,
|
|
type: 'guide',
|
|
},
|
|
{
|
|
id: MenuId.Api,
|
|
type: 'guide',
|
|
},
|
|
{
|
|
id: MenuId.Graphql,
|
|
type: 'guide',
|
|
},
|
|
{
|
|
id: MenuId.Auth,
|
|
type: 'guide',
|
|
},
|
|
{
|
|
id: MenuId.Functions,
|
|
type: 'guide',
|
|
},
|
|
{
|
|
id: MenuId.Realtime,
|
|
type: 'guide',
|
|
},
|
|
{
|
|
id: MenuId.Storage,
|
|
type: 'guide',
|
|
},
|
|
{
|
|
id: MenuId.Ai,
|
|
type: 'guide',
|
|
},
|
|
{
|
|
id: MenuId.Platform,
|
|
type: 'guide',
|
|
},
|
|
{
|
|
id: MenuId.Resources,
|
|
type: 'guide',
|
|
},
|
|
{
|
|
id: MenuId.SelfHosting,
|
|
type: 'guide',
|
|
},
|
|
{
|
|
id: MenuId.Integrations,
|
|
type: 'guide',
|
|
},
|
|
{
|
|
id: MenuId.Cli,
|
|
type: 'guide',
|
|
},
|
|
{
|
|
id: MenuId.RefJavaScriptV1,
|
|
type: 'reference',
|
|
path: '/reference/javascript/v1',
|
|
},
|
|
{
|
|
id: MenuId.RefJavaScriptV2,
|
|
type: 'reference',
|
|
path: '/reference/javascript',
|
|
},
|
|
{
|
|
id: MenuId.RefDartV1,
|
|
type: 'reference',
|
|
path: '/reference/dart/v1',
|
|
},
|
|
{
|
|
id: MenuId.RefDartV2,
|
|
type: 'reference',
|
|
path: '/reference/dart',
|
|
},
|
|
{
|
|
id: MenuId.RefCSharpV0,
|
|
type: 'reference',
|
|
path: '/reference/csharp/v0',
|
|
},
|
|
{
|
|
id: MenuId.RefCSharpV1,
|
|
type: 'reference',
|
|
path: '/reference/csharp',
|
|
},
|
|
{
|
|
id: MenuId.RefPythonV2,
|
|
type: 'reference',
|
|
path: '/reference/python',
|
|
},
|
|
{
|
|
id: MenuId.RefSwiftV1,
|
|
type: 'reference',
|
|
path: '/reference/swift',
|
|
},
|
|
{
|
|
id: MenuId.RefSwiftV2,
|
|
type: 'reference',
|
|
path: '/reference/swift',
|
|
},
|
|
{
|
|
id: MenuId.RefKotlinV1,
|
|
type: 'reference',
|
|
path: '/reference/kotlin/v1',
|
|
},
|
|
{
|
|
id: MenuId.RefKotlinV2,
|
|
type: 'reference',
|
|
path: '/reference/kotlin',
|
|
},
|
|
{
|
|
id: MenuId.RefCli,
|
|
type: 'reference',
|
|
path: '/reference/cli',
|
|
commonSectionsFile: 'common-cli-sections.json',
|
|
},
|
|
{
|
|
id: MenuId.RefApi,
|
|
type: 'reference',
|
|
path: '/reference/api',
|
|
commonSectionsFile: 'common-api-sections.json',
|
|
},
|
|
{
|
|
id: MenuId.SelfHostingAuth,
|
|
type: 'reference',
|
|
path: '/reference/self-hosting-auth',
|
|
commonSectionsFile: 'common-self-hosting-auth-sections.json',
|
|
},
|
|
{
|
|
id: MenuId.SelfHostingStorage,
|
|
type: 'reference',
|
|
path: '/reference/self-hosting-storage',
|
|
commonSectionsFile: 'common-self-hosting-storage-sections.json',
|
|
},
|
|
{
|
|
id: MenuId.SelfHostingRealtime,
|
|
type: 'reference',
|
|
path: '/reference/self-hosting-realtime',
|
|
commonSectionsFile: 'common-self-hosting-realtime-sections.json',
|
|
},
|
|
{
|
|
id: MenuId.SelfHostingAnalytics,
|
|
type: 'reference',
|
|
path: '/reference/self-hosting-analytics',
|
|
commonSectionsFile: 'common-self-hosting-analytics-sections.json',
|
|
},
|
|
{
|
|
id: MenuId.SelfHostingFunctions,
|
|
type: 'reference',
|
|
path: '/reference/self-hosting-functions',
|
|
commonSectionsFile: 'common-self-hosting-functions-sections.json',
|
|
},
|
|
]
|
|
|
|
function getMenuById(id: MenuId) {
|
|
return menus.find((menu) => menu.id === id)
|
|
}
|
|
|
|
function getMenuElement(menu: Menu | undefined) {
|
|
const menuType = menu?.type
|
|
switch (menuType) {
|
|
case 'guide':
|
|
return <NavigationMenuGuideList id={menu.id} />
|
|
case 'reference':
|
|
return (
|
|
<NavigationMenuRefList
|
|
id={menu.id}
|
|
basePath={menu.path}
|
|
commonSectionsFile={menu.commonSectionsFile}
|
|
/>
|
|
)
|
|
default:
|
|
return null
|
|
}
|
|
}
|
|
|
|
const NavigationMenu = ({ menuId }: { menuId: MenuId }) => {
|
|
const level = menuId
|
|
const menu = getMenuById(level)
|
|
|
|
useCloseMenuOnRouteChange()
|
|
|
|
return getMenuElement(menu)
|
|
}
|
|
|
|
export { MenuId, getMenuById }
|
|
export default memo(NavigationMenu)
|