-
Notifications
You must be signed in to change notification settings - Fork 595
/
SetupPackageRegistry.ts
518 lines (438 loc) · 18.3 KB
/
SetupPackageRegistry.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
// See LICENSE in the project root for license information.
import * as path from 'path';
import * as child_process from 'child_process';
import {
AlreadyReportedError,
Colors,
ConsoleTerminalProvider,
Executable,
FileSystem,
InternalError,
JsonObject,
NewlineKind,
Terminal,
Text
} from '@rushstack/node-core-library';
import { PrintUtilities } from '@rushstack/terminal';
import { RushConfiguration } from '../../api/RushConfiguration';
import { Utilities } from '../../utilities/Utilities';
import { IArtifactoryPackageRegistryJson, ArtifactoryConfiguration } from './ArtifactoryConfiguration';
import { WebClient, WebClientResponse } from '../../utilities/WebClient';
import { TerminalInput } from './TerminalInput';
interface IArtifactoryCustomizableMessages {
introduction: string;
obtainAnAccount: string;
visitWebsite: string;
locateUserName: string;
locateApiKey: string;
}
const defaultMessages: IArtifactoryCustomizableMessages = {
introduction: 'This monorepo consumes packages from an Artifactory private NPM registry.',
obtainAnAccount:
'Please contact the repository maintainers for help with setting up an Artifactory user account.',
visitWebsite: 'Please open this URL in your web browser:',
locateUserName: 'Your user name appears in the upper-right corner of the JFrog website.',
locateApiKey:
'Click "Edit Profile" on the JFrog website. Click the "Generate API Key"' +
" button if you haven't already done so previously."
};
export interface ISetupPackageRegistryOptions {
rushConfiguration: RushConfiguration;
isDebug: boolean;
/**
* Whether Utilities.syncNpmrc() has already been called.
*/
syncNpmrcAlreadyCalled: boolean;
}
export class SetupPackageRegistry {
private readonly _options: ISetupPackageRegistryOptions;
public readonly rushConfiguration: RushConfiguration;
private readonly _terminal: Terminal;
private readonly _artifactoryConfiguration: ArtifactoryConfiguration;
private readonly _messages: IArtifactoryCustomizableMessages;
public constructor(options: ISetupPackageRegistryOptions) {
this._options = options;
this.rushConfiguration = options.rushConfiguration;
this._terminal = new Terminal(
new ConsoleTerminalProvider({
verboseEnabled: options.isDebug
})
);
this._artifactoryConfiguration = new ArtifactoryConfiguration(
path.join(this.rushConfiguration.commonRushConfigFolder, 'artifactory.json')
);
this._messages = {
...defaultMessages,
...this._artifactoryConfiguration.configuration.packageRegistry.messageOverrides
};
}
private _writeInstructionBlock(message: string): void {
if (message === '') {
return;
}
this._terminal.writeLine(PrintUtilities.wrapWords(message));
this._terminal.writeLine();
}
/**
* Test whether the NPM token is valid.
*
* @returns - `true` if valid, `false` if not valid
*/
public async checkOnly(): Promise<boolean> {
const packageRegistry: IArtifactoryPackageRegistryJson =
this._artifactoryConfiguration.configuration.packageRegistry;
if (!packageRegistry.enabled) {
this._terminal.writeVerbose('Skipping package registry setup because packageRegistry.enabled=false');
return true;
}
const registryUrl: string = (packageRegistry?.registryUrl || '').trim();
if (registryUrl.length === 0) {
throw new Error('The "registryUrl" setting in artifactory.json is missing or empty');
}
if (!this._options.syncNpmrcAlreadyCalled) {
Utilities.syncNpmrc(
this.rushConfiguration.commonRushConfigFolder,
this.rushConfiguration.commonTempFolder
);
}
// Artifactory does not implement the "npm ping" protocol or any equivalent REST API.
// But if we query a package that is known not to exist, Artifactory will only return
// a 404 error if it is successfully authenticated. We can use this negative query
// to validate the credentials.
const npmArgs: string[] = [
'view',
'@rushstack/nonexistent-package',
'--json',
'--registry=' + packageRegistry.registryUrl
];
this._terminal.writeLine('Testing access to private NPM registry: ' + packageRegistry.registryUrl);
const result: child_process.SpawnSyncReturns<string> = Executable.spawnSync('npm', npmArgs, {
currentWorkingDirectory: this.rushConfiguration.commonTempFolder,
stdio: ['ignore', 'pipe', 'pipe'],
// Wait at most 10 seconds for "npm view" to succeed
timeoutMs: 10 * 1000
});
this._terminal.writeLine();
// (This is not exactly correct, for example Node.js puts a string in error.errno instead of a string.)
const error: (Error & Partial<NodeJS.ErrnoException>) | undefined = result.error;
if (error) {
if (error.code === 'ETIMEDOUT') {
// For example, an incorrect "https-proxy" setting can hang for a long time
throw new Error('The "npm view" command timed out; check your .npmrc file for an incorrect setting');
}
throw new Error('Error invoking "npm view": ' + result.error);
}
if (result.status === 0) {
throw new InternalError('"npm view" unexpectedly succeeded');
}
// NPM 6.x writes to stdout
let jsonContent: string | undefined = SetupPackageRegistry._tryFindJson(result.stdout);
if (jsonContent === undefined) {
// NPM 7.x writes dirty output to stderr; see https://github.com/npm/cli/issues/2740
jsonContent = SetupPackageRegistry._tryFindJson(result.stderr);
}
if (jsonContent === undefined) {
throw new InternalError('The "npm view" command did not return a JSON structure');
}
let jsonOutput: JsonObject;
try {
jsonOutput = JSON.parse(jsonContent);
} catch (error) {
this._terminal.writeVerboseLine('NPM response:\n\n--------\n' + jsonContent + '\n--------\n\n');
throw new InternalError('The "npm view" command returned an invalid JSON structure');
}
const errorCode: JsonObject = jsonOutput?.error?.code;
if (typeof errorCode !== 'string') {
this._terminal.writeVerboseLine('NPM response:\n' + JSON.stringify(jsonOutput, undefined, 2) + '\n\n');
throw new InternalError('The "npm view" command returned unexpected output');
}
switch (errorCode) {
case 'E404':
this._terminal.writeLine('NPM credentials are working');
this._terminal.writeLine();
return true;
case 'E401':
case 'E403':
this._terminal.writeVerboseLine(
'NPM response:\n' + JSON.stringify(jsonOutput, undefined, 2) + '\n\n'
);
// Credentials are missing or expired
return false;
default:
this._terminal.writeVerboseLine(
'NPM response:\n' + JSON.stringify(jsonOutput, undefined, 2) + '\n\n'
);
throw new Error(`The "npm view" command returned an unexpected error code "${errorCode}"`);
}
}
/**
* Test whether the NPM token is valid. If not, prompt to update it.
*/
public async checkAndSetup(): Promise<void> {
if (await this.checkOnly()) {
return;
}
this._terminal.writeWarningLine('NPM credentials are missing or expired');
this._terminal.writeLine();
const packageRegistry: IArtifactoryPackageRegistryJson =
this._artifactoryConfiguration.configuration.packageRegistry;
const fixThisProblem: boolean = await TerminalInput.promptYesNo({
message: 'Fix this problem now?',
defaultValue: false
});
this._terminal.writeLine();
if (!fixThisProblem) {
return;
}
this._writeInstructionBlock(this._messages.introduction);
const hasArtifactoryAccount: boolean = await TerminalInput.promptYesNo({
message: 'Do you already have an Artifactory user account?'
});
this._terminal.writeLine();
if (!hasArtifactoryAccount) {
this._writeInstructionBlock(this._messages.obtainAnAccount);
throw new AlreadyReportedError();
}
if (this._messages.visitWebsite) {
this._writeInstructionBlock(this._messages.visitWebsite);
const artifactoryWebsiteUrl: string =
this._artifactoryConfiguration.configuration.packageRegistry.artifactoryWebsiteUrl;
if (artifactoryWebsiteUrl) {
this._terminal.writeLine(' ', Colors.cyan(artifactoryWebsiteUrl));
this._terminal.writeLine();
}
}
this._writeInstructionBlock(this._messages.locateUserName);
let artifactoryUser: string = await TerminalInput.promptLine({
message: 'What is your Artifactory user name?'
});
this._terminal.writeLine();
artifactoryUser = artifactoryUser.trim();
if (artifactoryUser.length === 0) {
this._terminal.writeLine(Colors.red('Operation aborted because the input was empty'));
this._terminal.writeLine();
throw new AlreadyReportedError();
}
this._writeInstructionBlock(this._messages.locateApiKey);
let artifactoryKey: string = await TerminalInput.promptPasswordLine({
message: 'What is your Artifactory API key?'
});
this._terminal.writeLine();
artifactoryKey = artifactoryKey.trim();
if (artifactoryKey.length === 0) {
this._terminal.writeLine(Colors.red('Operation aborted because the input was empty'));
this._terminal.writeLine();
throw new AlreadyReportedError();
}
await this._fetchTokenAndUpdateNpmrc(artifactoryUser, artifactoryKey, packageRegistry);
}
/**
* Fetch a valid NPM token from the Artifactory service and add it to the `~/.npmrc` file,
* preserving other settings in that file.
*/
private async _fetchTokenAndUpdateNpmrc(
artifactoryUser: string,
artifactoryKey: string,
packageRegistry: IArtifactoryPackageRegistryJson
): Promise<void> {
this._terminal.writeLine('\nFetching an NPM token from the Artifactory service...');
const webClient: WebClient = new WebClient();
webClient.addBasicAuthHeader(artifactoryUser, artifactoryKey);
let queryUrl: string = packageRegistry.registryUrl;
if (!queryUrl.endsWith('/')) {
queryUrl += '/';
}
// There doesn't seem to be a way to invoke the "/auth" REST endpoint without a resource name.
// Artifactory's NPM folders always seem to contain a ".npm" folder, so we can use that to obtain
// our token.
queryUrl += `auth/.npm`;
let response: WebClientResponse;
try {
response = await webClient.fetchAsync(queryUrl);
} catch (e) {
console.log(e.toString());
return;
}
if (!response.ok) {
if (response.status === 401) {
throw new Error('Authorization failed; the Artifactory user name or API key may be incorrect.');
}
throw new Error(`The Artifactory request failed:\n (${response.status}) ${response.statusText}`);
}
// We expect a response like this:
//
// @.npm:registry=https://your-company.jfrog.io/your-artifacts/api/npm/npm-private/
// //your-company.jfrog.io/your-artifacts/api/npm/npm-private/:_password=dGhlIHRva2VuIGdvZXMgaGVyZQ==
// //your-company.jfrog.io/your-artifacts/api/npm/npm-private/:username=your.name@your-company.com
// //your-company.jfrog.io/your-artifacts/api/npm/npm-private/:email=your.name@your-company.com
// //your-company.jfrog.io/your-artifacts/api/npm/npm-private/:always-auth=true
const responseText: string = await response.text();
const responseLines: string[] = Text.convertToLf(responseText).trim().split('\n');
if (responseLines.length < 2 || !responseLines[0].startsWith('@.npm:')) {
throw new Error('Unexpected response from Artifactory');
}
responseLines.shift(); // Remove the @.npm line
// These are the lines to be injected in ~/.npmrc
const linesToAdd: string[] = [];
// Start with userNpmrcLinesToAdd...
if (packageRegistry.userNpmrcLinesToAdd) {
linesToAdd.push(...packageRegistry.userNpmrcLinesToAdd);
}
// ...then append the stuff we got from the REST API, but discard any junk that isn't a proper key/value
linesToAdd.push(...responseLines.filter((x) => SetupPackageRegistry._getNpmrcKey(x) !== undefined));
const npmrcPath: string = path.join(Utilities.getHomeFolder(), '.npmrc');
this._mergeLinesIntoNpmrc(npmrcPath, linesToAdd);
}
/**
* Update the `~/.npmrc` file by adding `linesToAdd` to it.
* @remarks
*
* If the `.npmrc` file has existing content, it gets merged as follows:
* - If `linesToAdd` contains key/value pairs and the key already appears in .npmrc,
* that line will be overwritten in place
* - If `linesToAdd` contains non-key lines (e.g. a comment) and it exactly matches a
* line in .npmrc, then that line will be kept where it is
* - The remaining `linesToAdd` that weren't handled by one of the two rules above
* are simply appended to the end of the file
* - Under no circumstances is a duplicate key/value added to the file; in the case of
* duplicates, the earliest line in `linesToAdd` takes precedence
*/
private _mergeLinesIntoNpmrc(npmrcPath: string, linesToAdd: readonly string[]): void {
// We'll replace entries with "undefined" if they get discarded
const workingLinesToAdd: (string | undefined)[] = [...linesToAdd];
// Now build a table of .npmrc keys that can be replaced if they already exist in the file.
// For example, if we are adding "always-auth=false" then we should delete an existing line
// that says "always-auth=true".
const keysToReplace: Map<string, number> = new Map(); // key --> linesToAdd index
for (let index: number = 0; index < workingLinesToAdd.length; ++index) {
const lineToAdd: string = workingLinesToAdd[index]!;
const key: string | undefined = SetupPackageRegistry._getNpmrcKey(lineToAdd);
if (key !== undefined) {
// If there are duplicate keys, the first one takes precedence.
// In particular this means "userNpmrcLinesToAdd" takes precedence over the REST API response
if (keysToReplace.has(key)) {
// Discard the duplicate key
workingLinesToAdd[index] = undefined;
} else {
keysToReplace.set(key, index);
}
}
}
this._terminal.writeLine();
this._terminal.writeLine(Colors.green('Adding Artifactory token to: '), npmrcPath);
const npmrcLines: string[] = [];
if (FileSystem.exists(npmrcPath)) {
const npmrcContent: string = FileSystem.readFile(npmrcPath, { convertLineEndings: NewlineKind.Lf });
npmrcLines.push(...npmrcContent.trimRight().split('\n'));
}
if (npmrcLines.length === 1 && npmrcLines[0] === '') {
// Edge case where split() adds a blank line to the start of the file
npmrcLines.length = 0;
}
// Make a set of existing .npmrc lines that are not key/value pairs.
const npmrcNonKeyLinesSet: Set<string> = new Set();
for (const npmrcLine of npmrcLines) {
const trimmed: string = npmrcLine.trim();
if (trimmed.length > 0) {
if (SetupPackageRegistry._getNpmrcKey(trimmed) === undefined) {
npmrcNonKeyLinesSet.add(trimmed);
}
}
}
// Overwrite any existing lines that match a key from "linesToAdd"
for (let index: number = 0; index < npmrcLines.length; ++index) {
const line: string = npmrcLines[index];
const key: string | undefined = SetupPackageRegistry._getNpmrcKey(line);
if (key) {
const linesToAddIndex: number | undefined = keysToReplace.get(key);
if (linesToAddIndex !== undefined) {
npmrcLines[index] = workingLinesToAdd[linesToAddIndex] || '';
// Delete it since it's been replaced
keysToReplace.delete(key);
// Also remove it from "linesToAdd"
workingLinesToAdd[linesToAddIndex] = undefined;
}
}
}
if (npmrcLines.length > 0 && npmrcLines[npmrcLines.length - 1] !== '') {
// Append a blank line
npmrcLines.push('');
}
// Add any remaining values that weren't matched above
for (const lineToAdd of workingLinesToAdd) {
// If a line is undefined, that means we already used it to replace an existing line above
if (lineToAdd !== undefined) {
// If a line belongs to npmrcNonKeyLinesSet, then we should not add it because it's
// already in the .npmrc file
if (!npmrcNonKeyLinesSet.has(lineToAdd.trim())) {
npmrcLines.push(lineToAdd);
}
}
}
// Save the result
FileSystem.writeFile(npmrcPath, npmrcLines.join('\n').trimRight() + '\n');
}
private static _getNpmrcKey(npmrcLine: string): string | undefined {
if (SetupPackageRegistry._isCommentLine(npmrcLine)) {
return undefined;
}
const delimiterIndex: number = npmrcLine.indexOf('=');
if (delimiterIndex < 1) {
return undefined;
}
const key: string = npmrcLine.substring(0, delimiterIndex + 1);
return key.trim();
}
private static _isCommentLine(npmrcLine: string): boolean {
return /^\s*#/.test(npmrcLine);
}
/**
* This is a workaround for https://github.com/npm/cli/issues/2740 where the NPM tool sometimes
* mixes together JSON and terminal messages in a single STDERR stream.
*
* @remarks
* Given an input like this:
* ```
* npm ERR! 404 Note that you can also install from a
* npm ERR! 404 tarball, folder, http url, or git url.
* {
* "error": {
* "code": "E404",
* "summary": "Not Found - GET https://registry.npmjs.org/@rushstack%2fnonexistent-package - Not found"
* }
* }
* npm ERR! A complete log of this run can be found in:
* ```
*
* @returns the JSON section, or `undefined` if a JSON object could not be detected
*/
private static _tryFindJson(dirtyOutput: string): string | undefined {
const lines: string[] = dirtyOutput.split(/\r?\n/g);
let startIndex: number | undefined;
let endIndex: number | undefined;
// Find the first line that starts with "{"
for (let i: number = 0; i < lines.length; ++i) {
const line: string = lines[i];
if (/^\s*\{/.test(line)) {
startIndex = i;
break;
}
}
if (startIndex === undefined) {
return undefined;
}
// Find the last line that ends with "}"
for (let i: number = lines.length - 1; i >= startIndex; --i) {
const line: string = lines[i];
if (/\}\s*$/.test(line)) {
endIndex = i;
break;
}
}
if (endIndex === undefined) {
return undefined;
}
return lines.slice(startIndex, endIndex + 1).join('\n');
}
}