File size: 4,024 Bytes
1e92f2d |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 |
import { PAGE_SEGMENT_KEY } from '../segment'
import type { Segment as FlightRouterStateSegment } from '../../../server/app-render/types'
// TypeScript trick to simulate opaque types, like in Flow.
type Opaque<K, T> = T & { __brand: K }
export type EncodedSegment = Opaque<'EncodedSegment', string>
export function encodeSegment(
segment: FlightRouterStateSegment
): EncodedSegment {
if (typeof segment === 'string') {
if (segment.startsWith(PAGE_SEGMENT_KEY)) {
// The Flight Router State type sometimes includes the search params in
// the page segment. However, the Segment Cache tracks this as a separate
// key. So, we strip the search params here, and then add them back when
// the cache entry is turned back into a FlightRouterState. This is an
// unfortunate consequence of the FlightRouteState being used both as a
// transport type and as a cache key; we'll address this once more of the
// Segment Cache implementation has settled.
// TODO: We should hoist the search params out of the FlightRouterState
// type entirely, This is our plan for dynamic route params, too.
return PAGE_SEGMENT_KEY as EncodedSegment
}
const safeName =
// TODO: FlightRouterState encodes Not Found routes as "/_not-found".
// But params typically don't include the leading slash. We should use
// a different encoding to avoid this special case.
segment === '/_not-found'
? '_not-found'
: encodeToFilesystemAndURLSafeString(segment)
// Since this is not a dynamic segment, it's fully encoded. It does not
// need to be "hydrated" with a param value.
return safeName as EncodedSegment
}
const name = segment[0]
const paramValue = segment[1]
const paramType = segment[2]
const safeName = encodeToFilesystemAndURLSafeString(name)
const safeValue = encodeToFilesystemAndURLSafeString(paramValue)
const encodedName = '$' + paramType + '$' + safeName + '$' + safeValue
return encodedName as EncodedSegment
}
export const ROOT_SEGMENT_KEY = ''
export function encodeChildSegmentKey(
// TODO: Make segment keys an opaque type, too?
parentSegmentKey: string,
parallelRouteKey: string,
segment: EncodedSegment
): string {
// Aside from being filesystem safe, segment keys are also designed so that
// each segment and parallel route creates its own subdirectory. Roughly in
// the same shape as the source app directory. This is mostly just for easier
// debugging (you can open up the build folder and navigate the output); if
// we wanted to do we could just use a flat structure.
// Omit the parallel route key for children, since this is the most
// common case. Saves some bytes (and it's what the app directory does).
const slotKey =
parallelRouteKey === 'children'
? segment
: `@${encodeToFilesystemAndURLSafeString(parallelRouteKey)}/${segment}`
return parentSegmentKey + '/' + slotKey
}
// Define a regex pattern to match the most common characters found in a route
// param. It excludes anything that might not be cross-platform filesystem
// compatible, like |. It does not need to be precise because the fallback is to
// just base64url-encode the whole parameter, which is fine; we just don't do it
// by default for compactness, and for easier debugging.
const simpleParamValueRegex = /^[a-zA-Z0-9\-_@]+$/
function encodeToFilesystemAndURLSafeString(value: string) {
if (simpleParamValueRegex.test(value)) {
return value
}
// If there are any unsafe characters, base64url-encode the entire value.
// We also add a ! prefix so it doesn't collide with the simple case.
const base64url = btoa(value)
.replace(/\+/g, '-') // Replace '+' with '-'
.replace(/\//g, '_') // Replace '/' with '_'
.replace(/=+$/, '') // Remove trailing '='
return '!' + base64url
}
export function convertSegmentPathToStaticExportFilename(
segmentPath: string
): string {
return `__next${segmentPath.replace(/\//g, '.')}.txt`
}
|