chore(connections): rename prop; add comments; more cleanup

Author: gribnoysup

packages/compass-connections/src/index.tsx

@@ -26,15 +26,42 @@ export type { ConnectionFeature } from './utils/connection-supports';
 export { connectionSupports } from './utils/connection-supports';
 
 const ConnectionsComponent: React.FunctionComponent<{
+  /**
+   * Application name, will be passed to the driver during connection
+   */
   appName: string;
+  /**
+   * Callback prop that should resolve with any extra connection information to
+   * be added to the connection tracking
+   */
   onExtraConnectionDataRequest: (
     connectionInfo: ConnectionInfo
   ) => Promise<[ExtraConnectionDataForTelemetry, string | null]>;
+  /**
+   * Callback prop that might optionally resolve with the connectionInfo object
+   * to be automatically connected to as soon as plugin is activated.
+   * ConnectionStorage argument can be used to pick connectionInfo from the list
+   * of existing connections
+   */
   onAutoconnectInfoRequest?: (
     connectionStorage: ConnectionStorage
   ) => Promise<ConnectionInfo | undefined>;
-  allowAutoconnectInfoReconnect?: boolean;
+  /**
+   * By default any connection returned by `onAutoconnectInfoRequest` will be
+   * automatically connected. This property can be used to disable "reconnect"
+   * if connection with the matching id was explicitly disconnected by the user
+   * in the UI before in the same session. Currently this is only behavior of
+   * Compass desktop.
+   */
+  doNotReconnectDisconnectedAutoconnectInfo?: boolean;
+  /**
+   * Can be used to override default connection function
+   */
   connectFn?: typeof devtoolsConnect | undefined;
+  /**
+   * Can be used to provide preloaded connections instead of triggering loading
+   * connections on plugin activate
+   */
   preloadStorageConnectionInfos?: ConnectionInfo[];
 }> = ({ children }) => {
   return (
@@ -71,7 +98,7 @@ const CompassConnectionsPlugin = registerHadronPlugin(
           void store.dispatch(
             autoconnectCheck(
               initialProps.onAutoconnectInfoRequest,
-              initialProps.allowAutoconnectInfoReconnect
+              initialProps.doNotReconnectDisconnectedAutoconnectInfo
             )
           );
         }

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

@@ -1403,7 +1403,7 @@ export const autoconnectCheck = (
   getAutoconnectInfo: (
     connectionStorage: ConnectionStorage
   ) => Promise<ConnectionInfo | undefined>,
-  allowAutoconnectInfoReconnect = true
+  doNotReconnectDisconnectedAutoconnectInfo = false
 ): ConnectionsThunkAction<
   Promise<void>,
   ConnectionAutoconnectCheckAction | ConnectionAttemptErrorAction
@@ -1421,16 +1421,17 @@ export const autoconnectCheck = (
       );
       const connectionInfo = await getAutoconnectInfo(connectionStorage);
       if (
-        allowAutoconnectInfoReconnect ||
-        getSessionConnectionStatus(connectionInfo?.id) !== 'disconnected'
+        doNotReconnectDisconnectedAutoconnectInfo &&
+        getSessionConnectionStatus(connectionInfo?.id) === 'disconnected'
       ) {
-        dispatch({
-          type: ActionTypes.ConnectionAutoconnectCheck,
-          connectionInfo: connectionInfo,
-        });
-        if (connectionInfo) {
-          void dispatch(connect(connectionInfo));
-        }
+        return;
+      }
+      dispatch({
+        type: ActionTypes.ConnectionAutoconnectCheck,
+        connectionInfo: connectionInfo,
+      });
+      if (connectionInfo) {
+        void dispatch(connect(connectionInfo));
       }
     } catch (err) {
       dispatch(connectionAttemptError(null, err));

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

@@ -326,20 +326,6 @@ export function useConnectionInfoRefForId(connectionId: ConnectionId): {
   return ref;
 }
 
-/**
- * @deprecated exposed for compat with old connections store interface, should
- * never be used anywhere else
- */
-export function useConnectionsState() {
-  return useSelector((state) => state, {
-    // These warnings are very noisy. We know this selector is bad, but there is
-    // no way to reimplement old connections store without it and we're going to
-    // remove it soon anyway
-    stabilityCheck: 'never',
-    noopCheck: 'never',
-  });
-}
-
 export function useConnectionsColorList(): {
   id: ConnectionId;
   color: string | undefined;

packages/compass/src/app/components/home.tsx

@@ -148,7 +148,7 @@ function HomeWithConnections({
           appName={props.appName}
           onExtraConnectionDataRequest={getExtraConnectionData}
           onAutoconnectInfoRequest={onAutoconnectInfoRequest}
-          allowAutoconnectInfoReconnect={false}
+          doNotReconnectDisconnectedAutoconnectInfo
         >
           <Home {...props}></Home>
         </CompassConnections>

packages/compass/src/app/components/workspace.tsx

@@ -78,10 +78,6 @@ export default function Workspace({
     [appName, getConnectionInfoById, onActiveWorkspaceTabChange]
   );
 
-  useEffect(() => {
-    updateTitle(appName);
-  }, [appName]);
-
   return (
     <WorkspacesProvider
       value={[