Remove fs-extra-promise and fs-extra (#17226)

Charles-Gagnon · web-flow · commit c3017781cca7 · 2022-01-31T13:21:09.000-08:00
* Remove fs-extra-promise

* const

* Remove one more

* Update comment
diff --git a/package.json b/package.json
@@ -124,7 +124,6 @@
     "error-ex": "^1.3.0",
     "figures": "^1.4.0",
     "find-remove": "1.2.1",
-    "fs-extra-promise": "^0.3.1",
     "getmac": "1.2.1",
     "http-proxy-agent": "^2.1.0",
     "https-proxy-agent": "^2.2.1",
diff --git a/src/languageservice/server.ts b/src/languageservice/server.ts
@@ -7,7 +7,7 @@ import * as path from 'path';
 import { Runtime } from '../models/platform';
 import ServiceDownloadProvider from './serviceDownloadProvider';
 import { IConfig, IStatusView } from './interfaces';
-import * as fs from 'fs-extra-promise';
+import * as fs from 'fs/promises';
 
 
 /*
@@ -23,29 +23,29 @@ export default class ServerProvider {
 	/**
 	 * Given a file path, returns the path to the SQL Tools service file.
 	 */
-	public findServerPath(filePath: string): Promise<string> {
-		return fs.lstatAsync(filePath).then(stats => {
-			// If a file path was passed, assume its the launch file.
-			if (stats.isFile()) {
-				return filePath;
-			}
-
-			// Otherwise, search the specified folder.
-			let candidate: string;
+	public async findServerPath(filePath: string): Promise<string | undefined> {
+		const stats = await fs.lstat(filePath);
+		// If a file path was passed, assume its the launch file.
+		if (stats.isFile()) {
+			return filePath;
+		}
 
-			if (this._config !== undefined) {
-				let executableFiles: string[] = this._config.getSqlToolsExecutableFiles();
-				executableFiles.forEach(element => {
-					let executableFile = path.join(filePath, element);
-					if (candidate === undefined && fs.existsSync(executableFile)) {
-						candidate = executableFile;
-						return candidate;
+		// Otherwise, search the specified folder.
+		if (this._config !== undefined) {
+			let executableFiles: string[] = this._config.getSqlToolsExecutableFiles();
+			for (const executableFile of executableFiles) {
+				const executablePath = path.join(filePath, executableFile);
+				try {
+					if (await fs.stat(executablePath)) {
+						return executablePath;
 					}
-				});
+				} catch (err) {
+					// no-op, the exe files list has all possible options and so depending on the platform we expect some
+					// to always fail
+				}
 			}
-
-			return candidate;
-		});
+		}
+		return undefined;
 	}
 
 	/**
@@ -75,25 +75,22 @@ export default class ServerProvider {
 	/**
 	 * Returns the path of the installed service
 	 */
-	public getServerPath(runtime: Runtime): Promise<string> {
-		const installDirectory = this._downloadProvider.getInstallDirectory(runtime);
+	public async getServerPath(runtime: Runtime): Promise<string> {
+		const installDirectory = await this._downloadProvider.getOrMakeInstallDirectory(runtime);
 		return this.findServerPath(installDirectory);
 	}
 
 	/**
 	 * Downloads the service and returns the path of the installed service
 	 */
-	public downloadServerFiles(runtime: Runtime): Promise<string> {
-		return new Promise<string>((resolve, reject) => {
-			const installDirectory = this._downloadProvider.getInstallDirectory(runtime);
-			return this._downloadProvider.installSQLToolsService(runtime).then(_ => {
-				return this.findServerPath(installDirectory).then(result => {
-					return resolve(result);
-				});
-			}).catch(err => {
-				this._statusView.serviceInstallationFailed();
-				reject(err);
-			});
-		});
+	public async downloadServerFiles(runtime: Runtime): Promise<string> {
+		const installDirectory = await this._downloadProvider.getOrMakeInstallDirectory(runtime);
+		try {
+			await this._downloadProvider.installSQLToolsService(runtime);
+			return this.findServerPath(installDirectory);
+		} catch (err) {
+			this._statusView.serviceInstallationFailed();
+			throw err;
+		}
 	}
 }
diff --git a/src/languageservice/serviceDownloadProvider.ts b/src/languageservice/serviceDownloadProvider.ts
@@ -9,7 +9,7 @@ import { Runtime, getRuntimeDisplayName } from '../models/platform';
 import { IConfig, IStatusView, IPackage, PackageError, IHttpClient, IDecompressProvider } from './interfaces';
 import { ILogger } from '../models/interfaces';
 import * as Constants from '../constants/constants';
-import * as fse from 'fs-extra';
+import * as fs from 'fs/promises';
 
 /*
 * Service Download Provider class which handles downloading the SQL Tools service.
@@ -45,16 +45,19 @@ export default class ServiceDownloadProvider {
 
 
 	/**
-	 * Returns SQL tools service installed folder.
+	 * Returns SQL tools service installed folder, creating it if it doesn't exist.
 	 */
-	public getInstallDirectory(platform: Runtime): string {
+	public async getOrMakeInstallDirectory(platform: Runtime): Promise<string> {
 
 		let basePath = this.getInstallDirectoryRoot();
 		let versionFromConfig = this._config.getSqlToolsPackageVersion();
 		basePath = basePath.replace('{#version#}', versionFromConfig);
 		basePath = basePath.replace('{#platform#}', getRuntimeDisplayName(platform));
-		if (!fse.existsSync(basePath)) {
-			fse.mkdirsSync(basePath);
+		try {
+			await fs.mkdir(basePath, { recursive: true });
+		} catch {
+			// Best effort to make the folder, if it already exists (expected scenario) or something else happens
+			// then just carry on
 		}
 		return basePath;
 	}
@@ -85,45 +88,39 @@ export default class ServiceDownloadProvider {
 	/**
 	 * Downloads the SQL tools service and decompress it in the install folder.
 	 */
-	public installSQLToolsService(platform: Runtime): Promise<boolean> {
+	public async installSQLToolsService(platform: Runtime): Promise<boolean> {
 		const proxy = <string>this._config.getWorkspaceConfig('http.proxy');
 		const strictSSL = this._config.getWorkspaceConfig('http.proxyStrictSSL', true);
 		const authorization = this._config.getWorkspaceConfig('http.proxyAuthorization');
 
-		return new Promise<boolean>((resolve, reject) => {
-			const fileName = this.getDownloadFileName(platform);
-			const installDirectory = this.getInstallDirectory(platform);
-
-			this._logger.appendLine(`${Constants.serviceInstallingTo} ${installDirectory}.`);
-			const urlString = this.getGetDownloadUrl(fileName);
-
-			const isZipFile: boolean = path.extname(fileName) === '.zip';
-
-			this._logger.appendLine(`${Constants.serviceDownloading} ${urlString}`);
-			let pkg: IPackage = {
-				installPath: installDirectory,
-				url: urlString,
-				tmpFile: undefined,
-				isZipFile: isZipFile
-			};
-			this.createTempFile(pkg).then(tmpResult => {
-				pkg.tmpFile = tmpResult;
-
-				this._httpClient.downloadFile(pkg.url, pkg, this._logger, this._statusView, proxy, strictSSL, authorization).then(_ => {
-
-					this._logger.logDebug(`Downloaded to ${pkg.tmpFile.name}...`);
-					this._logger.appendLine(' Done!');
-					this.install(pkg).then(result => {
-						resolve(true);
-					}).catch(installError => {
-						reject(installError);
-					});
-				}).catch(downloadError => {
-					this._logger.appendLine(`[ERROR] ${downloadError}`);
-					reject(downloadError);
-				});
-			});
-		});
+		const fileName = this.getDownloadFileName(platform);
+		const installDirectory = await this.getOrMakeInstallDirectory(platform);
+
+		this._logger.appendLine(`${Constants.serviceInstallingTo} ${installDirectory}.`);
+		const urlString = this.getGetDownloadUrl(fileName);
+
+		const isZipFile: boolean = path.extname(fileName) === '.zip';
+
+		this._logger.appendLine(`${Constants.serviceDownloading} ${urlString}`);
+		let pkg: IPackage = {
+			installPath: installDirectory,
+			url: urlString,
+			tmpFile: undefined,
+			isZipFile: isZipFile
+		};
+		const tmpResult = await this.createTempFile(pkg);
+		pkg.tmpFile = tmpResult;
+
+		try {
+			await this._httpClient.downloadFile(pkg.url, pkg, this._logger, this._statusView, proxy, strictSSL, authorization);
+			this._logger.logDebug(`Downloaded to ${pkg.tmpFile.name}...`);
+			this._logger.appendLine(' Done!');
+			await this.install(pkg);
+		} catch (err) {
+			this._logger.appendLine(`[ERROR] ${err}`);
+			throw err;
+		}
+		return true;
 	}
 
 	private createTempFile(pkg: IPackage): Promise<tmp.SynchrounousResult> {
diff --git a/src/languageservice/serviceInstallerUtil.ts b/src/languageservice/serviceInstallerUtil.ts
@@ -83,15 +83,15 @@ export function getServiceInstallDirectory(runtime: Runtime): Promise<string> {
 		if (runtime === undefined) {
 			PlatformInformation.getCurrent().then(platformInfo => {
 				if (platformInfo.isValidRuntime) {
-					resolve(downloadProvider.getInstallDirectory(platformInfo.runtimeId));
+					resolve(downloadProvider.getOrMakeInstallDirectory(platformInfo.runtimeId));
 				} else {
 					reject('unsupported runtime');
 				}
 			}).catch(error => {
 				reject(error);
 			});
 		} else {
-			resolve(downloadProvider.getInstallDirectory(runtime));
+			resolve(downloadProvider.getOrMakeInstallDirectory(runtime));
 		}
 	});
 
diff --git a/test/download.test.ts b/test/download.test.ts
@@ -14,7 +14,7 @@ import { Runtime } from '../src/models/platform';
 import * as path from 'path';
 import { ILogger } from '../src/models/interfaces';
 import { Logger } from '../src/models/logger';
-import * as fse from 'fs-extra';
+import * as fs from 'fs/promises';
 
 interface IFixture {
 	downloadUrl: string;
@@ -47,7 +47,7 @@ suite('ServiceDownloadProvider Tests', () => {
 			config.setup(x => x.getSqlToolsPackageVersion()).returns(() => expectedVersionFromConfig);
 			let downloadProvider = new ServiceDownloadProvider(config.object, undefined, testStatusView.object,
 				testHttpClient.object, testDecompressProvider.object);
-			let actual = downloadProvider.getInstallDirectory(Runtime.OSX_10_11_64);
+			let actual = downloadProvider.getOrMakeInstallDirectory(Runtime.OSX_10_11_64);
 			assert.equal(expected, actual);
 			done();
 		});
@@ -62,7 +62,7 @@ suite('ServiceDownloadProvider Tests', () => {
 			config.setup(x => x.getSqlToolsPackageVersion()).returns(() => expectedVersionFromConfig);
 			let downloadProvider = new ServiceDownloadProvider(config.object, undefined, testStatusView.object,
 				testHttpClient.object, testDecompressProvider.object);
-			let actual = downloadProvider.getInstallDirectory(Runtime.OSX_10_11_64);
+			let actual = downloadProvider.getOrMakeInstallDirectory(Runtime.OSX_10_11_64);
 			assert.equal(expected, actual);
 			done();
 		});
@@ -77,7 +77,7 @@ suite('ServiceDownloadProvider Tests', () => {
 			config.setup(x => x.getSqlToolsPackageVersion()).returns(() => expectedVersionFromConfig);
 			let downloadProvider = new ServiceDownloadProvider(config.object, undefined, testStatusView.object,
 				testHttpClient.object, testDecompressProvider.object);
-			let actual = downloadProvider.getInstallDirectory(Runtime.OSX_10_11_64);
+			let actual = downloadProvider.getOrMakeInstallDirectory(Runtime.OSX_10_11_64);
 			assert.equal(expected, actual);
 			done();
 		});
@@ -92,7 +92,7 @@ suite('ServiceDownloadProvider Tests', () => {
 			config.setup(x => x.getSqlToolsPackageVersion()).returns(() => expectedVersionFromConfig);
 			let downloadProvider = new ServiceDownloadProvider(config.object, undefined, testStatusView.object,
 				testHttpClient.object, testDecompressProvider.object);
-			let actual = downloadProvider.getInstallDirectory(Runtime.OSX_10_11_64);
+			let actual = downloadProvider.getOrMakeInstallDirectory(Runtime.OSX_10_11_64);
 			assert.equal(expected, actual);
 			done();
 		});
@@ -114,18 +114,18 @@ suite('ServiceDownloadProvider Tests', () => {
 		});
 	});
 
-	function createDownloadProvider(fixture: IFixture): IFixture {
+	async function createDownloadProvider(fixture: IFixture): Promise<IFixture> {
 		let fileName = 'fileName';
 		let baseDownloadUrl = 'baseDownloadUrl/{#version#}/{#fileName#}';
 		let version = '1.0.0';
 		let installFolder = path.join(__dirname, 'testService');
 		let fileNamesJson = { Windows_7_64: `${fileName}` };
 		let downloadUrl = 'baseDownloadUrl/1.0.0/fileName';
-		fse.remove(installFolder, function (err): void {
-			if (err) {
-				return console.error(err);
-			}
-		});
+		try {
+			await fs.rmdir(installFolder);
+		} catch (err) {
+			console.error(err);
+		}
 
 		config.setup(x => x.getSqlToolsInstallDirectory()).returns(() => installFolder);
 		config.setup(x => x.getSqlToolsConfigValue('downloadFileNames')).returns(() => fileNamesJson);
@@ -151,15 +151,15 @@ suite('ServiceDownloadProvider Tests', () => {
 		return fixture;
 	}
 
-	test('installSQLToolsService should download and decompress the service and update the status', () => {
+	test('installSQLToolsService should download and decompress the service and update the status', async () => {
 		let fixture: IFixture = {
 			downloadUrl: undefined,
 			downloadProvider: undefined,
 			downloadResult: Promise.resolve(),
 			decompressResult: Promise.resolve()
 		};
 
-		fixture = createDownloadProvider(fixture);
+		fixture = await createDownloadProvider(fixture);
 		return fixture.downloadProvider.installSQLToolsService(Runtime.Windows_7_64).then(_ => {
 			testHttpClient.verify(x => x.downloadFile(fixture.downloadUrl, TypeMoq.It.isAny(), TypeMoq.It.isAny(), TypeMoq.It.isAny(),
 				TypeMoq.It.isAny(), TypeMoq.It.isAny(), TypeMoq.It.isAny()),
@@ -172,15 +172,15 @@ suite('ServiceDownloadProvider Tests', () => {
 	});
 
 	// @cssuh 10/22 - commented this test because it was throwing some random undefined errors
-	test.skip('installSQLToolsService should not call decompress if download fails', () => {
+	test.skip('installSQLToolsService should not call decompress if download fails', async () => {
 		let fixture: IFixture = {
 			downloadUrl: undefined,
 			downloadProvider: undefined,
 			downloadResult: Promise.reject('download failed'),
 			decompressResult: Promise.resolve()
 		};
 
-		fixture = createDownloadProvider(fixture);
+		fixture = await createDownloadProvider(fixture);
 		return fixture.downloadProvider.installSQLToolsService(Runtime.Windows_7_64).catch(_ => {
 			testHttpClient.verify(x => x.downloadFile(fixture.downloadUrl, TypeMoq.It.isAny(), TypeMoq.It.isAny(), TypeMoq.It.isAny(),
 				TypeMoq.It.isAny(), TypeMoq.It.isAny(), TypeMoq.It.isAny()),
@@ -192,15 +192,15 @@ suite('ServiceDownloadProvider Tests', () => {
 		});
 	});
 
-	test.skip('installSQLToolsService should not update status to installed decompress fails', () => {
+	test.skip('installSQLToolsService should not update status to installed decompress fails', async () => {
 		let fixture: IFixture = {
 			downloadUrl: undefined,
 			downloadProvider: undefined,
 			downloadResult: Promise.resolve(),
 			decompressResult: Promise.reject('download failed')
 		};
 
-		fixture = createDownloadProvider(fixture);
+		fixture = await createDownloadProvider(fixture);
 		return fixture.downloadProvider.installSQLToolsService(Runtime.Windows_7_64).catch(_ => {
 			testHttpClient.verify(x => x.downloadFile(fixture.downloadUrl, TypeMoq.It.isAny(), TypeMoq.It.isAny(), TypeMoq.It.isAny(),
 				TypeMoq.It.isAny(), TypeMoq.It.isAny(), TypeMoq.It.isAny()),
diff --git a/test/server.test.ts b/test/server.test.ts
@@ -33,7 +33,7 @@ suite('Server tests', () => {
 
 	function setupMocks(fixture: IFixture): void {
 		testConfig.setup(x => x.getSqlToolsExecutableFiles()).returns(() => fixture.executablesFromConfig);
-		testDownloadProvider.setup(x => x.getInstallDirectory(fixture.runtime)).returns(() => fixture.installDir);
+		testDownloadProvider.setup(x => x.getOrMakeInstallDirectory(fixture.runtime)).returns(() => Promise.resolve(fixture.installDir));
 		testDownloadProvider.setup(x => x.installSQLToolsService(fixture.runtime)).callback(() => {
 			fixture.executablesFromConfig = [fixture.executableFileName.replace(fixture.installDir, '')];
 		}).returns(() => { return Promise.resolve(true); });
diff --git a/yarn.lock b/yarn.lock
