.sqlproj and datasources.json file parsing (#8921)

* Checkpoint

* Adding mock contents for tree

* added open sqlproj dialog

* reading files from directory

* Added directory traversal

* Adding tree sorting by folder vs file and label

* Improved auto-unfolding of tree based on node type

* replacing fs with fs.promise alias

* PR feedback

* added activation event for when workspace contains sqlproj files

* Returning after displaying error

* Fixing linter errors

* Reworked tree

* Fixing missing grandchildren

* Correcting tree URI construction

* Refactoring to isolate tree item responsibilities from data model responsibilities

* project file parsing

* constructing tree from project files rather than filesystem

* Fixing double-initialization

* Changing projectEntry to take enum for file type

* Correct node type for project item

* Parsing datasources.json

* Child nodes for sql data source

* Localizing strings

* Checkpoint

* Adding mock contents for tree

* added open sqlproj dialog

* reading files from directory

* Added directory traversal

* Adding tree sorting by folder vs file and label

* Improved auto-unfolding of tree based on node type

* replacing fs with fs.promise alias

* PR feedback

* added activation event for when workspace contains sqlproj files

* Returning after displaying error

* Fixing linter errors

* Reworked tree

* Fixing missing grandchildren

* Correcting tree URI construction

* Refactoring to isolate tree item responsibilities from data model responsibilities

* project file parsing

* constructing tree from project files rather than filesystem

* Fixing double-initialization

* Changing projectEntry to take enum for file type

* Correct node type for project item

* Parsing datasources.json

* Child nodes for sql data source

* Localizing strings

* missed file in merge

* changed extension method to helper

* cleanup

* Adding docstrings

extensions/sql-database-projects/src/common/constants.ts

@@ -15,10 +15,14 @@ export const dataSourcesFileName = 'datasources.json';
 export const noOpenProjectMessage = localize('noProjectOpenMessage', "No open database project");
 export const projectNodeName = localize('projectNodeName', "Database Project");
 export const dataSourcesNodeName = localize('dataSourcesNodeName', "Data Sources");
-export const foundDataSourcesFile = localize('foundDataSourcesFile', "Found {0}: ", dataSourcesFileName); // TODO: remove once datasources.json is actually getting removed.
+export const sqlConnectionStringFriendly = localize('sqlConnectionStringFriendly', "SQL connection string");
 
 // Error messages
 
 export const multipleSqlProjFiles = localize('multipleSqlProjFilesSelected', "Multiple .sqlproj files selected; please select only one.");
 export const noSqlProjFiles = localize('noSqlProjFilesSelected', "No .sqlproj file selected; please select one.");
 export const noDataSourcesFile = localize('noDataSourcesFile', "No {0} found", dataSourcesFileName);
+export const missingVersion = localize('missingVersion', "Missing 'version' entry in {0}", dataSourcesFileName);
+export const unrecognizedDataSourcesVersion = localize('unrecognizedDataSourcesVersion', "Unrecognized version: ");
+export const unknownDataSourceType = localize('unknownDataSourceType', "Unknown data source type: ");
+export const invalidSqlConnectionString = localize('invalidSqlConnectionString', "Invalid SQL connection string");

extensions/sql-database-projects/src/common/promise.ts

@@ -1,26 +0,0 @@
-/*---------------------------------------------------------------------------------------------
- *  Copyright (c) Microsoft Corporation. All rights reserved.
- *  Licensed under the Source EULA. See License.txt in the project root for license information.
- *--------------------------------------------------------------------------------------------*/
-
-/**
- * Deferred promise
- */
-export class Deferred<T> {
-	promise: Promise<T>;
-	resolve!: ((value?: T | PromiseLike<T>) => void);
-	reject!: ((reason?: any) => void);
-
-	constructor() {
-		this.promise = new Promise<T>((resolve, reject) => {
-			this.resolve = resolve;
-			this.reject = reject;
-		});
-	}
-
-	then<TResult>(onfulfilled?: (value: T) => TResult | Thenable<TResult>, onrejected?: (reason: any) => TResult | Thenable<TResult>): Thenable<TResult>;
-	then<TResult>(onfulfilled?: (value: T) => TResult | Thenable<TResult>, onrejected?: (reason: any) => void): Thenable<TResult>;
-	then<TResult>(onfulfilled?: (value: T) => TResult | Thenable<TResult>, onrejected?: (reason: any) => TResult | Thenable<TResult>): Thenable<TResult> {
-		return this.promise.then(onfulfilled, onrejected);
-	}
-}

extensions/sql-database-projects/src/common/utils.ts

@@ -3,7 +3,45 @@
  *  Licensed under the Source EULA. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
-
+import * as vscode from 'vscode';
+/**
+ * Consolidates on the error message string
+ */
 export function getErrorMessage(error: Error | string): string {
 	return (error instanceof Error) ? error.message : error;
 }
+
+/**
+ * removes any leading portion shared between the two URIs from outerUri.
+ * e.g. [@param innerUri: 'this\is'; @param outerUri: '\this\is\my\path'] => 'my\path'
+ * @param innerUri the URI that will be cut away from the outer URI
+ * @param outerUri the URI that will have any shared beginning portion removed
+ */
+export function trimUri(innerUri: vscode.Uri, outerUri: vscode.Uri): string {
+	let innerParts = innerUri.path.split('/');
+	let outerParts = outerUri.path.split('/');
+
+	while (innerParts.length > 0 && outerParts.length > 0 && innerParts[0].toLocaleLowerCase() === outerParts[0].toLocaleLowerCase()) {
+		innerParts = innerParts.slice(1);
+		outerParts = outerParts.slice(1);
+	}
+
+	return outerParts.join('/');
+}
+
+/**
+ * Trims any character contained in @param chars from both the beginning and end of @param input
+ */
+export function trimChars(input: string, chars: string): string {
+	let output = input;
+
+	let i = 0;
+	while (chars.includes(output[i])) { i++; }
+	output = output.substr(i);
+
+	i = 0;
+	while (chars.includes(output[output.length - i - 1])) { i++; }
+	output = output.substring(0, output.length - i);
+
+	return output;
+}