random-mirrors/cosmos-explorer
1
0
Fork 0
mirror of https://github.com/Azure/cosmos-explorer.git synced 2026-09-19 09:02:41 +01:00
Code Issues Packages Projects Releases Wiki Activity

Simplify connection string login error handling

Browse Source 
- Lift the login error state into HostedExplorer so failures from the connect form and from a postMessage login share one source of truth

- Show the message returned by the service instead of falling back to a generic unreachable message

- Move isAuthorizationError into AuthorizationUtils alongside the other shared auth helpers

- Widen getErrorMessage to accept unknown so catch variables no longer need a cast

- Show the connect screen error tooltip beside the icon and widen it so long service messages fit

- Consolidate the repeated account lookup and login steps in the SQL connection string spec
This commit is contained in:
Asier Isayas
2026-08-18 09:23:23 -07:00
parent 4c9167f5fd
commit 913dd3dcbf
9 changed files with 259 additions and 65 deletions
Download Patch File Download Diff File Expand all files Collapse all files
test/sql/connectionStringLogin.spec.ts
+58 -32
View File
@@ -1,4 +1,4 @@
import { expect, test } from "@playwright/test";
import { Page, expect, test } from "@playwright/test";
import { CosmosDBManagementClient } from "@azure/arm-cosmosdb";
import { CosmosClient, Database } from "@azure/cosmos";
@@ -18,8 +18,20 @@ const databaseId = generateUniqueName("db");
const containerId = "testcontainer";
const documentId = "testdoc1";
async function loginWithConnectionString(page: Page, connectionString: string): Promise<void> {
await page.goto("https://localhost:1234/hostedExplorer.html");
const switchConnectionLink = page.getByTestId("Link:SwitchConnectionType");
await switchConnectionLink.waitFor();
await switchConnectionLink.click();
await page.getByPlaceholder("Please enter a connection string").fill(connectionString);
await page.getByRole("button", { name: "Connect" }).click();
}
test.describe("SQL account using connection string login", () => {
let database: Database = null!;
let documentEndpoint: string = null!;
// SQL signs data-plane requests client-side with the account key, so no encrypted token is issued.
let connectionString: string = null!;
test.beforeAll("Seed Test Database", async () => {
const credentials = getAzureCLICredentials();
@@ -27,8 +39,10 @@ test.describe("SQL account using connection string login", () => {
const accountName = getAccountName(TestAccount.SQL, TestAuthType.ConnectionString);
const account = await armClient.databaseAccounts.get(resourceGroupName, accountName);
const keys = await armClient.databaseAccounts.listKeys(resourceGroupName, accountName);
documentEndpoint = account.documentEndpoint!;
connectionString = `AccountEndpoint=${documentEndpoint};AccountKey=${keys.primaryMasterKey};`;
const client = new CosmosClient({ endpoint: account.documentEndpoint!, key: keys.primaryMasterKey });
const client = new CosmosClient({ endpoint: documentEndpoint, key: keys.primaryMasterKey });
database = (await client.databases.createIfNotExists({ id: databaseId })).database;
const { container } = await database.containers.createIfNotExists({
id: containerId,
@@ -42,21 +56,7 @@ test.describe("SQL account using connection string login", () => {
});
test("reads a document after connection string login", async ({ page }) => {
const credentials = getAzureCLICredentials();
const armClient = new CosmosDBManagementClient(credentials, subscriptionId);
const accountName = getAccountName(TestAccount.SQL, TestAuthType.ConnectionString);
const account = await armClient.databaseAccounts.get(resourceGroupName, accountName);
const keys = await armClient.databaseAccounts.listKeys(resourceGroupName, accountName);
// SQL signs data-plane requests client-side with the account key, so no encrypted token is issued.
const connectionString = `AccountEndpoint=${account.documentEndpoint};AccountKey=${keys.primaryMasterKey};`;
await page.goto("https://localhost:1234/hostedExplorer.html");
const switchConnectionLink = page.getByTestId("Link:SwitchConnectionType");
await switchConnectionLink.waitFor();
await switchConnectionLink.click();
await page.getByPlaceholder("Please enter a connection string").fill(connectionString);
await page.getByRole("button", { name: "Connect" }).click();
await loginWithConnectionString(page, connectionString);
const explorer = await DataExplorer.waitForExplorer(page);
const collectionNode = await explorer.waitForContainerNode(databaseId, containerId);
@@ -84,26 +84,52 @@ test.describe("SQL account using connection string login", () => {
});
test("shows an error when the connection string has the wrong account key", async ({ page }) => {
const credentials = getAzureCLICredentials();
const armClient = new CosmosDBManagementClient(credentials, subscriptionId);
const accountName = getAccountName(TestAccount.SQL, TestAuthType.ConnectionString);
const account = await armClient.databaseAccounts.get(resourceGroupName, accountName);
// A well-formed but incorrect base64 account key (88-char, 64-byte): the endpoint is valid, so the
// Cosmos client reaches the account but the data-plane request is rejected with 401 Unauthorized.
const wrongKey = "A".repeat(86) + "==";
const connectionString = `AccountEndpoint=${account.documentEndpoint};AccountKey=${wrongKey};`;
await loginWithConnectionString(page, `AccountEndpoint=${documentEndpoint};AccountKey=${wrongKey};`);
await page.goto("https://localhost:1234/hostedExplorer.html");
const switchConnectionLink = page.getByTestId("Link:SwitchConnectionType");
await switchConnectionLink.waitFor();
await switchConnectionLink.click();
await page.getByPlaceholder("Please enter a connection string").fill(connectionString);
await page.getByRole("button", { name: "Connect" }).click();
// The connect form stays visible and surfaces the connectivity error instead of opening the explorer.
await expect(page.locator(".errorDetails")).toContainText("Unable to connect to the account", {
// The connect form stays visible and surfaces the 401 returned by the account instead of opening Data Explorer.
await expect(page.locator(".errorDetails")).toContainText("The wrong key is being used", {
timeout: ONE_MINUTE_MS,
});
});
test("opens the explorer when the connectivity check fails with a non-authorization error", async ({ page }) => {
// The pre-login connectivity check calls getDatabaseAccount from the top-level hosted explorer frame,
// which the dev server forwards from the proxy root. Failing only those requests with a 500 simulates a
// transient or internal service failure while leaving the requests Data Explorer makes from the iframe
// untouched, so the explorer still talks to the real account once the user is in.
const failedProxyTargets: string[] = [];
await page.route(
(url) => url.pathname === "/proxy",
async (route) => {
const request = route.request();
if (request.frame() !== page.mainFrame()) {
await route.continue();
return;
}
failedProxyTargets.push(request.headers()["x-ms-proxy-target"]);
await route.fulfill({
status: 500,
contentType: "application/json",
body: JSON.stringify({ code: "InternalServerError", message: "The service is temporarily unavailable." }),
});
},
);
// The account key is correct, so nothing about this login is a credential problem.
await loginWithConnectionString(page, connectionString);
// The failed check does not block login: the explorer opens and reads the account through the data plane.
const explorer = await DataExplorer.waitForExplorer(page);
const collectionNode = await explorer.waitForContainerNode(databaseId, containerId);
await expect(collectionNode.element).toBeAttached();
// The connectivity check ran against the endpoint from the connection string and did fail, and the
// transient failure was never surfaced to the user as a login error.
expect(failedProxyTargets).toContain(documentEndpoint);
await expect(page.locator(".errorDetails")).toHaveCount(0);
});
});