Data workspace projects changes (#13466)

* Fix project context menu actions (#12541)

* delete works again

* make fewer changes

* update all sql db project commands

* cleanup

* Remove old projects view (#12563)

* remove old projects view from file explorer view

* fix tests failing

* remove projects in open folder opening up in old view

* Update db reference dialog to show projects in the workspace (#12580)

* update database reference dialog to show projects in the workspace in the project dropdown

* remove workspace stuff from sql projects extension

* undo change

* add class that implements IExtension

* undo a change

* update DataWorkspaceExtension to take workspaceService as a parameter

* add type

* Update sql database project commands (#12595)

* remove sql proj's open and create new project from comman palette

* hook up create project from database to data workspace

* rename the remaining import databases to create project from database

* remove open, new, and close commands

* expose addProjectsToWorkspace() in IExtension instead of calling command

* Addressing comments

* fix failing sql project tests (#12651)

* update SSDT projects opened in projects viewlet (#12669)

* fix action not refreshing the tree issue (#12692)

* fix adding project references in new projects viewlet (#12688)

* Remove old projects tree provider (#12702)

* Remove old projects tree provider and fix tests

* formatting

* update refreshProjectsTree() to accept workspaceTreeItem()

* Cleanup ProjectsController (#12718)

* remove openProject from ProjectController and some cleanup

* rename

* add project and open project dialogs (#12729)

* empty dialogs

* wip

* new project dialog implementation

* revert gitattributes

* open project dialog

* implement add project

* remove icon helper

* refactor

* revert script change

* adjust views

* more updates

* make data-workspace a builtin extension

* show the view only when project provider is detected (#12819)

* only show the view when proj provider is available

* update

* fix sql project tests after merge (#12793)

* Update dialogs to be closer to mockups (#12879)

* small UI changes to dialogs

* center radio card group text

* Create workspace if needed when opening/new project (#12930)

* empty dialogs

* wip

* new project dialog implementation

* revert gitattributes

* open project dialog

* implement add project

* remove icon helper

* refactor

* revert script change

* create workspace

* initial changes

* create new workspace working

* fix tests

* cleanup

* remove showWorkspaceRequiredNotification()

* Add test for no workspace open

* update blue buttons

* move loading temp project to activate() instead of workspaceService constructor

* move workspace creation warning message to before project is created

* pass uri to createWorkspace

* add tests

Co-authored-by: Alan Ren <alanren@microsoft.com>

* Additional create workspace changes (#13004)

* Dialogs workspace updates (#13010)

* adding workspace text boxes

* match new project dialog to mockups

* Add validation error message for workspace file

* add enterWorkspace api

* add warning message for opening workspace

* cleanup

* update commands to remove project so they're more generic

* remove 'empty' from string

* Move default project location setting to data workspace extension (#13022)

* remove project location setting and notification from sql database projects extension

* add default project location setting to data workspace extension

* fix typo

* Add back project name incrementing

* other merge fixes

* fix strings from other PR

* default to last opened directory instead of home directory if no specified default location

* A few small updates (#13092)

* fix build error

* update title for inputboxes

* add missing file

* Add tests for data workspace dialogs (#13324)

* add tests for dialogs

* create helper functions

* New project dialog workspace inputbox fixes (#13407)

* workspace inputbox fixes

* fix folder icons

* Update package.jsons and readme (#13451)

* update package.jsons

* update readme

* add workspace information to open existing dialog (#13455)

Co-authored-by: Alan Ren <alanren@microsoft.com>

extensions/data-workspace/src/common/constants.ts

@@ -7,9 +7,48 @@ import { EOL } from 'os';
 import * as nls from 'vscode-nls';
 const localize = nls.loadMessageBundle();
 
-export const ExtensionActivationErrorMessage = (extensionId: string, err: any): string => { return localize('activateExtensionFailed', "Failed to load the project provider extension '{0}'. Error message: {1}", extensionId, err.message ?? err); };
-export const UnknownProjectsErrorMessage = (projectFiles: string[]): string => { return localize('UnknownProjectsError', "No provider was found for the following projects: {0}", projectFiles.join(EOL)); };
+export const ExtensionActivationError = (extensionId: string, err: any): string => { return localize('activateExtensionFailed', "Failed to load the project provider extension '{0}'. Error message: {1}", extensionId, err.message ?? err); };
+export const UnknownProjectsError = (projectFiles: string[]): string => { return localize('UnknownProjectsError', "No provider was found for the following projects: {0}", projectFiles.join(EOL)); };
 
 export const SelectProjectFileActionName = localize('SelectProjectFileActionName', "Select");
 export const AllProjectTypes = localize('AllProjectTypes', "All Project Types");
+export const ProviderNotFoundForProjectTypeError = (projectType: string): string => { return localize('UnknownProjectTypeError', "No provider was found for project type with id: '{0}'", projectType); };
+export const WorkspaceRequiredMessage = localize('dataworkspace.workspaceRequiredMessage', "A workspace is required in order to use the project feature.");
+export const OpenWorkspace = localize('dataworkspace.openWorkspace', "Open Workspace…");
+export const CreateWorkspaceConfirmation = localize('dataworkspace.createWorkspaceConfirmation', "A new workspace will be created and opened in order to open project. The Extension Host will restart and if there is a folder currently open, it will be closed.");
+export const EnterWorkspaceConfirmation = localize('dataworkspace.enterWorkspaceConfirmation', "To open this workspace, the Extension Host will restart and if there is a workspace or folder currently open, it will be closed.");
 
+// UI
+export const OkButtonText = localize('dataworkspace.ok', "OK");
+export const CancelButtonText = localize('dataworkspace.cancel', "Cancel");
+export const BrowseButtonText = localize('dataworkspace.browse', "Browse");
+export const DefaultInputWidth = '400px';
+export const DefaultButtonWidth = '80px';
+
+// New Project Dialog
+export const NewProjectDialogTitle = localize('dataworkspace.NewProjectDialogTitle', "Create new project");
+export const TypeTitle = localize('dataworkspace.Type', "Type");
+export const ProjectNameTitle = localize('dataworkspace.projectNameTitle', "Name");
+export const ProjectNamePlaceholder = localize('dataworkspace.projectNamePlaceholder', "Enter project name");
+export const ProjectLocationTitle = localize('dataworkspace.projectLocationTitle', "Location");
+export const ProjectLocationPlaceholder = localize('dataworkspace.projectLocationPlaceholder', "Enter project location");
+export const AddProjectToCurrentWorkspace = localize('dataworkspace.AddProjectToCurrentWorkspace', "This project will be added to the current workspace.");
+export const NewWorkspaceWillBeCreated = localize('dataworkspace.NewWorkspaceWillBeCreated', "A new workspace will be created for this project.");
+export const WorkspaceLocationTitle = localize('dataworkspace.workspaceLocationTitle', "Workspace location");
+export const ProjectParentDirectoryNotExistError = (location: string): string => { return localize('dataworkspace.projectParentDirectoryNotExistError', "The selected location: '{0}' does not exist or is not a directory.", location); };
+export const ProjectDirectoryAlreadyExistError = (projectName: string, location: string): string => { return localize('dataworkspace.projectDirectoryAlreadyExistError', "There is already a directory named '{0}' in the selected location: '{1}'.", projectName, location); };
+
+//Open Existing Dialog
+export const OpenExistingDialogTitle = localize('dataworkspace.openExistingDialogTitle', "Open existing");
+export const ProjectFileNotExistError = (projectFilePath: string): string => { return localize('dataworkspace.projectFileNotExistError', "The selected project file '{0}' does not exist or is not a file.", projectFilePath); };
+export const WorkspaceFileNotExistError = (workspaceFilePath: string): string => { return localize('dataworkspace.workspaceFileNotExistError', "The selected workspace file '{0}' does not exist or is not a file.", workspaceFilePath); };
+export const Project = localize('dataworkspace.project', "Project");
+export const Workspace = localize('dataworkspace.workspace', "Workspace");
+export const LocationSelectorTitle = localize('dataworkspace.locationSelectorTitle', "Location");
+export const ProjectFilePlaceholder = localize('dataworkspace.projectFilePlaceholder', "Enter project location");
+export const WorkspacePlaceholder = localize('dataworkspace.workspacePlaceholder', "Enter workspace location");
+export const WorkspaceFileExtension = 'code-workspace';
+
+// Workspace settings for saving new projects
+export const ProjectConfigurationKey = 'projects';
+export const ProjectSaveLocationKey = 'defaultProjectSaveLocation';

extensions/data-workspace/src/common/dataWorkspaceExtension.ts

@@ -0,0 +1,30 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the Source EULA. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import * as vscode from 'vscode';
+import { IExtension } from 'dataworkspace';
+import { WorkspaceService } from '../services/workspaceService';
+import { defaultProjectSaveLocation } from './projectLocationHelper';
+
+export class DataWorkspaceExtension implements IExtension {
+	constructor(private workspaceService: WorkspaceService) {
+	}
+
+	getProjectsInWorkspace(): vscode.Uri[] {
+		return this.workspaceService.getProjectsInWorkspace();
+	}
+
+	addProjectsToWorkspace(projectFiles: vscode.Uri[]): Promise<void> {
+		return this.workspaceService.addProjectsToWorkspace(projectFiles);
+	}
+
+	showProjectsView(): void {
+		vscode.commands.executeCommand('dataworkspace.views.main.focus');
+	}
+
+	get defaultProjectSaveLocation(): vscode.Uri | undefined {
+		return defaultProjectSaveLocation();
+	}
+}

extensions/data-workspace/src/common/iconHelper.ts

@@ -0,0 +1,38 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the Source EULA. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import * as vscode from 'vscode';
+
+export interface IconPath {
+	dark: string;
+	light: string;
+}
+
+export class IconPathHelper {
+	private static extensionContext: vscode.ExtensionContext;
+	public static folder: IconPath;
+
+	public static setExtensionContext(extensionContext: vscode.ExtensionContext) {
+		IconPathHelper.extensionContext = extensionContext;
+
+		IconPathHelper.folder = IconPathHelper.makeIcon('folder', true);
+	}
+
+	private static makeIcon(name: string, sameIcon: boolean = false) {
+		const folder = 'images';
+
+		if (sameIcon) {
+			return {
+				dark: IconPathHelper.extensionContext.asAbsolutePath(`${folder}/${name}.svg`),
+				light: IconPathHelper.extensionContext.asAbsolutePath(`${folder}/${name}.svg`)
+			};
+		} else {
+			return {
+				dark: IconPathHelper.extensionContext.asAbsolutePath(`${folder}/dark/${name}.svg`),
+				light: IconPathHelper.extensionContext.asAbsolutePath(`${folder}/light/${name}.svg`)
+			};
+		}
+	}
+}

extensions/data-workspace/src/common/interfaces.ts

@@ -26,9 +26,15 @@ export interface IProjectProviderRegistry {
 	 */
 	readonly providers: IProjectProvider[];
 
+	/**
+	 * Gets the project provider for the specified project extension
+	 * @param extension The file extension of the project
+	 */
+	getProviderByProjectExtension(extension: string): IProjectProvider | undefined;
+
 	/**
 	 * Gets the project provider for the specified project type
-	 * @param projectType The project type, file extension of the project
+	 * @param projectType The id of the project type
 	 */
 	getProviderByProjectType(projectType: string): IProjectProvider | undefined;
 }
@@ -45,7 +51,7 @@ export interface IWorkspaceService {
 	/**
 	 * Gets the project files in current workspace
 	 */
-	getProjectsInWorkspace(): Promise<vscode.Uri[]>;
+	getProjectsInWorkspace(): vscode.Uri[];
 
 	/**
 	 * Gets the project provider by project file
@@ -65,8 +71,28 @@ export interface IWorkspaceService {
 	 */
 	removeProject(projectFile: vscode.Uri): Promise<void>;
 
+	/**
+	 * Creates a new project from workspace
+	 * @param name The name of the project
+	 * @param location The location of the project
+	 * @param projectTypeId The project type id
+	 */
+	createProject(name: string, location: vscode.Uri, projectTypeId: string): Promise<vscode.Uri>;
+
+	readonly isProjectProviderAvailable: boolean;
+
 	/**
 	 * Event fires when projects in workspace changes
 	 */
 	readonly onDidWorkspaceProjectsChange: vscode.Event<void>;
+
+	/**
+	 * Verify that a workspace is open or if one isn't, ask user to pick whether a workspace should be automatically created
+	 */
+	validateWorkspace(): Promise<boolean>;
+
+	/**
+	 * Shows confirmation message that the extension host will be restarted and current workspace/file will be closed. If confirmed, the specified workspace will be entered.
+	 */
+	enterWorkspace(workspaceFile: vscode.Uri): Promise<void>;
 }

extensions/data-workspace/src/common/projectLocationHelper.ts

@@ -0,0 +1,46 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the Source EULA. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import * as vscode from 'vscode';
+import * as fs from 'fs';
+import * as constants from '../common/constants';
+
+/**
+ * Returns the default location to save a new database project
+ */
+export function defaultProjectSaveLocation(): vscode.Uri | undefined {
+	return projectSaveLocationSettingIsValid() ? vscode.Uri.file(projectSaveLocationSetting()) : undefined;
+}
+
+/**
+ * Get workspace configurations for this extension
+ */
+function config(): vscode.WorkspaceConfiguration {
+	return vscode.workspace.getConfiguration(constants.ProjectConfigurationKey);
+}
+
+/**
+ * Returns the workspace setting on the default location to save new database projects
+ */
+function projectSaveLocationSetting(): string {
+	return config()[constants.ProjectSaveLocationKey];
+}
+
+/**
+ * Returns if the default save location for new database projects workspace setting exists and is
+ * a valid path
+ */
+function projectSaveLocationSettingIsValid(): boolean {
+	return projectSaveLocationSettingExists() && fs.existsSync(projectSaveLocationSetting());
+}
+
+/**
+ * Returns if a value for the default save location for new database projects exists
+ */
+function projectSaveLocationSettingExists(): boolean {
+	return projectSaveLocationSetting() !== undefined && projectSaveLocationSetting() !== null
+		&& projectSaveLocationSetting().trim() !== '';
+}
+

extensions/data-workspace/src/common/projectProviderRegistry.ts

@@ -9,20 +9,24 @@ import { IProjectProviderRegistry } from './interfaces';
 
 export const ProjectProviderRegistry: IProjectProviderRegistry = new class implements IProjectProviderRegistry {
 	private _providers = new Array<IProjectProvider>();
-	private _providerMapping: { [key: string]: IProjectProvider } = {};
+	private _providerFileExtensionMapping: { [key: string]: IProjectProvider } = {};
+	private _providerProjectTypeMapping: { [key: string]: IProjectProvider } = {};
+
 
 	registerProvider(provider: IProjectProvider): vscode.Disposable {
 		this.validateProvider(provider);
 		this._providers.push(provider);
 		provider.supportedProjectTypes.forEach(projectType => {
-			this._providerMapping[projectType.projectFileExtension.toUpperCase()] = provider;
+			this._providerFileExtensionMapping[projectType.projectFileExtension.toUpperCase()] = provider;
+			this._providerProjectTypeMapping[projectType.id.toUpperCase()] = provider;
 		});
 		return new vscode.Disposable(() => {
 			const idx = this._providers.indexOf(provider);
 			if (idx >= 0) {
 				this._providers.splice(idx, 1);
 				provider.supportedProjectTypes.forEach(projectType => {
-					delete this._providerMapping[projectType.projectFileExtension.toUpperCase()];
+					delete this._providerFileExtensionMapping[projectType.projectFileExtension.toUpperCase()];
+					delete this._providerProjectTypeMapping[projectType.id.toUpperCase()];
 				});
 			}
 		});
@@ -39,7 +43,11 @@ export const ProjectProviderRegistry: IProjectProviderRegistry = new class imple
 	validateProvider(provider: IProjectProvider): void {
 	}
 
+	getProviderByProjectExtension(extension: string): IProjectProvider | undefined {
+		return extension ? this._providerFileExtensionMapping[extension.toUpperCase()] : undefined;
+	}
+
 	getProviderByProjectType(projectType: string): IProjectProvider | undefined {
-		return projectType ? this._providerMapping[projectType.toUpperCase()] : undefined;
+		return projectType ? this._providerProjectTypeMapping[projectType.toUpperCase()] : undefined;
 	}
 };

extensions/data-workspace/src/common/utils.ts

@@ -0,0 +1,31 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the Source EULA. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import * as fs from 'fs';
+
+export async function directoryExist(directoryPath: string): Promise<boolean> {
+	const stats = await getFileStatus(directoryPath);
+	return stats ? stats.isDirectory() : false;
+}
+
+export async function fileExist(filePath: string): Promise<boolean> {
+	const stats = await getFileStatus(filePath);
+	return stats ? stats.isFile() : false;
+}
+
+async function getFileStatus(path: string): Promise<fs.Stats | undefined> {
+	try {
+		const stats = await fs.promises.stat(path);
+		return stats;
+	}
+	catch (e) {
+		if (e.code === 'ENOENT') {
+			return undefined;
+		}
+		else {
+			throw e;
+		}
+	}
+}

extensions/data-workspace/src/common/workspaceTreeDataProvider.ts

@@ -5,7 +5,7 @@
 
 import * as vscode from 'vscode';
 import { IWorkspaceService } from './interfaces';
-import { UnknownProjectsErrorMessage } from './constants';
+import { UnknownProjectsError } from './constants';
 import { WorkspaceTreeItem } from 'dataworkspace';
 
 /**
@@ -37,6 +37,7 @@ export class WorkspaceTreeDataProvider implements vscode.TreeDataProvider<Worksp
 		else {
 			// if the element is undefined return the project tree items
 			const projects = await this._workspaceService.getProjectsInWorkspace();
+			await vscode.commands.executeCommand('setContext', 'isProjectsViewEmpty', projects.length === 0);
 			const unknownProjects: string[] = [];
 			const treeItems: WorkspaceTreeItem[] = [];
 			for (const project of projects) {
@@ -60,7 +61,7 @@ export class WorkspaceTreeDataProvider implements vscode.TreeDataProvider<Worksp
 				});
 			}
 			if (unknownProjects.length > 0) {
-				vscode.window.showErrorMessage(UnknownProjectsErrorMessage(unknownProjects));
+				vscode.window.showErrorMessage(UnknownProjectsError(unknownProjects));
 			}
 			return treeItems;
 		}