Use profileDir from settingsService (#3203)

rosen-vladimirov · rosen-vladimirov · commit 254ac9fb16af · 2017-11-13T11:29:20.000+02:00
Currently CLI's configuration directory is used from `$options.profileDir`. When user passes `--profileDir &lt;path&gt;`, the `$options.profileDir` value is populated.
In case user does not pass anything, a default value is set. All services that require configuration directory use the `$options.profileDir`. However, this causes several issues:
- `$options` is intended for use only when CLI is used as a standalone command line. In case you are using it as a library, the `$options` object will not be populated.
- Unable to test local installations of extensions when CLI is used as library - there's no way to set the custom profileDir when using CLI as a library. So the extensions are always loaded from the default location.

In order to resolve these issues, move the logic for profileDir in `settingsService` and introduce a new method to get the profileDir. In order to ensure code is backwards compatible (i.e. extensions that use `$options.profileDir` should still work), modify `$options` to set the value of `profileDir` in `settingsService`.
Whenever you want to test local extensions you can use:
```JavaScript
const tns = require("nativescript");
tns.settingsService.setSettings({ profileDir: "my custom dir" });
Promise.all(tns.extensibilityService.loadExtensions())
	.then((result) =&gt; {
		console.log("Loaded extensions:", result);
		// write your code here
	});
```

Replace all places where `$options.profileDir` is used with `$settingsService.getProfileDir()`.
diff --git a/PublicAPI.md b/PublicAPI.md
@@ -273,7 +273,7 @@ interface ISettingsService {
 
 * Usage:
 ```JavaScript
-tns.settingsService.setSettings({ userAgentName: "myUserAgent" });
+tns.settingsService.setSettings({ userAgentName: "myUserAgent", profileDir: "customProfileDir" });
 ```
 
 ## npm
diff --git a/lib/commands/post-install.ts b/lib/commands/post-install.ts
@@ -6,11 +6,11 @@ export class PostInstallCliCommand extends PostInstallCommand {
 		$staticConfig: Config.IStaticConfig,
 		$commandsService: ICommandsService,
 		$helpService: IHelpService,
-		$options: ICommonOptions,
+		$settingsService: ISettingsService,
 		$doctorService: IDoctorService,
 		$analyticsService: IAnalyticsService,
 		$logger: ILogger) {
-		super($fs, $staticConfig, $commandsService, $helpService, $options, $doctorService, $analyticsService, $logger);
+		super($fs, $staticConfig, $commandsService, $helpService, $settingsService, $doctorService, $analyticsService, $logger);
 	}
 
 	public async execute(args: string[]): Promise<void> {
diff --git a/lib/config.ts b/lib/config.ts
@@ -28,6 +28,9 @@ export class StaticConfig extends StaticConfigBase implements IStaticConfig {
 	public ERROR_REPORT_SETTING_NAME = "TrackExceptions";
 	public ANALYTICS_INSTALLATION_ID_SETTING_NAME = "AnalyticsInstallationID";
 	public INSTALLATION_SUCCESS_MESSAGE = "Installation successful. You are good to go. Connect with us on `http://twitter.com/NativeScript`.";
+	public get PROFILE_DIR_NAME(): string {
+		return ".nativescript-cli";
+	}
 
 	constructor($injector: IInjector) {
 		super($injector);
diff --git a/lib/npm-installation-manager.ts b/lib/npm-installation-manager.ts
@@ -7,6 +7,7 @@ export class NpmInstallationManager implements INpmInstallationManager {
 		private $childProcess: IChildProcess,
 		private $logger: ILogger,
 		private $options: IOptions,
+		private $settingsService: ISettingsService,
 		private $fs: IFileSystem,
 		private $staticConfig: IStaticConfig) {
 	}
@@ -59,7 +60,7 @@ export class NpmInstallationManager implements INpmInstallationManager {
 
 		// local installation takes precedence over cache
 		if (!this.inspectorAlreadyInstalled(inspectorPath)) {
-			const cachePath = path.join(this.$options.profileDir, constants.INSPECTOR_CACHE_DIRNAME);
+			const cachePath = path.join(this.$settingsService.getProfileDir(), constants.INSPECTOR_CACHE_DIRNAME);
 			this.prepareCacheDir(cachePath);
 			const pathToPackageInCache = path.join(cachePath, constants.NODE_MODULES_FOLDER_NAME, inspectorNpmPackageName);
 
diff --git a/lib/options.ts b/lib/options.ts
@@ -1,11 +1,10 @@
 import * as commonOptionsLibPath from "./common/options";
-import * as osenv from "osenv";
-import * as path from "path";
 
 export class Options extends commonOptionsLibPath.OptionsBase {
 	constructor($errors: IErrors,
 		$staticConfig: IStaticConfig,
-		$hostInfo: IHostInfo) {
+		$hostInfo: IHostInfo,
+		$settingsService: ISettingsService) {
 		super({
 			ipa: { type: OptionType.String },
 			frameworkPath: { type: OptionType.String },
@@ -39,24 +38,7 @@ export class Options extends commonOptionsLibPath.OptionsBase {
 			clean: { type: OptionType.Boolean },
 			watch: { type: OptionType.Boolean, default: true }
 		},
-			path.join($hostInfo.isWindows ? process.env.AppData : path.join(osenv.home(), ".local/share"), ".nativescript-cli"),
-			$errors, $staticConfig);
-
-		// On Windows we moved settings from LocalAppData to AppData. Move the existing file to keep the existing settings
-		// I guess we can remove this code after some grace period, say after 1.7 is out
-		if ($hostInfo.isWindows) {
-			try {
-				const shelljs = require("shelljs"),
-					oldSettings = path.join(process.env.LocalAppData, ".nativescript-cli", "user-settings.json"),
-					newSettings = path.join(process.env.AppData, ".nativescript-cli", "user-settings.json");
-				if (shelljs.test("-e", oldSettings) && !shelljs.test("-e", newSettings)) {
-					shelljs.mkdir(path.join(process.env.AppData, ".nativescript-cli"));
-					shelljs.mv(oldSettings, newSettings);
-				}
-			} catch (err) {
-				// ignore the error - it is too early to use $logger here
-			}
-		}
+			$errors, $staticConfig, $settingsService);
 
 		const that = (<any>this);
 		// if justlaunch is set, it takes precedence over the --watch flag and the default true value
diff --git a/lib/services/extensibility-service.ts b/lib/services/extensibility-service.ts
@@ -4,7 +4,7 @@ import * as constants from "../constants";
 
 export class ExtensibilityService implements IExtensibilityService {
 	private get pathToExtensions(): string {
-		return path.join(path.resolve(this.$options.profileDir), "extensions");
+		return path.join(this.$settingsService.getProfileDir(), "extensions");
 	}
 
 	private get pathToPackageJson(): string {
@@ -14,7 +14,7 @@ export class ExtensibilityService implements IExtensibilityService {
 	constructor(private $fs: IFileSystem,
 		private $logger: ILogger,
 		private $npm: INodePackageManager,
-		private $options: IOptions,
+		private $settingsService: ISettingsService,
 		private $requireService: IRequireService) {
 	}
 
diff --git a/lib/services/user-settings-service.ts b/lib/services/user-settings-service.ts
@@ -3,9 +3,9 @@ import * as userSettingsServiceBaseLib from "../common/services/user-settings-se
 
 class UserSettingsService extends userSettingsServiceBaseLib.UserSettingsServiceBase {
 	constructor($fs: IFileSystem,
-		$options: IOptions,
+		$settingsService: ISettingsService,
 		$lockfile: ILockFile) {
-		const userSettingsFilePath = path.join($options.profileDir, "user-settings.json");
+		const userSettingsFilePath = path.join($settingsService.getProfileDir(), "user-settings.json");
 		super(userSettingsFilePath, $fs, $lockfile);
 	}
 
diff --git a/test/android-project-properties-manager.ts b/test/android-project-properties-manager.ts
@@ -8,6 +8,7 @@ import * as LoggerLib from "../lib/common/logger";
 import * as ConfigLib from "../lib/config";
 import * as OptionsLib from "../lib/options";
 import * as yok from "../lib/common/yok";
+import { SettingsService } from "../lib/common/test/unit-tests/stubs";
 import * as path from "path";
 import temp = require("temp");
 temp.track();
@@ -23,6 +24,7 @@ function createTestInjector(): IInjector {
 	testInjector.register("logger", LoggerLib.Logger);
 	testInjector.register("config", ConfigLib.Configuration);
 	testInjector.register("options", OptionsLib.Options);
+	testInjector.register("settingsService", SettingsService);
 
 	return testInjector;
 }
diff --git a/test/commands/post-install.ts b/test/commands/post-install.ts
@@ -1,6 +1,7 @@
 import { Yok } from "../../lib/common/yok";
 import { assert } from "chai";
 import { PostInstallCliCommand } from "../../lib/commands/post-install";
+import { SettingsService } from "../../lib/common/test/unit-tests/stubs";
 
 const createTestInjector = (): IInjector => {
 	const testInjector = new Yok();
@@ -38,6 +39,8 @@ const createTestInjector = (): IInjector => {
 		printMarkdown: (...args: any[]): void => undefined
 	});
 
+	testInjector.register("settingsService", SettingsService);
+
 	testInjector.registerCommand("post-install-cli", PostInstallCliCommand);
 
 	return testInjector;
diff --git a/test/debug.ts b/test/debug.ts
@@ -11,6 +11,8 @@ import { AndroidDebugBridge } from "../lib/common/mobile/android/android-debug-b
 import { AndroidDebugBridgeResultHandler } from "../lib/common/mobile/android/android-debug-bridge-result-handler";
 import { DebugCommandErrors } from "../lib/constants";
 import { CONNECTED_STATUS, UNREACHABLE_STATUS } from "../lib/common/constants";
+import { SettingsService } from "../lib/common/test/unit-tests/stubs";
+
 const helpers = require("../lib/common/helpers");
 const originalIsInteracive = helpers.isInteractive;
 
@@ -73,6 +75,7 @@ function createTestInjector(): IInjector {
 			return null;
 		}
 	});
+	testInjector.register("settingsService", SettingsService);
 
 	return testInjector;
 }
diff --git a/test/ios-project-service.ts b/test/ios-project-service.ts
@@ -33,6 +33,7 @@ import * as constants from "../lib/constants";
 
 import { assert } from "chai";
 import { IOSProvisionService } from "../lib/services/ios-provision-service";
+import { SettingsService } from "../lib/common/test/unit-tests/stubs";
 import temp = require("temp");
 
 temp.track();
@@ -114,6 +115,8 @@ function createTestInjector(projectPath: string, projectName: string): IInjector
 	testInjector.register("npmInstallationManager", NpmInstallationManager);
 	testInjector.register("npm", NodePackageManager);
 	testInjector.register("xCConfigService", XCConfigService);
+	testInjector.register("settingsService", SettingsService);
+
 	return testInjector;
 }
 
diff --git a/test/npm-installation-manager.ts b/test/npm-installation-manager.ts
@@ -9,6 +9,7 @@ import * as OptionsLib from "../lib/options";
 import * as StaticConfigLib from "../lib/config";
 import * as yok from "../lib/common/yok";
 import ChildProcessLib = require("../lib/common/child-process");
+import { SettingsService } from "../lib/common/test/unit-tests/stubs";
 
 function createTestInjector(): IInjector {
 	const testInjector = new yok.Yok();
@@ -21,6 +22,7 @@ function createTestInjector(): IInjector {
 	testInjector.register("hostInfo", HostInfoLib.HostInfo);
 	testInjector.register("staticConfig", StaticConfigLib.StaticConfig);
 	testInjector.register("childProcess", ChildProcessLib.ChildProcess);
+	testInjector.register("settingsService", SettingsService);
 
 	testInjector.register("npmInstallationManager", NpmInstallationManagerLib.NpmInstallationManager);
 
diff --git a/test/npm-support.ts b/test/npm-support.ts
@@ -26,6 +26,7 @@ import { XmlValidator } from "../lib/xml-validator";
 import ProjectChangesLib = require("../lib/services/project-changes-service");
 import { Messages } from "../lib/common/messages/messages";
 import { NodeModulesDependenciesBuilder } from "../lib/tools/node-modules/node-modules-dependencies-builder";
+import { SettingsService } from "../lib/common/test/unit-tests/stubs";
 
 import path = require("path");
 import temp = require("temp");
@@ -82,7 +83,7 @@ function createTestInjector(): IInjector {
 	});
 	testInjector.register("messages", Messages);
 	testInjector.register("nodeModulesDependenciesBuilder", NodeModulesDependenciesBuilder);
-
+	testInjector.register("settingsService", SettingsService);
 	testInjector.register("devicePathProvider", {});
 
 	return testInjector;
diff --git a/test/platform-commands.ts b/test/platform-commands.ts
@@ -21,6 +21,7 @@ import { XmlValidator } from "../lib/xml-validator";
 import * as ChildProcessLib from "../lib/common/child-process";
 import ProjectChangesLib = require("../lib/services/project-changes-service");
 import { Messages } from "../lib/common/messages/messages";
+import { SettingsService } from "../lib/common/test/unit-tests/stubs";
 
 let isCommandExecuted = true;
 
@@ -149,6 +150,7 @@ function createTestInjector() {
 	testInjector.register("helpService", {
 		showCommandLineHelp: async (): Promise<void> => (undefined)
 	});
+	testInjector.register("settingsService", SettingsService);
 
 	return testInjector;
 }
diff --git a/test/platform-service.ts b/test/platform-service.ts
@@ -19,6 +19,7 @@ import { XmlValidator } from "../lib/xml-validator";
 import * as ChildProcessLib from "../lib/common/child-process";
 import ProjectChangesLib = require("../lib/services/project-changes-service");
 import { Messages } from "../lib/common/messages/messages";
+import { SettingsService } from "../lib/common/test/unit-tests/stubs";
 
 require("should");
 const temp = require("temp");
@@ -90,6 +91,7 @@ function createTestInjector() {
 	testInjector.register("helpService", {
 		showCommandLineHelp: async (): Promise<void> => (undefined)
 	});
+	testInjector.register("settingsService", SettingsService);
 
 	return testInjector;
 }
diff --git a/test/plugin-variables-service.ts b/test/plugin-variables-service.ts
@@ -11,6 +11,7 @@ import { ProjectHelper } from "../lib/common/project-helper";
 import { StaticConfig } from "../lib/config";
 import { MessagesService } from "../lib/common/services/messages-service";
 import { Yok } from '../lib/common/yok';
+import { SettingsService } from "../lib/common/test/unit-tests/stubs";
 import * as stubs from './stubs';
 import * as path from "path";
 import * as temp from "temp";
@@ -37,6 +38,7 @@ function createTestInjector(): IInjector {
 		}
 	});
 	testInjector.register("staticConfig", StaticConfig);
+	testInjector.register("settingsService", SettingsService);
 
 	return testInjector;
 }
diff --git a/test/plugins-service.ts b/test/plugins-service.ts
@@ -30,6 +30,7 @@ import { ProjectFilesProvider } from "../lib/providers/project-files-provider";
 import { MobilePlatformsCapabilities } from "../lib/mobile-platforms-capabilities";
 import { DevicePlatformsConstants } from "../lib/common/mobile/device-platforms-constants";
 import { XmlValidator } from "../lib/xml-validator";
+import { SettingsService } from "../lib/common/test/unit-tests/stubs";
 import StaticConfigLib = require("../lib/config");
 import * as path from "path";
 import * as temp from "temp";
@@ -101,6 +102,7 @@ function createTestInjector() {
 	testInjector.register("helpService", {
 		showCommandLineHelp: async (): Promise<void> => (undefined)
 	});
+	testInjector.register("settingsService", SettingsService);
 
 	return testInjector;
 }
diff --git a/test/project-service.ts b/test/project-service.ts
@@ -18,6 +18,7 @@ import { assert } from "chai";
 import { Options } from "../lib/options";
 import { HostInfo } from "../lib/common/host-info";
 import { ProjectTemplatesService } from "../lib/services/project-templates-service";
+import { SettingsService } from "../lib/common/test/unit-tests/stubs";
 
 const mockProjectNameValidator = {
 	validate: () => true
@@ -156,6 +157,7 @@ class ProjectIntegrationTest {
 			}
 		});
 		this.testInjector.register("npmInstallationManager", NpmInstallationManager);
+		this.testInjector.register("settingsService", SettingsService);
 	}
 }
 
@@ -429,6 +431,7 @@ describe("Project Service Tests", () => {
 			testInjector.register("staticConfig", {});
 			testInjector.register("projectHelper", {});
 			testInjector.register("npmInstallationManager", {});
+			testInjector.register("settingsService", SettingsService);
 
 			return testInjector;
 		};
diff --git a/test/services/extensibility-service.ts b/test/services/extensibility-service.ts
@@ -3,6 +3,7 @@ import { Yok } from "../../lib/common/yok";
 import * as stubs from "../stubs";
 import { assert } from "chai";
 import * as constants from "../../lib/constants";
+import { SettingsService } from "../../lib/common/test/unit-tests/stubs";
 const path = require("path");
 const originalResolve = path.resolve;
 
@@ -20,9 +21,7 @@ describe("extensibilityService", () => {
 		testInjector.register("fs", {});
 		testInjector.register("logger", stubs.LoggerStub);
 		testInjector.register("npm", {});
-		testInjector.register("options", {
-			profileDir: "profileDir"
-		});
+		testInjector.register("settingsService", SettingsService);
 		testInjector.register("requireService", {
 			require: (pathToRequire: string): any => undefined
 		});
@@ -121,10 +120,11 @@ describe("extensibilityService", () => {
 			it("passes full path to extensions dir for installation", async () => {
 				const extensionName = "extension1";
 				const testInjector = getTestInjector();
-				const options: IOptions = testInjector.resolve("options");
-				options.profileDir = "my-profile-dir";
+				const settingsService: ISettingsService = testInjector.resolve("settingsService");
+				const profileDir = "my-profile-dir";
+				settingsService.getProfileDir = () => profileDir;
 
-				const expectedDirForInstallation = path.join(options.profileDir, "extensions");
+				const expectedDirForInstallation = path.join(profileDir, "extensions");
 				const argsPassedToNpmInstall = await getArgsPassedToNpmInstallDuringInstallExtensionCall(extensionName, testInjector);
 				assert.deepEqual(argsPassedToNpmInstall.pathToSave, expectedDirForInstallation);
 			});
@@ -514,12 +514,13 @@ describe("extensibilityService", () => {
 			it("passes full path to extensions dir for uninstallation", async () => {
 				const extensionName = "extension1";
 				const testInjector = getTestInjector();
-				const options: IOptions = testInjector.resolve("options");
-				options.profileDir = "my-profile-dir";
+				const settingsService: ISettingsService = testInjector.resolve("settingsService");
+				const profileDir = "my-profile-dir";
+				settingsService.getProfileDir = () => profileDir;
 
-				const expectedDirForInstallation = path.join(options.profileDir, "extensions");
+				const expectedDirForUninstall = path.join(profileDir, "extensions");
 				const argsPassedToNpmUninstall = await getArgsPassedToNpmUninstallDuringUninstallExtensionCall(extensionName, testInjector);
-				assert.deepEqual(argsPassedToNpmUninstall.pathToSave, expectedDirForInstallation);
+				assert.deepEqual(argsPassedToNpmUninstall.pathToSave, expectedDirForUninstall);
 			});
 		});
 

Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@ import * as constants from "../constants";`
`4`	`4`
`5`	`5`	`export class ExtensibilityService implements IExtensibilityService {`
`6`	`6`	`private get pathToExtensions(): string {`
`7`		`- return path.join(path.resolve(this.$options.profileDir), "extensions");`
	`7`	`+ return path.join(this.$settingsService.getProfileDir(), "extensions");`
`8`	`8`	`}`
`9`	`9`
`10`	`10`	`private get pathToPackageJson(): string {`
`@@ -14,7 +14,7 @@ export class ExtensibilityService implements IExtensibilityService {`
`14`	`14`	`constructor(private $fs: IFileSystem,`
`15`	`15`	`private $logger: ILogger,`
`16`	`16`	`private $npm: INodePackageManager,`
`17`		`- private $options: IOptions,`
	`17`	`+ private $settingsService: ISettingsService,`
`18`	`18`	`private $requireService: IRequireService) {`
`19`	`19`	`}`
`20`	`20`
Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,8 @@ import { AndroidDebugBridge } from "../lib/common/mobile/android/android-debug-b`
`11`	`11`	`import { AndroidDebugBridgeResultHandler } from "../lib/common/mobile/android/android-debug-bridge-result-handler";`
`12`	`12`	`import { DebugCommandErrors } from "../lib/constants";`
`13`	`13`	`import { CONNECTED_STATUS, UNREACHABLE_STATUS } from "../lib/common/constants";`
	`14`	`+import { SettingsService } from "../lib/common/test/unit-tests/stubs";`
	`15`	`+`
`14`	`16`	`const helpers = require("../lib/common/helpers");`
`15`	`17`	`const originalIsInteracive = helpers.isInteractive;`
`16`	`18`
`@@ -73,6 +75,7 @@ function createTestInjector(): IInjector {`
`73`	`75`	`return null;`
`74`	`76`	`}`
`75`	`77`	`});`
	`78`	`+ testInjector.register("settingsService", SettingsService);`
`76`	`79`
`77`	`80`	`return testInjector;`
`78`	`81`	`}`