[MDiff] Introduce Metadata Diff functionality in Actions Hub

loc/translations-export/vscode-powerplatform.xlf

@@ -1095,6 +1095,15 @@ The fifth line should be '[TRANSLATION HERE](command:powerplatform-walkthrough.s
     <trans-unit id="powerpages.copilotPanel.clearConversation.title">
       <source xml:lang="en">Clear Conversation</source>
     </trans-unit>
+    <trans-unit id="microsoft.powerplatform.pages.actionsHub.compareWithLocal.title">
+      <source xml:lang="en">Compare with Local</source>
+    </trans-unit>
+    <trans-unit id="microsoft.powerplatform.pages.metadataDiff.login">
+      <source xml:lang="en">Compare your Power Pages website against a Power Pages environment to view any differences. [Learn more](https://go.microsoft.com/fwlink/?linkid=2305702).
+[Get Started](command:microsoft.powerplatform.pages.metadataDiff.triggerFlow)</source>
+      <note>This is a Markdown formatted string, and the formatting must persist across translations.
+The second line should be '[TRANSLATION HERE](command:microsoft.powerplatform.pages.metadataDiff.triggerFlow).', keeping brackets and the text in the parentheses unmodified</note>
+    </trans-unit>
     <trans-unit id="powerpages.copilotPanel.title">
       <source xml:lang="en">Copilot In Power Pages</source>
     </trans-unit>
@@ -1228,6 +1237,9 @@ The second line should be '[TRANSLATION HERE](command:powerplatform-walkthrough.
     <trans-unit id="microsoft-powerplatform-portals.navigation-loop.powerPagesFileExplorer.title">
       <source xml:lang="en">POWER PAGES ACTIONS</source>
     </trans-unit>
+    <trans-unit id="microsoft.powerplatform.pages.metadataDiff.title">
+      <source xml:lang="en">POWER PAGES METADATA COMPARATOR</source>
+    </trans-unit>
     <trans-unit id="power-platform-activitybar.title">
       <source xml:lang="en">Power Platform</source>
     </trans-unit>

package.json

@@ -195,6 +195,11 @@
         "when": "!virtualWorkspace && pacCLI.authPanel.interactiveLoginSupported",
         "enablement": "microsoft.powerplatform.environment.initialized && !microsoft.powerplatform.pages.actionsHub.loadingWebsites"
       },
+      {
+        "view": "microsoft.powerplatform.pages.metadataDiff",
+        "contents": "%microsoft.powerplatform.pages.metadataDiff.login%",
+        "when": "!virtualWorkspace && pacCLI.authPanel.interactiveLoginSupported"
+      },
       {
         "view": "microsoft.powerplatform.pages.actionsHub",
         "contents": "%pacCLI.authPanel.welcome.whenInteractiveNotSupported%",
@@ -474,6 +479,10 @@
         "command": "microsoft.powerplatform.pages.actionsHub.siteDetails",
         "title": "%microsoft.powerplatform.pages.actionsHub.siteDetails.title%"
       },
+      {
+        "command": "microsoft.powerplatform.pages.actionsHub.compareWithLocal",
+        "title": "%microsoft.powerplatform.pages.actionsHub.compareWithLocal.title%"
+      },
       {
         "command": "microsoft.powerplatform.pages.actionsHub.activeSite.downloadSite",
         "title": "%microsoft.powerplatform.pages.actionsHub.activeSite.downloadSite.title%"
@@ -491,6 +500,54 @@
         "category": "Power Pages",
         "title": "%microsoft.powerplatform.pages.actionsHub.currentActiveSite.runCodeQLScreening.title%",
         "when": "microsoft.powerplatform.pages.codeQlScanEnabled"
+      },
+      {
+        "command": "microsoft.powerplatform.pages.metadataDiff.triggerFlow",
+        "title": "Compare with Environment",
+        "category": "Power Pages Metadata Diff",
+        "icon": "$(cloud-download)"
+      },
+      {
+        "command": "microsoft.powerplatform.pages.metadataDiff.generateReport",
+        "title": "Generate HTML Report",
+        "category": "Power Pages Metadata Diff",
+        "icon": "$(markdown)"
+      },
+      {
+        "command": "microsoft.powerplatform.pages.metadataDiff.resync",
+        "title": "Re-sync",
+        "category": "Power Pages Metadata Diff",
+        "icon": "$(refresh)"
+      },
+      {
+        "command": "microsoft.powerplatform.pages.metadataDiff.clearView",
+        "title": "Clear View",
+        "category": "Power Pages Metadata Diff",
+        "icon": "$(clear-all)"
+      },
+      {
+        "command": "microsoft.powerplatform.pages.metadataDiff.exportReport",
+        "title": "Export Comparison View",
+        "category": "Power Pages Metadata Diff",
+        "icon": "$(save-as)"
+      },
+      {
+        "command": "microsoft.powerplatform.pages.metadataDiff.importReport",
+        "title": "Import Comparison View",
+        "category": "Power Pages Metadata Diff",
+        "icon": "$(folder-opened)"
+      },
+      {
+        "command": "metadataDiff.openComparison",
+        "title": "Open Comparison",
+        "category": "Power Pages Metadata Diff",
+        "icon": "$(diff)"
+      },
+      {
+        "command": "metadataDiff.discardLocalChanges",
+        "title": "Discard Local Changes",
+        "category": "Power Pages Metadata Diff",
+        "icon": "$(discard)"
       }
     ],
     "configuration": {
@@ -767,6 +824,10 @@
           "command": "microsoft-powerapps-portals.webfile",
           "group": "1_powerpages@5"
         },
