fix: prevent dev server crash (#17)

Author: HiDeoo

.changeset/wet-squids-drum.md

@@ -0,0 +1,7 @@
+---
+'starlight-changelogs': patch
+---
+
+Prevents the development server from crashing when failing to fetch remote data for a changelog.
+
+Previously, if some remote changelog data could not be fetched (due to network issues for example), the development server would crash. This update ensures that such failures are handled more gracefully, allowing the server to continue running. In such cases, warning messages will be logged to inform that no changelog data is available and associated pages will not be generated. The production build process remains unaffected by this change.

packages/starlight-changelogs/libs/net.ts

@@ -0,0 +1,23 @@
+import type { LoaderContext } from 'astro/loaders'
+
+export async function fetchFromLoader(
+  url: URL,
+  headers: HeadersInit,
+  logger: LoaderContext['logger'],
+): Promise<LoaderResult> {
+  let response: Response | undefined
+
+  try {
+    response = await fetch(url, { headers })
+  } catch (error) {
+    if (!import.meta.env.DEV) throw error
+
+    logger.error(`Failed to fetch data from ${url} with the following error:`)
+    logger.error(error instanceof Error ? error.message : String(error))
+    logger.error('Continuing without changelog data for now, but make sure the URL is correct and accessible.')
+  }
+
+  return response ? { ok: true, response } : { ok: false }
+}
+
+type LoaderResult = { ok: true; response: Response } | { ok: false }

packages/starlight-changelogs/providers/changeset.ts

@@ -10,6 +10,7 @@ import { toMarkdown } from 'mdast-util-to-markdown'
 import { toString } from 'mdast-util-to-string'
 import { CONTINUE, SKIP, visit } from 'unist-util-visit'
 
+import { fetchFromLoader } from '../libs/net'
 import { throwPluginError } from '../libs/plugin'
 import type { VersionDataEntry } from '../loader/schema'
 import { slugifyVersion } from '../loader/utils'
@@ -55,7 +56,10 @@ export async function loadChangesetData(config: ChangesetProviderConfig, context
   })
 }
 
-async function getChangelogContent(pathOrUrl: string | URL, { meta }: LoaderContext): Promise<ChangelogContent> {
+async function getChangelogContent(
+  pathOrUrl: string | URL,
+  { logger, meta }: LoaderContext,
+): Promise<ChangelogContent> {
   if (typeof pathOrUrl === 'string') {
     if (!existsSync(pathOrUrl)) throwPluginError(`The provided changelog file path at ${pathOrUrl} does not exist.`)
 
@@ -66,7 +70,10 @@ async function getChangelogContent(pathOrUrl: string | URL, { meta }: LoaderCont
 
   const headers = new Headers()
 
-  const response = await fetch(pathOrUrl, { headers: getConditionalHeaders({ init: headers, meta }) })
+  const result = await fetchFromLoader(pathOrUrl, getConditionalHeaders({ init: headers, meta }), logger)
+  if (!result.ok) return { modified: true, content: '' }
+
+  const response = result.response
 
   if (response.status === 304) return { modified: false }
   if (!response.ok)

packages/starlight-changelogs/providers/github.ts

@@ -2,6 +2,7 @@ import { getConditionalHeaders, storeConditionalHeaders } from '@ascorbic/loader
 import type { LoaderContext } from 'astro/loaders'
 import { z } from 'astro/zod'
 
+import { fetchFromLoader } from '../libs/net'
 import { throwPluginError } from '../libs/plugin'
 import type { VersionDataEntry } from '../loader/schema'
 import { slugifyVersion } from '../loader/utils'
@@ -54,7 +55,10 @@ async function syncData(
   }
 }
 
-async function fetchGitHubReleases(config: GitHubProviderConfig, { meta }: LoaderContext): Promise<GitHubApiResult> {
+async function fetchGitHubReleases(
+  config: GitHubProviderConfig,
+  { logger, meta }: LoaderContext,
+): Promise<GitHubApiResult> {
   let page: string | null = '1'
   const entries: VersionDataEntry[] = []
 
@@ -68,7 +72,10 @@ async function fetchGitHubReleases(config: GitHubProviderConfig, { meta }: Loade
     headers.set('X-GitHub-Api-Version', '2022-11-28')
     if (config.token) headers.set('Authorization', `Bearer ${config.token}`)
 
-    const response = await fetch(url, { headers: getConditionalHeaders({ init: headers, meta }) })
+    const result = await fetchFromLoader(url, getConditionalHeaders({ init: headers, meta }), logger)
+    if (!result.ok) return { modified: true, entries: [] }
+
+    const response = result.response
 
     if (response.status === 304) return { modified: false }
     if (!response.ok) throwPluginError(`Failed to fetch GitHub data: ${response.status} - ${response.statusText}`)