feat(workspaces): move tab rendering to the plugins COMPASS-9413

packages/compass-collection/src/index.ts

@@ -1,3 +1,4 @@
+import React from 'react';
 import CollectionTab from './components/collection-tab';
 import { activatePlugin as activateCollectionTabPlugin } from './stores/collection-tab';
 import { registerHadronPlugin } from 'hadron-app-registry';
@@ -7,27 +8,32 @@ import {
   type DataService,
 } from '@mongodb-js/compass-connections/provider';
 import { collectionModelLocator } from '@mongodb-js/compass-app-stores/provider';
-import type { WorkspaceComponent } from '@mongodb-js/compass-workspaces';
+import type { WorkspacePlugin } from '@mongodb-js/compass-workspaces';
 import { workspacesServiceLocator } from '@mongodb-js/compass-workspaces/provider';
+import {
+  CollectionWorkspaceTitle,
+  CollectionPluginTitle,
+} from './plugin-tab-title';
 
-export const CollectionTabPlugin = registerHadronPlugin(
-  {
-    name: 'CollectionTab',
-    component: CollectionTab,
-    activate: activateCollectionTabPlugin,
-  },
-  {
-    dataService: dataServiceLocator as DataServiceLocator<keyof DataService>,
-    collection: collectionModelLocator,
-    workspaces: workspacesServiceLocator,
-  }
-);
-
-export const WorkspaceTab: WorkspaceComponent<'Collection'> = {
-  name: 'Collection' as const,
-  component: CollectionTabPlugin,
+export const WorkspaceTab: WorkspacePlugin<typeof CollectionWorkspaceTitle> = {
+  name: CollectionWorkspaceTitle,
+  provider: registerHadronPlugin(
+    {
+      name: CollectionWorkspaceTitle,
+      component: function CollectionProvider({ children }) {
+        return React.createElement(React.Fragment, null, children);
+      },
+      activate: activateCollectionTabPlugin,
+    },
+    {
+      dataService: dataServiceLocator as DataServiceLocator<keyof DataService>,
+      collection: collectionModelLocator,
+      workspaces: workspacesServiceLocator,
+    }
+  ),
+  content: CollectionTab,
+  header: CollectionPluginTitle,
 };
 
-export default CollectionTabPlugin;
 export type { CollectionTabPluginMetadata } from './modules/collection-tab';
 export { CollectionTabsProvider } from './components/collection-tab-provider';

packages/compass-collection/src/plugin-tab-title.tsx

@@ -0,0 +1,111 @@
+import React from 'react';
+import { connect } from 'react-redux';
+import toNS from 'mongodb-ns';
+import {
+  useConnectionsListRef,
+  useTabConnectionTheme,
+} from '@mongodb-js/compass-connections/provider';
+import {
+  WorkspaceTab,
+  type WorkspaceTabCoreProps,
+} from '@mongodb-js/compass-components';
+import type { CollectionSubtab } from '@mongodb-js/compass-workspaces';
+
+import { type CollectionState } from './modules/collection-tab';
+
+type WorkspaceProps = {
+  id: string;
+  connectionId: string;
+  namespace: string;
+  subTab: CollectionSubtab;
+  initialQuery?: unknown;
+  initialPipeline?: unknown[];
+  initialPipelineText?: string;
+  initialAggregation?: unknown;
+  editViewName?: string;
+  isNonExistent: boolean;
+};
+
+function _PluginTitle({
+  isTimeSeries,
+  isReadonly,
+  sourceName,
+  tabProps,
+  workspaceProps,
+}: {
+  isTimeSeries?: boolean;
+  isReadonly?: boolean;
+  sourceName?: string | null;
+  tabProps: WorkspaceTabCoreProps;
+  workspaceProps: WorkspaceProps;
+}) {
+  const { getThemeOf } = useTabConnectionTheme();
+  const { getConnectionById } = useConnectionsListRef();
+
+  const { database, collection, ns } = toNS(workspaceProps.namespace);
+  const namespaceId = `${workspaceProps.connectionId}.${ns}`;
+  const connectionName =
+    getConnectionById(workspaceProps.connectionId)?.title || '';
+  const collectionType = isTimeSeries
+    ? 'timeseries'
+    : isReadonly
+    ? 'view'
+    : 'collection';
+  // Similar to what we have in the collection breadcrumbs.
+  const tooltip: [string, string][] = [
+    ['Connection', connectionName || ''],
+    ['Database', database],
+  ];
+  if (sourceName) {
+    tooltip.push(['View', collection]);
+    tooltip.push(['Derived from', toNS(sourceName).collection]);
+  } else if (workspaceProps.editViewName) {
+    tooltip.push(['View', toNS(workspaceProps.editViewName).collection]);
+    tooltip.push(['Derived from', collection]);
+  } else {
+    tooltip.push(['Collection', collection]);
+  }
+
+  return (
+    <WorkspaceTab
+      {...tabProps}
+      id={workspaceProps.id}
+      connectionName={connectionName}
+      type={CollectionWorkspaceTitle}
+      title={collection}
+      tooltip={tooltip}
+      iconGlyph={
+        collectionType === 'view'
+          ? 'Visibility'
+          : collectionType === 'timeseries'
+          ? 'TimeSeries'
+          : workspaceProps.isNonExistent
+          ? 'EmptyFolder'
+          : 'Folder'
+      }
+      data-namespace={ns}
+      tabTheme={getThemeOf(workspaceProps.connectionId)}
+      isNonExistent={workspaceProps.isNonExistent}
+    />
+  );
+}
+
+const ConnectedPluginTitle = connect((state: CollectionState) => ({
+  // TODO: Need to check the implications of moving this metadata here
+  // instead of having it passed from the workspaces store.
+  isTimeSeries: state.metadata?.isTimeSeries,
+  isReadonly: state.metadata?.isReadonly,
+  sourceName: state.metadata?.sourceName,
+}))(_PluginTitle);
+
+export const CollectionWorkspaceTitle = 'Collection' as const;
+export function CollectionPluginTitle(workspaceProps: WorkspaceProps) {
+  return (tabProps: WorkspaceTabCoreProps) => {
+    return (
+      <ConnectedPluginTitle
+        tabProps={tabProps}
+        workspaceProps={workspaceProps}
+      />
+    );
+  };
+}

packages/compass-components/src/components/workspace-tabs/tab.tsx

@@ -149,6 +149,11 @@ const draggingTabStyles = css({
   cursor: 'grabbing !important',
 });
 
+// TODO: Should this have a dark mode version?
+const nonExistentStyles = css({
+  color: palette.gray.base,
+});
+
 const tabIconStyles = css({
   color: 'currentColor',
   marginLeft: spacing[300],
@@ -185,25 +190,34 @@ const workspaceTabTooltipStyles = css({
   textWrap: 'wrap',
 });
 
-type TabProps = {
+// The plugins provide these essential props use to render the tab.
+// The workspace-tabs component provides the other parts of TabProps.
+export type WorkspaceTabPluginProps = {
   connectionName?: string;
   type: string;
-  title: string;
+  title: React.ReactNode;
+  isNonExistent?: boolean;
+  iconGlyph: GlyphName | 'Logo' | 'Server';
+  tooltip?: [string, string][];
+  tabTheme?: Partial<TabTheme>;
+};
+
+export type WorkspaceTabCoreProps = {
   isSelected: boolean;
   isDragging: boolean;
   onSelect: () => void;
   onClose: () => void;
-  iconGlyph: GlyphName | 'Logo' | 'Server';
   tabContentId: string;
-  tooltip?: [string, string][];
-  tabTheme?: Partial<TabTheme>;
 };
 
+type TabProps = WorkspaceTabCoreProps & WorkspaceTabPluginProps;
+
 function Tab({
   connectionName,
   type,
   title,
   tooltip,
+  isNonExistent,
   isSelected,
   isDragging,
   onSelect,
@@ -213,7 +227,7 @@ function Tab({
   tabTheme,
   className: tabClassName,
   ...props
-}: TabProps & React.HTMLProps<HTMLDivElement>) {
+}: TabProps & Omit<React.HTMLProps<HTMLDivElement>, 'title'>) {
   const darkMode = useDarkMode();
   const defaultActionProps = useDefaultAction(onSelect);
   const { listeners, setNodeRef, transform, transition } = useSortable({
@@ -254,6 +268,7 @@ function Tab({
           className={cx(
             tabStyles,
             themeClass,
+            isNonExistent && nonExistentStyles,
             isSelected && selectedTabStyles,
             isSelected && tabTheme && selectedThemedTabStyles,
             isDragging && draggingTabStyles,

packages/compass-components/src/components/workspace-tabs/workspace-tabs.spec.tsx

@@ -9,14 +9,23 @@ import { expect } from 'chai';
 import sinon from 'sinon';
 
 import { WorkspaceTabs } from './workspace-tabs';
-import type { TabProps } from './workspace-tabs';
+import { Tab, type WorkspaceTabCoreProps } from './tab';
 
-function mockTab(tabId: number): TabProps {
+function mockTab(tabId: number): {
+  id: string;
+  renderTab: (tabProps: WorkspaceTabCoreProps) => ReturnType<typeof Tab>;
+} {
   return {
-    type: 'Documents',
-    title: `mock-tab-${tabId}`,
     id: `${tabId}-content`,
-    iconGlyph: 'Folder',
+    renderTab: (tabProps: WorkspaceTabCoreProps) => (
+      <Tab
+        {...tabProps}
+        type="Documents"
+        title={`mock-tab-${tabId}`}
+        id={`${tabId}-content`}
+        iconGlyph="Folder"
+      />
+    ),
   };
 }
 

packages/compass-components/src/components/workspace-tabs/workspace-tabs.tsx

@@ -8,7 +8,6 @@ import React, {
 import { css, cx } from '@leafygreen-ui/emotion';
 import { palette } from '@leafygreen-ui/palette';
 import { spacing } from '@leafygreen-ui/tokens';
-import type { GlyphName } from '@leafygreen-ui/icon';
 import { rgba } from 'polished';
 
 import {
@@ -29,6 +28,7 @@ import { FocusState, useFocusState } from '../../hooks/use-focus-hover';
 import { Icon, IconButton } from '../leafygreen';
 import { mergeProps } from '../../utils/merge-props';
 import { Tab } from './tab';
+import type { WorkspaceTabCoreProps } from './tab';
 import { useHotkeys } from '../../hooks/use-hotkeys';
 
 export const scrollbarThumbLightTheme = rgba(palette.gray.base, 0.65);
@@ -139,8 +139,13 @@ function useTabListKeyboardNavigation<HTMLDivElement>({
   return [{ onKeyDown }];
 }
 
+type TabItem = {
+  id: string;
+  renderTab: (props: WorkspaceTabCoreProps) => ReturnType<typeof Tab>;
+};
+
 type SortableItemProps = {
-  tab: TabProps;
+  tab: TabItem;
   index: number;
   selectedTabIndex: number;
   activeId: UniqueIdentifier | null;
@@ -149,7 +154,7 @@ type SortableItemProps = {
 };
 
 type SortableListProps = {
-  tabs: TabProps[];
+  tabs: TabItem[];
   selectedTabIndex: number;
   onMove: (oldTabIndex: number, newTabIndex: number) => void;
   onSelect: (tabIndex: number) => void;
@@ -164,19 +169,10 @@ type WorkspaceTabsProps = {
   onSelectPrevTab: () => void;
   onCloseTab: (tabIndex: number) => void;
   onMoveTab: (oldTabIndex: number, newTabIndex: number) => void;
-  tabs: TabProps[];
+  tabs: TabItem[];
   selectedTabIndex: number;
 };
 
-export type TabProps = {
-  id: string;
-  type: string;
-  title: string;
-  tooltip?: [string, string][];
-  connectionId?: string;
-  iconGlyph: GlyphName | 'Logo' | 'Server';
-} & Omit<React.HTMLProps<HTMLDivElement>, 'id' | 'title'>;
-
 export function useRovingTabIndex<T extends HTMLElement = HTMLElement>({
   currentTabbable,
 }: {
@@ -263,7 +259,7 @@ const SortableList = ({
     >
       <SortableContext items={items} strategy={horizontalListSortingStrategy}>
         <div className={sortableItemContainerStyles}>
-          {tabs.map((tab: TabProps, index: number) => (
+          {tabs.map((tab: TabItem, index: number) => (
             <SortableItem
               key={tab.id}
               index={index}
@@ -281,15 +277,13 @@ const SortableList = ({
 };
 
 const SortableItem = ({
-  tab: tabProps,
+  tab: { id: tabId, renderTab },
   index,
   selectedTabIndex,
   activeId,
   onSelect,
   onClose,
 }: SortableItemProps) => {
-  const { id: tabId } = tabProps;
-
   const onTabSelected = useCallback(() => {
     onSelect(index);
   }, [onSelect, index]);
@@ -305,16 +299,19 @@ const SortableItem = ({
 
   const isDragging = useMemo(() => tabId === activeId, [tabId, activeId]);
 
-  return (
-    <Tab
-      {...tabProps}
-      isSelected={isSelected}
-      isDragging={isDragging}
-      tabContentId={tabId}
-      onSelect={onTabSelected}
-      onClose={onTabClosed}
-    />
+  const tab = useMemo(
+    () =>
+      renderTab({
+        isSelected,
+        isDragging,
+        tabContentId: tabId,
+        onSelect: onTabSelected,
+        onClose: onTabClosed,
+      }),
+    [renderTab]
   );
+
+  return tab;
 };
 
 function WorkspaceTabs({

packages/compass-components/src/index.ts

@@ -38,7 +38,11 @@ export {
 import { ResizeHandle, ResizeDirection } from './components/resize-handle';
 import { Accordion } from './components/accordion';
 import { CollapsibleFieldSet } from './components/collapsible-field-set';
-export { type TabTheme } from './components/workspace-tabs/tab';
+export {
+  Tab as WorkspaceTab,
+  type TabTheme,
+  type WorkspaceTabCoreProps,
+} from './components/workspace-tabs/tab';
 import { WorkspaceTabs } from './components/workspace-tabs/workspace-tabs';
 import ResizableSidebar, {
   defaultSidebarWidth,