+        {
+          "command": "microsoft.powerplatform.pages.metadataDiff.triggerFlow",
+          "group": "1_powerpages@6"
+        },
         {
           "command": "microsoft-powerapps-portals.webtemplate",
           "group": "1_powerpages@3"
@@ -985,6 +1046,10 @@
           "command": "microsoft.powerplatform.pages.actionsHub.siteDetails",
           "when": "never"
         },
+        {
+          "command": "microsoft.powerplatform.pages.actionsHub.compareWithLocal",
+          "when": "never"
+        },
         {
           "command": "microsoft.powerplatform.pages.actionsHub.activeSite.downloadSite",
           "when": "never"
@@ -1036,6 +1101,56 @@
           "when": "!virtualWorkspace && view == pacCLI.authPanel",
           "group": "inline"
         },
+        {
+          "command": "microsoft.powerplatform.pages.metadataDiff.generateReport",
+          "when": "view == microsoft.powerplatform.pages.actionsHub && viewItem == metadataDiffRoot && microsoft.powerplatform.pages.metadataDiffEnabled && microsoft.powerplatform.pages.metadataDiff.hasData",
+          "group": "metadataDiff@1"
+        },
+        {
+          "command": "microsoft.powerplatform.pages.metadataDiff.triggerFlow",
+          "when": "view == microsoft.powerplatform.pages.actionsHub && viewItem == metadataDiffRoot && microsoft.powerplatform.pages.metadataDiffEnabled",
+          "group": "metadataDiff@2"
+        },
+        {
+          "command": "microsoft.powerplatform.pages.metadataDiff.resync",
+          "when": "view == microsoft.powerplatform.pages.actionsHub && viewItem == metadataDiffRoot && microsoft.powerplatform.pages.metadataDiffEnabled && microsoft.powerplatform.pages.metadataDiff.hasData",
+          "group": "metadataDiff@3"
+        },
+        {
+          "command": "microsoft.powerplatform.pages.metadataDiff.clearView",
+          "when": "view == microsoft.powerplatform.pages.actionsHub && viewItem == metadataDiffRoot && microsoft.powerplatform.pages.metadataDiffEnabled",
+          "group": "metadataDiff@4"
+        },
+        {
+          "command": "microsoft.powerplatform.pages.metadataDiff.exportReport",
+          "when": "view == microsoft.powerplatform.pages.actionsHub && viewItem == metadataDiffRoot && microsoft.powerplatform.pages.metadataDiffEnabled && microsoft.powerplatform.pages.metadataDiff.hasData",
+          "group": "metadataDiff@5"
+        },
+        {
+          "command": "microsoft.powerplatform.pages.metadataDiff.importReport",
+          "when": "view == microsoft.powerplatform.pages.actionsHub && viewItem == metadataDiffRoot && microsoft.powerplatform.pages.metadataDiffEnabled",
+          "group": "metadataDiff@6"
+        },
+        {
+          "command": "microsoft.powerplatform.pages.metadataDiff.exportReport",
+          "when": "view == microsoft.powerplatform.pages.actionsHub && viewItem == metadataDiffItem && microsoft.powerplatform.pages.metadataDiffEnabled && microsoft.powerplatform.pages.metadataDiff.hasData",
+          "group": "metadataDiff@5"
+        },
+        {
+          "command": "microsoft.powerplatform.pages.metadataDiff.importReport",
+          "when": "view == microsoft.powerplatform.pages.actionsHub && viewItem == metadataDiffItem && microsoft.powerplatform.pages.metadataDiffEnabled",
+          "group": "metadataDiff@6"
+        },
+        {
+          "command": "metadataDiff.openComparison",
+          "when": "view == microsoft.powerplatform.pages.actionsHub && viewItem == metadataDiffFileModified && microsoft.powerplatform.pages.metadataDiffEnabled",
+          "group": "metadataDiffFile@1"
+        },
+        {
+          "command": "metadataDiff.discardLocalChanges",
+          "when": "view == microsoft.powerplatform.pages.actionsHub && viewItem == metadataDiffFileModified && microsoft.powerplatform.pages.metadataDiffEnabled",
+          "group": "metadataDiffFile@2"
+        },
         {
           "command": "pacCLI.authPanel.nameAuthProfile",
           "when": "!virtualWorkspace && view == pacCLI.authPanel"
@@ -1173,6 +1288,11 @@
           "command": "microsoft.powerplatform.pages.actionsHub.currentActiveSite.runCodeQLScreening",
           "when": "view == microsoft.powerplatform.pages.actionsHub && viewItem == currentActiveSite && microsoft.powerplatform.pages.codeQlScanEnabled",
           "group": "siteAction@7"
+        },
+        {
+          "command": "microsoft.powerplatform.pages.actionsHub.compareWithLocal",
+          "when": "view == microsoft.powerplatform.pages.actionsHub && (viewItem == currentActiveSite || viewItem == nonCurrentActiveSite || viewItem == inactiveSite)",
+          "group": "siteAction@9"
         }
       ]
     },

