Skip to content
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.

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

[rush] Fix issue where "rush update-autoinstaller" doesn't perform a full upgrade #4300

Merged
merged 8 commits into from
Aug 30, 2023
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"changes": [
{
"packageName": "@microsoft/rush",
"comment": "Fix an issue where `rush update-autoinstaller` sometimes did not fully upgrade the lockfile",
"type": "none"
}
],
"packageName": "@microsoft/rush"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"changes": [
{
"packageName": "@microsoft/rush",
"comment": "Fix an issue where \"undefined\" was sometimes printed instead of a blank line",
"type": "none"
}
],
"packageName": "@microsoft/rush"
}
26 changes: 20 additions & 6 deletions libraries/rush-lib/src/logic/Autoinstaller.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ import type { RushGlobalFolder } from '../api/RushGlobalFolder';
import { RushConstants } from './RushConstants';
import { LastInstallFlag } from '../api/LastInstallFlag';
import { RushCommandLineParser } from '../cli/RushCommandLineParser';
import { PnpmPackageManager } from '../api/packageManager/PnpmPackageManager';

interface IAutoinstallerOptions {
autoinstallerName: string;
Expand Down Expand Up @@ -167,7 +168,7 @@ export class Autoinstaller {

const autoinstallerPackageJsonPath: string = path.join(this.folderFullPath, 'package.json');

if (!FileSystem.exists(autoinstallerPackageJsonPath)) {
if (!(await FileSystem.existsAsync(autoinstallerPackageJsonPath))) {
throw new Error(`The specified autoinstaller path does not exist: ` + autoinstallerPackageJsonPath);
}

Expand All @@ -177,10 +178,23 @@ export class Autoinstaller {

let oldFileContents: string = '';

if (FileSystem.exists(this.shrinkwrapFilePath)) {
if (await FileSystem.existsAsync(this.shrinkwrapFilePath)) {
oldFileContents = FileSystem.readFile(this.shrinkwrapFilePath, { convertLineEndings: NewlineKind.Lf });
this._logIfConsoleOutputIsNotRestricted('Deleting ' + this.shrinkwrapFilePath);
FileSystem.deleteFile(this.shrinkwrapFilePath);
await FileSystem.deleteFileAsync(this.shrinkwrapFilePath);
if (this._rushConfiguration.packageManager === 'pnpm') {
// Workaround for https://github.com/pnpm/pnpm/issues/1890
//
// When "rush update-autoinstaller" is run, Rush deletes "common/autoinstallers/my-task/pnpm-lock.yaml"
// so that a new lockfile will be generated. However "pnpm install" by design will try to recover
// "pnpm-lock.yaml" from "my-task/node_modules/.pnpm/lock.yaml", which may prevent a full upgrade.
// Deleting both files ensures that a new lockfile will always be generated.
iclanton marked this conversation as resolved.
Show resolved Hide resolved
const pnpmPackageManager: PnpmPackageManager = this._rushConfiguration
.packageManagerWrapper as PnpmPackageManager;
await FileSystem.deleteFileAsync(
path.join(this.folderFullPath, pnpmPackageManager.internalShrinkwrapRelativePath)
);
}
}

// Detect a common mistake where PNPM prints "Already up-to-date" without creating a shrinkwrap file
Expand Down Expand Up @@ -218,13 +232,13 @@ export class Autoinstaller {
this._logIfConsoleOutputIsNotRestricted();
}

if (!FileSystem.exists(this.shrinkwrapFilePath)) {
if (!(await FileSystem.existsAsync(this.shrinkwrapFilePath))) {
throw new Error(
'The package manager did not create the expected shrinkwrap file: ' + this.shrinkwrapFilePath
);
}

const newFileContents: string = FileSystem.readFile(this.shrinkwrapFilePath, {
const newFileContents: string = await FileSystem.readFileAsync(this.shrinkwrapFilePath, {
convertLineEndings: NewlineKind.Lf
});
if (oldFileContents !== newFileContents) {
Expand All @@ -239,7 +253,7 @@ export class Autoinstaller {

private _logIfConsoleOutputIsNotRestricted(message?: string): void {
if (!this._restrictConsoleOutput) {
console.log(message);
console.log(message ?? '');
}
}
}
10 changes: 4 additions & 6 deletions libraries/rush-lib/src/logic/base/BaseInstallManager.ts
Original file line number Diff line number Diff line change
Expand Up @@ -755,12 +755,10 @@ ${gitLfsHookHandling}
if (this.rushConfiguration.packageManager === 'pnpm') {
// Workaround for https://github.com/pnpm/pnpm/issues/1890
//
// When "rush update --full" is run, rush deletes common/temp/pnpm-lock.yaml so that
// a new lockfile can be generated. But because of the above bug "pnpm install" would
// respect "common/temp/node_modules/.pnpm-lock.yaml" and thus would not generate a
// new lockfile. Deleting this file in addition to deleting common/temp/pnpm-lock.yaml
// ensures that a new lockfile will be generated with "rush update --full".

// When "rush update --full" is run, Rush deletes "common/temp/pnpm-lock.yaml"
// so that a new lockfile will be generated. However "pnpm install" by design will try to recover
// "pnpm-lock.yaml" from "common/temp/node_modules/.pnpm/lock.yaml", which may prevent a full upgrade.
// Deleting both files ensures that a new lockfile will always be generated.
const pnpmPackageManager: PnpmPackageManager = this.rushConfiguration
.packageManagerWrapper as PnpmPackageManager;

Expand Down