[MDiff] Update metadata diff labels and add clear functionality (#1409)

✨ Renamed "Metadata Diff" to "Site Comparison" for clarity.
✨ Added confirmation dialogs for clearing metadata diff results.
✨ Implemented functionality to clear individual site comparisons.
✨ Updated localization files with new labels and messages.
✨ Added tests for new clear functionality and site comparison behavior.

-Priyanshu

Author: priyanshu92

l10n/bundle.l10n.json

@@ -358,7 +358,7 @@
   "Site download failed. Please try again later.": "Site download failed. Please try again later.",
   "No differences found between the remote site and your local workspace.": "No differences found between the remote site and your local workspace.",
   "Comparing files...": "Comparing files...",
-  "Metadata Diff": "Metadata Diff",
+  "Site Comparison": "Site Comparison",
   "Modified": "Modified",
   "Added locally": "Added locally",
   "Deleted locally": "Deleted locally",
@@ -373,6 +373,12 @@
   "Yes, Don't Ask Again": "Yes, Don't Ask Again",
   "The website was not found in the selected environment. Please select a different environment.": "The website was not found in the selected environment. Please select a different environment.",
   "Discard Changes": "Discard Changes",
+  "Clear All": "Clear All",
+  "Clear all results?": "Clear all results?",
+  "This will close all active comparison views. Your local files will not be affected.": "This will close all active comparison views. Your local files will not be affected.",
+  "Clear": "Clear",
+  "Clear result?": "Clear result?",
+  "This will close the active comparison view. Your local files will not be affected.": "This will close the active comparison view. Your local files will not be affected.",
   "Show Diff": "Show Diff",
   "All changed files are binary files (e.g., images) and cannot be displayed in the diff viewer. You can view them individually in the file tree.": "All changed files are binary files (e.g., images) and cannot be displayed in the diff viewer. You can view them individually in the file tree.",
   "1 file changed": "1 file changed",

loc/translations-export/vscode-powerplatform.xlf

@@ -179,6 +179,18 @@
     <trans-unit id="++CODE++2c8d1f9ca282591926b952dc5949d44df6204f1f0a3f5183bcd5ef7ae5864bad">
       <source xml:lang="en">Choose web template</source>
     </trans-unit>
+    <trans-unit id="++CODE++83b12c2216efb4fdc924e1deb5182e905e4926ed0c1c324d467107f46d5a26a9">
+      <source xml:lang="en">Clear</source>
+    </trans-unit>
+    <trans-unit id="++CODE++ddceb7adfdb8816e4747bc48a2221702e830340e5596a701dc0993766eba5e60">
+      <source xml:lang="en">Clear All</source>
+    </trans-unit>
+    <trans-unit id="++CODE++f404fdaebef56580458d681961f3f87aeee6d5b864fa2a5f4e10873a65d81d7a">
+      <source xml:lang="en">Clear all results?</source>
+    </trans-unit>
+    <trans-unit id="++CODE++26ed15c8dd832c026cd98c581dcb29966b8181619b4c51247c04eceece2bb8b7">
+      <source xml:lang="en">Clear result?</source>
+    </trans-unit>
     <trans-unit id="++CODE++7aaafd1c6d6875eb1cd67e841f87457e929c922a18fef7c1452c1e1a4c036456">
       <source xml:lang="en">Clearing cache. See [details](https://aka.ms/pages-clear-cache).</source>
       <note>This is a markdown formatting which must persist across translations.
@@ -745,9 +757,6 @@ Return to this chat and @powerpages can help you write and edit your website cod
     <trans-unit id="++CODE++8a194d5287e3da019883144787cd5f282753f5ce892d933be0833b3818c25503">
       <source xml:lang="en">Maximum 30 characters allowed</source>
     </trans-unit>
-    <trans-unit id="++CODE++a6d287e1a3ca10ca1e47de17060293fbb14d1e43cd8ffb9a296661c576615b69">
-      <source xml:lang="en">Metadata Diff</source>
-    </trans-unit>
     <trans-unit id="++CODE++d39a5fa0fca9df105f95b7dfa9a2705ccddaead33bd3119052baabe6c923a85d">
       <source xml:lang="en">Metadata Diff JSON</source>
     </trans-unit>
@@ -1102,6 +1111,9 @@ The {3} represents Dataverse Environment's Organization ID (GUID)</note>
     <trans-unit id="++CODE++2f65ba5aa38a9acac3a9a9c0a9aeecd7b32796008dc63432bedbe6ef62982558">
       <source xml:lang="en">Sign in to VS Code with PAC CLI account</source>
     </trans-unit>
+    <trans-unit id="++CODE++413f481712d78c8cce54fc6b1ef2da1b4e35e9584c11fcdc51509c19017e2812">
+      <source xml:lang="en">Site Comparison</source>
+    </trans-unit>
     <trans-unit id="++CODE++524bca0347e50e3801bebf27374124b3babf072729b4da4bcc45ef5c385ee8f4">
       <source xml:lang="en">Site Details</source>
     </trans-unit>
@@ -1209,6 +1221,12 @@ The {3} represents Dataverse Environment's Organization ID (GUID)</note>
     <trans-unit id="++CODE++bcfc420c0358eb6f248fa6328797cfa38fa121baea6320a623280a0d34eeee75">
       <source xml:lang="en">This file was exported with a newer version of the extension. Please update your extension to import this file.</source>
     </trans-unit>
+    <trans-unit id="++CODE++e7de2855a45712e1d967171e4d86f37d4014c2f80a515bc552ed4c4a2984c3e4">
+      <source xml:lang="en">This will close all active comparison views. Your local files will not be affected.</source>
+    </trans-unit>
+    <trans-unit id="++CODE++f9463baef8e56e06230fca093d61bb43810240340033d21ecf4df81e02579913">
+      <source xml:lang="en">This will close the active comparison view. Your local files will not be affected.</source>
+    </trans-unit>
     <trans-unit id="++CODE++75670337a398f9840d2951dbc6746497caec6da9dd506ecff57ef79d59c6280f">
       <source xml:lang="en">Thumbs Down</source>
     </trans-unit>
@@ -1517,9 +1535,6 @@ The fifth line should be '[TRANSLATION HERE](command:powerplatform-walkthrough.s
     <trans-unit id="pacCLI.openDocumentation.title">
       <source xml:lang="en">Documentation</source>
     </trans-unit>
-    <trans-unit id="microsoft.powerplatform.pages.actionsHub.metadataDiff.generateHtmlReport.title">
-      <source xml:lang="en">Download HTML Report</source>
-    </trans-unit>
     <trans-unit id="microsoft.powerplatform.pages.actionsHub.activeSite.downloadSite.title">
       <source xml:lang="en">Download Site</source>
     </trans-unit>
@@ -1532,8 +1547,11 @@ The fifth line should be '[TRANSLATION HERE](command:powerplatform-walkthrough.s
     <trans-unit id="pacCLI.envAndSolutionsPanel.title">
       <source xml:lang="en">Environments &amp; Solutions</source>
     </trans-unit>
+    <trans-unit id="microsoft.powerplatform.pages.actionsHub.metadataDiff.generateHtmlReport.title">
+      <source xml:lang="en">Export as HTML Report</source>
+    </trans-unit>
     <trans-unit id="microsoft.powerplatform.pages.actionsHub.metadataDiff.export.title">
-      <source xml:lang="en">Export Comparison</source>
+      <source xml:lang="en">Export as JSON</source>
     </trans-unit>
     <trans-unit id="microsoft-powerapps-portals.walkthrough.fileSystem.title">
       <source xml:lang="en">File explorer</source>

package.nls.json

@@ -130,8 +130,8 @@
   "microsoft.powerplatform.pages.actionsHub.metadataDiff.sortByName.title": "Sort by Name",
   "microsoft.powerplatform.pages.actionsHub.metadataDiff.sortByPath.title": "Sort by Path",
   "microsoft.powerplatform.pages.actionsHub.metadataDiff.sortByStatus.title": "Sort by Status",
-  "microsoft.powerplatform.pages.actionsHub.metadataDiff.generateHtmlReport.title": "Download HTML Report",
-  "microsoft.powerplatform.pages.actionsHub.metadataDiff.export.title": "Export Comparison",
+  "microsoft.powerplatform.pages.actionsHub.metadataDiff.generateHtmlReport.title": "Export as HTML Report",
+  "microsoft.powerplatform.pages.actionsHub.metadataDiff.export.title": "Export as JSON",
   "microsoft.powerplatform.pages.actionsHub.metadataDiff.import.title": "Import Comparison",
   "microsoft.powerplatform.pages.actionsHub.metadataDiff.resync.title": "Refresh Comparison",
   "microsoft-powerapps-portals.compareWithEnvironment.title": "Compare with Environment",

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

@@ -179,7 +179,7 @@ export const Constants = {
         COMPARE_WITH_LOCAL_SITE_DOWNLOAD_FAILED: vscode.l10n.t("Site download failed. Please try again later."),
         NO_DIFFERENCES_FOUND: vscode.l10n.t("No differences found between the remote site and your local workspace."),
         COMPARING_FILES: vscode.l10n.t("Comparing files..."),
-        METADATA_DIFF_GROUP: vscode.l10n.t("Metadata Diff"),
+        METADATA_DIFF_GROUP: vscode.l10n.t("Site Comparison"),
         METADATA_DIFF_MODIFIED: vscode.l10n.t("Modified"),
         METADATA_DIFF_ADDED: vscode.l10n.t("Added locally"),
         METADATA_DIFF_DELETED: vscode.l10n.t("Deleted locally"),
@@ -194,6 +194,12 @@ export const Constants = {
         YES_DONT_ASK_AGAIN: vscode.l10n.t("Yes, Don't Ask Again"),
         WEBSITE_NOT_FOUND_IN_ENVIRONMENT: vscode.l10n.t("The website was not found in the selected environment. Please select a different environment."),
         DISCARD_CHANGES: vscode.l10n.t("Discard Changes"),
+        CLEAR_ALL: vscode.l10n.t("Clear All"),
+        CLEAR_ALL_RESULTS_TITLE: vscode.l10n.t("Clear all results?"),
+        CLEAR_ALL_RESULTS_MESSAGE: vscode.l10n.t("This will close all active comparison views. Your local files will not be affected."),
+        CLEAR: vscode.l10n.t("Clear"),
+        CLEAR_RESULT_TITLE: vscode.l10n.t("Clear result?"),
+        CLEAR_RESULT_MESSAGE: vscode.l10n.t("This will close the active comparison view. Your local files will not be affected."),
         SHOW_DIFF: vscode.l10n.t("Show Diff"),
         METADATA_DIFF_ONLY_BINARY_FILES: vscode.l10n.t("All changed files are binary files (e.g., images) and cannot be displayed in the diff viewer. You can view them individually in the file tree."),
         FILE_COUNT_DESCRIPTION_SINGULAR: vscode.l10n.t("1 file changed"),

src/client/power-pages/actions-hub/handlers/metadata-diff/ClearMetadataDiffHandler.ts

@@ -3,17 +3,29 @@
  * Licensed under the MIT License. See License.txt in the project root for license information.
  */
 
+import * as vscode from "vscode";
 import MetadataDiffContext from "../../MetadataDiffContext";
 import { traceInfo } from "../../TelemetryHelper";
 import { Constants } from "../../Constants";
 
 /**
- * Clears the metadata diff results from the tree view
+ * Clears the metadata diff results from the tree view after user confirmation
  */
-export function clearMetadataDiff(): void {
+export async function clearMetadataDiff(): Promise<void> {
     traceInfo(Constants.EventNames.ACTIONS_HUB_METADATA_DIFF_CLEAR, {
         methodName: clearMetadataDiff.name
     });
 
+    const confirmButton = Constants.Strings.CLEAR_ALL;
+    const result = await vscode.window.showWarningMessage(
+        Constants.Strings.CLEAR_ALL_RESULTS_TITLE,
+        { modal: true, detail: Constants.Strings.CLEAR_ALL_RESULTS_MESSAGE },
+        confirmButton
+    );
+
+    if (result !== confirmButton) {
+        return;
+    }
+
     MetadataDiffContext.clear();
 }

src/client/power-pages/actions-hub/handlers/metadata-diff/RemoveSiteHandler.ts

@@ -3,19 +3,31 @@
  * Licensed under the MIT License. See License.txt in the project root for license information.
  */
 
+import * as vscode from "vscode";
 import { MetadataDiffSiteTreeItem } from "../../tree-items/metadata-diff/MetadataDiffSiteTreeItem";
 import { traceInfo } from "../../TelemetryHelper";
 import { Constants } from "../../Constants";
 import MetadataDiffContext from "../../MetadataDiffContext";
 
 /**
- * Removes a specific site's comparison results from the metadata diff view
+ * Removes a specific site's comparison results from the metadata diff view after user confirmation
  */
-export function removeSiteComparison(siteItem: MetadataDiffSiteTreeItem): void {
+export async function removeSiteComparison(siteItem: MetadataDiffSiteTreeItem): Promise<void> {
     traceInfo(Constants.EventNames.ACTIONS_HUB_METADATA_DIFF_CLEAR, {
         methodName: removeSiteComparison.name,
         siteName: siteItem.siteName
     });
 
+    const confirmButton = Constants.Strings.CLEAR;
+    const result = await vscode.window.showWarningMessage(
+        Constants.Strings.CLEAR_RESULT_TITLE,
+        { modal: true, detail: Constants.Strings.CLEAR_RESULT_MESSAGE },
+        confirmButton
+    );
+
+    if (result !== confirmButton) {
+        return;
+    }
+
     MetadataDiffContext.clearSite(siteItem.siteName);
 }

src/client/test/Integration/power-pages/actions-hub/handlers/metadata-diff/ClearMetadataDiffHandler.test.ts

@@ -10,14 +10,17 @@ import { clearMetadataDiff } from "../../../../../../power-pages/actions-hub/han
 import MetadataDiffContext from "../../../../../../power-pages/actions-hub/MetadataDiffContext";
 import * as TelemetryHelper from "../../../../../../power-pages/actions-hub/TelemetryHelper";
 import { IFileComparisonResult } from "../../../../../../power-pages/actions-hub/models/IFileComparisonResult";
+import { Constants } from "../../../../../../power-pages/actions-hub/Constants";
 
 describe("ClearMetadataDiffHandler", () => {
     let sandbox: sinon.SinonSandbox;
+    let showWarningMessageStub: sinon.SinonStub;
 
     beforeEach(() => {
         sandbox = sinon.createSandbox();
         sandbox.stub(TelemetryHelper, "traceInfo");
         sandbox.stub(vscode.env, "sessionId").get(() => "test-session-id");
+        showWarningMessageStub = sandbox.stub(vscode.window, "showWarningMessage");
     });
 
     afterEach(() => {
@@ -26,7 +29,7 @@ describe("ClearMetadataDiffHandler", () => {
     });
 
     describe("clearMetadataDiff", () => {
-        it("should clear the metadata diff context", () => {
+        it("should clear the metadata diff context when user confirms", async () => {
             const results: IFileComparisonResult[] = [
                 {
                     localPath: "/local/file.txt",
@@ -36,18 +39,38 @@ describe("ClearMetadataDiffHandler", () => {
                 }
             ];
             MetadataDiffContext.setResults(results, "Test Site", "Local Test Site", "Test Environment", "test-website-id", "test-environment-id");
+            showWarningMessageStub.resolves(Constants.Strings.CLEAR_ALL);
 
-            clearMetadataDiff();
+            await clearMetadataDiff();
 
             expect(MetadataDiffContext.comparisonResults).to.deep.equal([]);
             expect(MetadataDiffContext.siteName).to.equal("");
             expect(MetadataDiffContext.isActive).to.be.false;
         });
 
-        it("should log telemetry event", () => {
+        it("should not clear when user cancels", async () => {
+            const results: IFileComparisonResult[] = [
+                {
+                    localPath: "/local/file.txt",
+                    remotePath: "/remote/file.txt",
+                    relativePath: "file.txt",
+                    status: "modified"
+                }
+            ];
+            MetadataDiffContext.setResults(results, "Test Site", "Local Test Site", "Test Environment", "test-website-id", "test-environment-id");
+            showWarningMessageStub.resolves(undefined); // User cancelled
+
+            await clearMetadataDiff();
+
+            expect(MetadataDiffContext.comparisonResults).to.have.lengthOf(1);
+            expect(MetadataDiffContext.isActive).to.be.true;
+        });
+
+        it("should log telemetry event", async () => {
             const traceInfoStub = TelemetryHelper.traceInfo as sinon.SinonStub;
+            showWarningMessageStub.resolves(Constants.Strings.CLEAR_ALL);
 
-            clearMetadataDiff();
+            await clearMetadataDiff();
 
             expect(traceInfoStub.calledOnce).to.be.true;
             expect(traceInfoStub.firstCall.args[0]).to.equal("ActionsHubMetadataDiffClear");
@@ -56,10 +79,25 @@ describe("ClearMetadataDiffHandler", () => {
             });
         });
 
-        it("should work when context is already empty", () => {
+        it("should show confirmation dialog with correct message", async () => {
+            showWarningMessageStub.resolves(undefined);
+
+            await clearMetadataDiff();
+
+            expect(showWarningMessageStub.calledOnce).to.be.true;
+            expect(showWarningMessageStub.firstCall.args[0]).to.equal(Constants.Strings.CLEAR_ALL_RESULTS_TITLE);
+            expect(showWarningMessageStub.firstCall.args[1]).to.deep.equal({
+                modal: true,
+                detail: Constants.Strings.CLEAR_ALL_RESULTS_MESSAGE
+            });
+            expect(showWarningMessageStub.firstCall.args[2]).to.equal(Constants.Strings.CLEAR_ALL);
+        });
+
+        it("should work when context is already empty and user confirms", async () => {
             MetadataDiffContext.clear();
+            showWarningMessageStub.resolves(Constants.Strings.CLEAR_ALL);
 
-            clearMetadataDiff();
+            await clearMetadataDiff();
 
             expect(MetadataDiffContext.comparisonResults).to.deep.equal([]);
             expect(MetadataDiffContext.isActive).to.be.false;