Modifying the migration extension to use its own service. (#21781)

* Adding migration service to sql migrations

* enabling auto flush log

* Adding support for env variable

* Adding TDE Migration service

* code cleanup

* updating service downloader

* Removing custom output channel

* remove unnecessary await

* Updated service version to get latest code

* Consolidate TDE into migration service

* Sync to latest main

* Update sql-migration package version

* Fix merge conflict error

* Fixing all merge conflicts

* Fixing stuff

* removing extra whitespace

* Cleaning up

---------

Co-authored-by: Akshay Mata <akma@microsoft.com>
This commit is contained in:
Aasim Khan
2023-02-12 09:59:09 -08:00
committed by GitHub
parent 12a3bf6b3b
commit 837236be0f
18 changed files with 1569 additions and 69 deletions

View File

@@ -0,0 +1,550 @@
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the Source EULA. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import { RequestType, NotificationType } from 'vscode-languageclient';
import * as azdata from 'azdata';
export interface IMessage {
jsonrpc: string;
}
export interface SqlMigrationAssessmentParams {
connectionString: string;
databases: string[];
xEventsFilesFolderPath: string;
}
export interface SqlMigrationImpactedObjectInfo {
name: string;
impactDetail: string;
objectType: string;
}
export interface SqlMigrationAssessmentResultItem {
rulesetVersion: string;
rulesetName: string;
ruleId: string;
targetType: string;
checkId: string;
tags: string[];
displayName: string;
description: string;
helpLink: string;
level: string;
timestamp: string;
kind: azdata.sqlAssessment.SqlAssessmentResultItemKind;
message: string;
appliesToMigrationTargetPlatform: string;
issueCategory: string;
databaseName: string;
impactedObjects: SqlMigrationImpactedObjectInfo[];
databaseRestoreFails: boolean;
}
export interface ServerTargetReadiness {
numberOfDatabasesReadyForMigration: number;
numberOfNonOnlineDatabases: number;
totalNumberOfDatabases: number;
}
export interface ErrorModel {
errorId: number;
message: string;
errorSummary: string;
possibleCauses: string;
guidance: string;
}
export interface DatabaseTargetReadiness {
noSelectionForMigration: boolean;
numOfBlockerIssues: number;
}
export interface DatabaseAssessmentProperties {
compatibilityLevel: string;
databaseSize: number;
isReplicationEnabled: boolean;
assessmentTimeInMilliseconds: number;
items: SqlMigrationAssessmentResultItem[];
errors: ErrorModel[];
sqlManagedInstanceTargetReadiness: DatabaseTargetReadiness;
name: string;
}
export interface ServerAssessmentProperties {
cpuCoreCount: number;
physicalServerMemory: number;
serverHostPlatform: string;
serverVersion: string;
serverEngineEdition: string;
serverEdition: string;
isClustered: boolean;
numberOfUserDatabases: number;
sqlAssessmentStatus: number;
assessedDatabaseCount: number;
sqlManagedInstanceTargetReadiness: ServerTargetReadiness;
items: SqlMigrationAssessmentResultItem[];
errors: ErrorModel[];
databases: DatabaseAssessmentProperties[];
name: string;
}
export interface AssessmentResult {
startTime: string;
endedTime: string;
assessmentResult: ServerAssessmentProperties;
rawAssessmentResult: any;
errors: ErrorModel[];
assessmentReportPath: string;
}
export namespace GetSqlMigrationAssessmentItemsRequest {
export const type = new RequestType<SqlMigrationAssessmentParams, AssessmentResult, void, void>('migration/getassessments');
}
export interface SqlMigrationSkuRecommendationsParams {
dataFolder: string;
perfQueryIntervalInSec: number;
targetPlatforms: string[];
targetSqlInstance: string;
targetPercentile: number;
scalingFactor: number;
startTime: string;
endTime: string;
includePreviewSkus: boolean;
databaseAllowList: string[];
}
export interface AzureSqlSkuCategory {
sqlTargetPlatform: AzureSqlTargetPlatform;
computeTier: ComputeTier;
}
export interface AzureSqlSkuPaaSCategory extends AzureSqlSkuCategory {
sqlPurchasingModel: AzureSqlPurchasingModel;
sqlServiceTier: AzureSqlPaaSServiceTier;
hardwareType: AzureSqlPaaSHardwareType;
}
export interface AzureSqlSkuIaaSCategory extends AzureSqlSkuCategory {
virtualMachineFamilyType: VirtualMachineFamilyType;
}
export interface AzureManagedDiskSku {
tier: AzureManagedDiskTier;
size: string;
caching: AzureManagedDiskCaching;
}
export interface AzureVirtualMachineSku {
virtualMachineFamily: VirtualMachineFamily;
sizeName: string;
computeSize: number;
azureSkuName: string;
vCPUsAvailable: number;
}
export interface AzureSqlSkuMonthlyCost {
computeCost: number;
storageCost: number;
totalCost: number;
}
export interface AzureSqlSku {
category: AzureSqlSkuPaaSCategory | AzureSqlSkuIaaSCategory;
computeSize: number;
predictedDataSizeInMb: number;
predictedLogSizeInMb: number;
}
export interface AzureSqlPaaSSku extends AzureSqlSku {
category: AzureSqlSkuPaaSCategory;
storageMaxSizeInMb: number;
}
export interface AzureSqlIaaSSku extends AzureSqlSku {
category: AzureSqlSkuIaaSCategory;
virtualMachineSize: AzureVirtualMachineSku;
dataDiskSizes: AzureManagedDiskSku[];
logDiskSizes: AzureManagedDiskSku[];
tempDbDiskSizes: AzureManagedDiskSku[];
}
export interface SkuRecommendationResultItem {
sqlInstanceName: string;
databaseName: string;
targetSku: AzureSqlIaaSSku | AzureSqlPaaSSku;
monthlyCost: AzureSqlSkuMonthlyCost;
ranking: number;
positiveJustifications: string[];
negativeJustifications: string[];
}
export interface SqlInstanceRequirements {
cpuRequirementInCores: number;
dataStorageRequirementInMB: number;
logStorageRequirementInMB: number;
memoryRequirementInMB: number;
dataIOPSRequirement: number;
logIOPSRequirement: number;
ioLatencyRequirementInMs: number;
ioThroughputRequirementInMBps: number;
tempDBSizeInMB: number;
dataPointsStartTime: string;
dataPointsEndTime: string;
aggregationTargetPercentile: number;
perfDataCollectionIntervalInSeconds: number;
databaseLevelRequirements: SqlDatabaseRequirements[];
numberOfDataPointsAnalyzed: number;
}
export interface SqlDatabaseRequirements {
cpuRequirementInCores: number;
dataIOPSRequirement: number;
logIOPSRequirement: number;
ioLatencyRequirementInMs: number;
ioThroughputRequirementInMBps: number;
dataStorageRequirementInMB: number;
logStorageRequirementInMB: number;
databaseName: string;
memoryRequirementInMB: number;
cpuRequirementInPercentageOfTotalInstance: number;
numberOfDataPointsAnalyzed: number;
fileLevelRequirements: SqlFileRequirements[];
}
export interface SqlFileRequirements {
fileName: string;
fileType: DatabaseFileType;
sizeInMB: number;
readLatencyInMs: number;
writeLatencyInMs: number;
iopsRequirement: number;
ioThroughputRequirementInMBps: number;
numberOfDataPointsAnalyzed: number;
}
export interface PaaSSkuRecommendationResultItem extends SkuRecommendationResultItem {
targetSku: AzureSqlPaaSSku;
}
export interface IaaSSkuRecommendationResultItem extends SkuRecommendationResultItem {
targetSku: AzureSqlIaaSSku;
}
export interface SkuRecommendationResult {
sqlDbRecommendationResults: PaaSSkuRecommendationResultItem[];
sqlDbRecommendationDurationInMs: number;
sqlMiRecommendationResults: PaaSSkuRecommendationResultItem[];
sqlMiRecommendationDurationInMs: number;
sqlVmRecommendationResults: IaaSSkuRecommendationResultItem[];
sqlVmRecommendationDurationInMs: number;
elasticSqlDbRecommendationResults: PaaSSkuRecommendationResultItem[];
elasticSqlDbRecommendationDurationInMs: number;
elasticSqlMiRecommendationResults: PaaSSkuRecommendationResultItem[];
elasticSqlMiRecommendationDurationInMs: number;
elasticSqlVmRecommendationResults: IaaSSkuRecommendationResultItem[];
elasticSqlVmRecommendationDurationInMs: number;
instanceRequirements: SqlInstanceRequirements;
skuRecommendationReportPaths: string[];
elasticSkuRecommendationReportPaths: string[];
}
// SKU recommendation enums, mirrored from Microsoft.SqlServer.Migration.SkuRecommendation
export const enum DatabaseFileType {
Rows = 0,
Log = 1,
Filestream = 2,
NotSupported = 3,
Fulltext = 4
}
export const enum AzureSqlTargetPlatform {
AzureSqlDatabase = 0,
AzureSqlManagedInstance = 1,
AzureSqlVirtualMachine = 2
}
export const enum ComputeTier {
Provisioned = 0,
ServerLess = 1
}
export const enum AzureManagedDiskTier {
Standard = 0,
Premium = 1,
Ultra = 2
}
export const enum AzureManagedDiskCaching {
NotApplicable = 0,
None = 1,
ReadOnly = 2,
ReadWrite = 3
}
export const enum AzureSqlPurchasingModel {
vCore = 0,
}
export const enum AzureSqlPaaSServiceTier {
GeneralPurpose = 0,
BusinessCritical,
HyperScale,
}
export const enum AzureSqlPaaSHardwareType {
Gen5 = 0,
PremiumSeries,
PremiumSeriesMemoryOptimized
}
export const enum VirtualMachineFamilyType {
GeneralPurpose,
ComputeOptimized,
MemoryOptimized,
StorageOptimized,
GPU,
HighPerformanceCompute
}
export const enum VirtualMachineFamily {
basicAFamily,
standardA0_A7Family,
standardAv2Family,
standardBSFamily,
standardDFamily,
standardDv2Family,
standardDv2PromoFamily,
standardDADSv5Family,
standardDASv4Family,
standardDASv5Family,
standardDAv4Family,
standardDDSv4Family,
standardDDSv5Family,
standardDDv4Family,
standardDDv5Family,
standardDSv3Family,
standardDSv4Family,
standardDSv5Family,
standardDv3Family,
standardDv4Family,
standardDv5Family,
standardDCADSv5Family,
standardDCASv5Family,
standardDCSv2Family,
standardDSFamily,
standardDSv2Family,
standardDSv2PromoFamily,
standardEIDSv5Family,
standardEIDv5Family,
standardEISv5Family,
standardEIv5Family,
standardEADSv5Family,
standardEASv4Family,
standardEASv5Family,
standardEDSv4Family,
standardEDSv5Family,
standardEBDSv5Family,
standardESv3Family,
standardESv4Family,
standardESv5Family,
standardEBSv5Family,
standardEAv4Family,
standardEDv4Family,
standardEDv5Family,
standardEv3Family,
standardEv4Family,
standardEv5Family,
standardEISv3Family,
standardEIv3Family,
standardXEIDSv4Family,
standardXEISv4Family,
standardECADSv5Family,
standardECASv5Family,
standardECIADSv5Family,
standardECIASv5Family,
standardFFamily,
standardFSFamily,
standardFSv2Family,
standardGFamily,
standardGSFamily,
standardHFamily,
standardHPromoFamily,
standardLSFamily,
standardLSv2Family,
standardMSFamily,
standardMDSMediumMemoryv2Family,
standardMSMediumMemoryv2Family,
standardMIDSMediumMemoryv2Family,
standardMISMediumMemoryv2Family,
standardMSv2Family,
standardNCSv3Family,
StandardNCASv3_T4Family,
standardNVSv2Family,
standardNVSv3Family,
standardNVSv4Family
}
export namespace GetSqlMigrationSkuRecommendationsRequest {
export const type = new RequestType<SqlMigrationSkuRecommendationsParams, SkuRecommendationResult, void, void>('migration/getskurecommendations');
}
export interface SqlMigrationStartPerfDataCollectionParams {
connectionString: string,
dataFolder: string,
perfQueryIntervalInSec: number,
staticQueryIntervalInSec: number,
numberOfIterations: number
}
export interface StartPerfDataCollectionResult {
dateTimeStarted: Date;
}
export namespace SqlMigrationStartPerfDataCollectionRequest {
export const type = new RequestType<SqlMigrationStartPerfDataCollectionParams, StartPerfDataCollectionResult, void, void>('migration/startperfdatacollection');
}
export interface SqlMigrationStopPerfDataCollectionParams {
}
export interface StopPerfDataCollectionResult {
dateTimeStopped: Date;
}
export namespace SqlMigrationStopPerfDataCollectionRequest {
export const type = new RequestType<SqlMigrationStopPerfDataCollectionParams, StopPerfDataCollectionResult, void, void>('migration/stopperfdatacollection');
}
export interface SqlMigrationRefreshPerfDataCollectionParams {
lastRefreshTime: Date
}
export interface RefreshPerfDataCollectionResult {
isCollecting: boolean;
messages: string[];
errors: string[];
refreshTime: Date;
}
export namespace SqlMigrationRefreshPerfDataCollectionRequest {
export const type = new RequestType<SqlMigrationRefreshPerfDataCollectionParams, RefreshPerfDataCollectionResult, void, void>('migration/refreshperfdatacollection');
}
export interface StartLoginMigrationsParams {
sourceConnectionString: string;
targetConnectionString: string;
loginList: string[];
aadDomainName: string;
}
export enum LoginMigrationStep {
StartValidations = 0,
MigrateLogins = 1,
EstablishUserMapping = 2,
MigrateServerRoles = 3,
EstablishServerRoleMapping = 4,
SetLoginPermissions = 5,
SetServerRolePermissions = 6,
}
export interface StartLoginMigrationResult {
exceptionMap: { [login: string]: any };
completedStep: LoginMigrationStep;
elapsedTime: string;
}
export namespace StartLoginMigrationRequest {
export const type = new RequestType<StartLoginMigrationsParams, StartLoginMigrationResult, void, void>('migration/startloginmigration');
}
export namespace ValidateLoginMigrationRequest {
export const type = new RequestType<StartLoginMigrationsParams, StartLoginMigrationResult, void, void>('migration/validateloginmigration');
}
export namespace MigrateLoginsRequest {
export const type = new RequestType<StartLoginMigrationsParams, StartLoginMigrationResult, void, void>('migration/migratelogins');
}
export namespace EstablishUserMappingRequest {
export const type = new RequestType<StartLoginMigrationsParams, StartLoginMigrationResult, void, void>('migration/establishusermapping');
}
export namespace MigrateServerRolesAndSetPermissionsRequest {
export const type = new RequestType<StartLoginMigrationsParams, StartLoginMigrationResult, void, void>('migration/migrateserverrolesandsetpermissions');
}
export namespace LoginMigrationNotification {
export const type = new NotificationType<StartLoginMigrationResult, void>('migration/loginmigrationnotification"');
}
export interface ISqlMigrationService {
providerId: string;
getAssessments(ownerUri: string, databases: string[], xEventsFilesFolderPath: string): Thenable<AssessmentResult | undefined>;
getSkuRecommendations(dataFolder: string, perfQueryIntervalInSec: number, targetPlatforms: string[], targetSqlInstance: string, targetPercentile: number, scalingFactor: number, startTime: string, endTime: string, includePreviewSkus: boolean, databaseAllowList: string[]): Promise<SkuRecommendationResult | undefined>;
startPerfDataCollection(ownerUri: string, dataFolder: string, perfQueryIntervalInSec: number, staticQueryIntervalInSec: number, numberOfIterations: number): Promise<StartPerfDataCollectionResult | undefined>;
stopPerfDataCollection(): Promise<StopPerfDataCollectionResult | undefined>;
refreshPerfDataCollection(lastRefreshedTime: Date): Promise<RefreshPerfDataCollectionResult | undefined>;
startLoginMigration(sourceConnectionString: string, targetConnectionString: string, loginList: string[], aadDomainName: string): Promise<StartLoginMigrationResult | undefined>;
validateLoginMigration(sourceConnectionString: string, targetConnectionString: string, loginList: string[], aadDomainName: string): Promise<StartLoginMigrationResult | undefined>;
migrateLogins(sourceConnectionString: string, targetConnectionString: string, loginList: string[], aadDomainName: string): Promise<StartLoginMigrationResult | undefined>;
establishUserMapping(sourceConnectionString: string, targetConnectionString: string, loginList: string[], aadDomainName: string): Promise<StartLoginMigrationResult | undefined>;
migrateServerRolesAndSetPermissions(sourceConnectionString: string, targetConnectionString: string, loginList: string[], aadDomainName: string): Promise<StartLoginMigrationResult | undefined>;
migrateCertificate(
encryptedDatabases: string[],
sourceSqlConnectionString: string,
targetSubscriptionId: string,
targetResourceGroupName: string,
targetManagedInstanceName: string,
networkSharePath: string,
accessToken: string,
reportUpdate: (dbName: string, succeeded: boolean, message: string) => void): Promise<TdeMigrationResult | undefined>;
}
export interface TdeMigrationRequest {
encryptedDatabases: string[];
sourceSqlConnectionString: string;
targetSubscriptionId: string;
targetResourceGroupName: string;
targetManagedInstanceName: string;
}
export interface TdeMigrationEntryResult {
dbName: string;
success: boolean;
message: string;
}
export interface TdeMigrationResult {
migrationStatuses: TdeMigrationEntryResult[];
}
export namespace TdeMigrateRequest {
export const type = new RequestType<TdeMigrationParams, TdeMigrationResult, void, void>('migration/tdemigration');
}
export interface TdeMigrationParams {
encryptedDatabases: string[];
sourceSqlConnectionString: string;
targetSubscriptionId: string;
targetResourceGroupName: string;
targetManagedInstanceName: string;
networkSharePath: string;
networkShareDomain: string;
networkShareUserName: string;
networkSharePassword: string;
accessToken: string;
}
export namespace TdeMigrateProgressEvent {
export const type = new NotificationType<TdeMigrateProgressParams, void>('migration/tdemigrationprogress');
}
export interface TdeMigrateProgressParams {
name: string;
success: boolean;
message: string;
}

View File

@@ -0,0 +1,320 @@
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the Source EULA. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import { SqlOpsDataClient, SqlOpsFeature } from 'dataprotocol-client';
import {
ClientCapabilities,
RPCMessageType,
ServerCapabilities,
} from 'vscode-languageclient';
import * as UUID from 'vscode-languageclient/lib/utils/uuid';
import { Disposable } from 'vscode';
import * as contracts from './contracts';
import { migrationServiceProvider } from './provider';
export enum ApiType {
SqlMigrationProvider = 'SqlMigrationProvider',
}
export abstract class MigrationExtensionService extends SqlOpsFeature<undefined> {
abstract providerId: ApiType;
}
export class SqlMigrationService extends MigrationExtensionService implements contracts.ISqlMigrationService {
private _reportUpdate: ((dbName: string, succeeded: boolean, error: string) => void) | undefined = undefined;
override providerId = ApiType.SqlMigrationProvider;
private static readonly messagesTypes: RPCMessageType[] = [
contracts.GetSqlMigrationAssessmentItemsRequest.type,
contracts.GetSqlMigrationSkuRecommendationsRequest.type,
contracts.SqlMigrationStartPerfDataCollectionRequest.type,
contracts.SqlMigrationRefreshPerfDataCollectionRequest.type,
contracts.SqlMigrationStopPerfDataCollectionRequest.type,
contracts.StartLoginMigrationRequest.type,
contracts.ValidateLoginMigrationRequest.type,
contracts.MigrateLoginsRequest.type,
contracts.EstablishUserMappingRequest.type,
contracts.MigrateServerRolesAndSetPermissionsRequest.type,
contracts.TdeMigrateRequest.type
];
constructor(client: SqlOpsDataClient) {
super(client, SqlMigrationService.messagesTypes);
}
public initialize(capabilities: ServerCapabilities): void {
this.register(this.messages, {
id: UUID.generateUuid(),
registerOptions: undefined
});
this._client.onNotification(contracts.TdeMigrateProgressEvent.type, e => {
if (this._reportUpdate === undefined) {
return;
}
this._reportUpdate(e.name, e.success, e.message);
});
}
protected registerProvider(options: undefined): Disposable {
migrationServiceProvider.addService(this);
return this;
}
public fillClientCapabilities(capabilities: ClientCapabilities): void {
// this isn't explicitly necessary
}
async getAssessments(connectionString: string, databases: string[], xEventsFilesFolderPath: string): Promise<contracts.AssessmentResult | undefined> {
let params: contracts.SqlMigrationAssessmentParams = { connectionString: connectionString, databases: databases, xEventsFilesFolderPath: xEventsFilesFolderPath };
try {
return this._client.sendRequest(contracts.GetSqlMigrationAssessmentItemsRequest.type, params);
}
catch (e) {
this._client.logFailedRequest(contracts.GetSqlMigrationAssessmentItemsRequest.type, e);
}
return undefined;
}
async getSkuRecommendations(
dataFolder: string,
perfQueryIntervalInSec: number,
targetPlatforms: string[],
targetSqlInstance: string,
targetPercentile: number,
scalingFactor: number,
startTime: string,
endTime: string,
includePreviewSkus: boolean,
databaseAllowList: string[]): Promise<contracts.SkuRecommendationResult | undefined> {
let params: contracts.SqlMigrationSkuRecommendationsParams = {
dataFolder,
perfQueryIntervalInSec,
targetPlatforms,
targetSqlInstance,
targetPercentile,
scalingFactor,
startTime,
endTime,
includePreviewSkus,
databaseAllowList
};
try {
return this._client.sendRequest(contracts.GetSqlMigrationSkuRecommendationsRequest.type, params);
}
catch (e) {
this._client.logFailedRequest(contracts.GetSqlMigrationSkuRecommendationsRequest.type, e);
}
return undefined;
}
async startPerfDataCollection(
connectionString: string,
dataFolder: string,
perfQueryIntervalInSec: number,
staticQueryIntervalInSec: number,
numberOfIterations: number): Promise<contracts.StartPerfDataCollectionResult | undefined> {
let params: contracts.SqlMigrationStartPerfDataCollectionParams = {
connectionString: connectionString,
dataFolder,
perfQueryIntervalInSec,
staticQueryIntervalInSec,
numberOfIterations
};
try {
return this._client.sendRequest(contracts.SqlMigrationStartPerfDataCollectionRequest.type, params);
}
catch (e) {
this._client.logFailedRequest(contracts.SqlMigrationStartPerfDataCollectionRequest.type, e);
}
return undefined;
}
async stopPerfDataCollection(): Promise<contracts.StopPerfDataCollectionResult | undefined> {
let params: contracts.SqlMigrationStopPerfDataCollectionParams = {};
try {
return this._client.sendRequest(contracts.SqlMigrationStopPerfDataCollectionRequest.type, params);
}
catch (e) {
this._client.logFailedRequest(contracts.SqlMigrationStopPerfDataCollectionRequest.type, e);
}
return undefined;
}
async refreshPerfDataCollection(lastRefreshedTime: Date): Promise<contracts.RefreshPerfDataCollectionResult | undefined> {
let params: contracts.SqlMigrationStopPerfDataCollectionParams = {
lastRefreshedTime
};
try {
return this._client.sendRequest(contracts.SqlMigrationRefreshPerfDataCollectionRequest.type, params);
}
catch (e) {
this._client.logFailedRequest(contracts.SqlMigrationRefreshPerfDataCollectionRequest.type, e);
}
return undefined;
}
async startLoginMigration(
sourceConnectionString: string,
targetConnectionString: string,
loginList: string[],
aadDomainName: string): Promise<contracts.StartLoginMigrationResult | undefined> {
let params: contracts.StartLoginMigrationsParams = {
sourceConnectionString,
targetConnectionString,
loginList,
aadDomainName
};
try {
return this._client.sendRequest(contracts.StartLoginMigrationRequest.type, params);
}
catch (e) {
this._client.logFailedRequest(contracts.StartLoginMigrationRequest.type, e);
}
return undefined;
}
async validateLoginMigration(
sourceConnectionString: string,
targetConnectionString: string,
loginList: string[],
aadDomainName: string): Promise<contracts.StartLoginMigrationResult | undefined> {
let params: contracts.StartLoginMigrationsParams = {
sourceConnectionString,
targetConnectionString,
loginList,
aadDomainName
};
try {
return this._client.sendRequest(contracts.ValidateLoginMigrationRequest.type, params);
}
catch (e) {
this._client.logFailedRequest(contracts.ValidateLoginMigrationRequest.type, e);
}
return undefined;
}
async migrateLogins(
sourceConnectionString: string,
targetConnectionString: string,
loginList: string[],
aadDomainName: string): Promise<contracts.StartLoginMigrationResult | undefined> {
let params: contracts.StartLoginMigrationsParams = {
sourceConnectionString,
targetConnectionString,
loginList,
aadDomainName
};
try {
return this._client.sendRequest(contracts.MigrateLoginsRequest.type, params);
}
catch (e) {
this._client.logFailedRequest(contracts.MigrateLoginsRequest.type, e);
}
return undefined;
}
async establishUserMapping(
sourceConnectionString: string,
targetConnectionString: string,
loginList: string[],
aadDomainName: string): Promise<contracts.StartLoginMigrationResult | undefined> {
let params: contracts.StartLoginMigrationsParams = {
sourceConnectionString,
targetConnectionString,
loginList,
aadDomainName
};
try {
return this._client.sendRequest(contracts.EstablishUserMappingRequest.type, params);
}
catch (e) {
this._client.logFailedRequest(contracts.EstablishUserMappingRequest.type, e);
}
return undefined;
}
async migrateServerRolesAndSetPermissions(
sourceConnectionString: string,
targetConnectionString: string,
loginList: string[],
aadDomainName: string): Promise<contracts.StartLoginMigrationResult | undefined> {
let params: contracts.StartLoginMigrationsParams = {
sourceConnectionString,
targetConnectionString,
loginList,
aadDomainName
};
try {
return this._client.sendRequest(contracts.MigrateServerRolesAndSetPermissionsRequest.type, params);
}
catch (e) {
this._client.logFailedRequest(contracts.MigrateServerRolesAndSetPermissionsRequest.type, e);
}
return undefined;
}
async migrateCertificate(
tdeEnabledDatabases: string[],
sourceSqlConnectionString: string,
targetSubscriptionId: string,
targetResourceGroupName: string,
targetManagedInstanceName: string,
networkSharePath: string,
accessToken: string,
reportUpdate: (dbName: string, succeeded: boolean, message: string) => void): Promise<contracts.TdeMigrationResult | undefined> {
this._reportUpdate = reportUpdate;
let params: contracts.TdeMigrationParams = {
encryptedDatabases: tdeEnabledDatabases,
sourceSqlConnectionString: sourceSqlConnectionString,
targetSubscriptionId: targetSubscriptionId,
targetResourceGroupName: targetResourceGroupName,
targetManagedInstanceName: targetManagedInstanceName,
networkSharePath: networkSharePath,
networkShareDomain: 'a', // Will remove this on the next STS version
networkShareUserName: 'b',
networkSharePassword: 'c',
accessToken: accessToken
};
try {
// This call needs to be awaited so, the updates are sent during the execution of the task.
// If the task is not await, the finally block will execute and no update will be sent.
const result = await this._client.sendRequest(contracts.TdeMigrateRequest.type, params);
return result;
}
catch (e) {
this._client.logFailedRequest(contracts.TdeMigrateRequest.type, e);
}
return undefined;
}
}

View File

@@ -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 { ApiType, MigrationExtensionService } from './features';
import * as constants from '../constants/strings';
import * as vscode from 'vscode';
export class MigrationServiceProvider {
private services: Map<ApiType, MigrationExtensionService> = new Map();
constructor() {
}
public addService(service: MigrationExtensionService) {
this.services.set(service.providerId, service);
}
public async getService(serviceId: ApiType): Promise<MigrationExtensionService> {
if (this.services.has(serviceId)) {
return this.services.get(serviceId)!;
}
return this.waitUntilProviderReady(serviceId);
}
public async waitUntilProviderReady(serviceId: ApiType): Promise<MigrationExtensionService> {
const service = await vscode.window.withProgress({
location: vscode.ProgressLocation.Notification,
title: constants.waitingForService(serviceId),
cancellable: false
}, (progress, token) => {
return new Promise<MigrationExtensionService>(resolve => {
const interval = setInterval(() => {
if (this.services.has(serviceId)) {
clearInterval(interval);
resolve(this.services.get(serviceId)!);
}
}, 250);
});
});
return service;
}
}
export const migrationServiceProvider = new MigrationServiceProvider();

View File

@@ -0,0 +1,230 @@
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the Source EULA. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import { SqlOpsDataClient, ClientOptions } from 'dataprotocol-client';
import { ServerProvider, Events, LogLevel, IConfig } from '@microsoft/ads-service-downloader';
import { ServerOptions, TransportKind } from 'vscode-languageclient';
import * as vscode from 'vscode';
import * as nls from 'vscode-nls';
const localize = nls.loadMessageBundle();
import * as path from 'path';
import { EventAndListener } from 'eventemitter2';
import { SqlMigrationService } from './features';
import { promises as fs } from 'fs';
import * as constants from '../constants/strings';
import { IMessage } from './contracts';
import { ErrorAction, CloseAction } from 'vscode-languageclient';
import { env } from 'process';
import { exists } from './utils';
import { logError, TelemetryViews } from '../telemetry';
export class ServiceClient {
private statusView: vscode.StatusBarItem;
constructor(
private outputChannel: vscode.OutputChannel,
) {
this.statusView = vscode.window.createStatusBarItem(vscode.StatusBarAlignment.Left);
}
public async startService(context: vscode.ExtensionContext): Promise<SqlOpsDataClient | undefined> {
const rawConfig = await fs.readFile(path.join(context.extensionPath, 'config.json'));
let clientOptions: ClientOptions = this.createClientOptions();
try {
let client: SqlOpsDataClient;
let serviceBinary: string = '';
let downloadBinary = true;
if (env['ADS_MIGRATIONSERVICE']) {
const config = <IConfig>JSON.parse(rawConfig.toString());
for (let executableFile of config.executableFiles) {
const executableFilePath = path.join(env['ADS_MIGRATIONSERVICE'], executableFile);
if (await exists(executableFilePath)) {
downloadBinary = false;
serviceBinary = executableFilePath;
}
}
if (!downloadBinary) {
vscode.window.showInformationMessage('Using Migration service found at: ' + serviceBinary).then((v) => { }, (r) => { });
} else {
vscode.window.showErrorMessage('Failed to find migration service binary falling back to downloaded binary').then((v) => { }, (r) => { });
}
}
if (downloadBinary) {
serviceBinary = await this.downloadBinaries(context, rawConfig);
}
let serverOptions = this.generateServerOptions(serviceBinary, context);
client = new SqlOpsDataClient(constants.serviceName, serverOptions, clientOptions);
client.onReady().then(() => {
this.statusView.text = localize('serviceStarted', "{0} Started", constants.serviceName);
setTimeout(() => {
this.statusView.hide();
}, 1500);
}).catch(e => {
console.error(e);
});
this.statusView.show();
this.statusView.text = localize('serviceStarting', "Starting {0}", constants.serviceName);
let disposable = client.start();
context.subscriptions.push(disposable);
return client;
}
catch (error) {
await vscode.window.showErrorMessage(localize('flatFileImport.serviceStartFailed', "Failed to start {0}: {1}", constants.serviceName, error.stack.toString()));
logError(TelemetryViews.SqlServerDashboard, error.stack.toString(), error);
return undefined;
}
}
public async downloadBinaries(context: vscode.ExtensionContext, rawConfig: Buffer): Promise<string> {
const config = JSON.parse(rawConfig.toString());
config.installDirectory = path.join(context.extensionPath, config.installDirectory);
config.proxy = vscode.workspace.getConfiguration('http').get('proxy');
config.strictSSL = vscode.workspace.getConfiguration('http').get('proxyStrictSSL') || true;
const serverdownloader = new ServerProvider(config);
serverdownloader.eventEmitter.onAny(this.generateHandleServerProviderEvent());
return serverdownloader.getOrDownloadServer();
}
private createClientOptions(): ClientOptions {
return {
providerId: constants.providerId,
errorHandler: new LanguageClientErrorHandler(),
synchronize: {
configurationSection: [constants.extensionConfigSectionName, constants.sqlConfigSectionName]
},
features: [
// we only want to add new features
SqlMigrationService,
],
outputChannel: this.outputChannel
};
}
private generateServerOptions(executablePath: string, context: vscode.ExtensionContext): ServerOptions {
let launchArgs = [];
launchArgs.push(`--locale`, vscode.env.language);
launchArgs.push('--log-file', path.join(context.logUri.fsPath));
launchArgs.push('--tracing-level', this.getConfigTracingLevel());
launchArgs.push('--autoflush-log');
return { command: executablePath, args: launchArgs, transport: TransportKind.stdio };
}
private getConfigTracingLevel(): TracingLevel {
let config = vscode.workspace.getConfiguration('mssql');
if (config) {
return config['tracingLevel'];
} else {
return TracingLevel.Critical;
}
}
private generateHandleServerProviderEvent(): EventAndListener {
let dots = 0;
return (e: string | string[], ...args: any[]) => {
switch (e) {
case Events.INSTALL_START:
this.outputChannel.show(true);
this.statusView.show();
this.outputChannel.appendLine(localize('installingServiceDetailed', "Installing {0} to {1}", constants.serviceName, args[0]));
this.statusView.text = localize('installingService', "Installing {0} Service", constants.serviceName);
break;
case Events.INSTALL_END:
this.outputChannel.appendLine(localize('serviceInstalled', "Installed {0}", constants.serviceName));
break;
case Events.DOWNLOAD_START:
this.outputChannel.appendLine(localize('downloadingService', "Downloading {0}", args[0]));
this.outputChannel.append(localize('downloadingServiceSize', "({0} KB)", Math.ceil(args[1] / 1024).toLocaleString(vscode.env.language)));
this.statusView.text = localize('downloadingServiceStatus', "Downloading {0}", constants.serviceName);
break;
case Events.DOWNLOAD_PROGRESS:
let newDots = Math.ceil(args[0] / 5);
if (newDots > dots) {
this.outputChannel.append('.'.repeat(newDots - dots));
dots = newDots;
}
break;
case Events.DOWNLOAD_END:
this.outputChannel.appendLine(localize('downloadingServiceComplete', "Done downloading {0}", constants.serviceName));
break;
case Events.ENTRY_EXTRACTED:
this.outputChannel.appendLine(localize('entryExtractedChannelMsg', "Extracted {0} ({1}/{2})", args[0], args[1], args[2]));
break;
case Events.LOG_EMITTED:
if (args[0] >= LogLevel.Warning) {
this.outputChannel.appendLine(args[1]);
}
break;
default:
break;
}
};
}
}
/**
* Handle Language Service client errors
*/
class LanguageClientErrorHandler {
/**
* Creates an instance of LanguageClientErrorHandler.
* @memberOf LanguageClientErrorHandler
*/
constructor() {
}
/**
* Show an error message prompt with a link to known issues wiki page
* @memberOf LanguageClientErrorHandler
*/
showOnErrorPrompt(error: Error): void {
// TODO add telemetry
// Telemetry.sendTelemetryEvent('SqlToolsServiceCrash');
console.log(error);
vscode.window.showErrorMessage(
constants.serviceCrashMessage(error.message),
).then(() => { }, () => { });
}
/**
* Callback for language service client error
*
* @memberOf LanguageClientErrorHandler
*/
error(error: Error, message: IMessage, count: number): ErrorAction {
this.showOnErrorPrompt(error);
// we don't retry running the service since crashes leave the extension
// in a bad, unrecovered state
return ErrorAction.Shutdown;
}
/**
* Callback for language service client closed
*
* @memberOf LanguageClientErrorHandler
*/
closed(): CloseAction {
this.showOnErrorPrompt({ name: 'Service crashed', message: constants.serviceCrashed });
// we don't retry running the service since crashes leave the extension
// in a bad, unrecovered state
return CloseAction.DoNotRestart;
}
}
/**
* The tracing level defined in the package.json
*/
enum TracingLevel {
All = 'All',
Off = 'Off',
Critical = 'Critical',
Error = 'Error',
Warning = 'Warning',
Information = 'Information',
Verbose = 'Verbose'
}

View File

@@ -0,0 +1,16 @@
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the Source EULA. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import { promises as fs } from 'fs';
export async function exists(path: string): Promise<boolean> {
try {
await fs.access(path);
return true;
} catch (e) {
return false;
}
}