scriptoriumadmin/skillhub
1
0
Fork 0
mirror of https://github.com/iflytek/skillhub.git synced 2026-08-27 11:14:59 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Merge pull request #418 from iflytek/fix/cli-update-registry

Browse source 
fix(cli): respect configured npm registry
This commit is contained in:
dongmucat 2026-05-11 15:18:29 +08:00 • committed by GitHub
commit 15e55e8055
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 202 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

69
cli/src/clients/npm-registry-client.ts
View file

@ -1,32 +1,85 @@
import { EXIT, CLI_PACKAGE_NAME } from '../shared/constants'
import { CliError } from '../shared/errors'
const DEFAULT_NPM_REGISTRY = 'https://registry.npmjs.org'
function readEnv(env: NodeJS.ProcessEnv, name: string): string | undefined {
const exactValue = env[name]?.trim()
if (exactValue) {
return exactValue
}
const lowerName = name.toLowerCase()
for (const [key, value] of Object.entries(env)) {
const normalizedValue = value?.trim()
if (key.toLowerCase() === lowerName && normalizedValue) {
return normalizedValue
}
}
return undefined
}
function resolveRegistry(env: NodeJS.ProcessEnv): string {
return readEnv(env, 'SKILLHUB_NPM_REGISTRY')
?? readEnv(env, 'npm_config_registry')
?? readEnv(env, 'NPM_CONFIG_REGISTRY')
?? DEFAULT_NPM_REGISTRY
}
function buildLatestUrl(registry: string, packageName: string): string {
try {
const base = registry.endsWith('/') ? registry : `${registry}/`
return new URL(`${encodeURIComponent(packageName)}/latest`, base).toString()
} catch {
throw new CliError('invalid npm registry URL', EXIT.usage, {
registry,
next: 'check npm registry configuration and retry'
})
}
}
export class NpmRegistryClient {
constructor(
private readonly fetchImpl: typeof fetch = fetch,
private readonly timeoutMs = 10_000
private readonly timeoutMs = 10_000,
private readonly env: NodeJS.ProcessEnv = process.env
) {}
async latestVersion(packageName = CLI_PACKAGE_NAME): Promise<string> {
const registry = resolveRegistry(this.env)
const url = buildLatestUrl(registry, packageName)
const controller = new AbortController()
const timer = setTimeout(() => controller.abort(), this.timeoutMs)
try {
let response: Response
try {
response = await this.fetchImpl(`https://registry.npmjs.org/${packageName}/latest`, {
response = await this.fetchImpl(url, {
signal: controller.signal
})
} catch {
} catch (error) {
const isTimeout = error instanceof Error && error.name === 'AbortError'
throw new CliError('npm registry unreachable', EXIT.network, {
next: 'check network connectivity and retry'
registry,
cause: error instanceof Error ? error.message : String(error),
next: isTimeout
? 'check npm registry connectivity or proxy settings and retry'
: 'check npm registry/proxy configuration and retry'
})
}
if (!response.ok) {
throw new CliError(`npm registry returned ${response.status}`, EXIT.network)
throw new CliError(`npm registry returned ${response.status}`, EXIT.network, { registry })
}
const body = await response.json()
if (typeof body.version !== 'string') {
throw new CliError('npm registry response missing version', EXIT.network)
let body: unknown
try {
body = await response.json()
} catch (error) {
throw new CliError('npm registry response invalid', EXIT.network, {
registry,
cause: error instanceof Error ? error.message : String(error)
})
}
if (typeof body !== 'object' || body === null || !('version' in body) || typeof body.version !== 'string') {
throw new CliError('npm registry response missing version', EXIT.network, { registry })
}
return body.version
} finally {

143
cli/test/unit/clients/npm-registry-client.test.ts
View file

@ -2,15 +2,154 @@ import { describe, expect, test } from 'bun:test'
import { NpmRegistryClient } from '../../../src/clients/npm-registry-client'
describe('NpmRegistryClient', () => {
test('uses npm_config_registry when checking the latest version', async () => {
let requestedUrl = ''
const successfulFetch = (async (input: RequestInfo | URL) => {
requestedUrl = String(input)
return Response.json({ version: '1.2.3' })
}) as typeof fetch
const client = new NpmRegistryClient(successfulFetch, 10_000, {
npm_config_registry: 'https://registry.npmmirror.com'
})
await expect(client.latestVersion()).resolves.toBe('1.2.3')
expect(requestedUrl).toBe('https://registry.npmmirror.com/%40astron-team%2Fskillhub/latest')
})
test('uses SkillHub registry override before npm registry env vars', async () => {
let requestedUrl = ''
const successfulFetch = (async (input: RequestInfo | URL) => {
requestedUrl = String(input)
return Response.json({ version: '1.2.3' })
}) as typeof fetch
const client = new NpmRegistryClient(successfulFetch, 10_000, {
SKILLHUB_NPM_REGISTRY: 'https://skillhub-registry.example.test/npm/',
npm_config_registry: 'https://lower-priority.example.test',
NPM_CONFIG_REGISTRY: 'https://lowest-priority.example.test'
})
await expect(client.latestVersion()).resolves.toBe('1.2.3')
expect(requestedUrl).toBe('https://skillhub-registry.example.test/npm/%40astron-team%2Fskillhub/latest')
})
test('resolves registry env names case-insensitively for Windows compatibility', async () => {
let requestedUrl = ''
const successfulFetch = (async (input: RequestInfo | URL) => {
requestedUrl = String(input)
return Response.json({ version: '1.2.3' })
}) as typeof fetch
const client = new NpmRegistryClient(successfulFetch, 10_000, {
skillhub_npm_registry: 'https://windows-env.example.test'
})
await expect(client.latestVersion()).resolves.toBe('1.2.3')
expect(requestedUrl).toBe('https://windows-env.example.test/%40astron-team%2Fskillhub/latest')
})
test('ignores empty registry env values before falling back', async () => {
let requestedUrl = ''
const successfulFetch = (async (input: RequestInfo | URL) => {
requestedUrl = String(input)
return Response.json({ version: '1.2.3' })
}) as typeof fetch
const client = new NpmRegistryClient(successfulFetch, 10_000, {
SKILLHUB_NPM_REGISTRY: ' ',
npm_config_registry: '',
NPM_CONFIG_REGISTRY: 'https://registry.example.test'
})
await expect(client.latestVersion()).resolves.toBe('1.2.3')
expect(requestedUrl).toBe('https://registry.example.test/%40astron-team%2Fskillhub/latest')
})
test('uses the default npm registry when no registry is configured', async () => {
let requestedUrl = ''
const successfulFetch = (async (input: RequestInfo | URL) => {
requestedUrl = String(input)
return Response.json({ version: '1.2.3' })
}) as typeof fetch
const client = new NpmRegistryClient(successfulFetch, 10_000, {})
await expect(client.latestVersion()).resolves.toBe('1.2.3')
expect(requestedUrl).toBe('https://registry.npmjs.org/%40astron-team%2Fskillhub/latest')
})
test('classifies network failures as CLI errors', async () => {
const failingFetch = (async () => {
throw new TypeError('fetch failed')
}) as unknown as typeof fetch
const client = new NpmRegistryClient(failingFetch)
const client = new NpmRegistryClient(failingFetch, 10_000, {
NPM_CONFIG_REGISTRY: 'https://registry.example.test'
})
await expect(client.latestVersion()).rejects.toMatchObject({
message: 'npm registry unreachable',
exitCode: 3
exitCode: 3,
details: {
registry: 'https://registry.example.test',
cause: 'fetch failed',
next: 'check npm registry/proxy configuration and retry'
}
})
})
test('reports registry context for non-2xx responses', async () => {
const failingFetch = (async () => new Response('{}', { status: 503 })) as unknown as typeof fetch
const client = new NpmRegistryClient(failingFetch, 10_000, {
SKILLHUB_NPM_REGISTRY: 'https://registry.example.test'
})
await expect(client.latestVersion()).rejects.toMatchObject({
message: 'npm registry returned 503',
exitCode: 3,
details: {
registry: 'https://registry.example.test'
}
})
})
test('rejects registry responses without a version', async () => {
const failingFetch = (async () => Response.json({ name: '@astron-team/skillhub' })) as unknown as typeof fetch
const client = new NpmRegistryClient(failingFetch, 10_000, {
npm_config_registry: 'https://registry.example.test'
})
await expect(client.latestVersion()).rejects.toMatchObject({
message: 'npm registry response missing version',
exitCode: 3,
details: {
registry: 'https://registry.example.test'
}
})
})
test('rejects invalid JSON registry responses', async () => {
const failingFetch = (async () => new Response('<html>not json</html>')) as unknown as typeof fetch
const client = new NpmRegistryClient(failingFetch, 10_000, {
npm_config_registry: 'https://registry.example.test'
})
await expect(client.latestVersion()).rejects.toMatchObject({
message: 'npm registry response invalid',
exitCode: 3,
details: {
registry: 'https://registry.example.test'
}
})
})
test('rejects invalid registry configuration', async () => {
const client = new NpmRegistryClient(fetch, 10_000, {
npm_config_registry: 'https://['
})
await expect(client.latestVersion()).rejects.toMatchObject({
message: 'invalid npm registry URL',
exitCode: 5,
details: {
registry: 'https://[',
next: 'check npm registry configuration and retry'
}
})
})
})