package.nls.json

@@ -97,6 +97,7 @@
   "microsoft.powerplatform.pages.actionsHub.switchEnvironment.title": "Change Environment",
   "microsoft.powerplatform.pages.actionsHub.showEnvironmentDetails.title": "Show Environment Details",
   "microsoft.powerplatform.pages.actionsHub.openSitesInStudio.title": "Open in Power Pages Studio",
+  "microsoft.powerplatform.pages.actionsHub.compareWithLocal.title": "Compare with Local",
   "microsoft.powerplatform.pages.actionsHub.activeSite.previewSite.title": "Preview",
   "microsoft.powerplatform.pages.actionsHub.login":{
     "message":  "Login and connect to a Power Pages environment to use Power Pages actions. [Learn more](https://go.microsoft.com/fwlink/?linkid=2305702).\n[Login](command:microsoft.powerplatform.pages.actionsHub.newAuthProfile)",
@@ -116,5 +117,13 @@
   "microsoft.powerplatform.pages.actionsHub.activeSite.openInStudio.title": "Open in Power Pages Studio",
   "microsoft.powerplatform.pages.actionsHub.inactiveSite.reactivateSite.title": "Reactivate Site",
   "microsoft.powerplatform.pages.actionsHub.currentActiveSite.runCodeQLScreening.title": "Run CodeQL Screening",
-  "microsoft.powerplatform.pages.actionsHub.configuration.downloadSite.description": "The folder where site will be downloaded when using Power Pages Actions. Leave this empty to ask for a folder every time you download a site."
+  "microsoft.powerplatform.pages.actionsHub.configuration.downloadSite.description": "The folder where site will be downloaded when using Power Pages Actions. Leave this empty to ask for a folder every time you download a site.",
+  "microsoft.powerplatform.pages.metadataDiff.title": "POWER PAGES METADATA COMPARATOR",
+  "microsoft.powerplatform.pages.metadataDiff.login":{
+    "message":  "Compare your Power Pages website against a Power Pages environment to view any differences. [Learn more](https://go.microsoft.com/fwlink/?linkid=2305702).\n[Get Started](command:microsoft.powerplatform.pages.metadataDiff.triggerFlow)",
+    "comment": [
+      "This is a Markdown formatted string, and the formatting must persist across translations.",
+      "The second line should be '[TRANSLATION HERE](command:microsoft.powerplatform.pages.metadataDiff.triggerFlow).', keeping brackets and the text in the parentheses unmodified"
+    ]
+  }
 }

src/client/extension.ts

