feat(connection-form): up to three buttons: save, connect, save & con…

…nect COMPASS-8360 (#6341)

* save, connect, save & onnect

* reformat

* tests

* tests

* add forceSave option to connect action creator

packages/compass-connections/src/components/legacy-connections.spec.tsx

@@ -25,7 +25,7 @@ async function loadSavedConnectionAndConnect(connectionInfo: ConnectionInfo) {
     )
   );
 
-  const connectButton = screen.getByRole('button', { name: 'Connect' });
+  const connectButton = screen.getByRole('button', { name: 'Save & Connect' });
   userEvent.click(connectButton);
 
   // Wait for the connecting... modal to hide.
@@ -267,7 +267,9 @@ describe.skip('Connections Component', function () {
           )
         );
 
-        const connectButton = screen.getByRole('button', { name: 'Connect' });
+        const connectButton = screen.getByRole('button', {
+          name: 'Save & Connect',
+        });
         userEvent.click(connectButton);
 
         // Wait for the connecting... modal to be shown.
@@ -288,7 +290,9 @@ describe.skip('Connections Component', function () {
         });
 
         it('should enable the connect button', function () {
-          const connectButton = screen.getByText('Connect');
+          const connectButton = screen.getByRole('button', {
+            name: 'Save & Connect',
+          });
           expect(connectButton).to.not.match('disabled');
         });
 

packages/compass-connections/src/stores/connections-store-redux.ts

