Use profileDir from settingsService

Currently CLI's configuration directory is used from `$options.profileDir`. When user passes `--profileDir <path>`, 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) => {
		console.log("Loaded extensions:", result);
		// write your code here
	});
```

Replace all places where `$options.profileDir` is used with `$settingsService.getProfileDir()`.

Author: rosen-vladimirov

appbuilder/proton-static-config.ts

@@ -20,5 +20,7 @@ export class ProtonStaticConfig extends StaticConfigBase {
 	public CLIENT_NAME = "Desktop Client - Universal";
 
 	public ANALYTICS_EXCEPTIONS_API_KEY: string = null;
+
+	public PROFILE_DIR_NAME: string = ".appbuilder-desktop-universal";
 }
 $injector.register("staticConfig", ProtonStaticConfig);

commands/post-install.ts

@@ -3,7 +3,7 @@ export class PostInstallCommand implements ICommand {
 		private $staticConfig: Config.IStaticConfig,
 		private $commandsService: ICommandsService,
 		private $helpService: IHelpService,
-		private $options: ICommonOptions,
+		private $settingsService: ISettingsService,
 		private $doctorService: IDoctorService,
 		private $analyticsService: IAnalyticsService,
 		private $logger: ILogger) {
@@ -18,7 +18,7 @@ export class PostInstallCommand implements ICommand {
 			// it is no longer accessible for the user initiating the installation
 			// patch the owner here
 			if (process.env.SUDO_USER) {
-				await this.$fs.setCurrentUserAsOwner(this.$options.profileDir, process.env.SUDO_USER);
+				await this.$fs.setCurrentUserAsOwner(this.$settingsService.getProfileDir(), process.env.SUDO_USER);
 			}
 		}
 

commands/preuninstall.ts

@@ -6,10 +6,10 @@ export class PreUninstallCommand implements ICommand {
 	public allowedParameters: ICommandParameter[] = [];
 
 	constructor(private $fs: IFileSystem,
-		private $options: ICommonOptions) { }
+		private $settingsService: ISettingsService) { }
 
 	public async execute(args: string[]): Promise<void> {
-		this.$fs.deleteFile(path.join(this.$options.profileDir, "KillSwitches", "cli"));
+		this.$fs.deleteFile(path.join(this.$settingsService.getProfileDir(), "KillSwitches", "cli"));
 	}
 }
 

declarations.d.ts

@@ -79,7 +79,13 @@ interface IConfigurationSettings {
 	 * This string will be used when constructing the UserAgent http header.
 	 * @type {string}
 	 */
-	userAgentName: string;
+	userAgentName?: string;
+
+	/**
+	 * Describes the profile directory that will be used for various CLI settings, like user-settings.json file location, extensions, etc.
+	 * @type {string}
+	 */
+	profileDir?: string;
 }
 
 /**
@@ -92,6 +98,12 @@ interface ISettingsService {
 	 * @returns {void}
 	 */
 	setSettings(settings: IConfigurationSettings): void;
+
+	/**
+	 * Returns currently used profile directory.
+	 * @returns {string}
+	 */
+	getProfileDir(): string;
 }
 
 /**

definitions/config.d.ts

@@ -28,6 +28,7 @@ declare module Config {
 		PATH_TO_BOOTSTRAP: string;
 		QR_SIZE: number;
 		INSTALLATION_SUCCESS_MESSAGE?: string;
+		PROFILE_DIR_NAME: string
 	}
 
 	interface IConfig {

options.ts

@@ -12,17 +12,17 @@ export class OptionsBase {
 		verbose: { type: OptionType.Boolean, alias: "v" },
 		version: { type: OptionType.Boolean },
 		help: { type: OptionType.Boolean, alias: "h" },
-		profileDir: { type: OptionType.String, default: this.defaultProfileDir },
+		profileDir: { type: OptionType.String },
 		analyticsClient: { type: OptionType.String },
 		path: { type: OptionType.String, alias: "p" },
 		// This will parse all non-hyphenated values as strings.
 		_: { type: OptionType.String }
 	};
 
 	constructor(public options: IDictionary<IDashedOption>,
-		public defaultProfileDir: string,
 		private $errors: IErrors,
-		private $staticConfig: Config.IStaticConfig) {
+		private $staticConfig: Config.IStaticConfig,
+		private $settingsService: ISettingsService) {
 
 		this.options = _.extend({}, this.commonOptions, this.options, this.globalOptions);
 		this.setArgv();
@@ -180,17 +180,24 @@ export class OptionsBase {
 		});
 
 		this.argv = yargs(process.argv.slice(2)).options(opts).argv;
+
+		// For backwards compatibility
+		// Previously profileDir had a default option and calling `this.$options.profileDir` always returned valid result.
+		// Now the profileDir should be used from $settingsService, but ensure the `this.$options.profileDir` returns the same value.
+		this.$settingsService.setSettings({ profileDir: this.argv.profileDir});
+		this.argv.profileDir = this.argv["profile-dir"] = this.$settingsService.getProfileDir();
+
 		this.adjustDashedOptions();
 	}
 
 	private adjustDashedOptions(): void {
 		_.each(this.optionNames, optionName => {
 			Object.defineProperty(OptionsBase.prototype, optionName, {
 				configurable: true,
-				get: function () {
+				get: () => {
 					return this.getOptionValue(optionName);
 				},
-				set: function (value: any) {
+				set: (value: any) => {
 					this.argv[optionName] = value;
 				}
 			});

services/lockfile.ts

@@ -6,7 +6,7 @@ export class LockFile implements ILockFile {
 
 	@cache()
 	private get defaultLockFilePath(): string {
-		return path.join(this.$options.profileDir, "lockfile.lock");
+		return path.join(this.$settingsService.getProfileDir(), "lockfile.lock");
 	}
 
 	private get defaultLockParams(): lockfile.Options {
@@ -22,7 +22,7 @@ export class LockFile implements ILockFile {
 	}
 
 	constructor(private $fs: IFileSystem,
-		private $options: ICommonOptions) {
+		private $settingsService: ISettingsService) {
 	}
 
 	public lock(lockFilePath?: string, lockFileOpts?: lockfile.Options): Promise<void> {

services/proxy-service.ts

@@ -8,9 +8,9 @@ export class ProxyService implements IProxyService {
 
 	constructor(private $credentialsService: ICredentialsService,
 		private $fs: IFileSystem,
-		private $options: ICommonOptions,
+		private $settingsService: ISettingsService,
 		private $staticConfig: Config.IStaticConfig) {
-		this.proxyCacheFilePath = path.join(this.$options.profileDir, Proxy.CACHE_FILE_NAME);
+		this.proxyCacheFilePath = path.join(this.$settingsService.getProfileDir(), Proxy.CACHE_FILE_NAME);
 		this.credentialsKey = `${this.$staticConfig.CLIENT_NAME}_PROXY`;
 	}
 

services/settings-service.ts

@@ -1,13 +1,33 @@
 import { exported } from "../decorators";
+import * as path from "path";
+import * as osenv from "osenv";
 
 export class SettingsService implements ISettingsService {
-	constructor(private $staticConfig: Config.IStaticConfig) { }
+	private _profileDir: string;
+
+	constructor(private $staticConfig: Config.IStaticConfig,
+		private $hostInfo: IHostInfo) {
+		this._profileDir = this.getDefaultProfileDir();
+	}
 
 	@exported("settingsService")
-	setSettings(settings: IConfigurationSettings): void {
-		if (settings.userAgentName) {
+	public setSettings(settings: IConfigurationSettings): void {
+		if (settings && settings.userAgentName) {
 			this.$staticConfig.USER_AGENT_NAME = settings.userAgentName;
 		}
+
+		if (settings && settings.profileDir) {
+			this._profileDir = path.resolve(settings.profileDir);
+		}
+	}
+
+	public getProfileDir(): string {
+		return this._profileDir;
+	}
+
+	private getDefaultProfileDir(): string {
+		const defaultProfileDirLocation = this.$hostInfo.isWindows ? process.env.AppData : path.join(osenv.home(), ".local", "share");
+		return path.join(defaultProfileDirLocation, this.$staticConfig.PROFILE_DIR_NAME);
 	}
 }
 

static-config-base.ts

@@ -19,6 +19,7 @@ export abstract class StaticConfigBase implements Config.IStaticConfig {
 	public version: string = null;
 	public pathToPackageJson: string;
 	private _userAgent: string = null;
+	public abstract PROFILE_DIR_NAME: string;
 
 	public get USER_AGENT_NAME(): string {
 		if (!this._userAgent) {