Add Schema Compare Controller Logic

gulpfile.js

@@ -1,4 +1,4 @@
-const gulp = require('gulp');
+const gulp = require('gulp');
 const rename = require('gulp-rename');
 const ts = require('gulp-typescript');
 const tsProject = ts.createProject('tsconfig.json');
@@ -190,6 +190,7 @@ async function generateReactWebviewsBundle() {
 			'queryResult': 'src/reactviews/pages/QueryResult/index.tsx',
 			'userSurvey': 'src/reactviews/pages/UserSurvey/index.tsx',
 			'schemaDesigner': 'src/reactviews/pages/SchemaDesigner/index.tsx',
+			'schemaCompare': 'src/reactviews/pages/SchemaCompare/index.tsx',
 		},
 		bundle: true,
 		outdir: 'out/src/reactviews/assets',

localization/l10n/bundle.l10n.json

@@ -808,6 +808,7 @@
     ]
   },
   "General": "General",
+  "Schema Compare": "Schema Compare",
   "Azure sign in failed.": "Azure sign in failed.",
   "Select subscriptions": "Select subscriptions",
   "Error loading Azure subscriptions.": "Error loading Azure subscriptions.",

localization/xliff/vscode-mssql.xlf

@@ -1103,6 +1103,9 @@
     <trans-unit id="++CODE++07b091a3fdc4e4c03cd047b5264e61241f20fe8dbc36a4c796d46cd8dc3e7d03">
       <source xml:lang="en">Schema</source>
     </trans-unit>
+    <trans-unit id="++CODE++154e484fc5e1a7cb4991c071caef673c453eaa7dcfef4321db537c576a5c56cf">
+      <source xml:lang="en">Schema Compare</source>
+    </trans-unit>
     <trans-unit id="++CODE++cce7c24ebb0a14bc98b7d6a3f18ddfe9c893e65adb1a599321b3e0eca3515490">
       <source xml:lang="en">Script As Create</source>
     </trans-unit>
@@ -1803,6 +1806,9 @@
     <trans-unit id="mssql.runQueryHistory">
       <source xml:lang="en">Run Query</source>
     </trans-unit>
+    <trans-unit id="mssql.schemaCompare">
+      <source xml:lang="en">Schema Compare (Preview)</source>
+    </trans-unit>
     <trans-unit id="mssql.scriptAlter">
       <source xml:lang="en">Script as Alter</source>
     </trans-unit>

package.json

@@ -422,6 +422,14 @@
           "when": "view == objectExplorer && config.mssql.enableRichExperiences && viewItem =~ /\\bfilterable=true\\b.*\\bhasFilters=true\\b/",
           "group": "inline@2"
         },
+        {
+          "command": "mssql.schemaCompare",
+          "when": "view == objectExplorer && config.mssql.enableRichExperiences && viewItem =~ /\\btype=(disconnectedServer|Server|Database)\\b/"
+        },
+        {
+          "command": "mssql.schemaCompare",
+          "when": "view == dataworkspace.views.main && config.mssql.enableRichExperiences && viewItem =~ /^(databaseProject.itemType.project|databaseProject.itemType.legacyProject)$/"
+        },
         {
           "command": "mssql.filterNode",
           "when": "view == objectExplorer && config.mssql.enableRichExperiences && viewItem =~ /\\bfilterable=true\\b.*\\bhasFilters=false\\b/"
@@ -524,6 +532,10 @@
           "command": "mssql.objectExplorerNewQuery",
           "when": "view == objectExplorer && viewItem =~ /\\btype=(disconnectedServer|Server|Database)\\b/"
         },
+        {
+          "command": "mssql.schemaCompare",
+          "when": "view == objectExplorer && config.mssql.enableRichExperiences && viewItem =~ /\\btype=(disconnectedServer|Server|Database)\\b/"
+        },
         {
           "command": "mssql.removeObjectExplorerNode",
           "when": "view == objectExplorer && viewItem =~ /\\btype=(disconnectedServer|Server)\\b/"
@@ -705,6 +717,11 @@
         "title": "%mssql.newQuery%",
         "category": "MS SQL"
       },
