Merge branch 'main' into dev/copy-and-paste/main

Author: tnaum-ms

.github/workflows/api-publish.yaml

@@ -0,0 +1,20 @@
+name: "API: Publish to npm"
+
+# 🚀 This workflow manually publishes the API package to npm.
+# It should only be triggered via GitHub's UI or CLI using `workflow_dispatch`.
+
+on:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+  echo:
+    runs-on: ubuntu-latest
+    steps:
+      - run: echo "dummy action"

l10n/bundle.l10n.json

@@ -85,6 +85,7 @@
   "Connection String": "Connection String",
   "Connection string cannot be empty": "Connection string cannot be empty",
   "Connection string not found.": "Connection string not found.",
+  "Connection updated successfully.": "Connection updated successfully.",
   "CosmosDB Accounts": "CosmosDB Accounts",
   "Could not find {0}": "Could not find {0}",
   "Could not find the Azure Resource Groups extension": "Could not find the Azure Resource Groups extension",
@@ -143,6 +144,7 @@
   "Enter the password": "Enter the password",
   "Enter the password for {experience}": "Enter the password for {experience}",
   "Enter the port number": "Enter the port number",
+  "Enter the port number your DocumentDB uses. The default port: {defaultPort}.": "Enter the port number your DocumentDB uses. The default port: {defaultPort}.",
   "Enter the username": "Enter the username",
   "Enter the username for {experience}": "Enter the username for {experience}",
   "Error creating resource: {0}": "Error creating resource: {0}",
@@ -195,6 +197,7 @@
   "Failed to save credentials for \"{cluster}\".": "Failed to save credentials for \"{cluster}\".",
   "Failed to save credentials.": "Failed to save credentials.",
   "Failed to store secrets for key {0}:": "Failed to store secrets for key {0}:",
+  "Failed to update the connection.": "Failed to update the connection.",
   "Failed with code \"{0}\".": "Failed with code \"{0}\".",
   "failed.": "failed.",
   "Find Query": "Find Query",
@@ -285,6 +288,7 @@
   "No session found for id {sessionId}": "No session found for id {sessionId}",
   "No subscriptions found": "No subscriptions found",
   "Not connected to any MongoDB database.": "Not connected to any MongoDB database.",
+  "Note: This confirmation type can be configured in the settings (documentDB.userInterface.confirmationStyle).": "Note: This confirmation type can be configured in the settings (documentDB.userInterface.confirmationStyle).",
   "Open Collection": "Open Collection",
   "Open installation page": "Open installation page",
   "Opening DocumentDB resource…": "Opening DocumentDB resource…",
@@ -293,6 +297,7 @@
   "Pick \"{number}\" to confirm and continue.": "Pick \"{number}\" to confirm and continue.",
   "Please confirm by re-entering the previous value.": "Please confirm by re-entering the previous value.",
   "Please connect to a MongoDB database before running a Scrapbook command.": "Please connect to a MongoDB database before running a Scrapbook command.",
+  "Please edit the connection string.": "Please edit the connection string.",
   "Please enter a new connection name.": "Please enter a new connection name.",
   "Please enter the password for the user \"{username}\"": "Please enter the password for the user \"{username}\"",
   "Please enter the username": "Please enter the username",
@@ -368,6 +373,7 @@
   "The connection with the name \"{0}\" already exists.": "The connection with the name \"{0}\" already exists.",
   "The custom cloud choice is not configured. Please configure the setting `{0}.{1}`.": "The custom cloud choice is not configured. Please configure the setting `{0}.{1}`.",
   "The database \"{0}\" already exists in the MongoDB Cluster \"{1}\".": "The database \"{0}\" already exists in the MongoDB Cluster \"{1}\".",
+  "The default port: {defaultPort}": "The default port: {defaultPort}",
   "The default port: 10255": "The default port: 10255",
   "The document with the _id \"{0}\" has been saved.": "The document with the _id \"{0}\" has been saved.",
   "The entered value does not match the original.": "The entered value does not match the original.",
@@ -425,6 +431,7 @@
   "Up": "Up",
   "Update Azure Account Extension to at least version \"{0}\"...": "Update Azure Account Extension to at least version \"{0}\"...",
   "Update cluster credentials": "Update cluster credentials",
