test: add coverage for critical resolveDependencyTree (#1911)

Author: serhalp

test/unit/server/utils/dependency-resolver.spec.ts

@@ -1,13 +1,48 @@
-import { describe, expect, it, vi } from 'vitest'
-import type { PackumentVersion } from '../../../../shared/types'
+import { describe, expect, it, vi, beforeEach } from 'vitest'
+import type { Packument, PackumentVersion } from '../../../../shared/types'
 
 // Mock Nitro globals before importing the module
 vi.stubGlobal('defineCachedFunction', (fn: Function) => fn)
 vi.stubGlobal('$fetch', vi.fn())
 
-const { TARGET_PLATFORM, matchesPlatform, resolveVersion } =
+const mockFetchNpmPackage = vi.fn<(name: string) => Promise<Packument | null>>()
+vi.stubGlobal('fetchNpmPackage', mockFetchNpmPackage)
+
+const { TARGET_PLATFORM, matchesPlatform, resolveVersion, resolveDependencyTree } =
   await import('../../../../server/utils/dependency-resolver')
 
+/**
+ * Helper to build a minimal Packument for mocking.
+ */
+function makePackument(
+  name: string,
+  versions: Array<{
+    version: string
+    deps?: Record<string, string>
+    optionalDeps?: Record<string, string>
+    os?: string[]
+    cpu?: string[]
+    libc?: string[]
+    unpackedSize?: number
+    deprecated?: string
+  }>,
+): Packument {
+  const versionsMap: Record<string, PackumentVersion> = {}
+  for (const v of versions) {
+    versionsMap[v.version] = {
+      version: v.version,
+      dependencies: v.deps,
+      optionalDependencies: v.optionalDeps,
+      os: v.os,
+      cpu: v.cpu,
+      ...(v.libc ? { libc: v.libc } : {}),
+      dist: { unpackedSize: v.unpackedSize },
+      ...(v.deprecated ? { deprecated: v.deprecated } : {}),
+    } as unknown as PackumentVersion
+  }
+  return { name, versions: versionsMap } as Packument
+}
+
 describe('dependency-resolver', () => {
   describe('TARGET_PLATFORM', () => {
     it('is configured for linux-x64-glibc', () => {
@@ -149,4 +184,230 @@ describe('dependency-resolver', () => {
       expect(resolveVersion('^2.0.0-beta.0', versions)).toBe('2.0.0')
     })
   })
+
+  describe('resolveDependencyTree', () => {
+    beforeEach(() => {
+      mockFetchNpmPackage.mockReset()
+    })
+
+    it('resolves a single package with no dependencies', async () => {
+      mockFetchNpmPackage.mockResolvedValue(
+        makePackument('root', [{ version: '1.0.0', unpackedSize: 5000 }]),
+      )
+
+      const result = await resolveDependencyTree('root', '1.0.0')
+
+      expect(result.size).toBe(1)
+      const pkg = result.get('root@1.0.0')
+      expect(pkg).toEqual({ name: 'root', version: '1.0.0', size: 5000, optional: false })
+    })
+
+    it('resolves direct dependencies', async () => {
+      mockFetchNpmPackage.mockImplementation(async (name: string) => {
+        if (name === 'root')
+          return makePackument('root', [
+            {
+              version: '1.0.0',
+              deps: { 'dep-a': '^1.0.0', 'dep-b': '^2.0.0' },
+              unpackedSize: 1000,
+            },
+          ])
+        if (name === 'dep-a')
+          return makePackument('dep-a', [{ version: '1.2.0', unpackedSize: 2000 }])
+        if (name === 'dep-b')
+          return makePackument('dep-b', [{ version: '2.1.0', unpackedSize: 3000 }])
+        return null
+      })
+
+      const result = await resolveDependencyTree('root', '1.0.0')
+
+      expect(result.size).toBe(3)
+      expect(result.get('root@1.0.0')).toMatchObject({ name: 'root', version: '1.0.0' })
+      expect(result.get('dep-a@1.2.0')).toMatchObject({
+        name: 'dep-a',
+        version: '1.2.0',
+        size: 2000,
+        optional: false,
+      })
+      expect(result.get('dep-b@2.1.0')).toMatchObject({
+        name: 'dep-b',
+        version: '2.1.0',
+        size: 3000,
+        optional: false,
+      })
+    })
+
+    it('resolves transitive dependencies (A → B → C)', async () => {
+      mockFetchNpmPackage.mockImplementation(async (name: string) => {
+        if (name === 'a') return makePackument('a', [{ version: '1.0.0', deps: { b: '^1.0.0' } }])
+        if (name === 'b') return makePackument('b', [{ version: '1.0.0', deps: { c: '^1.0.0' } }])
+        if (name === 'c') return makePackument('c', [{ version: '1.0.0' }])
+        return null
+      })
+
+      const result = await resolveDependencyTree('a', '1.0.0')
+
+      expect(result.size).toBe(3)
+      expect(result.has('a@1.0.0')).toBe(true)
+      expect(result.has('b@1.0.0')).toBe(true)
+      expect(result.has('c@1.0.0')).toBe(true)
+    })
+
+    it('handles circular dependencies without infinite loop', async () => {
+      mockFetchNpmPackage.mockImplementation(async (name: string) => {
+        if (name === 'a') return makePackument('a', [{ version: '1.0.0', deps: { b: '^1.0.0' } }])
+        if (name === 'b') return makePackument('b', [{ version: '1.0.0', deps: { a: '^1.0.0' } }])
+        return null
+      })
+
+      const result = await resolveDependencyTree('a', '1.0.0')
+
+      expect(result.size).toBe(2)
+      expect(result.has('a@1.0.0')).toBe(true)
+      expect(result.has('b@1.0.0')).toBe(true)
+    })
+
+    it('marks optional dependencies with optional: true', async () => {
+      mockFetchNpmPackage.mockImplementation(async (name: string) => {
+        if (name === 'root')
+          return makePackument('root', [
+            { version: '1.0.0', optionalDeps: { 'opt-dep': '^1.0.0' } },
+          ])
+        if (name === 'opt-dep')
+          return makePackument('opt-dep', [{ version: '1.0.0', unpackedSize: 500 }])
+        return null
+      })
+
+      const result = await resolveDependencyTree('root', '1.0.0')
+
+      expect(result.size).toBe(2)
+      expect(result.get('opt-dep@1.0.0')).toMatchObject({ optional: true })
+    })
+
+    it('skips dependencies that do not match the target platform', async () => {
+      mockFetchNpmPackage.mockImplementation(async (name: string) => {
+        if (name === 'root')
+          return makePackument('root', [
+            { version: '1.0.0', deps: { 'darwin-only': '^1.0.0', 'linux-ok': '^1.0.0' } },
+          ])
+        if (name === 'darwin-only')
+          return makePackument('darwin-only', [{ version: '1.0.0', os: ['darwin'] }])
+        if (name === 'linux-ok')
+          return makePackument('linux-ok', [{ version: '1.0.0', os: ['linux'] }])
+        return null
+      })
+
+      const result = await resolveDependencyTree('root', '1.0.0')
+
+      expect(result.has('darwin-only@1.0.0')).toBe(false)
+      expect(result.has('linux-ok@1.0.0')).toBe(true)
+    })
+
+    it('skips dependencies with unresolvable version ranges', async () => {
+      mockFetchNpmPackage.mockImplementation(async (name: string) => {
+        if (name === 'root')
+          return makePackument('root', [{ version: '1.0.0', deps: { missing: '^99.0.0' } }])
+        if (name === 'missing') return makePackument('missing', [{ version: '1.0.0' }])
+        return null
+      })
+
+      const result = await resolveDependencyTree('root', '1.0.0')
+
+      expect(result.size).toBe(1)
+      expect(result.has('root@1.0.0')).toBe(true)
+    })
+
+    it('continues resolving when fetchPackument fails for a dependency', async () => {
+      mockFetchNpmPackage.mockImplementation(async (name: string) => {
+        if (name === 'root')
+          return makePackument('root', [
+            { version: '1.0.0', deps: { broken: '^1.0.0', healthy: '^1.0.0' } },
+          ])
+        if (name === 'broken') return null
+        if (name === 'healthy') return makePackument('healthy', [{ version: '1.0.0' }])
+        return null
+      })
+
+      const result = await resolveDependencyTree('root', '1.0.0')
+
+      expect(result.size).toBe(2)
+      expect(result.has('root@1.0.0')).toBe(true)
+      expect(result.has('healthy@1.0.0')).toBe(true)
+      expect(result.has('broken@1.0.0')).toBe(false)
+    })
+
+    it('assigns depth and path when trackDepth is enabled', async () => {
+      mockFetchNpmPackage.mockImplementation(async (name: string) => {
+        if (name === 'root')
+          return makePackument('root', [{ version: '1.0.0', deps: { mid: '^1.0.0' } }])
+        if (name === 'mid')
+          return makePackument('mid', [{ version: '1.0.0', deps: { leaf: '^1.0.0' } }])
+        if (name === 'leaf') return makePackument('leaf', [{ version: '1.0.0' }])
+        return null
+      })
+
+      const result = await resolveDependencyTree('root', '1.0.0', { trackDepth: true })
+
+      expect(result.get('root@1.0.0')).toMatchObject({
+        depth: 'root',
+        path: ['root@1.0.0'],
+      })
+      expect(result.get('mid@1.0.0')).toMatchObject({
+        depth: 'direct',
+        path: ['root@1.0.0', 'mid@1.0.0'],
+      })
+      expect(result.get('leaf@1.0.0')).toMatchObject({
+        depth: 'transitive',
+        path: ['root@1.0.0', 'mid@1.0.0', 'leaf@1.0.0'],
+      })
+    })
+
+    it('does not include depth/path when trackDepth is not enabled', async () => {
+      mockFetchNpmPackage.mockResolvedValue(makePackument('root', [{ version: '1.0.0' }]))
+
+      const result = await resolveDependencyTree('root', '1.0.0')
+
+      const pkg = result.get('root@1.0.0')!
+      expect(pkg.depth).toBeUndefined()
+      expect(pkg.path).toBeUndefined()
+    })
+
+    it('includes deprecated field on deprecated versions', async () => {
+      mockFetchNpmPackage.mockResolvedValue(
+        makePackument('root', [{ version: '1.0.0', deprecated: 'Use v2 instead' }]),
+      )
+
+      const result = await resolveDependencyTree('root', '1.0.0')
+
+      expect(result.get('root@1.0.0')).toMatchObject({ deprecated: 'Use v2 instead' })
+    })
+
+    it('defaults size to 0 when unpackedSize is missing', async () => {
+      mockFetchNpmPackage.mockResolvedValue(makePackument('root', [{ version: '1.0.0' }]))
+
+      const result = await resolveDependencyTree('root', '1.0.0')
+
+      expect(result.get('root@1.0.0')!.size).toBe(0)
+    })
+
+    it('deduplicates the same name@version appearing via multiple paths', async () => {
+      // root → a, root → b, both a and b depend on shared@1.0.0
+      mockFetchNpmPackage.mockImplementation(async (name: string) => {
+        if (name === 'root')
+          return makePackument('root', [{ version: '1.0.0', deps: { a: '^1.0.0', b: '^1.0.0' } }])
+        if (name === 'a')
+          return makePackument('a', [{ version: '1.0.0', deps: { shared: '^1.0.0' } }])
+        if (name === 'b')
+          return makePackument('b', [{ version: '1.0.0', deps: { shared: '^1.0.0' } }])
+        if (name === 'shared') return makePackument('shared', [{ version: '1.0.0' }])
+        return null
+      })
+
+      const result = await resolveDependencyTree('root', '1.0.0')
+
+      // root + a + b + shared (only once)
+      expect(result.size).toBe(4)
+      expect(result.has('shared@1.0.0')).toBe(true)
+    })
+  })
 })