@@ -313,6 +313,9 @@ type ConnectionAutoconnectCheckAction = {
 type ConnectionAttemptStartAction = {
   type: ActionTypes.ConnectionAttemptStart;
   connectionInfo: ConnectionInfo;
+  options: {
+    forceSave: boolean;
+  };
 };
 
 type ConnectionAttemptSuccessAction = {
@@ -823,10 +826,13 @@ const reducer: Reducer<State, Action> = (state = INITIAL_STATE, action) => {
         state.connections,
         action.connectionInfo.id,
         {
-          ...(isNewConnection(state, action.connectionInfo.id)
+          ...(isNewConnection(state, action.connectionInfo.id) ||
+          action.options.forceSave
             ? {
-                // For new connections, update the state with new info right
-                // away (we will also save it to the storage at the end)
+                // For new connections or when we're forcing a
+                // save (the Save & Connect button), update the state with new
+                // info right away (we will also save it to the storage at the
+                // end)
                 info: action.connectionInfo,
               }
             : {
@@ -1464,6 +1470,35 @@ export const connect = (
   | ConnectionAttemptSuccessAction
   | ConnectionAttemptCancelledAction
   | OidcNotifyDeviceAuthAction
+> => {
+  return connectWithOptions(connectionInfo, { forceSave: false });
+};
+
+export const saveAndConnect = (
+  connectionInfo: ConnectionInfo
+): ConnectionsThunkAction<
+  Promise<void>,
+  | ConnectionAttemptStartAction
+  | ConnectionAttemptErrorAction
+  | ConnectionAttemptSuccessAction
+  | ConnectionAttemptCancelledAction
+  | OidcNotifyDeviceAuthAction
+> => {
+  return connectWithOptions(connectionInfo, { forceSave: true });
+};
+
+const connectWithOptions = (
+  connectionInfo: ConnectionInfo,
+  options: {
+    forceSave: boolean;
+  }
+): ConnectionsThunkAction<
+  Promise<void>,
+  | ConnectionAttemptStartAction
+  | ConnectionAttemptErrorAction
+  | ConnectionAttemptSuccessAction
+  | ConnectionAttemptCancelledAction
+  | OidcNotifyDeviceAuthAction
 > => {
   return async (
     dispatch,
@@ -1516,6 +1551,7 @@ export const connect = (
       dispatch({
         type: ActionTypes.ConnectionAttemptStart,
         connectionInfo,
+        options: { forceSave: options.forceSave },
       });
 
       track(

packages/compass-connections/src/stores/connections-store.spec.tsx

@@ -323,6 +323,37 @@ describe('useConnections', function () {
     }
   });
 
+  describe('#saveAndConnect', function () {
+    it('saves the connection options before connecting', async function () {
+      const { result, track, connectionStorage } = renderHookWithConnections(
+        useConnections,
+        {
+          connections: mockConnections,
+          preferences: defaultPreferences,
+        }
+      );
+
+      const updatedConnection = {
+        ...mockConnections[0],
+        savedConnectionType: 'recent' as const,
+      };
+
+      await result.current.saveAndConnect(updatedConnection);
+
+      await waitFor(() => {
+        expect(track.getCall(1).firstArg).to.eq('New Connection');
+      });
+
+      expect(
+        await connectionStorage.load({ id: updatedConnection.id })
+      ).to.have.property('savedConnectionType', 'recent');
+
+      expect(
+        screen.getByText(`Connected to ${mockConnections[0].favorite.name}`)
+      ).to.exist;
+    });
+  });
+
   describe('#disconnect', function () {
     it('disconnect even if connection is in progress cleaning up progress toasts', async function () {
       const { result, track } = renderHookWithConnections(useConnections, {

packages/compass-connections/src/stores/connections-store.tsx

@@ -5,6 +5,7 @@ type State = {
   connectionErrors: Record<string, Error | null>;
   editingConnectionInfo: ConnectionInfo;
   isEditingConnectionInfoModalOpen: boolean;
+  isEditingNewConnection: boolean;
   oidcDeviceAuthState: Record<string, { url: string; code: string }>;
 };
 
@@ -15,6 +16,7 @@ export function useConnections(): {
   state: State;
 
   connect: (connectionInfo: ConnectionInfo) => Promise<void>;
+  saveAndConnect: (connectionInfo: ConnectionInfo) => Promise<void>;
   disconnect: (connectionId: string) => void;
 
   createNewConnection: () => void;
@@ -32,16 +34,16 @@ export function useConnections(): {
   showNonGenuineMongoDBWarningModal: (connectionId: string) => void;
 } {
   const connectionsState = useConnectionsState();
+  const editingConnection =
+    connectionsState.connections.byId[connectionsState.editingConnectionInfoId];
   const state = {
     connectionErrors: Object.fromEntries(
       Object.entries(connectionsState.connections.byId).map(([k, v]) => {
         return [k, v.error ?? null];
       })
     ),
-    editingConnectionInfo:
-      connectionsState.connections.byId[
-        connectionsState.editingConnectionInfoId
-      ].info,
+    editingConnectionInfo: editingConnection.info,
+    isEditingNewConnection: !!editingConnection.isBeingCreated,
     isEditingConnectionInfoModalOpen:
       connectionsState.isEditingConnectionInfoModalOpen,
     oidcDeviceAuthState: Object.fromEntries(
@@ -52,6 +54,7 @@ export function useConnections(): {
   };
   const {
     connect,
+    saveAndConnect,
     disconnect,
     createNewConnection,
     editConnection,
@@ -66,6 +69,7 @@ export function useConnections(): {
   return {
     state,
     connect,
+    saveAndConnect,
     disconnect,
     createNewConnection,
     editConnection,

packages/compass-connections/src/stores/store-context.tsx

@@ -18,6 +18,7 @@ import type {
 import {
   cancelEditConnection,
   connect as connectionsConnect,
+  saveAndConnect,
   connectionsEventEmitter,
   createNewConnection,
   disconnect,
@@ -87,6 +88,9 @@ function getConnectionsActions(dispatch: ConnectionsStore['dispatch']) {
     connect: (connectionInfo: ConnectionInfo) => {
       return dispatch(connectionsConnect(connectionInfo));
     },
+    saveAndConnect: (connectionInfo: ConnectionInfo) => {
+      return dispatch(saveAndConnect(connectionInfo));
+    },
     disconnect: (connectionId: ConnectionId) => {
       return dispatch(disconnect(connectionId));
     },

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

@@ -109,6 +109,7 @@ export function MultipleConnectionSidebar({
   const connectionsWithStatus = useConnectionsWithStatus();
   const {
     connect,
+    saveAndConnect,
     disconnect,
     createNewConnection,
     editConnection,
@@ -120,6 +121,7 @@ export function MultipleConnectionSidebar({
     showNonGenuineMongoDBWarningModal,
     state: {
       editingConnectionInfo,
+      isEditingNewConnection,
       isEditingConnectionInfoModalOpen,
       connectionErrors,
     },
@@ -184,6 +186,10 @@ export function MultipleConnectionSidebar({
     [globalAppRegistry]
   );
 
+  const disableEditingConnectedConnection = !!findActiveConnection(
+    editingConnectionInfo.id
+  );
+
   return (
     <ResizableSidebar data-testid="navigation-sidebar" useNewTheme={true}>
       <aside className={sidebarStyles}>
@@ -229,7 +235,7 @@ export function MultipleConnectionSidebar({
         {editingConnectionInfo && (
           <ConnectionFormModal
             disableEditingConnectedConnection={
-              !!findActiveConnection(editingConnectionInfo.id)
+              disableEditingConnectedConnection
             }
             onDisconnectClicked={() => disconnect(editingConnectionInfo.id)}
             isOpen={isEditingConnectionInfoModalOpen}
@@ -240,20 +246,31 @@ export function MultipleConnectionSidebar({
               }
             }}
             initialConnectionInfo={editingConnectionInfo}
-            onSaveAndConnectClicked={(connectionInfo) => {
-              void connect(connectionInfo);
-            }}
-            onSaveClicked={(connectionInfo) => {
-              return saveEditedConnection(connectionInfo);
-            }}
-            onCancel={() => {
-              cancelEditConnection(editingConnectionInfo.id);
-            }}
             connectionErrorMessage={
               connectionErrors[editingConnectionInfo.id]?.message
             }
             openSettingsModal={openSettingsModal}
             {...formPreferences}
+            onCancel={() => {
+              cancelEditConnection(editingConnectionInfo.id);
+            }}
+            onSaveClicked={(connectionInfo) => {
+              return saveEditedConnection(connectionInfo);
+            }}
+            onConnectClicked={
+              isEditingNewConnection || disableEditingConnectedConnection
+                ? undefined
+                : (connectionInfo) => {
+                    void connect(connectionInfo);
+                  }
+            }
+            onSaveAndConnectClicked={
+              disableEditingConnectedConnection
+                ? undefined
+                : (connectionInfo) => {
+                    void saveAndConnect(connectionInfo);
+                  }
+            }
           />
         )}
         <MappedCsfleModal

packages/compass-web/src/entrypoint.spec.tsx

@@ -81,9 +81,9 @@ describe('CompassWeb', function () {
       screen.getAllByRole('button', { name: 'Add new connection' })[0]
     );
     await waitFor(() => {
-      screen.getByRole('button', { name: 'Connect' });
+      screen.getByRole('button', { name: 'Save & Connect' });
     });
-    userEvent.click(screen.getByRole('button', { name: 'Connect' }));
+    userEvent.click(screen.getByRole('button', { name: 'Save & Connect' }));
     return result;
   }
 

packages/connection-form/src/components/connection-form-actions.spec.tsx → packages/connection-form/src/components/connection-form-modal-actions.spec.tsx

@@ -3,7 +3,7 @@ import { render, screen, userEvent } from '@mongodb-js/testing-library-compass';
 import { expect } from 'chai';
 import sinon from 'sinon';
 
-import { ConnectionFormModalActions } from './connection-form-actions';
+import { ConnectionFormModalActions } from './connection-form-modal-actions';
 
 describe('<ConnectionFormModalActions />', function () {
   it('should show warnings', function () {
@@ -30,7 +30,7 @@ describe('<ConnectionFormModalActions />', function () {
     expect(screen.getByText('Error!')).to.be.visible;
   });
 
-  describe('Connect Button', function () {
+  describe('Save&Connect Button', function () {
     it('should call onSaveAndConnect function', function () {
       const onSaveAndConnectSpy = sinon.spy();
       render(
@@ -41,7 +41,9 @@ describe('<ConnectionFormModalActions />', function () {
           onSaveAndConnect={onSaveAndConnectSpy}
         ></ConnectionFormModalActions>
       );
-      const connectButton = screen.getByRole('button', { name: 'Connect' });
+      const connectButton = screen.getByRole('button', {
+        name: 'Save & Connect',
+      });
       userEvent.click(connectButton);
 
       expect(onSaveAndConnectSpy).to.have.been.calledOnce;
@@ -54,7 +56,8 @@ describe('<ConnectionFormModalActions />', function () {
           warnings={[]}
         ></ConnectionFormModalActions>
       );
-      expect(screen.queryByRole('button', { name: 'Connect' })).to.not.exist;
+      expect(screen.queryByRole('button', { name: 'Save & Connect' })).to.not
+        .exist;
     });
   });
 

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

@@ -45,6 +45,7 @@ export type ConnectionFormModalActionsProps = {
   onCancel?(): void;
   onSave?(): void;
   onSaveAndConnect?(): void;
+  onConnect?(): void;
 };
 
 export function ConnectionFormModalActions({
@@ -53,6 +54,7 @@ export function ConnectionFormModalActions({
   onCancel,
   onSave,
   onSaveAndConnect,
+  onConnect,
 }: ConnectionFormModalActionsProps): React.ReactElement {
   const saveAndConnectLabel = useConnectionFormSetting('saveAndConnectLabel');
   return (
@@ -102,9 +104,21 @@ export function ConnectionFormModalActions({
           </div>
         )}
 
+        {onConnect && (
+          <Button
+            data-testid={'connect-button'}
+            variant={ButtonVariant.PrimaryOutline}
+            onClick={onConnect}
+          >
+            Connect
+          </Button>
+        )}
+
         {onSaveAndConnect && (
           <Button
-            data-testid="connect-button"
+            data-testid={
+              onConnect ? 'save-and-connect-button' : 'connect-button'
+            }
             variant={ButtonVariant.Primary}
             onClick={onSaveAndConnect}
           >