add disposeTableDesigner (#17394)

This commit is contained in:
Alan Ren
2021-10-19 14:28:56 -07:00
committed by GitHub
parent ec8292adb7
commit 328ed83cb9
8 changed files with 57 additions and 21 deletions

View File

@@ -1050,4 +1050,7 @@ export namespace SaveTableDesignerChangesRequest {
export const type = new RequestType<SaveTableDesignerChangesRequestParams, void, void, void>('tabledesigner/savechanges');
}
export namespace DisposeTableDesignerRequest {
export const type = new RequestType<azdata.designers.TableInfo, void, void, void>('tabledesigner/dispose');
}
// ------------------------------- < Table Designer > ------------------------------------

View File

@@ -1146,11 +1146,22 @@ export class TableDesignerFeature extends SqlOpsFeature<undefined> {
}
};
const disposeTableDesigner = (tableInfo: azdata.designers.TableInfo): Thenable<void> => {
try {
return client.sendRequest(contracts.DisposeTableDesignerRequest.type, tableInfo);
}
catch (e) {
client.logFailedRequest(contracts.DisposeTableDesignerRequest.type, e);
return Promise.reject(e);
}
};
return azdata.dataprotocol.registerTableDesignerProvider({
providerId: client.providerId,
getTableDesignerInfo,
processTableEdit,
saveTable
saveTable,
disposeTableDesigner
});
}
}

View File

@@ -7,15 +7,17 @@ import { AppContext } from '../appContext';
import * as azdata from 'azdata';
import * as vscode from 'vscode';
import { sqlProviderName } from '../constants';
import { generateUuid } from 'vscode-languageclient/lib/utils/uuid';
export function registerTableDesignerCommands(appContext: AppContext) {
appContext.extensionContext.subscriptions.push(vscode.commands.registerCommand('mssql.newTable', async (context: azdata.ObjectExplorerContext) => {
const connectionUri = await azdata.connection.getUriForConnection(context.connectionProfile.id);
const connectionString = await azdata.connection.getConnectionString(context.connectionProfile.id, true);
await azdata.designers.openTableDesigner(sqlProviderName, {
server: context.connectionProfile.serverName,
database: context.connectionProfile.databaseName,
isNewTable: true,
connectionUri: connectionUri
id: generateUuid(),
connectionString: connectionString
});
}));
@@ -24,6 +26,7 @@ export function registerTableDesignerCommands(appContext: AppContext) {
const database = context.connectionProfile.databaseName;
const schema = context.nodeInfo.metadata.schema;
const name = context.nodeInfo.metadata.name;
const connectionString = await azdata.connection.getConnectionString(context.connectionProfile.id, true);
const connectionUri = await azdata.connection.getUriForConnection(context.connectionProfile.id);
await azdata.designers.openTableDesigner(sqlProviderName, {
server: server,
@@ -31,9 +34,8 @@ export function registerTableDesignerCommands(appContext: AppContext) {
isNewTable: false,
name: name,
schema: schema,
id: `${server}|${database}|${schema}|${name}`,
connectionUri: connectionUri
id: `${connectionUri}|${database}|${schema}|${name}`,
connectionString: connectionString
});
}));
}

View File

@@ -1028,6 +1028,12 @@ declare module 'azdata' {
* @param viewModel the object contains the state of the table designer
*/
saveTable(table: TableInfo, viewModel: DesignerViewModel): Thenable<void>;
/**
* Notify the provider that the table designer has been closed.
* @param table the table information
*/
disposeTableDesigner(table: TableInfo): Thenable<void>;
}
/**
@@ -1055,9 +1061,9 @@ declare module 'azdata' {
*/
isNewTable: boolean;
/**
* If this is not a new table, the id will be set to uniquely identify a table.
* Unique identifier of the table. Will be used to decide whether a designer is already opened for the table.
*/
id?: string;
id: string;
/**
* Extension can store additional information that the provider needs to uniquely identify a table.
*/

View File

@@ -521,6 +521,9 @@ export class MainThreadDataProtocol extends Disposable implements MainThreadData
},
saveTable(tableInfo: azdata.designers.TableInfo, data: azdata.designers.DesignerViewModel): Thenable<void> {
return self._proxy.$saveTable(handle, tableInfo, data);
},
disposeTableDesigner(tableInfo: azdata.designers.TableInfo): Thenable<void> {
return self._proxy.$disposeTableDesigner(handle, tableInfo);
}
});

View File

