Adding ORM definitions to schema designer (#21981)

Author: aasimkhan30

extensions/mssql/l10n/bundle.l10n.json

@@ -705,6 +705,14 @@
     "Definition": "Definition",
     "Show Definition": "Show Definition",
     "Hide Definition": "Hide Definition",
+    "Definition type": "Definition type",
+    "T-SQL": "T-SQL",
+    "Prisma": "Prisma",
+    "Sequelize": "Sequelize",
+    "TypeORM": "TypeORM",
+    "Drizzle": "Drizzle",
+    "SQLAlchemy": "SQLAlchemy",
+    "EF Core": "EF Core",
     "Delete Confirmation": "Delete Confirmation",
     "Are you sure you want to delete the selected items?": "Are you sure you want to delete the selected items?",
     "Undo": "Undo",
@@ -2144,6 +2152,15 @@
     "SQL Plan Files": "SQL Plan Files",
     "Script copied to clipboard": "Script copied to clipboard",
     "Copied": "Copied",
+    "Failed to open text in editor: {0}/{0} is the error message": {
+        "message": "Failed to open text in editor: {0}",
+        "comment": ["{0} is the error message"]
+    },
+    "Failed to copy text to clipboard: {0}/{0} is the error message": {
+        "message": "Failed to copy text to clipboard: {0}",
+        "comment": ["{0} is the error message"]
+    },
+    "Schema designer details are not available.": "Schema designer details are not available.",
     "Copying results...": "Copying results...",
     "Results copied to clipboard": "Results copied to clipboard",
     "Do you want to always display query results in a new tab instead of the query pane?": "Do you want to always display query results in a new tab instead of the query pane?",
@@ -3374,10 +3391,6 @@
         "message": "File: {0}",
         "comment": ["{0} is the file name"]
     },
-    "Failed to open text in editor: {0}/{0} is the error message": {
-        "message": "Failed to open text in editor: {0}",
-        "comment": ["{0} is the error message"]
-    },
     "Profiler events exported successfully to {0}/{0} is the file path": {
         "message": "Profiler events exported successfully to {0}",
         "comment": ["{0} is the file path"]

extensions/mssql/src/constants/locConstants.ts

@@ -780,6 +780,19 @@ export let executionPlan = l10n.t("Execution Plan");
 export let executionPlanFileFilter = l10n.t("SQL Plan Files");
 export let scriptCopiedToClipboard = l10n.t("Script copied to clipboard");
 export let copied = l10n.t("Copied");
+export let failedToOpenTextInEditor = (errorMessage: string) =>
+    l10n.t({
+        message: "Failed to open text in editor: {0}",
+        args: [errorMessage],
+        comment: ["{0} is the error message"],
+    });
+export let failedToCopyTextToClipboard = (errorMessage: string) =>
+    l10n.t({
+        message: "Failed to copy text to clipboard: {0}",
+        args: [errorMessage],
+        comment: ["{0} is the error message"],
+    });
+export let schemaDesignerDetailsUnavailable = l10n.t("Schema designer details are not available.");
 export let copyingResults = l10n.t("Copying results...");
 export let resultsCopiedToClipboard = l10n.t("Results copied to clipboard");
 

extensions/mssql/src/schemaDesigner/schemaDesignerWebviewController.ts

@@ -23,6 +23,10 @@ import { DabService } from "../services/dabService";
 import { Dab } from "../sharedInterfaces/dab";
 import { CopilotChat } from "../sharedInterfaces/copilotChat";
 import { addMcpServerToWorkspace } from "../copilot/copilotUtils";
+import {
+    getSchemaDesignerDefinitionOutput,
+    SchemaDesignerDefinitionOutput,
+} from "../sharedInterfaces/schemaDesignerDefinitionOutput";
 
 function isExpandCollapseButtonsEnabled(): boolean {
     return vscode.workspace
@@ -327,19 +331,39 @@ export class SchemaDesignerWebviewController extends WebviewPanelController<
         });
 
         this.onNotification(SchemaDesigner.CopyToClipboardNotification.type, async (params) => {
-            await vscode.env.clipboard.writeText(params.text);
-            await vscode.window.showInformationMessage(LocConstants.scriptCopiedToClipboard);
+            try {
+                const definition = await this.createDefinitionOutput(params);
+                await vscode.env.clipboard.writeText(definition.text);
+                await vscode.window.showInformationMessage(LocConstants.copied);
+            } catch (error) {
+                await vscode.window.showErrorMessage(
+                    LocConstants.failedToCopyTextToClipboard(getErrorMessage(error)),
+                );
+            }
         });
 