@@ -54,6 +54,7 @@ import { PROVIDER_ID } from "../common/services/Constants";
 import { activateServerApiAutocomplete } from "../common/intellisense";
 import { EnableServerLogicChanges } from "../common/ecs-features/ecsFeatureGates";
 import { setServerApiTelemetryContext } from "../common/intellisense/ServerApiTelemetryContext";
+import { MetadataDiffDesktop } from "./power-pages/metadata-diff/MetadataDiffDesktop";
 
 let client: LanguageClient;
 let _context: vscode.ExtensionContext;
@@ -311,6 +312,8 @@ export async function activate(
     const workspaceFolderWatcher = vscode.workspace.onDidChangeWorkspaceFolders(handleWorkspaceFolderChange);
     _context.subscriptions.push(workspaceFolderWatcher);
 
+    MetadataDiffDesktop.initialize(context, pacTerminal)
+
     if (shouldEnableDebugger()) {
         activateDebugger(context);
     }

src/client/pac/PacTypes.ts

@@ -62,6 +62,14 @@ export type OrgListOutput = {
 
 export type PacOrgListOutput = PacOutputWithResultList<OrgListOutput>;
 
+export type PagesList = {
+    FriendlyName: string,
+    WebsiteId: string,
+    ModelVersion: string
+}
+
+export type PacPagesListOutput = PacOutputWithResultList<PagesList>;
+
 export type ActiveOrgOutput = {
     OrgId: string,
     UniqueName: string,

src/client/pac/PacWrapper.ts

@@ -9,7 +9,7 @@ import * as readline from "readline";
 import * as fs from "fs-extra";
 import { ChildProcessWithoutNullStreams, spawn } from "child_process";
 import { BlockingQueue } from "../../common/utilities/BlockingQueue";
-import { PacOutput, PacAdminListOutput, PacAuthListOutput, PacSolutionListOutput, PacOrgListOutput, PacOrgWhoOutput, PacAuthWhoOutput } from "./PacTypes";
+import { PacOutput, PacAdminListOutput, PacAuthListOutput, PacSolutionListOutput, PacOrgListOutput, PacOrgWhoOutput, PacAuthWhoOutput, PacPagesListOutput} from "./PacTypes";
 import { v4 } from "uuid";
 import { oneDSLoggerWrapper } from "../../common/OneDSLoggerTelemetry/oneDSLoggerWrapper";
 
@@ -229,6 +229,14 @@ export class PacWrapper {
         // The next operation will create a new process
     }
 
+    public async pagesDownload(path: string, websiteId: string, modelVersion: string): Promise<PacOutput> {
+        return this.executeCommandAndParseResults<PacOutput>(new PacArguments("pages", "download", "-p", path, "-id", websiteId, "-mv", modelVersion));
+    }
+
+    public async pagesList(): Promise<PacPagesListOutput> {
+        return this.executeCommandAndParseResults<PacPagesListOutput>(new PacArguments("pages", "list", "--verbose"));
+    }
+
     public exit(): void {
         this.pacInterop.exit();
     }

src/client/power-pages/actions-hub/ActionsHubCommandHandlers.ts

@@ -703,6 +703,34 @@ export const showSiteDetails = async (siteTreeItem: SiteTreeItem) => {
     }
 }
 
+export const compareWithLocal = async (siteTreeItem: SiteTreeItem) => {
+    const siteInfo = siteTreeItem.siteInfo;
+
+    traceInfo(
+        Constants.EventNames.ACTIONS_HUB_COMPARE_WITH_LOCAL_CALLED,
+        {
+            methodName: compareWithLocal.name,
+            siteId: siteInfo.websiteId,
+            dataModelVersion: siteInfo.dataModelVersion
+        }
+    );
+
+    try {
+        // Execute the compare with local command with specific website ID
+        await vscode.commands.executeCommand('microsoft.powerplatform.pages.metadataDiff.triggerFlowWithSite', siteInfo.websiteId);
+    } catch (error) {
+        traceError(
+            Constants.EventNames.ACTIONS_HUB_COMPARE_WITH_LOCAL_FAILED,
+            error as Error,
+            {
+                methodName: compareWithLocal.name,
+                siteId: siteInfo.websiteId,
+                dataModelVersion: siteInfo.dataModelVersion
+            }
+        );
+    }
+}
+
 const getDownloadFolderOptions = () => {
     const options = [
         {