{auditLogEvents.map((event) => (
-
+
-
{event.action}
diff --git a/src/audit-logs/pages/audit-log-events.tsx b/src/audit-logs/pages/audit-log-events.tsx
index 27e84296aaf7..9389b6be21e0 100644
--- a/src/audit-logs/pages/audit-log-events.tsx
+++ b/src/audit-logs/pages/audit-log-events.tsx
@@ -1,4 +1,6 @@
import { GetServerSideProps } from 'next'
+import type { Response } from 'express'
+import type { ExtendedRequest } from '@/types'
import {
addUINamespaces,
@@ -60,8 +62,8 @@ export const getServerSideProps: GetServerSideProps = async (context) =>
const { getAutomatedPageMiniTocItems } = await import('@/frame/lib/get-mini-toc-items')
const { getCategorizedAuditLogEvents, getCategoryNotes } = await import('../lib')
- const req = context.req as object
- const res = context.res as object
+ const req = context.req as unknown as ExtendedRequest
+ const res = context.res as unknown as Response
const currentVersion = context.query.versionId as string
const url = context.req.url
diff --git a/src/frame/components/context/MainContext.tsx b/src/frame/components/context/MainContext.tsx
index 2316958598c0..9a48ac250781 100644
--- a/src/frame/components/context/MainContext.tsx
+++ b/src/frame/components/context/MainContext.tsx
@@ -1,9 +1,10 @@
import { createContext, useContext } from 'react'
import pick from 'lodash/pick'
+import type { Response } from 'express'
import type { BreadcrumbT } from '@/frame/components/page-header/Breadcrumbs'
import type { FeatureFlags } from '@/frame/components/hooks/useFeatureFlags'
-import type { SidebarLink } from '@/types'
+import type { ExtendedRequest, Permalink, SidebarLink } from '@/types'
export type ProductT = {
external: boolean
@@ -106,7 +107,7 @@ export type MainContextT = {
currentProduct?: ProductT
currentProductName: string
currentProductTree?: ProductTreeNode | null
- currentLayoutName?: string
+ currentLayoutName?: string | null
currentVersion?: string
data: DataT
enterpriseServerReleases: EnterpriseServerReleases
@@ -127,7 +128,7 @@ export type MainContextT = {
applicableVersions: string[]
docsTeamMetrics: string[] | null
} | null
- relativePath?: string
+ relativePath?: string | null
sidebarTree?: ProductTreeNode | null
status: number
xHost?: string
@@ -154,8 +155,8 @@ const DEFAULT_UI_NAMESPACES = [
'cookbook_landing',
]
-export function addUINamespaces(req: any, ui: UIStrings, namespaces: string[]) {
- const pool = req.context.site.data.ui
+export function addUINamespaces(req: ExtendedRequest, ui: UIStrings, namespaces: string[]) {
+ const pool = req.context!.site!.data.ui
for (const namespace of namespaces) {
if (!(namespace in pool)) {
throw new Error(
@@ -168,22 +169,26 @@ export function addUINamespaces(req: any, ui: UIStrings, namespaces: string[]) {
}
}
-export const getMainContext = async (req: any, res: any): Promise => {
+export const getMainContext = async (
+ req: ExtendedRequest,
+ res: Response,
+): Promise => {
+ const context = req.context!
// Our current translation process adds 'ms.*' frontmatter properties to files
// it translates including when data/ui.yml is translated. We don't use these
// properties and their syntax (e.g. 'ms.openlocfilehash',
// 'ms.sourcegitcommit', etc.) causes problems so just delete them.
- if (req.context.site.data.ui.ms) {
- delete req.context.site.data.ui.ms
+ if (context.site!.data.ui.ms) {
+ delete context.site!.data.ui.ms
}
- const { page } = req.context
+ const { page } = context
const documentType = page ? (page.documentType as string) : undefined
const ui: UIStrings = {}
addUINamespaces(req, ui, DEFAULT_UI_NAMESPACES)
- if (req.context.currentJourneyTrack?.trackId) {
+ if (context.currentJourneyTrack?.trackId) {
addUINamespaces(req, ui, ['journey_track_nav'])
}
@@ -197,26 +202,26 @@ export const getMainContext = async (req: any, res: any): Promise
// To know whether we need this key, we need to match this
// with the business logic in `DeprecationBanner.tsx` which is as follows:
if (
- req.context.enterpriseServerReleases.releasesWithOldestDeprecationDate.includes(
- req.context.currentRelease,
+ context.enterpriseServerReleases!.releasesWithOldestDeprecationDate.includes(
+ context.currentRelease as string,
)
) {
reusables.enterprise_deprecation = {
- version_was_deprecated: req.context.getDottedData(
+ version_was_deprecated: context.getDottedData!(
'reusables.enterprise_deprecation.version_was_deprecated',
- ),
- version_will_be_deprecated: req.context.getDottedData(
+ ) as string,
+ version_will_be_deprecated: context.getDottedData!(
'reusables.enterprise_deprecation.version_will_be_deprecated',
- ),
- deprecation_details: req.context.getDottedData(
+ ) as string,
+ deprecation_details: context.getDottedData!(
'reusables.enterprise_deprecation.deprecation_details',
- ),
+ ) as string,
}
}
// This is a number, like 3.13 or it's possibly null if there is no
// supported release candidate at the moment.
- const { releaseCandidate } = req.context.enterpriseServerReleases
+ const { releaseCandidate } = context.enterpriseServerReleases!
// Combine the version number with the prefix so it can appear
// as a full version string if the release candidate is set.
const releaseCandidateVersion = releaseCandidate ? `enterprise-server@${releaseCandidate}` : null
@@ -224,38 +229,38 @@ export const getMainContext = async (req: any, res: any): Promise
const pageInfo =
(page && {
documentType,
- contentType: req.context.page.contentType || null,
- title: req.context.page.title,
- fullTitle: req.context.page.fullTitle || null,
- introPlainText: req.context.page?.introPlainText || null,
- applicableVersions: req.context.page?.permalinks.map((obj: any) => obj.pageVersion) || [],
- hidden: req.context.page.hidden || false,
- noEarlyAccessBanner: req.context.page.noEarlyAccessBanner || false,
- docsTeamMetrics: req.context.page.docsTeamMetrics || null,
+ contentType: page.contentType || null,
+ title: page.title,
+ fullTitle: page.fullTitle || null,
+ introPlainText: page.introPlainText || null,
+ applicableVersions: page.permalinks.map((obj: Permalink) => obj.pageVersion),
+ hidden: page.hidden || false,
+ noEarlyAccessBanner: page.noEarlyAccessBanner || false,
+ docsTeamMetrics: page.docsTeamMetrics || null,
}) ||
null
- const currentProduct: ProductT = req.context.productMap[req.context.currentProduct] || null
- const currentProductName: string = req.context.currentProductName || ''
+ const currentProduct = (context.productMap?.[context.currentProduct || ''] || null) as ProductT
+ const currentProductName: string = context.currentProductName || ''
const props: MainContextT = {
- allVersions: minimalAllVersions(req.context.allVersions),
- breadcrumbs: req.context.breadcrumbs || {},
- communityRedirect: req.context.page?.communityRedirect || {},
- currentCategory: req.context.currentCategory || '',
- currentLayoutName: req.context.currentLayoutName || null,
- currentPathWithoutLanguage: req.context.currentPathWithoutLanguage,
+ allVersions: minimalAllVersions(context.allVersions!),
+ breadcrumbs: (context.breadcrumbs || {}) as MainContextT['breadcrumbs'],
+ communityRedirect: (context.page?.communityRedirect || {}) as MainContextT['communityRedirect'],
+ currentCategory: context.currentCategory || '',
+ currentLayoutName: context.currentLayoutName || null,
+ currentPathWithoutLanguage: context.currentPathWithoutLanguage!,
currentProduct,
currentProductName,
- // This is a slimmed down version of `req.context.currentProductTree`
+ // This is a slimmed down version of `context.currentProductTree`
// that only has the minimal titles stuff needed for sidebars and
// any page that is hidden is omitted.
// However, it's not needed on most pages. For example, on article pages,
// you don't need it. It's similar to the minimal product tree but,
// has the full length titles and not just the short titles.
currentProductTree:
- (includeFullProductTree && req.context.currentProductTreeTitlesExcludeHidden) || null,
- currentVersion: req.context.currentVersion,
+ (includeFullProductTree && context.currentProductTreeTitlesExcludeHidden) || null,
+ currentVersion: context.currentVersion,
data: {
ui,
reusables,
@@ -265,24 +270,24 @@ export const getMainContext = async (req: any, res: any): Promise
},
},
},
- enterpriseServerReleases: pick(req.context.enterpriseServerReleases, [
+ enterpriseServerReleases: pick(context.enterpriseServerReleases!, [
'isOldestReleaseDeprecated',
'oldestSupported',
'nextDeprecationDate',
'supported',
'releasesWithOldestDeprecationDate',
- ]),
- enterpriseServerVersions: req.context.enterpriseServerVersions,
- error: req.context.error ? req.context.error.toString() : '',
+ ]) as EnterpriseServerReleases,
+ enterpriseServerVersions: context.enterpriseServerVersions!,
+ error: context.error ? context.error.toString() : '',
featureFlags: {},
fullUrl: `${req.protocol}://${req.hostname}${req.originalUrl}`, // does not include port for localhost
- isHomepageVersion: req.context.page?.documentType === 'homepage',
- nonEnterpriseDefaultVersion: req.context.nonEnterpriseDefaultVersion,
- page: pageInfo,
- relativePath: req.context.page?.relativePath || null,
+ isHomepageVersion: context.page?.documentType === 'homepage',
+ nonEnterpriseDefaultVersion: context.nonEnterpriseDefaultVersion!,
+ page: pageInfo as MainContextT['page'],
+ relativePath: context.page?.relativePath || null,
// The minimal product tree is needed on all pages that depend on
// the product sidebar or the rest sidebar.
- sidebarTree: (includeSidebarTree && req.context.sidebarTree) || null,
+ sidebarTree: (includeSidebarTree && context.sidebarTree) || null,
status: res.statusCode,
xHost: req.get('x-host') || '',
}
diff --git a/src/github-apps/pages/endpoints-available-for-fine-grained-personal-access-tokens.tsx b/src/github-apps/pages/endpoints-available-for-fine-grained-personal-access-tokens.tsx
index 4ed5f5886956..f277786d7c0c 100644
--- a/src/github-apps/pages/endpoints-available-for-fine-grained-personal-access-tokens.tsx
+++ b/src/github-apps/pages/endpoints-available-for-fine-grained-personal-access-tokens.tsx
@@ -1,4 +1,6 @@
import { GetServerSideProps } from 'next'
+import type { Response } from 'express'
+import type { ExtendedRequest } from '@/types'
import {
AutomatedPageContextT,
@@ -41,7 +43,10 @@ export const getServerSideProps: GetServerSideProps = async (context) =>
return {
props: {
- mainContext: await getMainContext(context.req, context.res),
+ mainContext: await getMainContext(
+ context.req as unknown as ExtendedRequest,
+ context.res as unknown as Response,
+ ),
currentVersion,
appsItems: appsItems as EnabledListT,
automatedPageContext: getAutomatedPageContextFromRequest(context.req),
diff --git a/src/github-apps/pages/endpoints-available-for-github-app-installation-access-tokens.tsx b/src/github-apps/pages/endpoints-available-for-github-app-installation-access-tokens.tsx
index 3ac0fccc0f76..61cc5c8a9598 100644
--- a/src/github-apps/pages/endpoints-available-for-github-app-installation-access-tokens.tsx
+++ b/src/github-apps/pages/endpoints-available-for-github-app-installation-access-tokens.tsx
@@ -1,4 +1,6 @@
import { GetServerSideProps } from 'next'
+import type { Response } from 'express'
+import type { ExtendedRequest } from '@/types'
import {
AutomatedPageContextT,
@@ -41,7 +43,10 @@ export const getServerSideProps: GetServerSideProps = async (context) =>
return {
props: {
- mainContext: await getMainContext(context.req, context.res),
+ mainContext: await getMainContext(
+ context.req as unknown as ExtendedRequest,
+ context.res as unknown as Response,
+ ),
currentVersion,
appsItems: appsItems as EnabledListT,
automatedPageContext: getAutomatedPageContextFromRequest(context.req),
diff --git a/src/github-apps/pages/endpoints-available-for-github-app-user-access-tokens.tsx b/src/github-apps/pages/endpoints-available-for-github-app-user-access-tokens.tsx
index 4f45615698b8..3d49f73c7af8 100644
--- a/src/github-apps/pages/endpoints-available-for-github-app-user-access-tokens.tsx
+++ b/src/github-apps/pages/endpoints-available-for-github-app-user-access-tokens.tsx
@@ -1,4 +1,6 @@
import { GetServerSideProps } from 'next'
+import type { Response } from 'express'
+import type { ExtendedRequest } from '@/types'
import {
AutomatedPageContextT,
@@ -41,7 +43,10 @@ export const getServerSideProps: GetServerSideProps = async (context) =>
return {
props: {
- mainContext: await getMainContext(context.req, context.res),
+ mainContext: await getMainContext(
+ context.req as unknown as ExtendedRequest,
+ context.res as unknown as Response,
+ ),
currentVersion,
appsItems: appsItems as EnabledListT,
automatedPageContext: getAutomatedPageContextFromRequest(context.req),
diff --git a/src/github-apps/pages/permissions-required-for-fine-grained-personal-access-tokens.tsx b/src/github-apps/pages/permissions-required-for-fine-grained-personal-access-tokens.tsx
index cd84db30b503..8e512ba6eb1b 100644
--- a/src/github-apps/pages/permissions-required-for-fine-grained-personal-access-tokens.tsx
+++ b/src/github-apps/pages/permissions-required-for-fine-grained-personal-access-tokens.tsx
@@ -1,4 +1,6 @@
import { GetServerSideProps } from 'next'
+import type { Response } from 'express'
+import type { ExtendedRequest } from '@/types'
import {
AutomatedPageContextT,
@@ -42,7 +44,10 @@ export const getServerSideProps: GetServerSideProps = async (context) =>
return {
props: {
- mainContext: await getMainContext(context.req, context.res),
+ mainContext: await getMainContext(
+ context.req as unknown as ExtendedRequest,
+ context.res as unknown as Response,
+ ),
currentVersion,
appsItems: appsItems as PermissionListT,
automatedPageContext: getAutomatedPageContextFromRequest(context.req),
diff --git a/src/github-apps/pages/permissions-required-for-github-apps.tsx b/src/github-apps/pages/permissions-required-for-github-apps.tsx
index 583a234b7a5a..14de389c3c52 100644
--- a/src/github-apps/pages/permissions-required-for-github-apps.tsx
+++ b/src/github-apps/pages/permissions-required-for-github-apps.tsx
@@ -1,4 +1,6 @@
import { GetServerSideProps } from 'next'
+import type { Response } from 'express'
+import type { ExtendedRequest } from '@/types'
import {
AutomatedPageContextT,
getAutomatedPageContextFromRequest,
@@ -42,7 +44,10 @@ export const getServerSideProps: GetServerSideProps = async (context) =>
return {
props: {
- mainContext: await getMainContext(context.req, context.res),
+ mainContext: await getMainContext(
+ context.req as unknown as ExtendedRequest,
+ context.res as unknown as Response,
+ ),
currentVersion,
appsItems: appsItems as PermissionListT,
automatedPageContext: getAutomatedPageContextFromRequest(context.req),
diff --git a/src/graphql/pages/breaking-changes.tsx b/src/graphql/pages/breaking-changes.tsx
index 1224d0e54e75..b39033517190 100644
--- a/src/graphql/pages/breaking-changes.tsx
+++ b/src/graphql/pages/breaking-changes.tsx
@@ -1,4 +1,5 @@
import { GetServerSideProps } from 'next'
+import type { Response } from 'express'
import GithubSlugger from 'github-slugger'
import type { ExtendedRequest } from '@/types'
import type { ServerResponse } from 'http'
@@ -73,7 +74,7 @@ export const getServerSideProps: GetServerSideProps = async (context) =>
return {
props: {
- mainContext: await getMainContext(req, res),
+ mainContext: await getMainContext(req, res as unknown as Response),
automatedPageContext,
schema,
headings,
diff --git a/src/graphql/pages/changelog-year.tsx b/src/graphql/pages/changelog-year.tsx
index 79df6419c61b..99474ccf759d 100644
--- a/src/graphql/pages/changelog-year.tsx
+++ b/src/graphql/pages/changelog-year.tsx
@@ -1,4 +1,5 @@
import { GetServerSideProps } from 'next'
+import type { Response } from 'express'
import type { ExtendedRequest } from '@/types'
import type { ServerResponse } from 'http'
@@ -64,7 +65,7 @@ export const getServerSideProps: GetServerSideProps = async (context) =>
return {
props: {
- mainContext: await getMainContext(req, res),
+ mainContext: await getMainContext(req, res as unknown as Response),
automatedPageContext,
schema,
years,
diff --git a/src/graphql/pages/changelog.tsx b/src/graphql/pages/changelog.tsx
index 46bc884988a1..1aee0f1921bd 100644
--- a/src/graphql/pages/changelog.tsx
+++ b/src/graphql/pages/changelog.tsx
@@ -1,4 +1,5 @@
import { GetServerSideProps } from 'next'
+import type { Response } from 'express'
import type { ExtendedRequest } from '@/types'
import type { ServerResponse } from 'http'
@@ -59,7 +60,7 @@ export const getServerSideProps: GetServerSideProps = async (context) =>
return {
props: {
- mainContext: await getMainContext(req, res),
+ mainContext: await getMainContext(req, res as unknown as Response),
automatedPageContext,
schema,
years,
diff --git a/src/graphql/pages/reference.tsx b/src/graphql/pages/reference.tsx
index 1b8185a91fa6..bef78e785891 100644
--- a/src/graphql/pages/reference.tsx
+++ b/src/graphql/pages/reference.tsx
@@ -1,4 +1,5 @@
import { GetServerSideProps } from 'next'
+import type { Response } from 'express'
import { GraphqlCategoryPage, type CategorySchema } from '@/graphql/components/GraphqlCategoryPage'
import {
@@ -114,7 +115,7 @@ export const getServerSideProps: GetServerSideProps = async (context) =>
})
}
- const mainContext = await getMainContext(req, res)
+ const mainContext = await getMainContext(req, res as unknown as Response)
addUINamespaces(req, mainContext.data.ui, ['graphql'])
return {
diff --git a/src/graphql/pages/schema-previews.tsx b/src/graphql/pages/schema-previews.tsx
index 5a1ac1beb260..f2eda650a55f 100644
--- a/src/graphql/pages/schema-previews.tsx
+++ b/src/graphql/pages/schema-previews.tsx
@@ -1,4 +1,5 @@
import { GetServerSideProps } from 'next'
+import type { Response } from 'express'
import type { ExtendedRequest } from '@/types'
import type { ServerResponse } from 'http'
@@ -53,7 +54,7 @@ export const getServerSideProps: GetServerSideProps = async (context) =>
// Update the existing context to include the miniTocItems from GraphQL
automatedPageContext.miniTocItems.push(...changelogMiniTocItems)
- const mainContext = await getMainContext(req, res)
+ const mainContext = await getMainContext(req, res as unknown as Response)
addUINamespaces(req, mainContext.data.ui, ['graphql'])
return {
diff --git a/src/languages/scripts/purge-fastly-edge-cache-per-language.ts b/src/languages/scripts/purge-fastly-edge-cache-per-language.ts
deleted file mode 100644
index 8f68c02a6403..000000000000
--- a/src/languages/scripts/purge-fastly-edge-cache-per-language.ts
+++ /dev/null
@@ -1,131 +0,0 @@
-import { languageKeys } from '@/languages/lib/languages-server'
-
-import { makeLanguageSurrogateKey } from '@/frame/middleware/set-fastly-surrogate-key'
-import purgeEdgeCache from '@/workflows/purge-edge-cache'
-
-/**
- * In simple terms, this script sends purge commands for...
- *
- * 1. no-language
- * 2. 'en'
- * 3. 'ja'
- * 4. 'pt'
- * ...
- *
- * ...and so on for all languages.
- *
- * Each surrogate key is purged twice because of Fastly shielding: the first
- * purge clears the edge nodes and the second clears the origin shield.
- *
- * Two delays shape the schedule:
- *
- * - To avoid a stampeding herd after each purge, and to avoid unnecessary load
- * on the backend, there's a slight delay between each language's FIRST purge.
- * This gives the backend a chance to finish processing all the now stale URLs,
- * for that language, before tackling the next.
- * - The SECOND purge of a key happens a while after its first purge, long enough
- * for the now-stale content to be re-fetched and re-shielded before we clear
- * the shield again. Fastly's docs recommend ~2s for surrogate-key purges, but
- * in practice that's been too short and stale content survives the shielding
- * race, so we use a larger margin. See the "Race conditions" subsection of
- * https://www.fastly.com/documentation/guides/concepts/cache/purging#race-conditions
- * (the 30s figure there is for purge-all, which we don't use). The value must
- * stay a multiple of DELAY_BETWEEN_LANGUAGES to keep the slot alignment below.
- *
- * Rather than block on the second purge (which would serialize everything and
- * make the whole run take `DELAY_BEFORE_SECOND_PURGE` per key), we schedule all
- * purges against a wall-clock timeline up front. Because the second-purge delay
- * is a multiple of the between-languages delay, a key's second purge lands on
- * the same slot as a later key's first purge. For example, with a 10s cadence
- * and a 20s second-purge delay:
- *
- * t=0 no-language (1st)
- * t=10 en (1st)
- * t=20 es (1st) + no-language (2nd)
- * t=30 ja (1st) + en (2nd)
- * t=40 pt (1st) + es (2nd)
- * ...
- */
-const DELAY_BETWEEN_LANGUAGES = 10 * 1000
-const DELAY_BEFORE_SECOND_PURGE = 20 * 1000
-
-// The pipelining only lines up if the second-purge delay is a whole number of
-// language slots; otherwise second purges would drift off the cadence. Enforce
-// it so a future tweak to either constant can't silently break the schedule.
-if (DELAY_BEFORE_SECOND_PURGE % DELAY_BETWEEN_LANGUAGES !== 0) {
- throw new Error(
- `DELAY_BEFORE_SECOND_PURGE (${DELAY_BEFORE_SECOND_PURGE}ms) must be a multiple of ` +
- `DELAY_BETWEEN_LANGUAGES (${DELAY_BETWEEN_LANGUAGES}ms) to keep second purges ` +
- `aligned with later first-purge slots`,
- )
-}
-
-const sleep = (ms: number): Promise => new Promise((resolve) => setTimeout(resolve, ms))
-
-type PurgePhase = 'first' | 'second'
-type PurgeOutcome = { key: string; phase: PurgePhase; error?: unknown }
-
-const languages = process.env.LANGUAGES
- ? languagesFromString(process.env.LANGUAGES)
- : // Make sure `en` is first because contributors write mostly in English
- // and they're most likely wanting to see their landed changes appear
- // in production as soon as possible.
- languageKeys.sort((a) => (a === 'en' ? -1 : 1))
-
-// This covers things like `/api/webhooks` which isn't language specific, hence
-// the no-language key (an empty `makeLanguageSurrogateKey()`) leading the list.
-const surrogateKeys = [
- makeLanguageSurrogateKey(),
- ...languages.map((language) => makeLanguageSurrogateKey(language)),
-]
-
-// Schedule every purge against a single wall-clock start time so the cadence
-// doesn't drift with per-purge network latency, and so each second purge aligns
-// with a later first purge as described above.
-const startTime = Date.now()
-const purges: Promise[] = []
-
-// Each call returns a promise that resolves (never rejects) to an outcome: the
-// internal try/catch means a failed purge can't become an unhandled rejection
-// while we wait for the rest of the schedule, which can outlast an early second
-// purge. Failures are surfaced after all purges settle, below.
-async function runPurge(key: string, phase: PurgePhase, targetTime: number): Promise {
- await sleep(Math.max(0, targetTime - Date.now()))
- try {
- // `purgeEdgeCache` logs its own "Attempting Fastly purge..." line; word this
- // as the scheduled phase trigger so the two purges of a key are distinguishable.
- console.log(`Triggering ${phase}-phase purge for '${key}'...`)
- await purgeEdgeCache(key)
- return { key, phase }
- } catch (error) {
- return { key, phase, error }
- }
-}
-
-for (const [index, key] of surrogateKeys.entries()) {
- const slotStart = startTime + index * DELAY_BETWEEN_LANGUAGES
- purges.push(runPurge(key, 'first', slotStart))
- purges.push(runPurge(key, 'second', slotStart + DELAY_BEFORE_SECOND_PURGE))
-}
-
-const outcomes = await Promise.all(purges)
-const failures = outcomes.filter((outcome) => outcome.error)
-if (failures.length) {
- for (const failure of failures) {
- console.error(`Fastly ${failure.phase} purge failed for '${failure.key}':`, failure.error)
- }
- throw new Error(`${failures.length} Fastly purge(s) failed`)
-}
-
-function languagesFromString(str: string): string[] {
- const parsedLanguages = str
- .split(/,/)
- .map((x) => x.trim())
- .filter(Boolean)
- if (!parsedLanguages.every((lang) => languageKeys.includes(lang))) {
- throw new Error(
- `Unrecognized language code (${parsedLanguages.find((lang) => !languageKeys.includes(lang))})`,
- )
- }
- return parsedLanguages
-}
diff --git a/src/rest/pages/category.tsx b/src/rest/pages/category.tsx
index fc8912b5cd1f..652d82c86342 100644
--- a/src/rest/pages/category.tsx
+++ b/src/rest/pages/category.tsx
@@ -1,4 +1,5 @@
import { GetServerSideProps } from 'next'
+import type { Response } from 'express'
import type { ServerResponse } from 'http'
import { Operation } from '@/rest/components/types'
import type { ExtendedRequest, AllVersions } from '@/types/types'
@@ -207,7 +208,7 @@ export const getServerSideProps: GetServerSideProps = async (context) =>
// created.
tocLandingContext.tocItems = restCategoryTocItems
- const mainContext = await getMainContext(req, res)
+ const mainContext = await getMainContext(req, res as unknown as Response)
return {
props: {
diff --git a/src/rest/pages/subcategory.tsx b/src/rest/pages/subcategory.tsx
index b53d1d03f055..773ae3913861 100644
--- a/src/rest/pages/subcategory.tsx
+++ b/src/rest/pages/subcategory.tsx
@@ -1,4 +1,5 @@
import { GetServerSideProps } from 'next'
+import type { Response } from 'express'
import type { ServerResponse } from 'http'
import { Operation } from '@/rest/components/types'
import type { ExtendedRequest, AllVersions } from '@/types/types'
@@ -87,7 +88,7 @@ export const getServerSideProps: GetServerSideProps = async (context) =>
}
}
- const mainContext = await getMainContext(req, res)
+ const mainContext = await getMainContext(req, res as unknown as Response)
addUINamespaces(req, mainContext.data.ui, ['parameter_table', 'rest_reference'])
return {
diff --git a/src/secret-scanning/pages/supported-secret-scanning-patterns.tsx b/src/secret-scanning/pages/supported-secret-scanning-patterns.tsx
index 152c7bbcd4d5..7307840715cc 100644
--- a/src/secret-scanning/pages/supported-secret-scanning-patterns.tsx
+++ b/src/secret-scanning/pages/supported-secret-scanning-patterns.tsx
@@ -1,4 +1,5 @@
import { GetServerSideProps } from 'next'
+import type { Response } from 'express'
import {
getMainContext,
@@ -37,7 +38,7 @@ export default function SupportedSecretScanningPatterns({
export const getServerSideProps: GetServerSideProps = async (context) => {
const req = context.req as unknown as ExtendedRequest
- const res = context.res as object
+ const res = context.res as unknown as Response
const mainContext = await getMainContext(req, res)
addUINamespaces(req, mainContext.data.ui, ['secret_scanning'])
const automatedPageContext = getAutomatedPageContextFromRequest(req)
diff --git a/src/types/types.ts b/src/types/types.ts
index 53a1d508457f..d1472f619b8c 100644
--- a/src/types/types.ts
+++ b/src/types/types.ts
@@ -4,6 +4,7 @@ import type { Failbot } from '@github/failbot'
import type enterpriseServerReleases from '@/versions/lib/enterprise-server-releases.d'
import type { ValidOcticon } from '@/landings/types'
import type { Language, Languages } from '@/languages/lib/languages-server'
+import type { JourneyContext } from '@/journeys/lib/journey-path-resolver'
import type { MiniTocItem } from '@/frame/lib/get-mini-toc-items'
import type { UIStrings } from '@/frame/components/context/MainContext'
@@ -119,6 +120,7 @@ export type Context = {
// Allows dynamic properties like features & version shortnames as keys
[key: string]: unknown
currentCategory?: string
+ currentJourneyTrack?: JourneyContext | null
error?: Error
siteTree?: SiteTree
pages?: Record
@@ -341,6 +343,12 @@ export type Page = {
contentType?: string
docsTeamMetrics?: string[]
children?: string[]
+ introPlainText?: string
+ noEarlyAccessBanner?: boolean
+ communityRedirect?: {
+ name: string
+ href: string
+ }
}
export type SidebarLink = {
diff --git a/src/versions/lib/enterprise-server-releases.d.ts b/src/versions/lib/enterprise-server-releases.d.ts
index cab010afad08..e7405ea5b3a8 100644
--- a/src/versions/lib/enterprise-server-releases.d.ts
+++ b/src/versions/lib/enterprise-server-releases.d.ts
@@ -81,6 +81,7 @@ const allExports = {
dates,
nextDeprecationDate,
isOldestReleaseDeprecated,
+ releasesWithOldestDeprecationDate,
deprecatedOnNewSite,
deprecatedReleasesWithLegacyFormat,
deprecatedReleasesWithNewFormat,
diff --git a/src/webhooks/pages/webhook-events-and-payloads.tsx b/src/webhooks/pages/webhook-events-and-payloads.tsx
index 479dee096a8d..6c9cec91bbe9 100644
--- a/src/webhooks/pages/webhook-events-and-payloads.tsx
+++ b/src/webhooks/pages/webhook-events-and-payloads.tsx
@@ -1,4 +1,6 @@
import { GetServerSideProps } from 'next'
+import type { Response } from 'express'
+import type { ExtendedRequest } from '@/types'
import { useRouter } from 'next/router'
import { useEffect } from 'react'
@@ -78,8 +80,8 @@ export const getServerSideProps: GetServerSideProps = async (context) =>
const { getInitialPageWebhooks } = await import('@/webhooks/lib')
const { getAutomatedPageMiniTocItems } = await import('@/frame/lib/get-mini-toc-items')
- const req = context.req as object
- const res = context.res as object
+ const req = context.req as unknown as ExtendedRequest
+ const res = context.res as unknown as Response
const currentVersion = context.query.versionId as string
const mainContext = await getMainContext(req, res)
addUINamespaces(req, mainContext.data.ui, ['parameter_table', 'webhooks'])
diff --git a/src/workflows/README.md b/src/workflows/README.md
index e0c1c0e2d306..dd726a0ff986 100644
--- a/src/workflows/README.md
+++ b/src/workflows/README.md
@@ -26,7 +26,7 @@ Scripts are registered in `package.json`:
| check-content-type | `npm run check-content-type` | Validates content types |
| delete-orphan-translation-files | `npm run delete-orphan-translation-files` | Removes orphaned translations |
| enable-automerge | `npm run enable-automerge` | Enables PR automerge |
-| purge-fastly-edge-cache | `npm run purge-fastly-edge-cache` | Purges Fastly CDN cache |
+| purge-fastly | `npm run purge-fastly` | Purges Fastly CDN cache (per-language, single-key, or entire cache) |
| prevent-pushes-to-main | (Husky hook) | Prevents pushing to main |
### Running tests
diff --git a/src/workflows/purge-edge-cache.ts b/src/workflows/purge-edge-cache.ts
deleted file mode 100644
index 4546ceaee4fb..000000000000
--- a/src/workflows/purge-edge-cache.ts
+++ /dev/null
@@ -1,62 +0,0 @@
-import { fetchWithRetry } from '@/frame/lib/fetch-utils'
-
-async function purgeFastlyBySurrogateKey({
- apiToken,
- serviceId,
- surrogateKey,
-}: {
- apiToken: string
- serviceId: string
- surrogateKey: string
-}) {
- const safeServiceId = encodeURIComponent(serviceId)
- const safeSurrogateKey = encodeURIComponent(surrogateKey)
-
- const headers = {
- 'fastly-key': apiToken,
- accept: 'application/json',
- 'fastly-soft-purge': '1',
- }
- const requestPath = `https://api.fastly.com/service/${safeServiceId}/purge/${safeSurrogateKey}`
- const response = await fetchWithRetry(
- requestPath,
- {
- method: 'POST',
- headers: {
- ...headers,
- 'Content-Type': 'application/json',
- },
- },
- {
- retries: 0,
- timeout: 30_000,
- throwHttpErrors: false,
- },
- )
- if (!response.ok) {
- throw new Error(`HTTP ${response.status}: ${response.statusText}`)
- }
- return response
-}
-
-export default async function purgeEdgeCache(surrogateKey: string | undefined) {
- if (!surrogateKey) {
- throw new Error('No key set and/or no FASTLY_SURROGATE_KEY env var set')
- }
- console.log(`Fastly purgeEdgeCache initialized for: '${surrogateKey}'`)
-
- const { FASTLY_TOKEN, FASTLY_SERVICE_ID } = process.env
- if (!FASTLY_TOKEN || !FASTLY_SERVICE_ID) {
- throw new Error('Fastly env vars not detected; skipping purgeEdgeCache step')
- }
-
- const purgingParams = {
- apiToken: FASTLY_TOKEN,
- serviceId: FASTLY_SERVICE_ID,
- surrogateKey,
- }
-
- console.log('Attempting Fastly purge...')
- const result = await purgeFastlyBySurrogateKey(purgingParams)
- console.log('Fastly purge result:', result.status)
-}
diff --git a/src/workflows/purge-fastly-all.ts b/src/workflows/purge-fastly-all.ts
deleted file mode 100644
index 2d94ec0b0694..000000000000
--- a/src/workflows/purge-fastly-all.ts
+++ /dev/null
@@ -1,59 +0,0 @@
-import { fetchWithRetry } from '@/frame/lib/fetch-utils'
-
-// Purges the ENTIRE Fastly cache for the docs service via Fastly's purge_all
-// endpoint. This is the workflow equivalent of the "Purge all" button in the
-// Fastly UI. It is intentionally a separate, manually triggered entry point:
-// routine post-deploy purging is handled by
-// `purge-fastly-edge-cache-per-language.ts`, and a gentler "refresh everything"
-// can be done by running the Purge Fastly workflow with an empty languages
-// input (a soft surrogate-key purge of every language).
-//
-// NOTE: Fastly's purge_all is always a HARD purge. The `fastly-soft-purge`
-// header has no effect on this endpoint, so every object is evicted immediately
-// and origin sees a traffic spike while the cache refills. Only reach for this
-// when a targeted purge will not do.
-// https://www.fastly.com/documentation/reference/api/purging/
-
-async function purgeFastlyAll({ apiToken, serviceId }: { apiToken: string; serviceId: string }) {
- const safeServiceId = encodeURIComponent(serviceId)
- const requestPath = `https://api.fastly.com/service/${safeServiceId}/purge_all`
- const response = await fetchWithRetry(
- requestPath,
- {
- method: 'POST',
- headers: {
- 'fastly-key': apiToken,
- accept: 'application/json',
- 'Content-Type': 'application/json',
- },
- },
- {
- retries: 0,
- timeout: 30_000,
- throwHttpErrors: false,
- },
- )
- if (!response.ok) {
- // Fastly puts permission/feature-disabled details in the response body,
- // which is often the only actionable signal, so surface it best-effort.
- let body = ''
- try {
- body = await response.text()
- } catch {
- body = ''
- }
- throw new Error(
- `Fastly purge_all failed: HTTP ${response.status} ${response.statusText}${body ? `: ${body}` : ''}`,
- )
- }
- return response
-}
-
-const { FASTLY_TOKEN, FASTLY_SERVICE_ID } = process.env
-if (!FASTLY_TOKEN || !FASTLY_SERVICE_ID) {
- throw new Error('Fastly env vars not detected; refusing to run purge_all')
-}
-
-console.log('Attempting Fastly purge_all (hard purge of the entire cache)...')
-const result = await purgeFastlyAll({ apiToken: FASTLY_TOKEN, serviceId: FASTLY_SERVICE_ID })
-console.log('Fastly purge_all result:', result.status)
diff --git a/src/workflows/purge-fastly-edge-cache.ts b/src/workflows/purge-fastly-edge-cache.ts
deleted file mode 100755
index 54637b0cd163..000000000000
--- a/src/workflows/purge-fastly-edge-cache.ts
+++ /dev/null
@@ -1,28 +0,0 @@
-import purgeEdgeCache from './purge-edge-cache'
-
-// This will purge every response that *contains*
-// `process.env.FASTLY_SURROGATE_KEY`.
-// We send Surrogate-Key values like:
-//
-// language:en
-// language:fr
-// language:ja
-// or
-// no-language
-//
-// `purgeEdgeCache` throws if no key is set, so a `FASTLY_SURROGATE_KEY` must be
-// provided. This is the manual/targeted purge entry point; routine per-deploy
-// purging is handled by `purge-fastly-edge-cache-per-language.ts`.
-//
-// Because we use Fastly shielding, a single surrogate-key purge can lose a race
-// with the shield re-fetching stale content, so we purge twice: the first purge
-// clears the edge nodes and the second clears the origin shield. Fastly
-// recommends ~2s between surrogate-key purges. See
-// https://developer.fastly.com/learning/concepts/purging/#shielding
-const DELAY_BETWEEN_PURGES = 2 * 1000
-const sleep = (ms: number): Promise => new Promise((resolve) => setTimeout(resolve, ms))
-
-const surrogateKey = process.env.FASTLY_SURROGATE_KEY
-await purgeEdgeCache(surrogateKey)
-await sleep(DELAY_BETWEEN_PURGES)
-await purgeEdgeCache(surrogateKey)
diff --git a/src/workflows/purge-fastly.ts b/src/workflows/purge-fastly.ts
new file mode 100644
index 000000000000..09d2c320827e
--- /dev/null
+++ b/src/workflows/purge-fastly.ts
@@ -0,0 +1,297 @@
+import { execFileSync } from 'node:child_process'
+
+import { program } from 'commander'
+
+import { fetchWithRetry } from '@/frame/lib/fetch-utils'
+import { languageKeys } from '@/languages/lib/languages-server'
+import { makeLanguageSurrogateKey } from '@/frame/middleware/set-fastly-surrogate-key'
+
+// Single entry point for purging Fastly. It runs in one of three modes:
+//
+// - --everything -> hard purge the ENTIRE cache via `purge_all`.
+// - --surrogate-key -> double-purge that one surrogate key. Search uses
+// this for `api-search:`.
+// - otherwise -> double-purge `no-language` + each `language:`
+// key, the routine post-deploy / manual purge.
+//
+// --wait-for-build polls production until it serves this commit before purging,
+// so an automatic post-deploy purge doesn't revalidate against a still-rolling-
+// out instance. --hard forces a hard purge; --everything ignores it and is
+// always hard.
+
+const { FASTLY_TOKEN, FASTLY_SERVICE_ID } = process.env
+
+const DELAY_BETWEEN_KEYS = 10 * 1000
+const DELAY_BEFORE_SECOND_PURGE = 20 * 1000
+
+const BUILD_WAIT_REQUIRED_MATCHES = 5
+const BUILD_WAIT_INTERVAL = 15 * 1000
+const BUILD_WAIT_TIMEOUT = 1200 * 1000
+
+// The pipelining in purgeKeys only lines up if the second-purge delay is a whole
+// number of key slots; otherwise second purges would drift off the cadence.
+// Enforce it so a future tweak to either constant can't silently break it.
+if (DELAY_BEFORE_SECOND_PURGE % DELAY_BETWEEN_KEYS !== 0) {
+ throw new Error(
+ `DELAY_BEFORE_SECOND_PURGE (${DELAY_BEFORE_SECOND_PURGE}ms) must be a multiple of ` +
+ `DELAY_BETWEEN_KEYS (${DELAY_BETWEEN_KEYS}ms) to keep second purges ` +
+ `aligned with later first-purge slots`,
+ )
+}
+
+const sleep = (ms: number): Promise => new Promise((resolve) => setTimeout(resolve, ms))
+
+program
+ .description(
+ 'Purges Fastly after a deploy and on demand. Soft purge by default; can hard ' +
+ 'purge specific languages, or hard purge the entire cache.',
+ )
+ .option('--wait-for-build', 'Wait until production serves the current commit before purging')
+ .option(
+ '--languages ',
+ "Comma separated languages to purge, e.g. 'en,es,ja'. Blank/omitted = all languages.",
+ )
+ .option('--surrogate-key ', 'Purge a single explicit surrogate key. e.g. api-search:en')
+ .option('--hard', 'Evict immediately instead of the default soft purge')
+ .option('--everything', 'Hard purge the ENTIRE cache: every key. Ignores --languages/--hard.')
+ .parse(process.argv)
+
+type Options = {
+ waitForBuild?: boolean
+ languages?: string
+ surrogateKey?: string
+ hard?: boolean
+ everything?: boolean
+}
+
+await main(program.opts())
+
+async function main(options: Options) {
+ if (!FASTLY_TOKEN) {
+ throw new Error('FASTLY_TOKEN not detected; refusing to purge')
+ }
+ if (!FASTLY_SERVICE_ID) {
+ throw new Error('FASTLY_SERVICE_ID not detected; refusing to purge')
+ }
+
+ if (options.waitForBuild) {
+ await waitForBuild()
+ }
+
+ if (options.everything) {
+ // NOTE: Fastly's purge_all is always a HARD purge. The `fastly-soft-purge`
+ // header has no effect here, so every object is evicted immediately and
+ // origin sees a traffic spike while the cache refills. It clears every
+ // surrogate key: content, no-language, manual-purge assets, search, and so
+ // on. A targeted surrogate-key purge cannot reach those, so only reach for
+ // this when a targeted purge will not do.
+ // https://www.fastly.com/documentation/reference/api/purging/
+ console.log('Attempting hard purge of the entire cache...')
+ const result = await fastlyPurge('purge_all')
+ console.log('Fastly purge_all result:', result.status)
+ return
+ }
+
+ const soft = !options.hard
+ const surrogateKeys = options.surrogateKey
+ ? [options.surrogateKey]
+ : languageSurrogateKeys(options.languages)
+ await purgeKeys(surrogateKeys, soft)
+}
+
+// Poll production until it serves the build commit. A single /_build match only
+// proves one Moda instance has the new build; others may still be mid-rollout,
+// and a soft purge could then revalidate against a lagging instance and re-cache
+// old content for a full TTL. So require several consecutive matches first.
+async function waitForBuild() {
+ const needs = execFileSync('git', ['rev-parse', 'HEAD']).toString().trim()
+ const startTime = Date.now()
+ let consecutive = 0
+
+ while (consecutive < BUILD_WAIT_REQUIRED_MATCHES) {
+ if (Date.now() - startTime > BUILD_WAIT_TIMEOUT) {
+ throw new Error(
+ `Production did not reach ${BUILD_WAIT_REQUIRED_MATCHES} consecutive build matches within ${BUILD_WAIT_TIMEOUT / 1000} seconds`,
+ )
+ }
+
+ let current = ''
+ try {
+ const response = await fetchWithRetry(
+ 'https://docs.github.com/_build',
+ {},
+ { retries: 5, timeout: 30_000, throwHttpErrors: false },
+ )
+ if (response.ok) {
+ current = (await response.text()).trim()
+ }
+ } catch {
+ // Treat a fetch failure like a non-match: reset and keep polling.
+ current = ''
+ }
+
+ if (current && current === needs) {
+ consecutive += 1
+ console.log(
+ `Production matches the build commit (${consecutive}/${BUILD_WAIT_REQUIRED_MATCHES})`,
+ )
+ } else {
+ if (consecutive > 0) {
+ console.log('Production stopped matching the build commit; resetting consecutive count')
+ } else {
+ console.log('Production is not up to date with the build commit')
+ }
+ consecutive = 0
+ }
+
+ if (consecutive < BUILD_WAIT_REQUIRED_MATCHES) {
+ await sleep(BUILD_WAIT_INTERVAL)
+ }
+ }
+ console.log(
+ `Production is up to date with the build commit.`,
+ `${BUILD_WAIT_REQUIRED_MATCHES} consecutive matches.`,
+ )
+}
+
+function languageSurrogateKeys(languagesInput?: string): string[] {
+ // Put `en` first because contributors write mostly in English and are most
+ // likely waiting to see their landed changes appear in production. Build a
+ // new array rather than sorting `languageKeys` in place, which is shared
+ // state.
+ const trimmed = languagesInput?.trim()
+ const languages = trimmed
+ ? languagesFromString(trimmed)
+ : ['en', ...languageKeys.filter((lang) => lang !== 'en')]
+
+ // The leading no-language key, an empty `makeLanguageSurrogateKey()`, covers
+ // things like `/api/webhooks` which aren't language specific.
+ return [
+ makeLanguageSurrogateKey(),
+ ...languages.map((language) => makeLanguageSurrogateKey(language)),
+ ]
+}
+
+function languagesFromString(str: string): string[] {
+ const parsedLanguages = str
+ .split(/,/)
+ .map((x) => x.trim())
+ .filter(Boolean)
+ if (!parsedLanguages.every((lang) => languageKeys.includes(lang))) {
+ throw new Error(
+ `Unrecognized language code (${parsedLanguages.find((lang) => !languageKeys.includes(lang))})`,
+ )
+ }
+ return parsedLanguages
+}
+
+type PurgePhase = 'first' | 'second'
+type PurgeOutcome = { key: string; phase: PurgePhase; error?: unknown }
+
+/**
+ * Double-purge a set of surrogate keys. Per-deploy / manual purges pass
+ * `no-language` plus each `language:` key; the search reindex passes a
+ * single `api-search:` key.
+ *
+ * Each key is purged twice because of Fastly shielding: the first purge clears
+ * the edge nodes, the second clears the origin shield. Two delays shape the run.
+ * DELAY_BETWEEN_KEYS spaces out each key's first purge to avoid a stampeding
+ * herd on the backend. DELAY_BEFORE_SECOND_PURGE waits long enough for the now-
+ * stale content to be re-fetched and re-shielded before the second purge clears
+ * it. Fastly suggests ~2s between surrogate-key purges, but that's been too short
+ * in practice, so we use a larger margin. See the "Race conditions" section of
+ * https://www.fastly.com/documentation/guides/concepts/cache/purging#race-conditions
+ * Its 30s figure is for purge-all, which we don't use.
+ *
+ * To avoid serializing the run, we schedule every purge against one wall-clock
+ * timeline up front instead of blocking on each second purge. Because the second-
+ * purge delay is a multiple of the between-keys delay, a key's second purge
+ * shares a slot with a later key's first purge:
+ *
+ * t=0 no-language (1st)
+ * t=10 en (1st)
+ * t=20 es (1st) + no-language (2nd)
+ * t=30 ja (1st) + en (2nd)
+ * t=40 pt (1st) + es (2nd)
+ * ...
+ *
+ * A single-key purge is the degenerate case: first at t=0, second at t=20s.
+ */
+async function purgeKeys(surrogateKeys: string[], soft: boolean) {
+ // One wall-clock start time so the cadence doesn't drift with per-purge network
+ // latency and each second purge aligns with a later first purge, as above.
+ const startTime = Date.now()
+ const purges: Promise[] = []
+
+ // Each call resolves to an outcome and never rejects: the try/catch keeps a
+ // failed purge from becoming an unhandled rejection while later scheduled
+ // purges are still pending. Failures are surfaced after all purges settle.
+ async function runPurge(
+ key: string,
+ phase: PurgePhase,
+ targetTime: number,
+ ): Promise {
+ await sleep(Math.max(0, targetTime - Date.now()))
+ try {
+ console.log(`Triggering ${phase}-phase ${soft ? 'soft' : 'hard'} purge for '${key}'...`)
+ const result = await fastlyPurge(`purge/${encodeURIComponent(key)}`, { soft })
+ console.log(`Fastly purge result for '${key}':`, result.status)
+ return { key, phase }
+ } catch (error) {
+ return { key, phase, error }
+ }
+ }
+
+ for (const [index, key] of surrogateKeys.entries()) {
+ const slotStart = startTime + index * DELAY_BETWEEN_KEYS
+ purges.push(runPurge(key, 'first', slotStart))
+ purges.push(runPurge(key, 'second', slotStart + DELAY_BEFORE_SECOND_PURGE))
+ }
+
+ const outcomes = await Promise.all(purges)
+ const failures = outcomes.filter((outcome) => outcome.error)
+ if (failures.length) {
+ for (const failure of failures) {
+ console.error(`Fastly ${failure.phase} purge failed for '${failure.key}':`, failure.error)
+ }
+ throw new Error(`${failures.length} Fastly purge(s) failed`)
+ }
+}
+
+// Low-level Fastly purge. `endpoint` is appended to the service path, e.g.
+// `purge/` or `purge_all`. Returns the response; on a non-2xx throws with
+// the body best-effort, since Fastly puts permission/feature details there.
+//
+// Soft purge marks the object stale and serves stale-while-revalidate; hard
+// purge evicts it outright. Soft can fail to clear content whose origin returns
+// `304 Not Modified` on revalidation, since a 304 just extends the stale object,
+// so use hard then. `purge_all` ignores the soft header and is always hard.
+async function fastlyPurge(endpoint: string, { soft = false }: { soft?: boolean } = {}) {
+ const headers: Record = {
+ 'fastly-key': FASTLY_TOKEN as string,
+ accept: 'application/json',
+ 'Content-Type': 'application/json',
+ }
+ if (soft) {
+ headers['fastly-soft-purge'] = '1'
+ }
+
+ const url = `https://api.fastly.com/service/${encodeURIComponent(FASTLY_SERVICE_ID as string)}/${endpoint}`
+ const response = await fetchWithRetry(
+ url,
+ { method: 'POST', headers },
+ { retries: 0, timeout: 30_000, throwHttpErrors: false },
+ )
+ if (!response.ok) {
+ let body = ''
+ try {
+ body = await response.text()
+ } catch {
+ body = ''
+ }
+ throw new Error(
+ `Fastly purge failed: HTTP ${response.status} ${response.statusText}${body ? `: ${body}` : ''}`,
+ )
+ }
+ return response
+}