+      {
+        "command": "mssql.schemaCompare",
+        "title": "%mssql.schemaCompare%",
+        "category": "MS SQL"
+      },
       {
         "command": "mssql.rebuildIntelliSenseCache",
         "title": "%mssql.rebuildIntelliSenseCache%",

package.nls.json

@@ -34,6 +34,7 @@
 "mssql.showGettingStarted":"Getting Started Guide",
 "mssql.newQuery":"New Query",
 "mssql.objectExplorerNewQuery":"New Query",
+"mssql.schemaCompare": "Schema Compare (Preview)",
 "mssql.toggleSqlCmd":"Toggle SQLCMD Mode",
 "mssql.copyObjectName":"Copy Object Name",
 "mssql.addAadAccount":"Add Microsoft Entra Account",

src/constants/constants.ts

@@ -41,6 +41,7 @@ export const cmdStartQueryHistory = "mssql.startQueryHistoryCapture";
 export const cmdPauseQueryHistory = "mssql.pauseQueryHistoryCapture";
 export const cmdCommandPaletteQueryHistory = "mssql.commandPaletteQueryHistory";
 export const cmdNewQuery = "mssql.newQuery";
+export const cmdSchemaCompare = "mssql.schemaCompare";
 export const cmdManageConnectionProfiles = "mssql.manageProfiles";
 export const cmdClearPooledConnections = "mssql.clearPooledConnections";
 export const cmdRebuildIntelliSenseCache = "mssql.rebuildIntelliSenseCache";

src/constants/locConstants.ts

@@ -799,3 +799,7 @@ export class TableDesigner {
     public static Columns = l10n.t("Columns");
     public static AdvancedOptions = l10n.t("Advanced Options");
 }
+
+export class SchemaCompare {
+    public static Title = l10n.t("Schema Compare");
+}

src/controllers/mainController.ts

@@ -1,4 +1,4 @@
-/*---------------------------------------------------------------------------------------------
+/*---------------------------------------------------------------------------------------------
  *  Copyright (c) Microsoft Corporation. All rights reserved.
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
@@ -63,6 +63,8 @@ import { ObjectExplorerDragAndDropController } from "../objectExplorer/objectExp
 import { SchemaDesignerService } from "../services/schemaDesignerService";
 import { SchemaDesignerWebviewController } from "../schemaDesigner/schemaDesignerWebviewController";
 import store from "../queryResult/singletonStore";
+import { SchemaCompareWebViewController } from "../schemaCompare/schemaCompareWebViewController";
+import { SchemaCompare } from "../constants/locConstants";
 
 /**
  * The main controller class that initializes the extension
@@ -896,6 +898,13 @@ export default class MainController implements vscode.Disposable {
         );
 
         if (this.isRichExperiencesEnabled) {
+            this._context.subscriptions.push(
+                vscode.commands.registerCommand(
+                    Constants.cmdSchemaCompare,
+                    async (node: any) => this.onSchemaCompare(node),
+                ),
+            );
+
             this._context.subscriptions.push(
                 vscode.commands.registerCommand(
                     Constants.cmdEditConnection,
@@ -1983,6 +1992,23 @@ export default class MainController implements vscode.Disposable {
         return false;
     }
 
+    public async onSchemaCompare(node: any): Promise<void> {
+        if (node) {
+            const result = await this.schemaCompareService.getDefaultOptions();
+            const schemaCompareWebView = new SchemaCompareWebViewController(
+                this._context,
+                this._vscodeWrapper,
+                node,
+                this.schemaCompareService,
+                this._connectionMgr,
+                result,
+                SchemaCompare.Title,
+            );
+
+            schemaCompareWebView.revealToForeground();
+        }
+    }
+
     /**
      * Check if the extension launched file exists.
      * This is to detect when we are running in a clean install scenario.

src/reactviews/pages/SchemaCompare/SchemaCompare.tsx

@@ -0,0 +1,13 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+export const SchemaComparePage = () => {
+    return (
+        <div>
+            {/* WIP/Initial Checkin: Page is a work in progress */}
+            <h1>Schema Compare Page</h1>
+        </div>
+    );
+};

src/reactviews/pages/SchemaCompare/SchemaCompareStateProvider.tsx

