Skip to content

fix: honor COREPACK_NPM_REGISTRY for tarballs hosted elsewhere #897

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Yash121l wants to merge 1 commit into
base: main
Choose a base branch
from
+28 −4
Open

fix: honor COREPACK_NPM_REGISTRY for tarballs hosted elsewhere #897

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 13 additions & 3 deletions sources/npmRegistryUtils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,15 @@ export const DEFAULT_HEADERS: Record<string, string> = {
};
export const DEFAULT_NPM_REGISTRY_URL = `https://registry.npmjs.org`;

export async function fetchAsJson(packageName: string, version?: string) {
function getRegistryURL() {
// Strip any trailing slashes so a `COREPACK_NPM_REGISTRY` with a trailing
// slash does not produce a double slash in the request URL (some registries,
// e.g. registry.npmmirror.com, reject `//package` with a 404).
const npmRegistryUrl = (process.env.COREPACK_NPM_REGISTRY || DEFAULT_NPM_REGISTRY_URL).replace(/\/+$/, ``);
return (process.env.COREPACK_NPM_REGISTRY || DEFAULT_NPM_REGISTRY_URL).replace(/\/+$/, ``);
}

export async function fetchAsJson(packageName: string, version?: string) {
const npmRegistryUrl = getRegistryURL();

if (process.env.COREPACK_ENABLE_NETWORK === `0`)
throw new UsageError(`Network access disabled by the environment; can't reach npm repository ${npmRegistryUrl}`);
Expand Down Expand Up @@ -116,5 +120,11 @@ export async function fetchTarballURLAndSignature(packageName: string, version:
if (tarball === undefined || !tarball.startsWith(`http`))
throw new Error(`${packageName}@${version} does not have a valid tarball.`);

return {tarball, signatures, integrity};
const tarballPath = tarball.indexOf(`/${packageName}/-/`);

return {
tarball: tarballPath === -1 ? tarball : getRegistryURL() + tarball.slice(tarballPath),
signatures,
integrity,
};
}
2 changes: 1 addition & 1 deletion tests/_registryServer.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ function generateVersionMetadata(packageName, version) {
dist: {
shasum,
size: mockPackageTarGz.length,
tarball: `https://registry.npmjs.org/${packageName}/-/${packageName}-${version}.tgz`,
tarball: `${process.env.TEST_TARBALL_HOST ?? `https://registry.npmjs.org`}/${packageName}/-/${packageName}-${version}.tgz`,
...generateSignature(packageName, version),
},
};
Expand Down
14 changes: 14 additions & 0 deletions tests/main.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1929,6 +1929,20 @@ for (const authType of [`COREPACK_NPM_REGISTRY`, `COREPACK_NPM_TOKEN`, `COREPACK
});
}

it(`should download from COREPACK_NPM_REGISTRY when the registry advertises the tarball on another host`, async () => {
await xfs.mktempPromise(async cwd => {
process.env.AUTH_TYPE = `COREPACK_NPM_TOKEN`; // See `_registryServer.mjs`
process.env.COREPACK_INTEGRITY_KEYS = ``;
process.env.TEST_TARBALL_HOST = `https://cdn.example.org`; // See `_registryServer.mjs`

await expect(runCli(cwd, [`pnpm@1.x`, `--version`], true)).resolves.toMatchObject({
exitCode: 0,
stdout: `pnpm: Hello from custom registry\n`,
stderr: ``,
});
});
});

describe(`handle integrity checks`, () => {
beforeEach(() => {
process.env.AUTH_TYPE = `COREPACK_NPM_TOKEN`; // See `_registryServer.mjs`
Expand Down