refactor(@angular/cli): remove duplicate npmrc logic

This commit is contained in:
Alan Agius 2021-06-16 13:04:20 +02:00 committed by Charles
parent 277b356e2f
commit e680aa1f48
5 changed files with 95 additions and 233 deletions

View File

@ -10,9 +10,8 @@ import { logging, tags } from '@angular-devkit/core';
import { Rule, SchematicContext, SchematicsException, Tree } from '@angular-devkit/schematics'; import { Rule, SchematicContext, SchematicsException, Tree } from '@angular-devkit/schematics';
import * as npa from 'npm-package-arg'; import * as npa from 'npm-package-arg';
import * as semver from 'semver'; import * as semver from 'semver';
import { getNpmPackageJson } from './npm'; import { Dependency, JsonSchemaForNpmPackageJsonFiles } from '../../../../utilities/package-json';
import { NpmRepositoryPackageJson } from './npm-package-json'; import { NpmRepositoryPackageJson, getNpmPackageJson } from '../../../../utilities/package-metadata';
import { Dependency, JsonSchemaForNpmPackageJsonFiles } from './package-json';
import { Schema as UpdateSchema } from './schema'; import { Schema as UpdateSchema } from './schema';
type VersionRange = string & { __VERSION_RANGE: void }; type VersionRange = string & { __VERSION_RANGE: void };
@ -818,7 +817,7 @@ export default function (options: UpdateSchema): Rule {
const allPackageMetadata = await Promise.all( const allPackageMetadata = await Promise.all(
Array.from(npmDeps.keys()).map((depName) => Array.from(npmDeps.keys()).map((depName) =>
getNpmPackageJson(depName, logger, { getNpmPackageJson(depName, logger, {
registryUrl: options.registry, registry: options.registry,
usingYarn, usingYarn,
verbose: options.verbose, verbose: options.verbose,
}), }),

View File

@ -1,28 +0,0 @@
/**
* @license
* Copyright Google LLC All Rights Reserved.
*
* Use of this source code is governed by an MIT-style license that can be
* found in the LICENSE file at https://angular.io/license
*/
import { JsonSchemaForNpmPackageJsonFiles } from './package-json';
export interface NpmRepositoryPackageJson {
name: string;
requestedName: string;
description: string;
'dist-tags': {
[name: string]: string;
};
versions: {
[version: string]: JsonSchemaForNpmPackageJsonFiles;
};
time: {
modified: string;
created: string;
[version: string]: string;
};
}

View File

@ -1,166 +0,0 @@
/**
* @license
* Copyright Google LLC All Rights Reserved.
*
* Use of this source code is governed by an MIT-style license that can be
* found in the LICENSE file at https://angular.io/license
*/
import { logging } from '@angular-devkit/core';
import { existsSync, readFileSync } from 'fs';
import { homedir } from 'os';
import * as path from 'path';
import { NpmRepositoryPackageJson } from './npm-package-json';
const lockfile = require('@yarnpkg/lockfile');
const ini = require('ini');
const pacote = require('pacote');
type PackageManagerOptions = Record<string, unknown>;
const npmPackageJsonCache = new Map<string, Promise<Partial<NpmRepositoryPackageJson>>>();
let npmrc: PackageManagerOptions;
function readOptions(
logger: logging.LoggerApi,
yarn = false,
showPotentials = false,
): PackageManagerOptions {
const cwd = process.cwd();
const baseFilename = yarn ? 'yarnrc' : 'npmrc';
const dotFilename = '.' + baseFilename;
let globalPrefix: string;
if (process.env.PREFIX) {
globalPrefix = process.env.PREFIX;
} else {
globalPrefix = path.dirname(process.execPath);
if (process.platform !== 'win32') {
globalPrefix = path.dirname(globalPrefix);
}
}
const defaultConfigLocations = [
path.join(globalPrefix, 'etc', baseFilename),
path.join(homedir(), dotFilename),
];
const projectConfigLocations: string[] = [path.join(cwd, dotFilename)];
const root = path.parse(cwd).root;
for (let curDir = path.dirname(cwd); curDir && curDir !== root; curDir = path.dirname(curDir)) {
projectConfigLocations.unshift(path.join(curDir, dotFilename));
}
if (showPotentials) {
logger.info(`Locating potential ${baseFilename} files:`);
}
const options: PackageManagerOptions = {};
for (const location of [...defaultConfigLocations, ...projectConfigLocations]) {
if (existsSync(location)) {
if (showPotentials) {
logger.info(`Trying '${location}'...found.`);
}
const data = readFileSync(location, 'utf8');
// Normalize RC options that are needed by 'npm-registry-fetch'.
// See: https://github.com/npm/npm-registry-fetch/blob/ebddbe78a5f67118c1f7af2e02c8a22bcaf9e850/index.js#L99-L126
const rcConfig: PackageManagerOptions = yarn ? lockfile.parse(data) : ini.parse(data);
for (const [key, value] of Object.entries(rcConfig)) {
switch (key) {
case 'noproxy':
case 'no-proxy':
options['noProxy'] = value;
break;
case 'maxsockets':
options['maxSockets'] = value;
break;
case 'https-proxy':
case 'proxy':
options['proxy'] = value;
break;
case 'strict-ssl':
options['strictSSL'] = value;
break;
case 'local-address':
options['localAddress'] = value;
break;
case 'cafile':
if (typeof value === 'string') {
const cafile = path.resolve(path.dirname(location), value);
try {
options['ca'] = readFileSync(cafile, 'utf8').replace(/\r?\n/g, '\n');
} catch {}
}
break;
default:
options[key] = value;
break;
}
}
} else if (showPotentials) {
logger.info(`Trying '${location}'...not found.`);
}
}
// Substitute any environment variable references
for (const key in options) {
const value = options[key];
if (typeof value === 'string') {
options[key] = value.replace(/\$\{([^\}]+)\}/, (_, name) => process.env[name] || '');
}
}
return options;
}
/**
* Get the NPM repository's package.json for a package. This is p
* @param {string} packageName The package name to fetch.
* @param {string} registryUrl The NPM Registry URL to use.
* @param {LoggerApi} logger A logger instance to log debug information.
* @returns An observable that will put the pacakge.json content.
* @private
*/
export function getNpmPackageJson(
packageName: string,
logger: logging.LoggerApi,
options?: {
registryUrl?: string;
usingYarn?: boolean;
verbose?: boolean;
},
): Promise<Partial<NpmRepositoryPackageJson>> {
const cachedResponse = npmPackageJsonCache.get(packageName);
if (cachedResponse) {
return cachedResponse;
}
if (!npmrc) {
try {
npmrc = readOptions(logger, false, options && options.verbose);
} catch {}
if (options && options.usingYarn) {
try {
npmrc = { ...npmrc, ...readOptions(logger, true, options && options.verbose) };
} catch {}
}
}
const resultPromise: Promise<NpmRepositoryPackageJson> = pacote.packument(packageName, {
fullMetadata: true,
...npmrc,
...(options && options.registryUrl ? { registry: options.registryUrl } : {}),
});
// TODO: find some way to test this
const response = resultPromise.catch((err) => {
logger.warn(err.message || err);
return { requestedName: packageName };
});
npmPackageJsonCache.set(packageName, response);
return response;
}

View File

@ -10,13 +10,31 @@ import { logging } from '@angular-devkit/core';
import { existsSync, readFileSync } from 'fs'; import { existsSync, readFileSync } from 'fs';
import { homedir } from 'os'; import { homedir } from 'os';
import * as path from 'path'; import * as path from 'path';
import { JsonSchemaForNpmPackageJsonFiles } from './package-json';
const lockfile = require('@yarnpkg/lockfile'); const lockfile = require('@yarnpkg/lockfile');
const ini = require('ini'); const ini = require('ini');
const pacote = require('pacote'); const pacote = require('pacote');
export interface PackageDependencies { const npmPackageJsonCache = new Map<string, Promise<Partial<NpmRepositoryPackageJson>>>();
[dependency: string]: string;
export interface NpmRepositoryPackageJson {
name: string;
requestedName: string;
description: string;
'dist-tags': {
[name: string]: string;
};
versions: {
[version: string]: JsonSchemaForNpmPackageJsonFiles;
};
time: {
modified: string;
created: string;
[version: string]: string;
};
} }
export type NgAddSaveDepedency = 'dependencies' | 'devDependencies' | boolean; export type NgAddSaveDepedency = 'dependencies' | 'devDependencies' | boolean;
@ -37,17 +55,16 @@ export interface PackageManifest {
license?: string; license?: string;
private?: boolean; private?: boolean;
deprecated?: boolean; deprecated?: boolean;
dependencies: Record<string, string>;
dependencies: PackageDependencies; devDependencies: Record<string, string>;
devDependencies: PackageDependencies; peerDependencies: Record<string, string>;
peerDependencies: PackageDependencies; optionalDependencies: Record<string, string>;
optionalDependencies: PackageDependencies;
'ng-add'?: { 'ng-add'?: {
save?: NgAddSaveDepedency; save?: NgAddSaveDepedency;
}; };
'ng-update'?: { 'ng-update'?: {
migrations: string; migrations: string;
packageGroup: { [name: string]: string }; packageGroup: Record<string, string>;
}; };
} }
@ -58,7 +75,9 @@ export interface PackageMetadata {
'dist-tags'?: unknown; 'dist-tags'?: unknown;
} }
type PackageManagerOptions = Record<string, unknown>; interface PackageManagerOptions extends Record<string, unknown> {
forceAuth?: Record<string, unknown>;
}
let npmrc: PackageManagerOptions; let npmrc: PackageManagerOptions;
@ -122,47 +141,44 @@ function readOptions(
// See: https://github.com/npm/npm-registry-fetch/blob/ebddbe78a5f67118c1f7af2e02c8a22bcaf9e850/index.js#L99-L126 // See: https://github.com/npm/npm-registry-fetch/blob/ebddbe78a5f67118c1f7af2e02c8a22bcaf9e850/index.js#L99-L126
const rcConfig: PackageManagerOptions = yarn ? lockfile.parse(data) : ini.parse(data); const rcConfig: PackageManagerOptions = yarn ? lockfile.parse(data) : ini.parse(data);
for (const [key, value] of Object.entries(rcConfig)) { for (const [key, value] of Object.entries(rcConfig)) {
let substitutedValue = value;
// Substitute any environment variable references.
if (typeof value === 'string') {
substitutedValue = value.replace(/\$\{([^\}]+)\}/, (_, name) => process.env[name] || '');
}
switch (key) { switch (key) {
case 'noproxy': case 'noproxy':
case 'no-proxy': case 'no-proxy':
options['noProxy'] = value; options['noProxy'] = substitutedValue;
break; break;
case 'maxsockets': case 'maxsockets':
options['maxSockets'] = value; options['maxSockets'] = substitutedValue;
break; break;
case 'https-proxy': case 'https-proxy':
case 'proxy': case 'proxy':
options['proxy'] = value; options['proxy'] = substitutedValue;
break; break;
case 'strict-ssl': case 'strict-ssl':
options['strictSSL'] = value; options['strictSSL'] = substitutedValue;
break; break;
case 'local-address': case 'local-address':
options['localAddress'] = value; options['localAddress'] = substitutedValue;
break; break;
case 'cafile': case 'cafile':
if (typeof value === 'string') { if (typeof substitutedValue === 'string') {
const cafile = path.resolve(path.dirname(location), value); const cafile = path.resolve(path.dirname(location), substitutedValue);
try { try {
options['ca'] = readFileSync(cafile, 'utf8').replace(/\r?\n/g, '\n'); options['ca'] = readFileSync(cafile, 'utf8').replace(/\r?\n/g, '\n');
} catch {} } catch {}
} }
break; break;
default: default:
options[key] = value; options[key] = substitutedValue;
break; break;
} }
} }
} else if (showPotentials) {
logger.info(`Trying '${location}'...not found.`);
}
}
// Substitute any environment variable references
for (const key in options) {
const value = options[key];
if (typeof value === 'string') {
options[key] = value.replace(/\$\{([^\}]+)\}/, (_, name) => process.env[name] || '');
} }
} }
@ -238,18 +254,13 @@ export async function fetchPackageMetadata(
export async function fetchPackageManifest( export async function fetchPackageManifest(
name: string, name: string,
logger: logging.LoggerApi, logger: logging.LoggerApi,
options?: { options: {
registry?: string; registry?: string;
usingYarn?: boolean; usingYarn?: boolean;
verbose?: boolean; verbose?: boolean;
}, } = {},
): Promise<PackageManifest> { ): Promise<PackageManifest> {
const { usingYarn, verbose, registry } = { const { usingYarn = false, verbose = false, registry } = options;
registry: undefined,
usingYarn: false,
verbose: false,
...options,
};
ensureNpmrc(logger, usingYarn, verbose); ensureNpmrc(logger, usingYarn, verbose);
@ -261,3 +272,49 @@ export async function fetchPackageManifest(
return normalizeManifest(response); return normalizeManifest(response);
} }
export function getNpmPackageJson(
packageName: string,
logger: logging.LoggerApi,
options: {
registry?: string;
usingYarn?: boolean;
verbose?: boolean;
} = {},
): Promise<Partial<NpmRepositoryPackageJson>> {
const cachedResponse = npmPackageJsonCache.get(packageName);
if (cachedResponse) {
return cachedResponse;
}
const { usingYarn = false, verbose = false, registry } = options;
if (!npmrc) {
try {
npmrc = readOptions(logger, false, verbose);
} catch {}
if (usingYarn) {
try {
npmrc = { ...npmrc, ...readOptions(logger, true, verbose) };
} catch {}
}
}
const resultPromise: Promise<NpmRepositoryPackageJson> = pacote.packument(packageName, {
fullMetadata: true,
...npmrc,
...(registry ? { registry } : {}),
});
// TODO: find some way to test this
const response = resultPromise.catch((err) => {
logger.warn(err.message || err);
return { requestedName: packageName };
});
npmPackageJsonCache.set(packageName, response);
return response;
}