moved has changelog to it's own api endpoint

Author: WilcoSp

app/composables/usePackageAnalysis.ts

@@ -10,8 +10,6 @@ export interface PackageAnalysisResponse {
     npm?: string
   }
   createPackage?: CreatePackageInfo
-  // TODO move this to it's own composable
-  hasChangelog?: boolean
 }
 
 /**

app/composables/usePackageHasChangelog.ts

@@ -0,0 +1,18 @@
+export function usePackageHasChangelog(
+  packageName: MaybeRefOrGetter<string>,
+  version?: MaybeRefOrGetter<string | null | undefined>,
+) {
+  return useLazyFetch<boolean>(
+    () => {
+      const name = toValue(packageName)
+      const ver = toValue(version)
+      const base = `/api/changelog/has/${name}`
+      return ver ? `${base}/v/${ver}` : base
+    },
+    {
+      onResponse(r) {
+        console.log({ r })
+      },
+    },
+  )
+}

app/pages/package/[...package].vue

@@ -117,6 +117,9 @@ const { data: skillsData } = useLazyFetch<SkillsListResponse>(
 
 const { data: packageAnalysis } = usePackageAnalysis(packageName, requestedVersion)
 const { data: moduleReplacement } = useModuleReplacement(packageName)
+const { data: hasChangelog } = usePackageHasChangelog(packageName, requestedVersion)
+
+watchEffect(() => console.log('hasChangelog', hasChangelog.value))
 
 const {
   data: resolvedVersion,
@@ -756,9 +759,8 @@ onKeyStroke(
                 {{ $t('package.links.issues') }}
               </a>
             </li>
-
             <NuxtLink
-              v-if="packageAnalysis?.hasChangelog"
+              v-if="hasChangelog"
               class="link-subtle font-mono text-sm inline-flex items-center gap-1.5"
             >
               <span class="i-carbon:catalog w-4 h-4" aria-hidden="true" />

i18n/locales/en.json

@@ -183,7 +183,8 @@
       "code": "code",
       "docs": "docs",
       "fund": "fund",
-      "compare": "compare"
+      "compare": "compare",
+      "changelog": "changelog"
     },
     "docs": {
       "not_available": "Docs not available",

lunaria/files/en-GB.json

@@ -183,7 +183,8 @@
       "code": "code",
       "docs": "docs",
       "fund": "fund",
-      "compare": "compare"
+      "compare": "compare",
+      "changelog": "changelog"
     },
     "docs": {
       "not_available": "Docs not available",

lunaria/files/en-US.json

@@ -183,7 +183,8 @@
       "code": "code",
       "docs": "docs",
       "fund": "fund",
-      "compare": "compare"
+      "compare": "compare",
+      "changelog": "changelog"
     },
     "docs": {
       "not_available": "Docs not available",

server/api/changelog/has/[...pkg].get.ts

@@ -0,0 +1,45 @@
+import type { ExtendedPackageJson } from '#shared/utils/package-analysis'
+import { PackageRouteParamsSchema } from '#shared/schemas/package'
+import {
+  ERROR_PACKAGE_HAS_CHANGELOG,
+  NPM_REGISTRY,
+  CACHE_MAX_AGE_ONE_DAY,
+} from '#shared/utils/constants'
+import * as v from 'valibot'
+import { detectHasChangelog } from '~~/server/utils/has-changelog'
+
+export default defineCachedEventHandler(
+  async event => {
+    const pkgParamSegments = getRouterParam(event, 'pkg')?.split('/') ?? []
+
+    const { rawPackageName, rawVersion } = parsePackageParams(pkgParamSegments)
+
+    try {
+      const { packageName, version } = v.parse(PackageRouteParamsSchema, {
+        packageName: rawPackageName,
+        version: rawVersion,
+      })
+
+      const encodedName = encodePackageName(packageName)
+      const versionSuffix = version ? `/${version}` : '/latest'
+      const pkg = await $fetch<ExtendedPackageJson>(
+        `${NPM_REGISTRY}/${encodedName}${versionSuffix}`,
+      )
+
+      return await detectHasChangelog(pkg)
+    } catch (error) {
+      handleApiError(error, {
+        statusCode: 502,
+        message: ERROR_PACKAGE_HAS_CHANGELOG,
+      })
+    }
+  },
+  {
+    maxAge: CACHE_MAX_AGE_ONE_DAY, // 24 hours - analysis rarely changes
+    swr: true,
+    getKey: event => {
+      const pkg = getRouterParam(event, 'pkg') ?? ''
+      return `changelog:v1:${pkg.replace(/\/+$/, '').trim()}`
+    },
+  },
+)

server/api/registry/analysis/[...pkg].get.ts

@@ -19,7 +19,6 @@ import {
 } from '#shared/utils/constants'
 import { parseRepoUrl } from '#shared/utils/git-providers'
 import { getLatestVersion, getLatestVersionBatch } from 'fast-npm-meta'
-import { detectHasChangelog } from '~~/server/utils/has-changelog'
 
 export default defineCachedEventHandler(
   async event => {
@@ -54,13 +53,10 @@ export default defineCachedEventHandler(
       const createPackage = await findAssociatedCreatePackage(packageName, pkg)
 
       const analysis = analyzePackage(pkg, { typesPackage, createPackage })
-      // TODO move this to it's own endpoint
-      const hasChangelog = await detectHasChangelog(pkg)
       return {
         package: packageName,
         version: pkg.version ?? version ?? 'latest',
         ...analysis,
-        hasChangelog,
       } satisfies PackageAnalysisResponse
     } catch (error: unknown) {
       handleApiError(error, {
@@ -218,5 +214,4 @@ function hasSameRepositoryOwner(
 export interface PackageAnalysisResponse extends PackageAnalysis {
   package: string
   version: string
-  hasChangelog: boolean | null
 }

server/utils/has-changelog.ts

@@ -24,7 +24,7 @@ export async function detectHasChangelog(
     return true
   }
 
-  return null
+  return false
 }
 
 /**

shared/utils/constants.ts

@@ -16,6 +16,7 @@ export const ERROR_PACKAGE_ANALYSIS_FAILED = 'Failed to analyze package.'
 export const ERROR_PACKAGE_VERSION_AND_FILE_FAILED = 'Version and file path are required.'
 export const ERROR_PACKAGE_REQUIREMENTS_FAILED =
   'Package name, version, and file path are required.'
+export const ERROR_PACKAGE_HAS_CHANGELOG = 'failed to detect package has changelog'
 export const ERROR_FILE_LIST_FETCH_FAILED = 'Failed to fetch file list.'
 export const ERROR_CALC_INSTALL_SIZE_FAILED = 'Failed to calculate install size.'
 export const NPM_MISSING_README_SENTINEL = 'ERROR: No README data found!'