Skip to content

feat: allow tag and range versions in the preview app plugin versions validation #5104

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

Merged
merged 1 commit into from
Oct 30, 2019
Merged

feat: allow tag and range versions in the preview app plugin versions validation #5104

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
4 changes: 2 additions & 2 deletions lib/definitions/preview-app-livesync.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ declare global {
interface IGetQrCodeUrlOptions extends IHasUseHotModuleReloadOption, IProjectDir { }

interface IPreviewAppPluginsService {
getPluginsUsageWarnings(data: IPreviewAppLiveSyncData, device: Device): string[];
getPluginsUsageWarnings(data: IPreviewAppLiveSyncData, device: Device): Promise<string[]>;
comparePluginsOnDevice(data: IPreviewAppLiveSyncData, device: Device): Promise<void>;
getExternalPlugins(device: Device): string[];
}
Expand Down Expand Up @@ -56,7 +56,7 @@ declare global {
updateConnectedDevices(devices: Device[]): void;
getDeviceById(id: string): Device;
getDevicesForPlatform(platform: string): Device[];
getPluginsUsageWarnings(data: IPreviewAppLiveSyncData, device: Device): string[];
getPluginsUsageWarnings(data: IPreviewAppLiveSyncData, device: Device): Promise<string[]>;
}

interface IPreviewSchemaService {
Expand Down
2 changes: 1 addition & 1 deletion lib/services/livesync/playground/devices/preview-devices-service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ export class PreviewDevicesService extends EventEmitter implements IPreviewDevic
return _.filter(this.connectedDevices, { platform: platform.toLowerCase() });
}

public getPluginsUsageWarnings(data: IPreviewAppLiveSyncData, device: Device): string[] {
public getPluginsUsageWarnings(data: IPreviewAppLiveSyncData, device: Device): Promise<string[]> {
return this.$previewAppPluginsService.getPluginsUsageWarnings(data, device);
}

Expand Down
50 changes: 30 additions & 20 deletions lib/services/livesync/playground/preview-app-plugins-service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,10 @@ export class PreviewAppPluginsService implements IPreviewAppPluginsService {
constructor(private $errors: IErrors,
private $fs: IFileSystem,
private $logger: ILogger,
private $packageInstallationManager: IPackageInstallationManager,
private $pluginsService: IPluginsService) { }

public getPluginsUsageWarnings(data: IPreviewAppLiveSyncData, device: Device): string[] {
public async getPluginsUsageWarnings(data: IPreviewAppLiveSyncData, device: Device): Promise<string[]> {
if (!device) {
this.$errors.fail("No device provided.");
}
Expand All @@ -23,19 +24,21 @@ export class PreviewAppPluginsService implements IPreviewAppPluginsService {

const devicePlugins = this.getDevicePlugins(device);
const localPlugins = this.getLocalPlugins(data.projectDir);
const warnings = _.keys(localPlugins)
.map(localPlugin => {
const localPluginVersion = localPlugins[localPlugin];
const devicePluginVersion = devicePlugins[localPlugin];
return this.getWarningForPlugin(data, localPlugin, localPluginVersion, devicePluginVersion, device);
})
.filter(item => !!item);
const warnings: string[] = [];
for (const pluginName in localPlugins) {
const localPluginVersion = localPlugins[pluginName];
const devicePluginVersion = devicePlugins[pluginName];
const pluginWarnings = await this.getWarningForPlugin(data, pluginName, localPluginVersion, devicePluginVersion, device);
if (pluginWarnings) {
warnings.push(pluginWarnings);
}
}

return warnings;
}

public async comparePluginsOnDevice(data: IPreviewAppLiveSyncData, device: Device): Promise<void> {
const warnings = this.getPluginsUsageWarnings(data, device);
const warnings = await this.getPluginsUsageWarnings(data, device);
_.map(warnings, warning => this.$logger.warn(warning));
}

Expand Down Expand Up @@ -69,33 +72,40 @@ export class PreviewAppPluginsService implements IPreviewAppPluginsService {
}
}

private getWarningForPlugin(data: IPreviewAppLiveSyncData, localPlugin: string, localPluginVersion: string, devicePluginVersion: string, device: Device): string {
private async getWarningForPlugin(data: IPreviewAppLiveSyncData, localPlugin: string, localPluginVersion: string, devicePluginVersion: string, device: Device): Promise<string> {
const pluginPackageJsonPath = path.join(data.projectDir, NODE_MODULES_DIR_NAME, localPlugin, PACKAGE_JSON_FILE_NAME);
const isNativeScriptPlugin = this.$pluginsService.isNativeScriptPlugin(pluginPackageJsonPath);
const shouldCompare = isNativeScriptPlugin && this.hasNativeCode(localPlugin, device.platform, data.projectDir);
let warning = null;
if (shouldCompare) {
warning = await this.getWarningForPluginCore(localPlugin, localPluginVersion, devicePluginVersion, device.id);
}

return shouldCompare ? this.getWarningForPluginCore(localPlugin, localPluginVersion, devicePluginVersion, device.id) : null;
return warning;
}

private getWarningForPluginCore(localPlugin: string, localPluginVersion: string, devicePluginVersion: string, deviceId: string): string {
this.$logger.trace(`Comparing plugin ${localPlugin} with localPluginVersion ${localPluginVersion} and devicePluginVersion ${devicePluginVersion}`);
private async getWarningForPluginCore(pluginName: string, localPluginVersion: string, devicePluginVersion: string, deviceId: string): Promise<string> {
this.$logger.trace(`Comparing plugin ${pluginName} with localPluginVersion ${localPluginVersion} and devicePluginVersion ${devicePluginVersion}`);

if (!devicePluginVersion) {
return util.format(PluginComparisonMessages.PLUGIN_NOT_INCLUDED_IN_PREVIEW_APP, localPlugin, deviceId);
return util.format(PluginComparisonMessages.PLUGIN_NOT_INCLUDED_IN_PREVIEW_APP, pluginName, deviceId);
}

const shouldSkipCheck = !semver.valid(localPluginVersion) && !semver.validRange(localPluginVersion);
if (shouldSkipCheck) {
return null;
}

const localPluginVersionData = semver.coerce(localPluginVersion);
const devicePluginVersionData = semver.coerce(devicePluginVersion);
const localPluginVersionData = await this.$packageInstallationManager.getMaxSatisfyingVersionSafe(pluginName, localPluginVersion);
const devicePluginVersionData = await this.$packageInstallationManager.getMaxSatisfyingVersionSafe(pluginName, devicePluginVersion);

if (semver.valid(localPluginVersionData) && semver.valid(devicePluginVersionData)) {
if (semver.major(localPluginVersionData) !== semver.major(devicePluginVersionData)) {
return util.format(PluginComparisonMessages.LOCAL_PLUGIN_WITH_DIFFERENCE_IN_MAJOR_VERSION, pluginName, localPluginVersion, devicePluginVersion);
} else if (semver.minor(localPluginVersionData) > semver.minor(devicePluginVersionData)) {
return util.format(PluginComparisonMessages.LOCAL_PLUGIN_WITH_GREATHER_MINOR_VERSION, pluginName, localPluginVersion, devicePluginVersion);
}

if (localPluginVersionData.major !== devicePluginVersionData.major) {
return util.format(PluginComparisonMessages.LOCAL_PLUGIN_WITH_DIFFERENCE_IN_MAJOR_VERSION, localPlugin, localPluginVersion, devicePluginVersion);
} else if (localPluginVersionData.minor > devicePluginVersionData.minor) {
return util.format(PluginComparisonMessages.LOCAL_PLUGIN_WITH_GREATHER_MINOR_VERSION, localPlugin, localPluginVersion, devicePluginVersion);
}

return null;
Expand Down
8 changes: 5 additions & 3 deletions test/services/playground/preview-app-plugins-service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ import { Device } from "nativescript-preview-sdk";
import { assert } from "chai";
import * as util from "util";
import { PluginComparisonMessages } from "../../../lib/services/livesync/playground/preview-app-constants";
import { ErrorsStub } from "../../stubs";
import { ErrorsStub, PackageInstallationManagerStub } from "../../stubs";

let readJsonParams: string[] = [];
let warnParams: string[] = [];

const deviceId = "myTestDeviceId";
const projectDir = "testProjectDir";
const projectDir = "testProjectDir";

function createTestInjector(localPlugins: IStringDictionary, options?: { isNativeScriptPlugin?: boolean, hasPluginNativeCode?: boolean }): IInjector {
options = options || {};
Expand Down Expand Up @@ -42,8 +42,10 @@ function createTestInjector(localPlugins: IStringDictionary, options?: { isNativ
});
injector.register("logger", {
trace: () => ({}),
warn: (message: string) => warnParams.push(message)
warn: (message: string) => warnParams.push(message)
});

injector.register("packageInstallationManager", PackageInstallationManagerStub);
injector.register("errors", ErrorsStub);
injector.register("previewAppPluginsService", PreviewAppPluginsService);
return injector;
Expand Down