@@ -0,0 +1,131 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import * as sc from "../../../sharedInterfaces/schemaCompare";
+import * as mssql from "vscode-mssql";
+
+import { createContext } from "react";
+import { useVscodeWebview } from "../../common/vscodeWebviewProvider";
+
+const schemaCompareContext = createContext<sc.SchemaCompareContextProps>(
+    {} as sc.SchemaCompareContextProps,
+);
+
+interface SchemaCompareStateProviderProps {
+    children: React.ReactNode;
+}
+
+const SchemaCompareStateProvider: React.FC<SchemaCompareStateProviderProps> = ({
+    children,
+}) => {
+    const webViewState = useVscodeWebview<
+        sc.SchemaCompareWebViewState,
+        sc.SchemaCompareReducers
+    >();
+    const schemaCompareState = webViewState?.state;
+
+    return (
+        <schemaCompareContext.Provider
+            value={{
+                state: schemaCompareState,
+                themeKind: webViewState?.themeKind,
+                compare: function (
+                    sourceEndpointInfo: mssql.SchemaCompareEndpointInfo,
+                    targetEndpointInfo: mssql.SchemaCompareEndpointInfo,
+                    taskExecutionMode: mssql.TaskExecutionMode,
+                    deploymentOptions: mssql.DeploymentOptions,
+                ): void {
+                    webViewState?.extensionRpc.action("compare", {
+                        sourceEndpointInfo: sourceEndpointInfo,
+                        targetEndpointInfo: targetEndpointInfo,
+                        taskExecutionMode: taskExecutionMode,
+                        deploymentOptions: deploymentOptions,
+                    });
+                },
+                generateScript: function (
+                    targetServerName: string,
+                    targetDatabaseName: string,
+                    taskExecutionMode: mssql.TaskExecutionMode,
+                ): void {
+                    webViewState?.extensionRpc.action("generateScript", {
+                        targetServerName: targetServerName,
+                        targetDatabaseName: targetDatabaseName,
+                        taskExecutionMode: taskExecutionMode,
+                    });
+                },
+                publishDatabaseChanges: function (
+                    targetServerName: string,
+                    targetDatabaseName: string,
+                    taskExecutionMode: mssql.TaskExecutionMode,
+                ): void {
+                    webViewState?.extensionRpc.action(
+                        "publishDatabaseChanges",
+                        {
+                            targetServerName: targetServerName,
+                            targetDatabaseName: targetDatabaseName,
+                            taskExecutionMode: taskExecutionMode,
+                        },
+                    );
+                },
+                publishProjectChanges: function (
+                    targetProjectPath: string,
+                    targetFolderStructure: mssql.ExtractTarget,
+                    taskExecutionMode: mssql.TaskExecutionMode,
+                ): void {
+                    webViewState?.extensionRpc.action("publishProjectChanges", {
+                        targetProjectPath: targetProjectPath,
+                        targetFolderStructure: targetFolderStructure,
+                        taskExecutionMode: taskExecutionMode,
+                    });
+                },
+                getDefaultOptions: function (): void {
+                    webViewState?.extensionRpc.action("getDefaultOptions", {});
+                },
+                includeExcludeNode: function (
+                    diffEntry: mssql.DiffEntry,
+                    includeRequest: boolean,
+                    taskExecutionMode: mssql.TaskExecutionMode,
+                ): void {
+                    webViewState?.extensionRpc.action("includeExcludeNode", {
+                        diffEntry: diffEntry,
+                        includeRequest: includeRequest,
+                        taskExecutionMode: taskExecutionMode,
+                    });
+                },
+                openScmp: function (filePath: string): void {
+                    webViewState?.extensionRpc.action("openScmp", {
+                        filePath: filePath,
+                    });
+                },
+                saveScmp: function (
+                    sourceEndpointInfo: mssql.SchemaCompareEndpointInfo,
+                    targetEndpointInfo: mssql.SchemaCompareEndpointInfo,
+                    taskExecutionMode: mssql.TaskExecutionMode,
+                    deploymentOptions: mssql.DeploymentOptions,
+                    scmpFilePath: string,
+                    excludedSourceObjects: mssql.SchemaCompareObjectId[],
+                    excludedTargetObjects: mssql.SchemaCompareObjectId[],
+                ): void {
+                    webViewState?.extensionRpc.action("saveScmp", {
+                        sourceEndpointInfo: sourceEndpointInfo,
+                        targetEndpointInfo: targetEndpointInfo,
+                        taskExecutionMode: taskExecutionMode,
+                        deploymentOptions: deploymentOptions,
+                        scmpFilePath: scmpFilePath,
+                        excludedSourceObjects: excludedSourceObjects,
+                        excludedTargetObjects: excludedTargetObjects,
+                    });
+                },
+                cancel: function (): void {
+                    webViewState?.extensionRpc.action("cancel", {});
+                },
+            }}
+        >
+            {children}
+        </schemaCompareContext.Provider>
+    );
+};
+
+export { SchemaCompareStateProvider };

src/reactviews/pages/SchemaCompare/index.tsx

@@ -0,0 +1,18 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import ReactDOM from "react-dom/client";
+import "../../index.css";
+import { VscodeWebviewProvider } from "../../common/vscodeWebviewProvider";
+import { SchemaComparePage } from "./SchemaCompare";
+import { SchemaCompareStateProvider } from "./SchemaCompareStateProvider";
+
+ReactDOM.createRoot(document.getElementById("root")!).render(
+    <VscodeWebviewProvider>
+        <SchemaCompareStateProvider>
+            <SchemaComparePage />
+        </SchemaCompareStateProvider>
+    </VscodeWebviewProvider>,
+);