@@ -892,16 +892,20 @@ export class ExtHostDataProtocol extends ExtHostDataProtocolShape {
}
// Table Designer
public override $getTableDesignerInfo(handle, table: azdata.designers.TableInfo): Thenable<azdata.designers.TableDesignerInfo> {
public override $getTableDesignerInfo(handle: number, table: azdata.designers.TableInfo): Thenable<azdata.designers.TableDesignerInfo> {
return this._resolveProvider<azdata.designers.TableDesignerProvider>(handle).getTableDesignerInfo(table);
}
public override $processTableDesignerEdit(handle, table: azdata.designers.TableInfo, data: azdata.designers.DesignerViewModel, edit: azdata.designers.DesignerEdit): Thenable<azdata.designers.DesignerEditResult> {
return this._resolveProvider<azdata.designers.TableDesignerProvider>(handle).processTableEdit(table, data, edit);
public override $processTableDesignerEdit(handle: number, table: azdata.designers.TableInfo, viewModel: azdata.designers.DesignerViewModel, edit: azdata.designers.DesignerEdit): Thenable<azdata.designers.DesignerEditResult> {
return this._resolveProvider<azdata.designers.TableDesignerProvider>(handle).processTableEdit(table, viewModel, edit);
}
public override $saveTable(handle, table: azdata.designers.TableInfo, data: azdata.designers.DesignerViewModel): Thenable<void> {
return this._resolveProvider<azdata.designers.TableDesignerProvider>(handle).saveTable(table, data);
public override $saveTable(handle: number, table: azdata.designers.TableInfo, viewModel: azdata.designers.DesignerViewModel): Thenable<void> {
return this._resolveProvider<azdata.designers.TableDesignerProvider>(handle).saveTable(table, viewModel);
}
public override $disposeTableDesigner(handle: number, table: azdata.designers.TableInfo): Thenable<void> {
return this._resolveProvider<azdata.designers.TableDesignerProvider>(handle).disposeTableDesigner(table);
}
public override $openTableDesigner(providerId: string, tableInfo: azdata.designers.TableInfo): Promise<void> {

View File

@@ -530,17 +530,22 @@ export abstract class ExtHostDataProtocolShape {
/**
* Gets the table designer info for the specified table
*/
$getTableDesignerInfo(handle, table: azdata.designers.TableInfo): Thenable<azdata.designers.TableDesignerInfo> { throw ni(); }
$getTableDesignerInfo(handle: number, table: azdata.designers.TableInfo): Thenable<azdata.designers.TableDesignerInfo> { throw ni(); }
/**
* Process the table edit.
*/
$processTableDesignerEdit(handle, table: azdata.designers.TableInfo, data: azdata.designers.DesignerViewModel, edit: azdata.designers.DesignerEdit): Thenable<azdata.designers.DesignerEditResult> { throw ni(); }
$processTableDesignerEdit(handle: number, table: azdata.designers.TableInfo, data: azdata.designers.DesignerViewModel, edit: azdata.designers.DesignerEdit): Thenable<azdata.designers.DesignerEditResult> { throw ni(); }
/**
* Process the table edit.
*/
$saveTable(handle, table: azdata.designers.TableInfo, data: azdata.designers.DesignerViewModel): Thenable<void> { throw ni(); }
$saveTable(handle: number, table: azdata.designers.TableInfo, data: azdata.designers.DesignerViewModel): Thenable<void> { throw ni(); }
/**
* Dispose the table designer.
*/
$disposeTableDesigner(handle: number, table: azdata.designers.TableInfo): Thenable<void> { throw ni(); }
/**
* Open a new instance of table designer.

View File

@@ -12,6 +12,7 @@ import * as azdata from 'azdata';
import { GroupIdentifier, IEditorInput, IRevertOptions, ISaveOptions } from 'vs/workbench/common/editor';
import { IInstantiationService } from 'vs/platform/instantiation/common/instantiation';
import { IEditorService } from 'vs/workbench/services/editor/common/editorService';
import { onUnexpectedError } from 'vs/base/common/errors';
const NewTable: string = localize('tableDesigner.newTable', "New Table");
@@ -78,12 +79,13 @@ export class TableDesignerInput extends EditorInput {
}
override matches(otherInput: any): boolean {
// For existing tables, the table designer provider will give us unique id, we can use it to do the match.
// For new tables, we can do the match using their names.
return otherInput instanceof TableDesignerInput
&& this._provider.providerId === otherInput._provider.providerId
&& this._tableInfo.isNewTable === otherInput._tableInfo.isNewTable
&& (!this._tableInfo.isNewTable || this.getName() === otherInput.getName())
&& (this._tableInfo.isNewTable || this._tableInfo.id === otherInput._tableInfo.id);
&& this._tableInfo.id === otherInput._tableInfo.id;
}
override dispose(): void {
super.dispose();
this._provider.disposeTableDesigner(this._tableInfo).then(undefined, err => onUnexpectedError(err));
}
}