-        this.onNotification(SchemaDesigner.OpenInEditorNotification.type, async () => {
-            const definition = await this.schemaDesignerService.getDefinition({
-                updatedSchema: this.schemaDesignerDetails!.schema,
-                sessionId: this._sessionId,
-            });
-            await this.mainController.sqlDocumentService.newQuery({
-                content: definition.script,
-                connectionStrategy: ConnectionStrategy.DoNotConnect,
-            });
+        this.onNotification(SchemaDesigner.OpenInEditorNotification.type, async (params) => {
+            try {
+                const definition = await this.createDefinitionOutput(params);
+
+                if (definition.language === "sql") {
+                    await this.mainController.sqlDocumentService.newQuery({
+                        content: definition.text,
+                        connectionStrategy: ConnectionStrategy.DoNotConnect,
+                    });
+                    return;
+                }
+
+                const document = await vscode.workspace.openTextDocument({
+                    content: definition.text,
+                    language: definition.language,
+                });
+                await vscode.window.showTextDocument(document, { preview: false });
+            } catch (error) {
+                await vscode.window.showErrorMessage(
+                    LocConstants.failedToOpenTextInEditor(getErrorMessage(error)),
+                );
+            }
         });
 
         this.onNotification(SchemaDesigner.OpenInEditorWithConnectionNotification.type, () => {
@@ -578,6 +602,38 @@ export class SchemaDesignerWebviewController extends WebviewPanelController<
         });
     }
 
+    private async createDefinitionOutput(
+        params?: SchemaDesigner.OpenInEditorOptions | SchemaDesigner.CopyToClipboardOptions,
+    ): Promise<SchemaDesignerDefinitionOutput> {
+        if (params?.text !== undefined) {
+            return {
+                text: params.text,
+                language: "language" in params ? (params.language ?? "sql") : "sql",
+            };
+        }
+
+        const updatedSchema = params?.updatedSchema ?? this.schemaDesignerDetails?.schema;
+        if (!updatedSchema) {
+            throw new Error(LocConstants.schemaDesignerDetailsUnavailable);
+        }
+
+        this.updateCacheItem(updatedSchema);
+
+        const definitionKind = params?.definitionKind ?? SchemaDesigner.DefinitionKind.Sql;
+        if (definitionKind === SchemaDesigner.DefinitionKind.Sql) {
+            const definition = await this.schemaDesignerService.getDefinition({
+                updatedSchema,
+                sessionId: this._sessionId || this.schemaDesignerDetails?.sessionId || "",
+            });
+            return {
+                text: definition.script,
+                language: "sql",
+            };
+        }
+
+        return getSchemaDesignerDefinitionOutput(updatedSchema, definitionKind);
+    }
+
     private setupConfigurationListener() {
         const configChangeDisposable = vscode.workspace.onDidChangeConfiguration((e) => {
             if (e.affectsConfiguration(configSchemaDesignerEnableExpandCollapseButtons)) {
@@ -596,7 +652,19 @@ export class SchemaDesignerWebviewController extends WebviewPanelController<
         updatedSchema?: SchemaDesigner.Schema,
         isDirty?: boolean,
     ): SchemaDesigner.SchemaDesignerCacheItem {
-        let schemaDesignerCacheItem = this.schemaDesignerCache.get(this._key)!;
+        let schemaDesignerCacheItem = this.schemaDesignerCache.get(this._key);
+        if (!schemaDesignerCacheItem) {
+            if (!this.schemaDesignerDetails) {
+                throw new Error(LocConstants.schemaDesignerDetailsUnavailable);
+            }
+
+            schemaDesignerCacheItem = {
+                schemaDesignerDetails: this.schemaDesignerDetails,
+                baselineSchema: this.baselineSchema ?? this.schemaDesignerDetails.schema,
+                isDirty: false,
+            };
+        }
+        this.schemaDesignerDetails ??= schemaDesignerCacheItem.schemaDesignerDetails;
         if (updatedSchema) {
             this.schemaDesignerDetails!.schema = updatedSchema;
             schemaDesignerCacheItem.schemaDesignerDetails.schema = updatedSchema;

extensions/mssql/src/sharedInterfaces/schemaDesigner.ts

@@ -147,6 +147,16 @@ export namespace SchemaDesigner {
         Dab = "dab",
     }
 
+    export enum DefinitionKind {
+        Sql = "sql",
+        Prisma = "prisma",
+        Sequelize = "sequelize",
+        TypeOrm = "typeorm",
+        Drizzle = "drizzle",
+        SqlAlchemy = "sqlalchemy",
+        EfCore = "efcore",
+    }
+
     /**
      * Schema designer model ready event
      * This event is sent when the schema designer model is ready
@@ -356,11 +366,16 @@ export namespace SchemaDesigner {
     }
 
     export interface CopyToClipboardOptions {
-        text: string;
+        text?: string;
+        updatedSchema?: Schema;
+        definitionKind?: DefinitionKind;
     }
 
     export interface OpenInEditorOptions {
-        text: string;
+        text?: string;
+        language?: string;
+        updatedSchema?: Schema;
+        definitionKind?: DefinitionKind;
     }
 
     export interface SchemaDesignerReducers {
@@ -399,10 +414,6 @@ export namespace SchemaDesigner {
     export namespace CloseSchemaDesignerNotification {
         export const type = new NotificationType<void>("closeDesigner");
     }
-    export interface OpenInEditorParams {
-        text: string;
-    }
-
     export namespace OpenInEditorWithConnectionNotification {
         export const type = new NotificationType<void>("openInEditorWithConnection");
     }
@@ -411,7 +422,7 @@ export namespace SchemaDesigner {
     }
 
     export namespace CopyToClipboardNotification {
-        export const type = new NotificationType<OpenInEditorParams>("copyToClipboard");
+        export const type = new NotificationType<CopyToClipboardOptions>("copyToClipboard");
     }
 
     export interface UpdatedSchemaParams {