refactor: fetch JSON with native fetch instead of ofetch

Author: danielroe

packages/nuxt-cli/package.json

@@ -63,7 +63,6 @@
 "magicast": "^0.5.3",
 "nypm": "^0.6.8",
 "obug": "^2.1.1",
-"ofetch": "^1.5.1",
 "ohash": "^2.0.11",
 "pathe": "^2.0.3",
 "perfect-debounce": "^2.1.0",

packages/nuxt-cli/src/commands/init.ts

@@ -13,7 +13,6 @@ import { box, cancel, confirm, intro, isCancel, outro, S_BAR, select, spinner, t
 import{defineCommand,showUsage}from'citty'
 import{downloadTemplate,startShell}from'giget'
 import{detectPackageManager}from'nypm'
-import{$fetch}from'ofetch'
 import{basename,join,relative,resolve}from'pathe'
 importcolorsfrom'picocolors'
 import{findFile,readPackageJSON,writePackageJSON}from'pkg-types'
@@ -22,6 +21,7 @@ import { x } from 'tinyexec'
 
 import{runCommandDefasrunCommand}from'../run-command'
 import{nuxtIcon,themeColor}from'../utils/ascii'
+import{fetchJson}from'../utils/fetch'
 import{createInstallLog,resolvePackageManagerDescriptor,runInstall,takeUnreportedIgnoredBuilds}from'../utils/install'
 import{debug,logger}from'../utils/logger'
 import{classifyNetworkError,describeNetworkError,logNetworkError,probeNetworkError}from'../utils/network'
@@ -429,7 +429,7 @@ export default defineCommand({
 constnightlySpinner=spinner()
 nightlySpinner.start('Fetching nightly version info')
 
-constresponse=await$fetch<{'dist-tags': Record<string,string>}>(NIGHTLY_DIST_TAGS_URL).catch((err)=>{
+constresponse=awaitfetchJson<{'dist-tags': Record<string,string>}>(NIGHTLY_DIST_TAGS_URL).catch((err)=>{
 nightlySpinner.error('Failed to fetch nightly version info')
 logNetworkError(err,{url: NIGHTLY_DIST_TAGS_URL})
 process.exit(1)
@@ -772,7 +772,7 @@ export default defineCommand({
 asyncfunctiongetModuleDependencies(moduleName: string){
 consturl=`https://registry.npmjs.org/${moduleName}/latest`
 try{
-constresponse=await$fetch(url)
+constresponse=awaitfetchJson<{dependencies?: Record<string,string>}>(url)
 constdependencies=response.dependencies||{}
 returnObject.keys(dependencies)
 }

packages/nuxt-cli/src/commands/module/_utils.ts

@@ -4,11 +4,11 @@ import type { PackageJson } from 'pkg-types'
 import{existsSync}from'node:fs'
 
 import{confirm,isCancel}from'@clack/prompts'
-import{$fetch}from'ofetch'
 import{resolve}from'pathe'
 importcolorsfrom'picocolors'
 import{satisfies}from'verkit'
 
+import{fetchJson}from'../../utils/fetch'
 import{logger}from'../../utils/logger'
 import{relativeToProcess}from'../../utils/paths'
 import{cwdArgs,logLevelArgs}from'../_shared'
@@ -109,7 +109,7 @@ export interface NuxtModule {
 exportconstMODULES_API_URL='https://api.nuxt.com/modules?version=all'
 
 exportasyncfunctionfetchModules(): Promise<NuxtModule[]>{
-const{ modules }=await$fetch<NuxtApiModulesResponse>(MODULES_API_URL)
+const{ modules }=awaitfetchJson<NuxtApiModulesResponse>(MODULES_API_URL)
 returnmodules
 }
 

packages/nuxt-cli/src/commands/module/add.ts

@@ -8,7 +8,6 @@ import process from 'node:process'
 import{cancel,confirm,isCancel,select,spinner}from'@clack/prompts'
 import{defineCommand}from'citty'
 import{detectPackageManager,packageManagers}from'nypm'
-import{$fetch}from'ofetch'
 import{resolve}from'pathe'
 importcolorsfrom'picocolors'
 import{readPackageJSON}from'pkg-types'
@@ -17,6 +16,7 @@ import { satisfies } from 'verkit'
 
 import{runCommandDefasrunCommand}from'../../run-command'
 import{updateConfig}from'../../utils/config'
+import{fetchJson}from'../../utils/fetch'
 import{createInstallLog,resolvePackageManagerDescriptor,runInstall,takeUnreportedIgnoredBuilds}from'../../utils/install'
 import{logger}from'../../utils/logger'
 import{logNetworkError}from'../../utils/network'
@@ -447,7 +447,7 @@ async function resolveModule(moduleName: string, cwd: string): Promise<ModuleRes
 
 // TODO: spinner
 constpkgUrl=joinURL(meta.registry,`${pkgName}`)
-constpkgDetails=await$fetch(pkgUrl,{ headers }).catch((err: unknown)=>{
+constpkgDetails=awaitfetchJson<any>(pkgUrl,{ headers }).catch((err: unknown)=>{
 logNetworkError(err,{url: pkgUrl,prefix: `Failed to fetch package details for ${colors.cyan(pkgName)}.`})
 returnnull
 })

packages/nuxt-cli/src/utils/fetch.ts

@@ -0,0 +1,58 @@
+/** Status codes worth a second attempt: transient overload, throttling and gateway faults. */
+constRETRY_STATUS_CODES=newSet([408,409,425,429,500,502,503,504])
+
+exportinterfaceFetchJsonOptions{
+headers?: Record<string,string>
+/** Milliseconds before the request is aborted. Unlimited when omitted. */
+timeout?: number
+/** Extra attempts after the first. Defaults to one. */
+retry?: number
+}
+
+interfaceFetchJsonErrorextendsError{
+status: number
+response: Response
+}
+
+/**
+ * `GET` a JSON document, throwing on a non-2xx response.
+ *
+ * Errors carry `status` and `response` so `classifyNetworkError` can tell an HTTP
+ * failure from a transport failure. Transport errors and the status codes above
+ * are retried, since `fetch` itself will not.
+ *
+ * This module deliberately has no imports: it is loaded directly by
+ * `scripts/generate-data.ts` under Node's type stripping, where extensionless
+ * relative specifiers do not resolve.
+ */
+exportasyncfunctionfetchJson<T>(url: string,options: FetchJsonOptions={}): Promise<T>{
+constattempts=(options.retry??1)+1
+letlastError: unknown
+for(letattempt=0;attempt<attempts;attempt++){
+try{
+constresponse=awaitfetch(url,{
+headers: options.headers,
+signal: options.timeout ? AbortSignal.timeout(options.timeout) : undefined,
+})
+if(response.ok){
+returnawaitresponse.json()asT
+}
+lastError=Object.assign(
+newError(`Request to ${url} failed with ${response.status}${response.statusText}`),
+{status: response.status, response },
+)satisfiesFetchJsonError
+if(!RETRY_STATUS_CODES.has(response.status)){
+break
+}
+}
+catch(error){
+lastError=error
+// A timeout is a deliberate deadline, so retrying would silently double it.
+constname=(errorasError|undefined)?.name
+if(name==='TimeoutError'||name==='AbortError'){
+break
+}
+}
+}
+throwlastError
+}

packages/nuxt-cli/src/utils/starter-templates.ts

@@ -1,5 +1,6 @@
 importprocessfrom'node:process'
-import{$fetch}from'ofetch'
+
+import{fetchJson}from'./fetch.ts'
 
 exportconsthiddenTemplates=[
 'doc-driven',
@@ -26,7 +27,6 @@ const fetchOptions = {
 // than 3s. The template list is prefetched and has a static fallback, so a
 // slightly longer deadline only ever delays the prompt on a broken network.
 timeout: 5000,
-responseType: 'json',
 headers: {
 'user-agent': '@nuxt/cli',
  ...process.env.GITHUB_TOKEN ? {authorization: `token ${process.env.GITHUB_TOKEN}`} : {},
@@ -45,7 +45,7 @@ export async function getTemplates() {
 exportasyncfunctionfetchTemplates(){
 consttemplates={}asRecord<string,TemplateData>
 
-constfiles=await$fetch<Array<{name: string,type: string,download_url?: string}>>(
+constfiles=awaitfetchJson<Array<{name: string,type: string,download_url?: string}>>(
 TEMPLATES_API_URL,
 fetchOptions,
 )
@@ -59,7 +59,7 @@ export async function fetchTemplates() {
 return
 }
 templates[templateName]=undefinedasunknownasTemplateData
-templates[templateName]=await$fetch(file.download_url,fetchOptions)
+templates[templateName]=awaitfetchJson<TemplateData>(file.download_url,fetchOptions)
 }))
 
 returntemplates

packages/nuxt-cli/src/utils/update.ts

@@ -1,13 +1,13 @@
 importprocessfrom'node:process'
 
 import{box}from'@clack/prompts'
-import{$fetch}from'ofetch'
 importcolorsfrom'picocolors'
 import{readUser,updateUser}from'rc9'
 import{isCI,isTest,provider}from'std-env'
 import{joinURL}from'ufo'
 import{isGreater,tryParse}from'verkit'
 
+import{fetchJson}from'./fetch'
 import{debug}from'./logger'
 import{detectNpmRegistry}from'./registry'
 
@@ -78,7 +78,7 @@ async function resolveLatestVersion(): Promise<string | undefined> {
 letlatest: string|undefined
 try{
 const{ registry, authToken }=awaitdetectNpmRegistry(null)
-latest=(await$fetch<{latest?: string}>(joinURL(registry,'-/package/nuxt/dist-tags'),{
+latest=(awaitfetchJson<{latest?: string}>(joinURL(registry,'-/package/nuxt/dist-tags'),{
 headers: authToken ? {Authorization: `Bearer ${authToken}`} : undefined,
 timeout: FETCH_TIMEOUT,
 retry: 0,

packages/nuxt-cli/src/utils/versions.ts

@@ -1,11 +1,11 @@
 import{readFileSync}from'node:fs'
 import{resolveModulePath}from'exsolve'
-import{$fetch}from'ofetch'
 import{readPackageJSON}from'pkg-types'
 import{joinURL}from'ufo'
 import{coerce,findMaxSatisfying}from'verkit'
 
 import{resolveCatalogEntry}from'./catalog'
+import{fetchJson}from'./fetch'
 import{tryResolveNuxt}from'./kit'
 import{debug}from'./logger'
 import{detectNpmRegistry}from'./registry'
@@ -45,7 +45,7 @@ export async function resolveRegistryVersion(pkg: string, range: string): Promis
 constscope=pkg.startsWith('@') ? pkg.split('/')[0]! : null
 const{ registry, authToken }=awaitdetectNpmRegistry(scope)
 
-packument=await$fetch(joinURL(registry,pkg),{
+packument=awaitfetchJson(joinURL(registry,pkg),{
 headers: {
 // The abbreviated packument is a fraction of the size of the full one and
 // still carries every version and dist-tag.

packages/nuxt-cli/test/unit/commands/add.spec.ts

@@ -40,9 +40,9 @@ vi.mock('pkg-types', async () => {
 }
 })
 
-vi.mock('ofetch',async()=>{
+vi.mock('../../../src/utils/fetch',async()=>{
 return{
-$fetch: mock$fetch,
+fetchJson: mock$fetch,
 }
 })
 

packages/nuxt-cli/test/unit/commands/module/add-config.spec.ts

@@ -22,8 +22,8 @@ vi.mock('nypm', () => ({
 vi.mock('pkg-types',()=>({
 readPackageJSON: ()=>Promise.resolve({devDependencies: {nuxt: '3.0.0'}}),
 }))
-vi.mock('ofetch',()=>({
-$fetch: vi.fn(()=>Promise.resolve({
+vi.mock('../../../../src/utils/fetch',()=>({
+fetchJson: vi.fn(()=>Promise.resolve({
 'dist-tags': {latest: '1.0.0'},
 'versions': {'1.0.0': manifest},
 })),