Skip to content

feat: yarn2+ support #5701

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

Merged
merged 7 commits into from
Mar 25, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
9 changes: 7 additions & 2 deletions lib/base-package-manager.ts
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ export abstract class BasePackageManager implements INodePackageManager {
protected getFlagsString(config: any, asArray: boolean): any {
const array: Array<string> = [];
for (const flag in config) {
if (flag === "global" && this.packageManager !== "yarn") {
if (flag === "global" && this.packageManager !== "yarn" && this.packageManager !== "yarn2") {
array.push(`--${flag}`);
array.push(`${config[flag]}`);
} else if (config[flag]) {
Expand All @@ -141,7 +141,12 @@ export abstract class BasePackageManager implements INodePackageManager {
flag === "gradle" ||
flag === "version_info"
) {
array.push(` ${flag}`);
if (this.packageManager === "yarn2") {
array.push(`--fields ${flag}`);
} else {
array.push(` ${flag}`);

}
continue;
}
array.push(`--${flag}`);
Expand Down
1 change: 1 addition & 0 deletions lib/bootstrap.ts
Original file line number Diff line number Diff line change
Expand Up @@ -219,6 +219,7 @@ injector.requireCommand("setup|*", "./commands/setup");
injector.requirePublic("packageManager", "./package-manager");
injector.requirePublic("npm", "./node-package-manager");
injector.requirePublic("yarn", "./yarn-package-manager");
injector.requirePublic("yarn2", "./yarn2-package-manager");
injector.requirePublic("pnpm", "./pnpm-package-manager");
injector.requireCommand(
"package-manager|*get",
Expand Down
1 change: 1 addition & 0 deletions lib/commands/preview.ts
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ export class PreviewCommand implements ICommand {
installCommand = "npm install --save-dev @nativescript/preview-cli";
break;
case PackageManagers.yarn:
case PackageManagers.yarn2:
installCommand = "yarn add -D @nativescript/preview-cli";
break;
case PackageManagers.pnpm:
Expand Down
1 change: 1 addition & 0 deletions lib/common/dispatchers.ts
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,7 @@ export class CommandDispatcher implements ICommandDispatcher {
updateCommand = "npm i -g nativescript";
break;
case PackageManagers.yarn:
case PackageManagers.yarn2:
updateCommand = "yarn global add nativescript";
break;
case PackageManagers.pnpm:
Expand Down
1 change: 1 addition & 0 deletions lib/constants.ts
Original file line number Diff line number Diff line change
Expand Up @@ -493,4 +493,5 @@ export enum PackageManagers {
npm = "npm",
pnpm = "pnpm",
yarn = "yarn",
yarn2 = "yarn2",
}
1 change: 1 addition & 0 deletions lib/declarations.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -663,6 +663,7 @@ interface IOptions
frameworkName: string;
frameworkVersion: string;
yarn: string;
yarn2: string;
pnpm: string;
ipa: string;
tsc: boolean;
Expand Down
1 change: 1 addition & 0 deletions lib/options.ts
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,7 @@ export class Options {
ts: { type: OptionType.Boolean, hasSensitiveValue: false },
typescript: { type: OptionType.Boolean, hasSensitiveValue: false },
yarn: { type: OptionType.Boolean, hasSensitiveValue: false },
yarn2: { type: OptionType.Boolean, hasSensitiveValue: false },
pnpm: { type: OptionType.Boolean, hasSensitiveValue: false },
androidTypings: { type: OptionType.Boolean, hasSensitiveValue: false },
bundle: { type: OptionType.String, hasSensitiveValue: false },
Expand Down
5 changes: 3 additions & 2 deletions lib/package-installation-manager.ts
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ export class PackageInstallationManager implements IPackageInstallationManager {
versions: true,
});

return semver.maxSatisfying(data, versionRange);
return semver.maxSatisfying(data?.versions ?? data, versionRange);
}

public async getMaxSatisfyingVersionSafe(
Expand Down Expand Up @@ -320,9 +320,10 @@ export class PackageInstallationManager implements IPackageInstallationManager {
packageName: string,
version: string
): Promise<string> {
const data: any = await this.$packageManager.view(packageName, {
let data: any = await this.$packageManager.view(packageName, {
"dist-tags": true,
});
data = data?.["dist-tags"] ?? data;
this.$logger.trace("Using version %s. ", data[version]);

return data[version];
Expand Down
4 changes: 4 additions & 0 deletions lib/package-manager.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ export class PackageManager implements IPackageManager {
private $npm: INodePackageManager,
private $options: IOptions,
private $yarn: INodePackageManager,
private $yarn2: INodePackageManager,
private $pnpm: INodePackageManager,
private $logger: ILogger,
private $userSettingsService: IUserSettingsService,
Expand Down Expand Up @@ -164,6 +165,9 @@ export class PackageManager implements IPackageManager {
if (pm === PackageManagers.yarn || this.$options.yarn) {
this._packageManagerName = PackageManagers.yarn;
return this.$yarn;
} if (pm === PackageManagers.yarn2 || this.$options.yarn2) {
this._packageManagerName = PackageManagers.yarn2;
return this.$yarn2;
} else if (pm === PackageManagers.pnpm || this.$options.pnpm) {
this._packageManagerName = PackageManagers.pnpm;
return this.$pnpm;
Expand Down
11 changes: 8 additions & 3 deletions lib/services/android-plugin-build-service.ts
Original file line number Diff line number Diff line change
Expand Up @@ -375,7 +375,7 @@ export class AndroidPluginBuildService implements IAndroidPluginBuildService {
const allGradleTemplateFiles = path.join(gradleTemplatePath, "*");
const buildGradlePath = path.join(pluginTempDir, "build.gradle");
const settingsGradlePath = path.join(pluginTempDir, "settings.gradle");

this.$fs.copyFile(allGradleTemplateFiles, pluginTempDir);
const runtimeGradleVersions = await this.getRuntimeGradleVersions(
projectDir
Expand Down Expand Up @@ -430,12 +430,13 @@ export class AndroidPluginBuildService implements IAndroidPluginBuildService {
let runtimeVersion: string = null;

try {
const result = await this.$packageManager.view(
let result = await this.$packageManager.view(
SCOPED_ANDROID_RUNTIME_NAME,
{
"dist-tags": true,
}
);
result = result?.["dist-tags"] ?? result;
runtimeVersion = result.latest;
} catch (err) {
this.$logger.trace(
Expand Down Expand Up @@ -529,6 +530,7 @@ export class AndroidPluginBuildService implements IAndroidPluginBuildService {
`${SCOPED_ANDROID_RUNTIME_NAME}@${runtimeVersion}`,
{ version_info: true }
);
output = output?.["version_info"] ?? output;

if (!output) {
/**
Expand All @@ -543,6 +545,7 @@ export class AndroidPluginBuildService implements IAndroidPluginBuildService {
`${SCOPED_ANDROID_RUNTIME_NAME}@${runtimeVersion}`,
{ gradle: true }
);
output = output?.["gradle"] ?? output;

const { version, android } = output;

Expand Down Expand Up @@ -709,7 +712,9 @@ export class AndroidPluginBuildService implements IAndroidPluginBuildService {
projectDir: pluginBuildSettings.projectDir,
});
pluginBuildSettings.androidToolsInfo = this.$androidToolsInfo.getToolsInfo(
{ projectDir: pluginBuildSettings.projectDir }
{
projectDir: pluginBuildSettings.projectDir,
}
);
}

Expand Down
14 changes: 7 additions & 7 deletions lib/services/pacote-service.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,8 @@ export class PacoteService implements IPacoteService {
options?: IPacoteManifestOptions
): Promise<any> {
this.$logger.trace(
`Calling pacoteService.manifest for packageName: '${packageName}' and options: ${options}`
`Calling pacoteService.manifest for packageName: '${packageName}' and options: `,
options
);
const manifestOptions: IPacoteBaseOptions = await this.getPacoteBaseOptions();

Expand All @@ -39,13 +40,12 @@ export class PacoteService implements IPacoteService {

packageName = this.getRealPackageName(packageName);
this.$logger.trace(
`Calling pacote.manifest for packageName: ${packageName} and options: ${JSON.stringify(
manifestOptions,
null,
2
)}`
`Calling pacote.manifest for packageName: ${packageName} and manifestOptions:`,
manifestOptions
);
const result = pacote.manifest(packageName, manifestOptions);
const result = await pacote.manifest(packageName, manifestOptions);

this.$logger.trace("pacote.manifest result:", result);

return result;
}
Expand Down
168 changes: 168 additions & 0 deletions lib/yarn2-package-manager.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,168 @@
import * as path from "path";
import * as _ from "lodash";
import { BasePackageManager } from "./base-package-manager";
import { exported } from "./common/decorators";
import {
INodePackageManagerInstallOptions,
INpmInstallResultInfo,
INpmsResult,
} from "./declarations";
import {
IChildProcess,
IErrors,
IFileSystem,
IHostInfo,
Server,
IDictionary,
} from "./common/declarations";
import { injector } from "./common/yok";

export class Yarn2PackageManager extends BasePackageManager {
private $hostInfo_: IHostInfo;
constructor(
$childProcess: IChildProcess,
private $errors: IErrors,
$fs: IFileSystem,
$hostInfo: IHostInfo,
private $httpClient: Server.IHttpClient,
private $logger: ILogger,
$pacoteService: IPacoteService
) {
super($childProcess, $fs, $hostInfo, $pacoteService, "yarn2");
this.$hostInfo_ = $hostInfo;
}

protected getPackageManagerExecutableName(): string {
let executableName = "yarn";

if (this.$hostInfo_.isWindows) {
executableName += ".cmd";
}

return executableName;
}

@exported("yarn2")
public async install(
packageName: string,
pathToSave: string,
config: INodePackageManagerInstallOptions
): Promise<INpmInstallResultInfo> {
if (config.disableNpmInstall) {
return;
}
if (config.ignoreScripts) {
config["ignore-scripts"] = true;
}

const packageJsonPath = path.join(pathToSave, "package.json");
const jsonContentBefore = this.$fs.readJson(packageJsonPath);

// remove unsupported flags
// todo: refactor all package managers to map typed flags to the actual flags
const cleanedConfig = _.omit(config, ["save-dev", "save-exact"]);

const flags = this.getFlagsString(cleanedConfig, true);
let params = [];
const isInstallingAllDependencies = packageName === pathToSave;
if (!isInstallingAllDependencies) {
params.push("add", packageName);
}

params = params.concat(flags);
const cwd = pathToSave;

try {
const result = await this.processPackageManagerInstall(
packageName,
params,
{ cwd, isInstallingAllDependencies }
);
return result;
} catch (e) {
this.$fs.writeJson(packageJsonPath, jsonContentBefore);
throw e;
}
}

@exported("yarn2")
public uninstall(
packageName: string,
config?: IDictionary<string | boolean>,
cwd?: string
): Promise<string> {
const flags = this.getFlagsString(config, false);
return this.$childProcess.exec(`yarn remove ${packageName} ${flags}`, {
cwd,
});
}

@exported("yarn2")
public async view(packageName: string, config: Object): Promise<any> {
const wrappedConfig = _.extend({}, config, { json: true });

const flags = this.getFlagsString(wrappedConfig, false);
let viewResult: any;
try {
viewResult = await this.$childProcess.exec(
`yarn npm info ${packageName} ${flags}`
);
} catch (e) {
this.$errors.fail(e.message);
}

try {
return JSON.parse(viewResult);
} catch (err) {
this.$errors.fail(err.message);
return null;
}
}

@exported("yarn2")
public search(
filter: string[],
config: IDictionary<string | boolean>
): Promise<string> {
this.$errors.fail(
"Method not implemented. Yarn does not support searching for packages in the registry."
);
return null;
}

public async searchNpms(keyword: string): Promise<INpmsResult> {
const httpRequestResult = await this.$httpClient.httpRequest(
`https://api.npms.io/v2/search?q=keywords:${keyword}`
);
const result: INpmsResult = JSON.parse(httpRequestResult.body);
return result;
}

@exported("yarn2")
public async getRegistryPackageData(packageName: string): Promise<any> {
const registry = await this.$childProcess.exec(
`yarn config get npmRegistryServer`
);
const url = `${registry.trim()}/${packageName}`;
this.$logger.trace(
`Trying to get data from yarn registry for package ${packageName}, url is: ${url}`
);
const responseData = (await this.$httpClient.httpRequest(url)).body;
this.$logger.trace(
`Successfully received data from yarn registry for package ${packageName}. Response data is: ${responseData}`
);
const jsonData = JSON.parse(responseData);
this.$logger.trace(
`Successfully parsed data from yarn registry for package ${packageName}.`
);
return jsonData;
}

@exported("yarn2")
public async getCachePath(): Promise<string> {
const result = await this.$childProcess.exec(`yarn config get cacheFolder`);
return result.toString().trim();
}
}

injector.register("yarn2", Yarn2PackageManager);
2 changes: 2 additions & 0 deletions test/controllers/add-platform-controller.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import { AddPlaformErrors } from "../../lib/constants";
import { PackageManager } from "../../lib/package-manager";
import { NodePackageManager } from "../../lib/node-package-manager";
import { YarnPackageManager } from "../../lib/yarn-package-manager";
import { Yarn2PackageManager } from "../../lib/yarn2-package-manager";
import { PnpmPackageManager } from "../../lib/pnpm-package-manager";
import { MobileHelper } from "../../lib/common/mobile/mobile-helper";

Expand All @@ -29,6 +30,7 @@ function createInjector(data?: { latestFrameworkVersion: string }) {
injector.register("packageManager", PackageManager);
injector.register("npm", NodePackageManager);
injector.register("yarn", YarnPackageManager);
injector.register("yarn2", Yarn2PackageManager);
injector.register("pnpm", PnpmPackageManager);
injector.register("userSettingsService", {
getSettingValue: async (settingName: string): Promise<void> => undefined,
Expand Down
2 changes: 2 additions & 0 deletions test/package-installation-manager.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import * as HostInfoLib from "../lib/common/host-info";
import * as LoggerLib from "../lib/common/logger/logger";
import * as NpmLib from "../lib/node-package-manager";
import * as YarnLib from "../lib/yarn-package-manager";
import * as Yarn2Lib from "../lib/yarn2-package-manager";
import * as PnpmLib from "../lib/pnpm-package-manager";
import * as PackageManagerLib from "../lib/package-manager";
import * as PackageInstallationManagerLib from "../lib/package-installation-manager";
Expand Down Expand Up @@ -46,6 +47,7 @@ function createTestInjector(): IInjector {
});
testInjector.register("npm", NpmLib.NodePackageManager);
testInjector.register("yarn", YarnLib.YarnPackageManager);
testInjector.register("yarn2", Yarn2Lib.Yarn2PackageManager);
testInjector.register("pnpm", PnpmLib.PnpmPackageManager);
testInjector.register("packageManager", PackageManagerLib.PackageManager);
testInjector.register("projectConfigService", ProjectConfigServiceStub);
Expand Down
Loading