Skip to content

feat(preview-api): expose public api for getting device's warnings #4132

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 3 commits into from
Nov 16, 2018
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
2 changes: 2 additions & 0 deletions lib/definitions/preview-app-livesync.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ declare global {
}

interface IPreviewAppPluginsService {
getPluginsUsageWarnings(data: IPreviewAppLiveSyncData, device: Device): string[];
comparePluginsOnDevice(data: IPreviewAppLiveSyncData, device: Device): Promise<void>;
getExternalPlugins(device: Device): string[];
}
Expand Down Expand Up @@ -49,5 +50,6 @@ declare global {
updateConnectedDevices(devices: Device[]): void;
getDeviceById(id: string): Device;
getDevicesForPlatform(platform: string): Device[];
getPluginsUsageWarnings(data: IPreviewAppLiveSyncData, device: Device): string[];
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,11 @@ import { DeviceDiscoveryEventNames, DEVICE_LOG_EVENT_NAME } from "../../../../co
export class PreviewDevicesService extends EventEmitter implements IPreviewDevicesService {
private connectedDevices: Device[] = [];

constructor(private $previewAppLogProvider: IPreviewAppLogProvider) {
super();
constructor(private $previewAppLogProvider: IPreviewAppLogProvider,
private $previewAppPluginsService: IPreviewAppPluginsService) {
super();

this.initialize();
this.initialize();
}

public getConnectedDevices(): Device[] {
Expand All @@ -33,6 +34,10 @@ export class PreviewDevicesService extends EventEmitter implements IPreviewDevic
return _.filter(this.connectedDevices, { platform: platform.toLowerCase() });
}

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

private initialize(): void {
this.$previewAppLogProvider.on(DEVICE_LOG_EVENT_NAME, (deviceId: string, message: string) => {
this.emit(DEVICE_LOG_EVENT_NAME, deviceId, message);
Expand Down
20 changes: 17 additions & 3 deletions lib/services/livesync/playground/preview-app-plugins-service.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,20 @@ import { PLATFORMS_DIR_NAME, PACKAGE_JSON_FILE_NAME } from "../../../constants";
export class PreviewAppPluginsService implements IPreviewAppPluginsService {
private previewAppVersionWarnings: IDictionary<string[]> = {};

constructor(private $fs: IFileSystem,
constructor(private $errors: IErrors,
private $fs: IFileSystem,
private $logger: ILogger,
private $pluginsService: IPluginsService) { }

public async comparePluginsOnDevice(data: IPreviewAppLiveSyncData, device: Device): Promise<void> {
public getPluginsUsageWarnings(data: IPreviewAppLiveSyncData, device: Device): string[] {
if (!device) {
this.$errors.failWithoutHelp("No device provided.");
}

if (!device.previewAppVersion) {
this.$errors.failWithoutHelp("No version of preview app provided.");
}

if (!this.previewAppVersionWarnings[device.previewAppVersion]) {
const devicePlugins = this.getDevicePlugins(device);
const localPlugins = this.getLocalPlugins(data.projectDir);
Expand All @@ -27,7 +36,12 @@ export class PreviewAppPluginsService implements IPreviewAppPluginsService {
this.previewAppVersionWarnings[device.previewAppVersion] = warnings;
}

this.previewAppVersionWarnings[device.previewAppVersion].map(warning => this.$logger.warn(warning));
return this.previewAppVersionWarnings[device.previewAppVersion];
}

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

public getExternalPlugins(device: Device): string[] {
Expand Down
2 changes: 2 additions & 0 deletions test/services/playground/preview-app-plugins-service.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ 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";

let readJsonParams: string[] = [];
let warnParams: string[] = [];
Expand Down Expand Up @@ -43,6 +44,7 @@ function createTestInjector(localPlugins: IStringDictionary, options?: { isNativ
trace: () => ({}),
warn: (message: string) => warnParams.push(message)
});
injector.register("errors", ErrorsStub);
injector.register("previewAppPluginsService", PreviewAppPluginsService);
return injector;
}
Expand Down
4 changes: 3 additions & 1 deletion test/services/preview-devices-service.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,19 @@ import { PreviewDevicesService } from "../../lib/services/livesync/playground/de
import { Device } from "nativescript-preview-sdk";
import { assert } from "chai";
import { DeviceDiscoveryEventNames } from "../../lib/common/constants";
import { LoggerStub } from "../stubs";
import { LoggerStub, ErrorsStub } from "../stubs";

let foundDevices: Device[] = [];
let lostDevices: Device[] = [];

function createTestInjector(): IInjector {
const injector = new Yok();
injector.register("errors", ErrorsStub);
injector.register("previewDevicesService", PreviewDevicesService);
injector.register("previewAppLogProvider", {
on: () => ({})
});
injector.register("previewAppPluginsService", {});
injector.register("logger", LoggerStub);
return injector;
}
Expand Down