SQL Operations Studio Public Preview 1 (0.23) release source code

src/sql/parts/connection/common/connectionManagement.ts

@@ -0,0 +1,341 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the Source EULA. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+'use strict';
+
+import { IViewlet } from 'vs/workbench/common/viewlet';
+import { createDecorator } from 'vs/platform/instantiation/common/instantiation';
+import { TPromise } from 'vs/base/common/winjs.base';
+import Event from 'vs/base/common/event';
+import data = require('data');
+import { IConnectionProfileGroup, ConnectionProfileGroup } from 'sql/parts/connection/common/connectionProfileGroup';
+import { ConnectionProfile } from 'sql/parts/connection/common/connectionProfile';
+import { IConnectionProfile } from 'sql/parts/connection/common/interfaces';
+import Severity from 'vs/base/common/severity';
+import { ISelectionData } from 'data';
+import { ConnectionManagementInfo } from './connectionManagementInfo';
+
+export const VIEWLET_ID = 'workbench.view.connections';
+
+export interface IConnectionsViewlet extends IViewlet {
+	search(text: string): void;
+}
+
+/**
+ * Options for the actions that could happen after connecting is complete
+ */
+export interface IConnectionCompletionOptions {
+	/**
+	 * save the connection to MRU and settings (only save to setting if profile.saveProfile is set to true)
+	 */
+	saveTheConnection: boolean;
+
+	/**
+	 * open the dashboard after connection is complete
+	 */
+	showDashboard: boolean;
+
+	/**
+	 * Parameters to be used if connecting from an editor
+	 */
+	params: INewConnectionParams;
+
+	/**
+	 * Open the connection dialog if connection fails
+	 */
+	showConnectionDialogOnError: boolean;
+
+	/**
+	 * Open the connection firewall rule dialog if connection fails
+	 */
+	showFirewallRuleOnError: boolean;
+}
+
+export interface IConnectionResult {
+	connected: boolean;
+	errorMessage: string;
+	errorCode: number;
+	errorHandled?: boolean;
+}
+
+export interface IConnectionCallbacks {
+	onConnectStart(): void;
+	onConnectReject(error?: string): void;
+	onConnectSuccess(params?: INewConnectionParams): void;
+	onDisconnect(): void;
+}
+
+export const SERVICE_ID = 'connectionManagementService';
+
+export const IConnectionManagementService = createDecorator<IConnectionManagementService>(SERVICE_ID);
+
+export interface IConnectionManagementService {
+	_serviceBrand: any;
+
+	// Event Emitters
+	onAddConnectionProfile: Event<IConnectionProfile>;
+	onDeleteConnectionProfile: Event<void>;
+	onConnect: Event<IConnectionParams>;
+	onDisconnect: Event<IConnectionParams>;
+	onConnectionChanged: Event<IConnectionParams>;
+	onLanguageFlavorChanged: Event<data.DidChangeLanguageFlavorParams>;
+
+	/**
+	 * Opens the connection dialog to create new connection
+	 */
+	showConnectionDialog(params?: INewConnectionParams, model?: IConnectionProfile, error?: string): Promise<void>;
+
+	/**
+	 * Opens the add server group dialog
+	 */
+	showCreateServerGroupDialog(callbacks?: IServerGroupDialogCallbacks): Promise<void>;
+
+	/**
+	 * Opens the edit server group dialog
+	 */
+	showEditServerGroupDialog(group: ConnectionProfileGroup): Promise<void>;
+
+	/**
+	 * Load the password and opens a new connection
+	 */
+	connect(connection: IConnectionProfile, uri: string, options?: IConnectionCompletionOptions, callbacks?: IConnectionCallbacks): Promise<IConnectionResult>;
+
+	/**
+	 * Opens a new connection and save the profile in settings
+	 */
+	connectAndSaveProfile(connection: IConnectionProfile, uri: string, options?: IConnectionCompletionOptions, callbacks?: IConnectionCallbacks): Promise<IConnectionResult>;
+
+	/**
+	 * Finds existing connection for given profile and purpose is any exists.
+	 * The purpose is connection by default
+	 */
+	findExistingConnection(connection: IConnectionProfile, purpose?: 'dashboard' | 'insights' | 'connection'): ConnectionProfile;
+
+	/**
+	 * If there's already a connection for given profile and purpose, returns the ownerUri for the connection
+	 * otherwise tries to make a connection and returns the owner uri when connection is complete
+	 * The purpose is connection by default
+	 */
+	connectIfNotConnected(connection: IConnectionProfile, purpose?: 'dashboard' | 'insights' | 'connection'): Promise<string>;
+
+	/**
+	 * Adds the successful connection to MRU and send the connection error back to the connection handler for failed connections
+	 */
+	onConnectionComplete(handle: number, connectionInfoSummary: data.ConnectionInfoSummary): void;
+
+	onIntelliSenseCacheComplete(handle: number, connectionUri: string): void;
+
+	onConnectionChangedNotification(handle: number, changedConnInfo: data.ChangedConnectionInfo);
+
+	getConnectionGroups(): ConnectionProfileGroup[];
+
+	getRecentConnections(): ConnectionProfile[];
+
+	clearRecentConnectionsList(): void;
+
+	getActiveConnections(): ConnectionProfile[];
+
+	saveProfileGroup(profile: IConnectionProfileGroup): Promise<string>;
+
+	changeGroupIdForConnectionGroup(source: IConnectionProfileGroup, target: IConnectionProfileGroup): Promise<void>;
+
+	changeGroupIdForConnection(source: ConnectionProfile, targetGroupName: string): Promise<void>;
+
+	deleteConnection(connection: ConnectionProfile): Promise<boolean>;
+
+	deleteConnectionGroup(group: ConnectionProfileGroup): Promise<boolean>;
+
+	getAdvancedProperties(): data.ConnectionOption[];
+
+	getConnectionId(connectionProfile: IConnectionProfile): string;
+
+	getFormattedUri(uri: string, connectionProfile: IConnectionProfile): string;
+
+	isConnected(fileUri: string): boolean;
+
+	/**
+	 * Returns true if the connection profile is connected
+	 */
+	isProfileConnected(connectionProfile: IConnectionProfile): boolean;
+
+	/**
+	 * Returns true if the connection profile is connecting
+	 */
+	isProfileConnecting(connectionProfile: IConnectionProfile): boolean;
+
+	isRecent(connectionProfile: ConnectionProfile): boolean;
+
+	isConnected(fileUri: string, connectionProfile?: ConnectionProfile): boolean;
+
+	disconnectEditor(owner: IConnectableInput, force?: boolean): Promise<boolean>;
+
+	disconnect(connection: ConnectionProfile): Promise<void>;
+
+	disconnect(ownerUri: string): Promise<void>;
+
+	addSavedPassword(connectionProfile: IConnectionProfile): Promise<IConnectionProfile>;
+
+	listDatabases(connectionUri: string): Thenable<data.ListDatabasesResult>;
+
+	/**
+	 * Register a connection provider
+	 */
+	registerProvider(providerId: string, provider: data.ConnectionProvider): void;
+
+	editGroup(group: ConnectionProfileGroup): Promise<void>;
+
+	getConnectionProfile(fileUri: string): IConnectionProfile;
+
+	getConnectionInfo(fileUri: string): ConnectionManagementInfo;
+
+	/**
+	 * Cancels the connection
+	 */
+	cancelConnection(connection: IConnectionProfile): Thenable<boolean>;
+
+	/**
+	 * Changes the database for an active connection
+	 */
+	changeDatabase(connectionUri: string, databaseName: string): Thenable<boolean>;
+
+	/**
+	 * Cancels the connection for the editor
+	 */
+	cancelEditorConnection(owner: IConnectableInput): Thenable<boolean>;
+
+	showDashboard(connection: ConnectionProfile): Thenable<boolean>;
+
+	closeDashboard(uri: string): void;
+
+	getProviderIdFromUri(ownerUri: string): string;
+
+	hasRegisteredServers(): boolean;
+
+	getCapabilities(providerName: string): data.DataProtocolServerCapabilities;
+
+	canChangeConnectionConfig(profile: ConnectionProfile, newGroupID: string): boolean;
+
+	/**
+	 * Sends a notification that the language flavor for a given URI has changed.
+	 * For SQL, this would be the specific SQL implementation being used.
+	 *
+	 * @param {string} uri the URI of the resource whose language has changed
+	 * @param {string} language the base language
+	 * @param {string} flavor the specific language flavor that's been set
+	 *
+	 * @memberof IConnectionManagementService
+	 */
+	doChangeLanguageFlavor(uri: string, language: string, flavor: string): void;
+
+	/**
+	 * Ensures that a default language flavor is set for a URI, if none has already been defined.
+	 * @param {string} uri document identifier
+	 * @memberof ConnectionManagementService
+	 */
+	ensureDefaultLanguageFlavor(uri: string): void;
+
+	/**
+	 * Gets an array of all known providers.
+	 *
+	 * @returns {string[]} An array of provider names
+	 * @memberof IConnectionManagementService
+	 */
+	getProviderNames(): string[];
+
+	/**
+	 * Refresh the IntelliSense cache for the connection with the given URI
+	 */
+	rebuildIntelliSenseCache(uri: string): Thenable<void>;
+}
+
+export const IConnectionDialogService = createDecorator<IConnectionDialogService>('connectionDialogService');
+export interface IConnectionDialogService {
+	_serviceBrand: any;
+	showDialog(connectionManagementService: IConnectionManagementService, params: INewConnectionParams, model: IConnectionProfile, error?: string): Thenable<void>;
+}
+
+export interface IServerGroupDialogCallbacks {
+	onAddGroup(groupName: string): void;
+	onClose(): void;
+}
+export const IServerGroupController = createDecorator<IServerGroupController>('serverGroupController');
+export interface IServerGroupController {
+	_serviceBrand: any;
+	showCreateGroupDialog(connectionManagementService: IConnectionManagementService, callbacks?: IServerGroupDialogCallbacks): TPromise<void>;
+	showEditGroupDialog(connectionManagementService: IConnectionManagementService, group: ConnectionProfileGroup): TPromise<void>;
+}
+
+export const IErrorMessageService = createDecorator<IErrorMessageService>('errorMessageService');
+export interface IErrorMessageService {
+	_serviceBrand: any;
+	showDialog(severity: Severity, headerTitle: string, message: string): void;
+}
+
+export enum ServiceOptionType {
+	string = 0,
+	multistring = 1,
+	password = 2,
+	number = 3,
+	category = 4,
+	boolean = 5
+}
+
+export enum ConnectionOptionSpecialType {
+	serverName = 0,
+	databaseName = 1,
+	authType = 2,
+	userName = 3,
+	password = 4,
+	appName = 5
+}
+
+export enum RunQueryOnConnectionMode {
+	none = 0,
+	executeQuery = 1,
+	executeCurrentQuery = 2,
+	estimatedQueryPlan = 3
+}
+
+export interface INewConnectionParams {
+	connectionType: ConnectionType;
+	input?: IConnectableInput;
+	runQueryOnCompletion?: RunQueryOnConnectionMode;
+	querySelection?: ISelectionData;
+	showDashboard?: boolean;
+}
+
+export interface IConnectableInput {
+	uri: string;
+	onConnectStart(): void;
+	onConnectReject(error?: string): void;
+	onConnectSuccess(params?: INewConnectionParams): void;
+	onDisconnect(): void;
+}
+
+export enum ConnectionType {
+	default = 0,
+	editor = 1
+}
+
+export enum MetadataType {
+	Table = 0,
+	View = 1,
+	SProc = 2,
+	Function = 3
+}
+
+export enum TaskStatus {
+	notStarted = 0,
+	inProgress = 1,
+	succeeded = 2,
+	succeededWithWarning = 3,
+	failed = 4,
+	canceled = 5
+}
+
+export interface IConnectionParams {
+	connectionUri: string;
+	connectionProfile: IConnectionProfile;
+}