Switch query events to just send ranges instead of full query text (#19823)

* Switch query events to just send ranges instead of full query text

* undo azdata changes

* fix type

* comment + remove unneeded ?
This commit is contained in:
Charles Gagnon
2022-06-24 15:43:40 -07:00
committed by GitHub
parent 34f32e6564
commit ed5a64f80f
8 changed files with 69 additions and 78 deletions

View File

@@ -18,9 +18,6 @@ import { ConnectionProfile } from 'sql/platform/connection/common/connectionProf
import { ILogService } from 'vs/platform/log/common/log';
import { URI } from 'vs/base/common/uri';
import { IQueryEditorService } from 'sql/workbench/services/queryEditor/common/queryEditorService';
import { IModelService } from 'vs/editor/common/services/modelService';
import { Range } from 'vs/editor/common/core/range';
import { IExtHostQueryEvent } from 'sql/workbench/api/common/sqlExtHostTypes';
@extHostNamedCustomer(SqlMainContext.MainThreadQueryEditor)
export class MainThreadQueryEditor extends Disposable implements MainThreadQueryEditorShape {
@@ -35,8 +32,7 @@ export class MainThreadQueryEditor extends Disposable implements MainThreadQuery
@IEditorService private _editorService: IEditorService,
@IQueryManagementService private _queryManagementService: IQueryManagementService,
@ILogService private _logService: ILogService,
@IQueryEditorService private _queryEditorService: IQueryEditorService,
@IModelService private _modelService: IModelService
@IQueryEditorService private _queryEditorService: IQueryEditorService
) {
super();
if (extHostContext) {
@@ -121,35 +117,8 @@ export class MainThreadQueryEditor extends Disposable implements MainThreadQuery
public $registerQueryInfoListener(handle: number): void {
const disposable = this._queryModelService.onQueryEvent(event => {
let connectionProfile = this._connectionManagementService.getConnectionProfile(event.uri);
const uri: URI = URI.parse(event.uri);
const model = this._modelService.getModel(uri);
// Get the query text from the model - we do it here so we can send the query text for all events
// to the extension host from one place
let queryText: string | undefined = undefined;
if (model) {
// VS Range is 1 based so offset values by 1. The endLine we get back from SqlToolsService is incremented
// by 1 from the original input range sent in as well so take that into account and don't modify
queryText = event.queryInfo.range.length > 0 ?
model.getValueInRange(new Range(
event.queryInfo.range[0].startLineNumber,
event.queryInfo.range[0].startColumn,
event.queryInfo.range[0].endLineNumber,
event.queryInfo.range[0].endColumn)) :
// If no specific selection get the entire text
model.getValue();
}
// Convert into an IExtHostQueryEvent with the properties it expects
const extHostEvent: IExtHostQueryEvent = {
type: event.type,
uri: event.uri,
params: event.params,
queryInfo: {
messages: event.queryInfo.messages,
queryText
}
};
this._proxy.$onQueryEvent(connectionProfile?.providerName, handle, event.uri, extHostEvent);
const connectionProfile = this._connectionManagementService.getConnectionProfile(event.uri);
this._proxy.$onQueryEvent(connectionProfile?.providerName, handle, event.uri, event);
});
this._queryEventListenerDisposables.set(handle, disposable);
}

View File

@@ -9,7 +9,8 @@ import * as azdata from 'azdata';
import { mssqlProviderName } from 'sql/platform/connection/common/constants';
import { Disposable } from 'vs/workbench/api/common/extHostTypes';
import { URI } from 'vs/base/common/uri';
import { IExtHostQueryEvent } from 'sql/workbench/api/common/sqlExtHostTypes';
import { IQueryEvent } from 'sql/workbench/services/query/common/queryModel';
import * as sqlTypeConverters from 'sql/workbench/api/common/sqlExtHostTypeConverters';
class ExtHostQueryDocument implements azdata.queryeditor.QueryDocument {
constructor(
@@ -64,11 +65,11 @@ export class ExtHostQueryEditor implements ExtHostQueryEditorShape {
});
}
public $onQueryEvent(providerId: string, handle: number, fileUri: string, event: IExtHostQueryEvent): void {
public $onQueryEvent(providerId: string, handle: number, fileUri: string, event: IQueryEvent): void {
let listener: azdata.queryeditor.QueryEventListener = this._queryListeners[handle];
if (listener) {
let params = event.params && event.params.planXml ? event.params.planXml : event.params;
listener.onQueryEvent(event.type, new ExtHostQueryDocument(providerId, fileUri, this._proxy), params, event.queryInfo);
listener.onQueryEvent(event.type, new ExtHostQueryDocument(providerId, fileUri, this._proxy), params, sqlTypeConverters.QueryInfo.to(event.queryInfo));
}
}

View File

@@ -23,14 +23,14 @@ import {
IModelViewWizardDetails, IModelViewWizardPageDetails, IExecuteManagerDetails, INotebookSessionDetails,
INotebookKernelDetails, INotebookFutureDetails, FutureMessageType, INotebookFutureDone, INotebookEditOperation,
NotebookChangeKind,
ISerializationManagerDetails,
IExtHostQueryEvent
ISerializationManagerDetails
} from 'sql/workbench/api/common/sqlExtHostTypes';
import { IUndoStopOptions } from 'vs/workbench/api/common/extHost.protocol';
import { IExtensionDescription } from 'vs/platform/extensions/common/extensions';
import { EditorViewColumn } from 'vs/workbench/api/common/shared/editor';
import { TreeDataTransferDTO } from 'vs/workbench/api/common/shared/treeDataTransfer';
import { ITelemetryEventProperties } from 'sql/platform/telemetry/common/telemetry';
import { IQueryEvent } from 'sql/workbench/services/query/common/queryModel';
export abstract class ExtHostAzureBlobShape {
public $createSas(connectionUri: string, blobContainerUri: string, blobStorageKey: string, storageAccountName: string, expirationDate: string): Thenable<mssql.CreateSasResponse> { throw ni(); }
@@ -921,7 +921,7 @@ export interface MainThreadModelViewDialogShape extends IDisposable {
$setDirty(handle: number, isDirty: boolean): void;
}
export interface ExtHostQueryEditorShape {
$onQueryEvent(providerId: string, handle: number, fileUri: string, event: IExtHostQueryEvent): void;
$onQueryEvent(providerId: string, handle: number, fileUri: string, event: IQueryEvent): void;
}
export interface MainThreadQueryEditorShape extends IDisposable {

View File

@@ -0,0 +1,21 @@
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the Source EULA. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import type * as azdata from 'azdata';
import { IQueryInfo } from 'sql/workbench/services/query/common/queryModel';
import * as typeConverters from 'vs/workbench/api/common/extHostTypeConverters';
export namespace QueryInfo {
export function to(queryInfo: IQueryInfo | undefined): azdata.queryeditor.QueryInfo | undefined {
if (!queryInfo) {
return undefined;
}
return {
messages: queryInfo.messages,
range: queryInfo.range.map(r => typeConverters.Range.to(r))
};
}
}

View File

@@ -1057,14 +1057,3 @@ export namespace executionPlan {
None = 4
}
}
/**
* Query event info to send to the extension host. This is a separate type from IQueryEvent
* since this has the query text ranges converted into the actual query text.
*/
export interface IExtHostQueryEvent {
type: azdata.queryeditor.QueryEventType;
uri: string;
queryInfo: azdata.queryeditor.IQueryInfo;
params?: any;
}