Files
supabase/apps/docs/features/helpers.fs.ts
Charis fc164b5d07 Refactor/app router refs (#28095)
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.
2024-08-13 16:12:59 -04:00

54 lines
1.3 KiB
TypeScript

import { watch } from 'node:fs'
import { stat } from 'node:fs/promises'
import type { OrPromise } from '~/features/helpers.types'
import { IS_DEV } from '~/lib/constants'
/**
* Caches a function for the length of the server process.
*
* In DEV, watches a directory to cache bust on edit.
*/
export const cache_fullProcess_withDevCacheBust = <Args extends unknown[], Output>(
/**
* The function whose results to cache
*/
fn: (...args: Args) => OrPromise<Output>,
/**
* The directory to watch for edits
*/
watchDirectory: string,
/**
* A function that generates the cache key to bust, given the changed
* filename (relative to the watch directory)
*/
genCacheKeyFromFilename: (filename: string) => string
) => {
const _cache = new Map<string, Output>()
if (IS_DEV) {
watch(watchDirectory, { recursive: true }, (_, filename) => {
if (!filename) return
const cacheKey = genCacheKeyFromFilename(filename)
_cache.delete(cacheKey)
})
}
return async (...args: Args) => {
const cacheKey = JSON.stringify(args)
if (!_cache.has(cacheKey)) {
_cache.set(cacheKey, await fn(...args))
}
return _cache.get(cacheKey)!
}
}
export const existsFile = async (fullPath: string) => {
try {
await stat(fullPath)
return true
} catch {
return false
}
}