Changing dacFxService and schemaCompareService to use shared logic for error handling (#22718)

* Move helper function to base class

* Switching DacFxService over

* Thenable -> Promise

* Converting SchemaCompareService
This commit is contained in:
Benjin Dubishar
2023-04-13 12:44:13 -07:00
committed by GitHub
parent 35e1d63871
commit 8202e1ec4e
5 changed files with 85 additions and 173 deletions

View File

@@ -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 { RequestType } from 'vscode-languageclient';
import { SqlOpsDataClient } from 'dataprotocol-client';
/**
* Base class containing shared code to reduce boilerplate for services
*/
export abstract class BaseService {
constructor(protected readonly client: SqlOpsDataClient) { }
/**
* Runs the specified request wrapped in the requisite try-catch
* @param type RequestType, typically in the format 'contracts.DoThingRequest.type'
* @param params parameters to be passed to the request
* @returns result from the request
*/
protected async runWithErrorHandling<P, R, E, RO>(type: RequestType<P, R, E, RO>, params: P): Promise<R> {
try {
const result = await this.client.sendRequest(type, params);
return result;
} catch (e) {
this.client.logFailedRequest(type, e);
throw e;
}
}
}

View File

@@ -1106,11 +1106,11 @@ export namespace SchemaCompareGetDefaultOptionsRequest {
}
export namespace SchemaCompareIncludeExcludeNodeRequest {
export const type = new RequestType<SchemaCompareNodeParams, azdata.ResultStatus, void, void>('schemaCompare/includeExcludeNode');
export const type = new RequestType<SchemaCompareNodeParams, mssql.SchemaCompareIncludeExcludeResult, void, void>('schemaCompare/includeExcludeNode');
}
export namespace SchemaCompareOpenScmpRequest {
export const type = new RequestType<SchemaCompareOpenScmpParams, azdata.ResultStatus, void, void>('schemaCompare/openScmp');
export const type = new RequestType<SchemaCompareOpenScmpParams, mssql.SchemaCompareOpenScmpResult, void, void>('schemaCompare/openScmp');
}
export namespace SchemaCompareSaveScmpRequest {

View File

@@ -4,15 +4,17 @@
*--------------------------------------------------------------------------------------------*/
import * as mssql from 'mssql';
import { AppContext } from '../appContext';
import { ISqlOpsFeature, SqlOpsDataClient } from 'dataprotocol-client';
import { ClientCapabilities } from 'vscode-languageclient';
import * as constants from '../constants';
import * as Utils from '../utils';
import * as azdata from 'azdata';
import * as contracts from '../contracts';
export class DacFxService implements mssql.IDacFxService {
import { AppContext } from '../appContext';
import { ISqlOpsFeature, SqlOpsDataClient } from 'dataprotocol-client';
import { ClientCapabilities } from 'vscode-languageclient';
import { BaseService } from '../baseService';
export class DacFxService extends BaseService implements mssql.IDacFxService {
public static asFeature(context: AppContext): ISqlOpsFeature {
return class extends DacFxService {
constructor(client: SqlOpsDataClient) {
@@ -28,117 +30,58 @@ export class DacFxService implements mssql.IDacFxService {
};
}
private constructor(context: AppContext, protected readonly client: SqlOpsDataClient) {
private constructor(context: AppContext, client: SqlOpsDataClient) {
super(client);
context.registerService(constants.DacFxService, this);
}
public exportBacpac(databaseName: string, packageFilePath: string, ownerUri: string, taskExecutionMode: azdata.TaskExecutionMode): Thenable<mssql.DacFxResult> {
public exportBacpac(databaseName: string, packageFilePath: string, ownerUri: string, taskExecutionMode: azdata.TaskExecutionMode): Promise<mssql.DacFxResult> {
const params: contracts.ExportParams = { databaseName: databaseName, packageFilePath: packageFilePath, ownerUri: ownerUri, taskExecutionMode: taskExecutionMode };
return this.client.sendRequest(contracts.ExportRequest.type, params).then(
undefined,
e => {
this.client.logFailedRequest(contracts.ExportRequest.type, e);
return Promise.reject(e);
}
);
return this.runWithErrorHandling(contracts.ExportRequest.type, params);
}
public importBacpac(packageFilePath: string, databaseName: string, ownerUri: string, taskExecutionMode: azdata.TaskExecutionMode): Thenable<mssql.DacFxResult> {
public importBacpac(packageFilePath: string, databaseName: string, ownerUri: string, taskExecutionMode: azdata.TaskExecutionMode): Promise<mssql.DacFxResult> {
const params: contracts.ImportParams = { packageFilePath: packageFilePath, databaseName: databaseName, ownerUri: ownerUri, taskExecutionMode: taskExecutionMode };
return this.client.sendRequest(contracts.ImportRequest.type, params).then(
undefined,
e => {
this.client.logFailedRequest(contracts.ImportRequest.type, e);
return Promise.reject(undefined);
}
);
return this.runWithErrorHandling(contracts.ImportRequest.type, params);
}
public extractDacpac(databaseName: string, packageFilePath: string, applicationName: string, applicationVersion: string, ownerUri: string, taskExecutionMode: azdata.TaskExecutionMode): Thenable<mssql.DacFxResult> {
public extractDacpac(databaseName: string, packageFilePath: string, applicationName: string, applicationVersion: string, ownerUri: string, taskExecutionMode: azdata.TaskExecutionMode): Promise<mssql.DacFxResult> {
const params: contracts.ExtractParams = { databaseName: databaseName, packageFilePath: packageFilePath, applicationName: applicationName, applicationVersion: applicationVersion, ownerUri: ownerUri, extractTarget: mssql.ExtractTarget.dacpac, taskExecutionMode: taskExecutionMode };
return this.client.sendRequest(contracts.ExtractRequest.type, params).then(
undefined,
e => {
this.client.logFailedRequest(contracts.ExtractRequest.type, e);
return Promise.reject(undefined);
}
);
return this.runWithErrorHandling(contracts.ExtractRequest.type, params);
}
public createProjectFromDatabase(databaseName: string, targetFilePath: string, applicationName: string, applicationVersion: string, ownerUri: string, extractTarget: mssql.ExtractTarget, taskExecutionMode: azdata.TaskExecutionMode, includePermissions?: boolean): Thenable<mssql.DacFxResult> {
public createProjectFromDatabase(databaseName: string, targetFilePath: string, applicationName: string, applicationVersion: string, ownerUri: string, extractTarget: mssql.ExtractTarget, taskExecutionMode: azdata.TaskExecutionMode, includePermissions?: boolean): Promise<mssql.DacFxResult> {
const params: contracts.ExtractParams = { databaseName: databaseName, packageFilePath: targetFilePath, applicationName: applicationName, applicationVersion: applicationVersion, ownerUri: ownerUri, extractTarget: extractTarget, taskExecutionMode: taskExecutionMode, includePermissions: includePermissions };
return this.client.sendRequest(contracts.ExtractRequest.type, params).then(
undefined,
e => {
this.client.logFailedRequest(contracts.ExtractRequest.type, e);
return Promise.reject(undefined);
}
);
return this.runWithErrorHandling(contracts.ExtractRequest.type, params);
}
public deployDacpac(packageFilePath: string, targetDatabaseName: string, upgradeExisting: boolean, ownerUri: string, taskExecutionMode: azdata.TaskExecutionMode, sqlCommandVariableValues?: Record<string, string>, deploymentOptions?: mssql.DeploymentOptions): Thenable<mssql.DacFxResult> {
public deployDacpac(packageFilePath: string, targetDatabaseName: string, upgradeExisting: boolean, ownerUri: string, taskExecutionMode: azdata.TaskExecutionMode, sqlCommandVariableValues?: Record<string, string>, deploymentOptions?: mssql.DeploymentOptions): Promise<mssql.DacFxResult> {
const params: contracts.DeployParams = { packageFilePath: packageFilePath, databaseName: targetDatabaseName, upgradeExisting: upgradeExisting, sqlCommandVariableValues: sqlCommandVariableValues, deploymentOptions: deploymentOptions, ownerUri: ownerUri, taskExecutionMode: taskExecutionMode };
return this.client.sendRequest(contracts.DeployRequest.type, params).then(
undefined,
e => {
this.client.logFailedRequest(contracts.DeployRequest.type, e);
return Promise.reject(undefined);
}
);
return this.runWithErrorHandling(contracts.DeployRequest.type, params);
}
public generateDeployScript(packageFilePath: string, targetDatabaseName: string, ownerUri: string, taskExecutionMode: azdata.TaskExecutionMode, sqlCommandVariableValues?: Record<string, string>, deploymentOptions?: mssql.DeploymentOptions): Thenable<mssql.DacFxResult> {
public generateDeployScript(packageFilePath: string, targetDatabaseName: string, ownerUri: string, taskExecutionMode: azdata.TaskExecutionMode, sqlCommandVariableValues?: Record<string, string>, deploymentOptions?: mssql.DeploymentOptions): Promise<mssql.DacFxResult> {
const params: contracts.GenerateDeployScriptParams = { packageFilePath: packageFilePath, databaseName: targetDatabaseName, sqlCommandVariableValues: sqlCommandVariableValues, deploymentOptions: deploymentOptions, ownerUri: ownerUri, taskExecutionMode: taskExecutionMode };
return this.client.sendRequest(contracts.GenerateDeployScriptRequest.type, params).then(
undefined,
e => {
this.client.logFailedRequest(contracts.GenerateDeployScriptRequest.type, e);
return Promise.reject(undefined);
}
);
return this.runWithErrorHandling(contracts.GenerateDeployScriptRequest.type, params);
}
public generateDeployPlan(packageFilePath: string, targetDatabaseName: string, ownerUri: string, taskExecutionMode: azdata.TaskExecutionMode): Thenable<mssql.GenerateDeployPlanResult> {
public generateDeployPlan(packageFilePath: string, targetDatabaseName: string, ownerUri: string, taskExecutionMode: azdata.TaskExecutionMode): Promise<mssql.GenerateDeployPlanResult> {
const params: contracts.GenerateDeployPlanParams = { packageFilePath: packageFilePath, databaseName: targetDatabaseName, ownerUri: ownerUri, taskExecutionMode: taskExecutionMode };
return this.client.sendRequest(contracts.GenerateDeployPlanRequest.type, params).then(
undefined,
e => {
this.client.logFailedRequest(contracts.GenerateDeployPlanRequest.type, e);
return Promise.reject(undefined);
}
);
return this.runWithErrorHandling(contracts.GenerateDeployPlanRequest.type, params);
}
public getOptionsFromProfile(profilePath: string): Thenable<mssql.DacFxOptionsResult> {
public getOptionsFromProfile(profilePath: string): Promise<mssql.DacFxOptionsResult> {
const params: contracts.GetOptionsFromProfileParams = { profilePath: profilePath };
return this.client.sendRequest(contracts.GetOptionsFromProfileRequest.type, params).then(
undefined,
e => {
this.client.logFailedRequest(contracts.GetOptionsFromProfileRequest.type, e);
return Promise.reject(undefined);
}
);
return this.runWithErrorHandling(contracts.GetOptionsFromProfileRequest.type, params);
}
public validateStreamingJob(packageFilePath: string, createStreamingJobTsql: string): Thenable<mssql.ValidateStreamingJobResult> {
public validateStreamingJob(packageFilePath: string, createStreamingJobTsql: string): Promise<mssql.ValidateStreamingJobResult> {
const params: contracts.ValidateStreamingJobParams = { packageFilePath: packageFilePath, createStreamingJobTsql: createStreamingJobTsql };
return this.client.sendRequest(contracts.ValidateStreamingJobRequest.type, params).then(
undefined,
e => {
this.client.logFailedRequest(contracts.ValidateStreamingJobRequest.type, e);
return Promise.reject(undefined);
}
);
return this.runWithErrorHandling(contracts.ValidateStreamingJobRequest.type, params);
}
public async parseTSqlScript(filePath: string, databaseSchemaProvider: string): Promise<mssql.ParseTSqlScriptResult> {
const params: contracts.ParseTSqlScriptParams = { filePath, databaseSchemaProvider };
try {
const result = await this.client.sendRequest(contracts.ParseTSqlScriptRequest.type, params);
return result;
} catch (e) {
this.client.logFailedRequest(contracts.ParseTSqlScriptRequest.type, e);
throw e;
}
return this.runWithErrorHandling(contracts.ParseTSqlScriptRequest.type, params);
}
}

View File

@@ -11,8 +11,9 @@ import * as Utils from '../utils';
import { ClientCapabilities } from 'vscode-languageclient';
import * as azdata from 'azdata';
import * as contracts from '../contracts';
import { BaseService } from '../baseService';
export class SchemaCompareService implements mssql.ISchemaCompareService {
export class SchemaCompareService extends BaseService implements mssql.ISchemaCompareService {
public static asFeature(context: AppContext): ISqlOpsFeature {
return class extends SchemaCompareService {
constructor(client: SqlOpsDataClient) {
@@ -28,106 +29,53 @@ export class SchemaCompareService implements mssql.ISchemaCompareService {
};
}
private constructor(context: AppContext, protected readonly client: SqlOpsDataClient) {
private constructor(context: AppContext, client: SqlOpsDataClient) {
super(client);
context.registerService(constants.SchemaCompareService, this);
}
public schemaCompare(operationId: string, sourceEndpointInfo: mssql.SchemaCompareEndpointInfo, targetEndpointInfo: mssql.SchemaCompareEndpointInfo, taskExecutionMode: azdata.TaskExecutionMode, deploymentOptions: mssql.DeploymentOptions): Thenable<mssql.SchemaCompareResult> {
public schemaCompare(operationId: string, sourceEndpointInfo: mssql.SchemaCompareEndpointInfo, targetEndpointInfo: mssql.SchemaCompareEndpointInfo, taskExecutionMode: azdata.TaskExecutionMode, deploymentOptions: mssql.DeploymentOptions): Promise<mssql.SchemaCompareResult> {
const params: contracts.SchemaCompareParams = { operationId: operationId, sourceEndpointInfo: sourceEndpointInfo, targetEndpointInfo: targetEndpointInfo, taskExecutionMode: taskExecutionMode, deploymentOptions: deploymentOptions };
return this.client.sendRequest(contracts.SchemaCompareRequest.type, params).then(
undefined,
e => {
this.client.logFailedRequest(contracts.SchemaCompareRequest.type, e);
return Promise.reject(e)
}
);
return this.runWithErrorHandling(contracts.SchemaCompareRequest.type, params);
}
public schemaCompareGenerateScript(operationId: string, targetServerName: string, targetDatabaseName: string, taskExecutionMode: azdata.TaskExecutionMode): Thenable<azdata.ResultStatus> {
public schemaCompareGenerateScript(operationId: string, targetServerName: string, targetDatabaseName: string, taskExecutionMode: azdata.TaskExecutionMode): Promise<azdata.ResultStatus> {
const params: contracts.SchemaCompareGenerateScriptParams = { operationId: operationId, targetServerName: targetServerName, targetDatabaseName: targetDatabaseName, taskExecutionMode: taskExecutionMode };
return this.client.sendRequest(contracts.SchemaCompareGenerateScriptRequest.type, params).then(
undefined,
e => {
this.client.logFailedRequest(contracts.SchemaCompareGenerateScriptRequest.type, e);
return Promise.reject(e)
}
);
return this.runWithErrorHandling(contracts.SchemaCompareGenerateScriptRequest.type, params);
}
public schemaComparePublishDatabaseChanges(operationId: string, targetServerName: string, targetDatabaseName: string, taskExecutionMode: azdata.TaskExecutionMode): Thenable<azdata.ResultStatus> {
public schemaComparePublishDatabaseChanges(operationId: string, targetServerName: string, targetDatabaseName: string, taskExecutionMode: azdata.TaskExecutionMode): Promise<azdata.ResultStatus> {
const params: contracts.SchemaComparePublishDatabaseChangesParams = { operationId: operationId, targetServerName: targetServerName, targetDatabaseName: targetDatabaseName, taskExecutionMode: taskExecutionMode };
return this.client.sendRequest(contracts.SchemaComparePublishDatabaseChangesRequest.type, params).then(
undefined,
e => {
this.client.logFailedRequest(contracts.SchemaComparePublishDatabaseChangesRequest.type, e);
return Promise.reject(e)
}
);
return this.runWithErrorHandling(contracts.SchemaComparePublishDatabaseChangesRequest.type, params);
}
public schemaComparePublishProjectChanges(operationId: string, targetProjectPath: string, targetFolderStructure: mssql.ExtractTarget, taskExecutionMode: azdata.TaskExecutionMode): Thenable<mssql.SchemaComparePublishProjectResult> {
public schemaComparePublishProjectChanges(operationId: string, targetProjectPath: string, targetFolderStructure: mssql.ExtractTarget, taskExecutionMode: azdata.TaskExecutionMode): Promise<mssql.SchemaComparePublishProjectResult> {
const params: contracts.SchemaComparePublishProjectChangesParams = { operationId: operationId, targetProjectPath: targetProjectPath, targetFolderStructure: targetFolderStructure, taskExecutionMode: taskExecutionMode };
return this.client.sendRequest(contracts.SchemaComparePublishProjectChangesRequest.type, params).then(
undefined,
(e: any) => {
this.client.logFailedRequest(contracts.SchemaComparePublishProjectChangesRequest.type, e);
return Promise.reject(e)
}
);
return this.runWithErrorHandling(contracts.SchemaComparePublishProjectChangesRequest.type, params);
}
public schemaCompareGetDefaultOptions(): Thenable<mssql.SchemaCompareOptionsResult> {
public schemaCompareGetDefaultOptions(): Promise<mssql.SchemaCompareOptionsResult> {
const params: contracts.SchemaCompareGetOptionsParams = {};
return this.client.sendRequest(contracts.SchemaCompareGetDefaultOptionsRequest.type, params).then(
undefined,
e => {
this.client.logFailedRequest(contracts.SchemaCompareGetDefaultOptionsRequest.type, e);
return Promise.reject(e)
}
);
return this.runWithErrorHandling(contracts.SchemaCompareGetDefaultOptionsRequest.type, params);
}
public schemaCompareIncludeExcludeNode(operationId: string, diffEntry: mssql.DiffEntry, includeRequest: boolean, taskExecutionMode: azdata.TaskExecutionMode): Thenable<mssql.SchemaCompareIncludeExcludeResult> {
public schemaCompareIncludeExcludeNode(operationId: string, diffEntry: mssql.DiffEntry, includeRequest: boolean, taskExecutionMode: azdata.TaskExecutionMode): Promise<mssql.SchemaCompareIncludeExcludeResult> {
const params: contracts.SchemaCompareNodeParams = { operationId: operationId, diffEntry, includeRequest, taskExecutionMode: taskExecutionMode };
return this.client.sendRequest(contracts.SchemaCompareIncludeExcludeNodeRequest.type, params).then(
undefined,
e => {
this.client.logFailedRequest(contracts.SchemaCompareIncludeExcludeNodeRequest.type, e);
return Promise.reject(e)
}
);
return this.runWithErrorHandling(contracts.SchemaCompareIncludeExcludeNodeRequest.type, params);
}
public schemaCompareOpenScmp(filePath: string): Thenable<mssql.SchemaCompareOpenScmpResult> {
public schemaCompareOpenScmp(filePath: string): Promise<mssql.SchemaCompareOpenScmpResult> {
const params: contracts.SchemaCompareOpenScmpParams = { filePath: filePath };
return this.client.sendRequest(contracts.SchemaCompareOpenScmpRequest.type, params).then(
undefined,
e => {
this.client.logFailedRequest(contracts.SchemaCompareOpenScmpRequest.type, e);
return Promise.reject(e)
}
);
return this.runWithErrorHandling(contracts.SchemaCompareOpenScmpRequest.type, params);
}
public schemaCompareSaveScmp(sourceEndpointInfo: mssql.SchemaCompareEndpointInfo, targetEndpointInfo: mssql.SchemaCompareEndpointInfo, taskExecutionMode: azdata.TaskExecutionMode, deploymentOptions: mssql.DeploymentOptions, scmpFilePath: string, excludedSourceObjects: mssql.SchemaCompareObjectId[], excludedTargetObjects: mssql.SchemaCompareObjectId[]): Thenable<azdata.ResultStatus> {
public schemaCompareSaveScmp(sourceEndpointInfo: mssql.SchemaCompareEndpointInfo, targetEndpointInfo: mssql.SchemaCompareEndpointInfo, taskExecutionMode: azdata.TaskExecutionMode, deploymentOptions: mssql.DeploymentOptions, scmpFilePath: string, excludedSourceObjects: mssql.SchemaCompareObjectId[], excludedTargetObjects: mssql.SchemaCompareObjectId[]): Promise<azdata.ResultStatus> {
const params: contracts.SchemaCompareSaveScmpParams = { sourceEndpointInfo: sourceEndpointInfo, targetEndpointInfo: targetEndpointInfo, taskExecutionMode: taskExecutionMode, deploymentOptions: deploymentOptions, scmpFilePath: scmpFilePath, excludedSourceObjects: excludedSourceObjects, excludedTargetObjects: excludedTargetObjects };
return this.client.sendRequest(contracts.SchemaCompareSaveScmpRequest.type, params).then(
undefined,
e => {
this.client.logFailedRequest(contracts.SchemaCompareSaveScmpRequest.type, e);
return Promise.reject(e)
}
);
return this.runWithErrorHandling(contracts.SchemaCompareSaveScmpRequest.type, params);
}
public schemaCompareCancel(operationId: string): Thenable<azdata.ResultStatus> {
public schemaCompareCancel(operationId: string): Promise<azdata.ResultStatus> {
const params: contracts.SchemaCompareCancelParams = { operationId: operationId };
return this.client.sendRequest(contracts.SchemaCompareCancellationRequest.type, params).then(
undefined,
e => {
this.client.logFailedRequest(contracts.SchemaCompareCancellationRequest.type, e);
return Promise.reject(e)
}
);
return this.runWithErrorHandling(contracts.SchemaCompareCancellationRequest.type, params);
}
}

View File

@@ -11,9 +11,9 @@ import * as contracts from '../contracts';
import { AppContext } from '../appContext';
import { ISqlOpsFeature, SqlOpsDataClient } from 'dataprotocol-client';
import { ClientCapabilities } from 'vscode-languageclient';
import { RequestType } from 'vscode-languageclient';
import { BaseService } from '../baseService';
export class SqlProjectsService implements mssql.ISqlProjectsService {
export class SqlProjectsService extends BaseService implements mssql.ISqlProjectsService {
public static asFeature(context: AppContext): ISqlOpsFeature {
return class extends SqlProjectsService {
constructor(client: SqlOpsDataClient) {
@@ -29,7 +29,8 @@ export class SqlProjectsService implements mssql.ISqlProjectsService {
};
}
private constructor(context: AppContext, protected readonly client: SqlOpsDataClient) {
private constructor(context: AppContext, client: SqlOpsDataClient) {
super(client);
context.registerService(constants.SqlProjectsService, this);
}
@@ -445,14 +446,4 @@ export class SqlProjectsService implements mssql.ISqlProjectsService {
const params: contracts.MoveItemParams = { projectUri: projectUri, destinationPath: destinationPath, path: path };
return await this.runWithErrorHandling(contracts.MoveNoneItemRequest.type, params);
}
private async runWithErrorHandling<P, R, E, RO>(type: RequestType<P, R, E, RO>, params: P): Promise<R> {
try {
const result = await this.client.sendRequest(type, params);
return result;
} catch (e) {
this.client.logFailedRequest(type, e);
throw e;
}
}
}