chore(e2e): port most e2e tests to multiple connections COMPASS-7925 COMPASS-8001 #5878

lerouxb · 2024-06-07T12:14:11Z

Adds support for --test-multiple-connections, ports most tests, disables a bunch of others (with tons of new TODO comments) and adds a temporary new evergreen build variant for running the multiple connections e2e tests.

lerouxb · 2024-06-07T12:15:31Z

packages/compass-connections-navigation/src/navigation-item.tsx

@@ -87,7 +87,7 @@ export function NavigationItem({
    if (item.type === 'connection') {
      return {
        'data-connection-id': item.connectionInfo.id,
-        'data-connection-name': item.connectionInfo.favorite?.name,
+        'data-connection-name': item.name,


Some connections don't have a favourite name. Not sure if that's intended. But there's always a name because that's what's displayed.

yea that's a good catch - name will always be there

...s/compass-sidebar/src/components/multiple-connections/saved-connections/saved-connection.tsx

lerouxb · 2024-06-07T12:19:31Z

packages/connection-form/src/components/connection-form-actions.tsx

@@ -166,7 +166,7 @@ export function ConnectionFormModalActions({

        <div className={saveAndConnectStyles}>
          <Button
-            data-testid="save-and-connect-button"
+            data-testid="save-button"


We had two buttons with the same identical save-and-connect-button testid.

lerouxb · 2024-06-07T12:22:03Z

packages/compass-sidebar/src/components/multiple-connections/header/sidebar-header.tsx

@@ -29,7 +29,7 @@ export function SidebarHeader({
  onAction(actionName: Action): void;
 }): React.ReactElement {
  return (
-    <div className={sidebarHeaderStyles}>
+    <div className={sidebarHeaderStyles} data-testid="sidebar-header">


testid used in e2e selectors for some custom browser commands that need to go click somewhere/anywhere that will have no effect other than that it will blur whatever is actually focused and give some browser.waitUntil() a chance to succeed next time.

Total hack. Documented in the custom commands but that doesn't necessarily show up in the diff in this PR so I figured I'd just leave this comment here.

.evergreen/buildvariants.yml

…ngodb-js/compass into port-multiple-connections-e2e

lerouxb · 2024-06-20T15:54:37Z

packages/compass-e2e-tests/helpers/commands/save-connection-string-as-favorite.ts

 ): Promise<string> {
+  if (TEST_MULTIPLE_CONNECTIONS && color === 'color1') {


This is a total hack for now, but this whole command should just go away when we remove single connections.

lerouxb · 2024-06-20T15:55:38Z

packages/compass-e2e-tests/helpers/commands/save-favorite.ts

 import type { CompassBrowser } from '../compass-browser';
 import * as Selectors from '../selectors';
 import { expect } from 'chai';

 export async function saveFavorite(
  browser: CompassBrowser,
  favoriteName: string,
-  color: `color${number}`
+  // TODO(COMPASS-8003): make color optional for multiple connections
+  color: `color${number}` | string


Same here: This whole command will also just go away along with single connections because you can now save a favorite via the connection form with setConnectioFormState().

lerouxb · 2024-06-20T15:59:32Z

packages/compass-e2e-tests/helpers/commands/set-connect-form-state.ts

+  color9: 'Purple',
+};
+
+function colorValueToName(color: string): string {


There's probably a better way to do this, but this is so we can select an option by its display value. ie. the select's value is 'color1', but the option is displayed as 'Red'. We can probably import this from somewhere rather than hardcoding it..

yea this is available in connection-form package most likely, maybe not exported

lerouxb · 2024-06-20T16:33:41Z

packages/compass-e2e-tests/helpers/commands/wait-for-connection-result.ts

@@ -18,6 +18,8 @@ export async function waitForConnectionResult(
    // indicator that we are connected to the server
    selector = TEST_COMPASS_WEB
      ? '[data-testid="workspace-tab-button"][title=Databases]'
+      : TEST_MULTIPLE_CONNECTIONS
+      ? Selectors.SidebarTreeItems


This kinda assumes that any connection is good enough, but you could have already had a connection before you even connected, so then it actually won't wait for anything. Ideally we'd wait for the element for the expected connection name to appear, but we don't have that context here.

lerouxb · 2024-06-21T14:01:12Z

packages/compass-e2e-tests/tests/protect-connection-strings.test.ts

    );
    let actual = '';
    await browser.waitUntil(
      async () => {
-        return (actual = await clipboard.read()) === expected;
+        actual = await clipboard.read();
+        console.log({ actual, expected });


Yes this is intentional.

…n e2e tests

himanshusinghs

Its looking good. I also think we unblocked a few todos like import export connections, protectConnectionString flake.

himanshusinghs · 2024-06-24T10:50:24Z

packages/compass-connections-navigation/src/navigation-item.tsx

@@ -87,7 +87,7 @@ export function NavigationItem({
    if (item.type === 'connection') {
      return {
        'data-connection-id': item.connectionInfo.id,
-        'data-connection-name': item.connectionInfo.favorite?.name,
+        'data-connection-name': item.name,


yea that's a good catch - name will always be there

himanshusinghs · 2024-06-24T13:00:08Z

packages/compass-e2e-tests/helpers/commands/set-connect-form-state.ts

+  color9: 'Purple',
+};
+
+function colorValueToName(color: string): string {


yea this is available in connection-form package most likely, maybe not exported

himanshusinghs · 2024-06-24T14:04:53Z

packages/compass-e2e-tests/tests/collection-aggregations-tab.test.ts

@@ -1605,7 +1606,7 @@ describe('Collection aggregations tab', function () {
      );

      await browser.selectOption(
-        Selectors.AggregationWizardSortFormDirectionSelect(0),
+        `${Selectors.AggregationWizardSortFormDirectionSelect(0)} button`,


i think i saw somewhere button removed from dropdown selector - was wondering if that's more hit and try thingy?

I have no recollection of it. I think I moved it around while in Berlin but can't remember if it was really required or not. I think the reasoning is that the selector points to the component and the button is a thing inside there and therefore by not making it point at the button the selector is more reusable.

All I know is that this has been rock solid ever since, so probably fine ;)

himanshusinghs · 2024-06-24T16:56:59Z

packages/compass-e2e-tests/tests/protect-connection-strings.test.ts

+    // TODO(COMPASS-8029): This regressed for multiple connections
+    if (TEST_MULTIPLE_CONNECTIONS) {
+      this.skip();
+    }


This should be now fixed with #5955

Yes I'm still leaving that for a follow-up task and PR, though ;)

port most e2e tests to multiple connections

2ea4bc4

lerouxb added the feature flagged PRs labeled with this label will not be included in the release notes of the next release label Jun 7, 2024

lerouxb commented Jun 7, 2024

View reviewed changes

...s/compass-sidebar/src/components/multiple-connections/saved-connections/saved-connection.tsx Outdated Show resolved Hide resolved

lerouxb commented Jun 7, 2024

View reviewed changes

lerouxb added 10 commits June 7, 2024 13:25

remove new test id that's not actually used

b710fd7

don't toggle the feature in compass web

fd0aa4b

hopefully reduce flakyness

5626c12

Merge branch 'main' into port-multiple-connections-e2e

f704eaf

brittle selector

65beb7d

take some screenshots to debug flakes

dc491f6

copy some missing code to multiple connections

1da86ec

Merge branch 'main' into port-multiple-connections-e2e

5081926

fix multiple connections ci command

16fc916

Merge branch 'main' into port-multiple-connections-e2e

eb86a65

lerouxb commented Jun 11, 2024

View reviewed changes

.evergreen/buildvariants.yml Outdated Show resolved Hide resolved

lerouxb added 4 commits June 11, 2024 12:30

move multiple connections to its own build variant

c936650

skip usage of shellEval in multiple connections tests

92a3f7b

Merge branch 'port-multiple-connections-e2e' of https://github.com/mo…

70a24d4

…ngodb-js/compass into port-multiple-connections-e2e

skip some more things

16bd32d

lerouxb changed the title ~~chore(e2e): port most e2e tests to multiple connections COMPASS-7925~~ chore(e2e): port most e2e tests to multiple connections COMPASS-7925 COMPASS-8001 Jun 12, 2024

update TODO comments

510c4fc

lerouxb marked this pull request as ready for review June 12, 2024 10:43

lerouxb added 6 commits June 12, 2024 11:48

more TODOs

64b1e99

reuse getConnectionTitle

754b5bf

screenshots to help debug errors

fdcd03e

Merge branch 'main' into port-multiple-connections-e2e

f02a849

fix for flakyness in auto connect

7c08f11

better fix for auto connect flakes

5fefd94

lerouxb commented Jun 20, 2024

View reviewed changes

lerouxb added 6 commits June 20, 2024 17:01

remove outdated comment

3b4919f

update dep version

3d911ff

TODO comments

1183750

s/favoriteName/connectionName

063446f

s/favoriteName/connectionName

44cd826

Merge branch 'main' into port-multiple-connections-e2e

7139f95

lerouxb commented Jun 20, 2024

View reviewed changes

lerouxb added 3 commits June 20, 2024 17:35

comment

55bd5f7

workarounds for connection issues

4b386b5

had some selectors inverted

230dc96

lerouxb commented Jun 21, 2024

View reviewed changes

lerouxb added 13 commits June 21, 2024 15:02

remove comment

a063611

TODO comment

36c3cb9

TODO comment

df6e358

remove some drive-by workarounds that aren't needed anymore

a6dcc3b

don't focus

554f96d

it turns out there's no need to mess with test order

5762313

just move the test to the end so it won't interfere with others

c2e31d5

print the test order

ac3929e

only toggle the feature flag AFTER the welcome modal was closed

6db4877

remove hack that turned out not to be necessary

f1b1c5f

use a global config file to toggle the multiple connections feature i…

3bbab7d

…n e2e tests

add a wait as a workaround for the preference flake

8cc76cb

set the env var in init whenever it hasn't already been set

98937eb

himanshusinghs approved these changes Jun 24, 2024

View reviewed changes

lerouxb merged commit 27e0721 into main Jun 24, 2024
30 checks passed

lerouxb deleted the port-multiple-connections-e2e branch June 24, 2024 17:30

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore(e2e): port most e2e tests to multiple connections COMPASS-7925 COMPASS-8001 #5878

chore(e2e): port most e2e tests to multiple connections COMPASS-7925 COMPASS-8001 #5878

lerouxb commented Jun 7, 2024 •

edited

Loading

lerouxb Jun 7, 2024

himanshusinghs Jun 24, 2024

lerouxb Jun 7, 2024

lerouxb Jun 7, 2024

lerouxb Jun 20, 2024

lerouxb Jun 20, 2024 •

edited

Loading

lerouxb Jun 20, 2024

himanshusinghs Jun 24, 2024

lerouxb Jun 20, 2024

lerouxb Jun 21, 2024

himanshusinghs left a comment

himanshusinghs Jun 24, 2024

himanshusinghs Jun 24, 2024

himanshusinghs Jun 24, 2024

lerouxb Jun 24, 2024

himanshusinghs Jun 24, 2024

lerouxb Jun 24, 2024

		): Promise<string> {
		if (TEST_MULTIPLE_CONNECTIONS && color === 'color1') {

chore(e2e): port most e2e tests to multiple connections COMPASS-7925 COMPASS-8001 #5878

chore(e2e): port most e2e tests to multiple connections COMPASS-7925 COMPASS-8001 #5878

Conversation

lerouxb commented Jun 7, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lerouxb Jun 20, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

himanshusinghs left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lerouxb commented Jun 7, 2024 •

edited

Loading

lerouxb Jun 20, 2024 •

edited

Loading