+  "Update Connection String": "Update Connection String",
   "Update existing {accountType} connection?": "Update existing {accountType} connection?",
   "Updated entity \"{name}\".": "Updated entity \"{name}\".",
   "Upload": "Upload",
@@ -446,7 +453,7 @@
   "Yes": "Yes",
   "Yes, save my credentials": "Yes, save my credentials",
   "You are not signed in to an Azure account. Please sign in.": "You are not signed in to an Azure account. Please sign in.",
-  "You are not signed in to Azure. Sign in to continue.": "You are not signed in to Azure. Sign in to continue.",
+  "You are not signed in to Azure. Sign in and retry.": "You are not signed in to Azure. Sign in and retry.",
   "You are not signed in to the MongoDB Cluster. Please sign in (by expanding the node \"{0}\") and try again.": "You are not signed in to the MongoDB Cluster. Please sign in (by expanding the node \"{0}\") and try again.",
   "You can connect to a different DocumentDB by:": "You can connect to a different DocumentDB by:",
   "You do not have permission to create a resource group in subscription \"{0}\".": "You do not have permission to create a resource group in subscription \"{0}\".",

package-lock.json

@@ -275,7 +275,14 @@
         "icon": "$(key)"
       },
       {
-        "//": "[ConnectionsView] Update Credentials",
+        "//": "[ConnectionsView] Update Connection String",
+        "category": "DocumentDB",
+        "command": "vscode-documentdb.command.connectionsView.updateConnectionString",
+        "title": "Update Connection String…",
+        "icon": "$(whole-word)"
+      },
+      {
+        "//": "[ConnectionsView] Rename Connection",
         "category": "DocumentDB",
         "command": "vscode-documentdb.command.connectionsView.renameConnection",
         "title": "Rename…",
@@ -509,20 +516,25 @@
       "editor/title": [],
       "view/item/context": [
         {
-          "command": "vscode-documentdb.command.connectionsView.updateCredentials",
+          "command": "vscode-documentdb.command.connectionsView.updateConnectionString",
           "when": "view == connectionsView && viewItem =~ /treeitem[.]mongoCluster(?![a-z.\\/])/i",
           "group": "0@2"
         },
         {
-          "command": "vscode-documentdb.command.connectionsView.renameConnection",
+          "command": "vscode-documentdb.command.connectionsView.updateCredentials",
           "when": "view == connectionsView && viewItem =~ /treeitem[.]mongoCluster(?![a-z.\\/])/i",
           "group": "0@3"
         },
+        {
+          "command": "vscode-documentdb.command.connectionsView.renameConnection",
+          "when": "view == connectionsView && viewItem =~ /treeitem[.]mongoCluster(?![a-z.\\/])/i",
+          "group": "0@4"
+        },
         {
           "//": "Remove Connection...",
           "command": "vscode-documentdb.command.connectionsView.removeConnection",
           "when": "view == connectionsView && viewItem =~ /treeitem[.]mongoCluster(?![a-z.\\/])/i",
-          "group": "0@4"
+          "group": "0@5"
         },
         {
           "command": "vscode-documentdb.command.discoveryView.removeRegistry",
@@ -676,6 +688,10 @@
           "command": "vscode-documentdb.command.connectionsView.updateCredentials",
           "when": "never"
         },
+        {
+          "command": "vscode-documentdb.command.connectionsView.updateConnectionString",
+          "when": "never"
+        },
         {
           "command": "vscode-documentdb.command.connectionsView.removeConnection",
           "when": "never"
@@ -791,7 +807,7 @@
               "Prompts with a challenge where you select the correct number among multiple options to confirm deletion.",
               "Prompts with an input box where you enter the name of the resource to confirm deletion."
             ],
-            "default": "challengeConfirmation"
+            "default": "wordConfirmation"
           },
           "documentDB.userInterface.ShowOperationSummaries": {
             "order": 1,

package.json

@@ -0,0 +1,41 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import { AzureWizardPromptStep } from '@microsoft/vscode-azext-utils';
+
+import * as l10n from '@vscode/l10n';
+import { type UpdateCSWizardContext } from './UpdateCSWizardContext';
+
+export class ConnectionStringStep extends AzureWizardPromptStep<UpdateCSWizardContext> {
+    public async prompt(context: UpdateCSWizardContext): Promise<void> {
+        const newConnectionString = await context.ui.showInputBox({
+            prompt: l10n.t('Please edit the connection string.'),
+            value: context.originalCS_NoCredentials,
+            ignoreFocusOut: true,
+            asyncValidationTask: (name: string) => this.validateConnectionString(name),
+        });
+
+        context.newCS_NoCredentials = newConnectionString.trim();
+    }
+
+    public shouldPrompt(): boolean {
+        return true;
+    }
+
+    private async validateConnectionString(connectionString: string): Promise<string | undefined> {
+        connectionString = connectionString ? connectionString.trim() : '';
+
+        if (connectionString.length === 0) {
+            // skip this for now, asyncValidationTask takes care of this case, otherwise it's only warnings the user sees..
+            return undefined;
+        }
+
+        if (!(connectionString.startsWith('mongodb://') || connectionString.startsWith('mongodb+srv://'))) {
+            return l10n.t('"mongodb://" or "mongodb+srv://" must be the prefix of the connection string.');
+        }
+
+        return undefined;
+    }
+}

src/commands/updateConnectionString/ConnectionStringStep.ts

@@ -0,0 +1,54 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import { AzureWizardExecuteStep } from '@microsoft/vscode-azext-utils';
+import { l10n, window } from 'vscode';
+import { StorageNames, StorageService } from '../../services/storageService';
+import { showConfirmationAsInSettings } from '../../utils/dialogs/showConfirmation';
+import { nonNullValue } from '../../utils/nonNull';
+import { type UpdateCSWizardContext } from './UpdateCSWizardContext';
+
+export class ExecuteStep extends AzureWizardExecuteStep<UpdateCSWizardContext> {
+    public priority: number = 100;
+
+    public async execute(context: UpdateCSWizardContext): Promise<void> {
+        const resourceType = context.isEmulator ? 'emulators' : 'clusters';
+        const storage = StorageService.get(StorageNames.Connections);
+        const item = await storage.getItem(resourceType, context.storageId);
+
+        if (item) {
+            if (!item.secrets) {
+                item.secrets = [];
+            }
+
+            // now, copy the credentials from the original connection string,
+            // take it directly from the storage item
+            // and update the new connection string with the credentials
+            const originalCS_WithCredentials = new URL(item.secrets[0] || '');
+            const newCS = new URL(context.newCS_NoCredentials || '');
+
+            newCS.username = originalCS_WithCredentials.username;
+            newCS.password = originalCS_WithCredentials.password;
+
+            item.secrets[0] = nonNullValue(newCS.toString());
+
+            try {
+                await storage.push(resourceType, item, true);
+            } catch (pushError) {
+                console.error(`Failed to update the item "${context.storageId}":`, pushError);
+                void window.showErrorMessage(l10n.t('Failed to update the connection.'));
+            }
+        } else {
+            console.error(`Item with ID "${context.storageId}" not found in storage.`);
+            void window.showErrorMessage(l10n.t('Failed to update the connection.'));
+        }
+
+        showConfirmationAsInSettings(l10n.t('Connection updated successfully.'));
+    }
+
+    public shouldExecute(context: UpdateCSWizardContext): boolean {
+        return !!context.newCS_NoCredentials && context.newCS_NoCredentials !== context.originalCS_NoCredentials;
+    }
+}

src/commands/updateConnectionString/ExecuteStep.ts

@@ -0,0 +1,15 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import { type IActionContext } from '@microsoft/vscode-azext-utils';
+
+export interface UpdateCSWizardContext extends IActionContext {
+    // target item details
+    isEmulator: boolean;
+    storageId: string;
+
+    originalCS_NoCredentials: string;
+    newCS_NoCredentials?: string;
+}

src/commands/updateConnectionString/UpdateCSWizardContext.ts

@@ -0,0 +1,55 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import { AzureWizard, type IActionContext } from '@microsoft/vscode-azext-utils';
+import * as l10n from '@vscode/l10n';
+import ConnectionString from 'mongodb-connection-string-url';
+import { Views } from '../../documentdb/Views';
+import { StorageNames, StorageService } from '../../services/storageService';
+import { type DocumentDBClusterItem } from '../../tree/connections-view/DocumentDBClusterItem';
+import { refreshView } from '../refreshView/refreshView';
+import { ConnectionStringStep } from './ConnectionStringStep';
+import { ExecuteStep } from './ExecuteStep';
+import { type UpdateCSWizardContext } from './UpdateCSWizardContext';
+
+export async function updateConnectionString(context: IActionContext, node: DocumentDBClusterItem): Promise<void> {
+    if (!node) {
+        throw new Error(l10n.t('No node selected.'));
+    }
+
+    // Extract the connection string but hide the username and password
+
+    // Note to future maintainers: the node.cluster might be out of date
+    // as the object is cached in the tree view, and in the 'retry/error' nodes
+    // that's why we need to get the fresh one each time.
+
+    const resourceType = node.cluster.emulatorConfiguration?.isEmulator ? 'emulators' : 'clusters';
+    const storage = StorageService.get(StorageNames.Connections);
+    const currentItem = await storage.getItem(resourceType, node.storageId);
+    const connectionString = currentItem?.secrets?.[0] || '';
+    context.valuesToMask.push(connectionString);
+    const parsedCS = new ConnectionString(connectionString);
+
+    parsedCS.username = '';
+    parsedCS.password = '';
+
+    const wizardContext: UpdateCSWizardContext = {
+        ...context,
+        originalCS_NoCredentials: parsedCS.toString(),
+        isEmulator: Boolean(node.cluster.emulatorConfiguration?.isEmulator),
+        storageId: node.storageId,
+    };
+
+    const wizard = new AzureWizard(wizardContext, {
+        title: l10n.t('Update Connection String'),
+        promptSteps: [new ConnectionStringStep()],
+        executeSteps: [new ExecuteStep()],
+    });
+
+    await wizard.prompt();
+    await wizard.execute();
+
+    await refreshView(context, Views.ConnectionsView);
+}

src/commands/updateConnectionString/updateConnectionString.ts

@@ -3,12 +3,13 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
-import { AzureWizard, nonNullValue, type IActionContext } from '@microsoft/vscode-azext-utils';
+import { AzureWizard, type IActionContext } from '@microsoft/vscode-azext-utils';
 import * as l10n from '@vscode/l10n';
 import ConnectionString from 'mongodb-connection-string-url';
 import { ClustersClient } from '../../documentdb/ClustersClient';
 import { CredentialCache } from '../../documentdb/CredentialCache';
 import { Views } from '../../documentdb/Views';
+import { StorageNames, StorageService } from '../../services/storageService';
 import { type DocumentDBClusterItem } from '../../tree/connections-view/DocumentDBClusterItem';
 import { refreshView } from '../refreshView/refreshView';
 import { ExecuteStep } from './ExecuteStep';
@@ -22,9 +23,21 @@ export async function updateCredentials(context: IActionContext, node: DocumentD
     }
 
     // access credentials assigned to the selected cluster
-    const connectionString = new ConnectionString(nonNullValue(node.cluster.connectionString));
-    const username: string | undefined = connectionString.username;
-    const password: string | undefined = connectionString.password;
+
+    // Note to future maintainers: the node.cluster might be out of date
+    // as the object is cached in the tree view, and in the 'retry/error' nodes
+    // that's why we need to get the fresh one each time.
+
+    const resourceType = node.cluster.emulatorConfiguration?.isEmulator ? 'emulators' : 'clusters';
+    const storage = StorageService.get(StorageNames.Connections);
+    const currentItem = await storage.getItem(resourceType, node.storageId);
+    const connectionString = currentItem?.secrets?.[0] || '';
+    context.valuesToMask.push(connectionString);
+
+    const parsedCS = new ConnectionString(connectionString);
+
+    const username: string | undefined = parsedCS.username;
+    const password: string | undefined = parsedCS.password;
 
     const wizardContext: UpdateCredentialsWizardContext = {
         ...context,