chore(workspaces): replace workspace opening events with openWorkspace methods (#5213)

* chore(workspaces): add workspace provider; decouple sidebar from workspaces and use new hook to get state

* chore(workspaces): use openWorkspace methods in sidebar, collection, and databases-collections plugins

* chore(workspaces): move workspace tab definition to workspaces plugin to avoid circular dependencies

* chore(workspaces): replace rest of the tab opening events with openWorkspace methods

* chore(workspace): refactor workspaces provider to allow mocking in test environment

* chore(workspaces): add a separate method for opening a collection in a view editing state

* chore(workspaces): fix slot rendering; fix failing tests

* chore(instance-store): clean up instance store and add tests

* chore(home): fix dataService mock

* chore(collection-model): pick type as part of the collection info

* chore(workspaces): use optional chaining

Co-authored-by: Anna Henningsen <[email protected]>

* chore(collection): stricter collection tab provider types

---------

Co-authored-by: Anna Henningsen <[email protected]>

Author: gribnoysup

package-lock.json

@@ -52,7 +52,7 @@ type CollectionMetadata = {
 
 interface CollectionProps {
   _id: string;
-  type: string;
+  type: 'collection' | 'view' | 'timeseries';
   status: 'initial' | 'fetching' | 'refreshing' | 'ready' | 'error';
   statusError: string | null;
   ns: string;
@@ -106,6 +106,11 @@ interface CollectionCollection extends Array<Collection> {
   toJSON(opts?: { derived: boolean }): Array<CollectionProps>;
   at(index: number): Collection | undefined;
   get(id: string, key?: '_id' | 'name'): Collection | undefined;
+  add(props: Partial<CollectionProps>): Collection;
+  remove(
+    models: string | [string] | Collection | [Collection]
+  ): Collection | undefined;
+  remove(models: string[] | Collection[]): (Collection | undefined)[];
 }
 
 export default Collection;

packages/collection-model/index.d.ts

@@ -93,6 +93,7 @@ function getParentByType(model, type) {
 }
 
 function pickCollectionInfo({
+  type,
   readonly,
   view_on,
   collation,
@@ -101,7 +102,7 @@ function pickCollectionInfo({
   clustered,
   fle2,
 }) {
-  return { readonly, view_on, collation, pipeline, validation, clustered, fle2 };
+  return { type, readonly, view_on, collation, pipeline, validation, clustered, fle2 };
 }
 
 /**
@@ -368,10 +369,9 @@ const CollectionCollection = AmpersandCollection.extend(
             // refactor significantly. We can address this in COMPASS-5211
             return getNamespaceInfo(coll._id).system === false;
           })
-          .map(({ _id, type, ...rest }) => {
+          .map(({ _id, ...rest }) => {
             return {
               _id,
-              type,
               ...pickCollectionInfo(rest),
             };
           })

packages/collection-model/lib/model.js

@@ -39,12 +39,14 @@
   "license": "SSPL",
   "peerDependencies": {
     "@mongodb-js/atlas-service": "^0.12.2",
+    "@mongodb-js/compass-app-stores": "^7.7.4",
     "@mongodb-js/compass-components": "^1.20.2",
     "@mongodb-js/compass-crud": "^13.21.5",
     "@mongodb-js/compass-editor": "^0.19.2",
     "@mongodb-js/compass-generative-ai": "^0.6.2",
     "@mongodb-js/compass-logging": "^1.2.8",
     "@mongodb-js/compass-utils": "^0.5.7",
+    "@mongodb-js/compass-workspaces": "^0.2.4",
     "@mongodb-js/explain-plan-helper": "^1.1.5",
     "@mongodb-js/mongodb-constants": "^0.8.7",
     "@mongodb-js/mongodb-redux-common": "^2.0.17",
@@ -82,6 +84,9 @@
     "lodash": "^4.17.21",
     "mocha": "^10.2.0",
     "mongodb": "^6.3.0",
+    "mongodb-collection-model": "^5.16.3",
+    "mongodb-database-model": "^2.16.3",
+    "mongodb-instance-model": "^12.16.3",
     "mongodb-ns": "^2.4.0",
     "mongodb-query-parser": "^4.0.0",
     "mongodb-schema": "^12.1.0",
@@ -100,12 +105,14 @@
   },
   "dependencies": {
     "@mongodb-js/atlas-service": "^0.12.2",
+    "@mongodb-js/compass-app-stores": "^7.7.4",
     "@mongodb-js/compass-components": "^1.20.2",
     "@mongodb-js/compass-crud": "^13.21.5",
     "@mongodb-js/compass-editor": "^0.19.2",
     "@mongodb-js/compass-generative-ai": "^0.6.2",
     "@mongodb-js/compass-logging": "^1.2.8",
     "@mongodb-js/compass-utils": "^0.5.7",
+    "@mongodb-js/compass-workspaces": "^0.2.4",
     "@mongodb-js/explain-plan-helper": "^1.1.5",
     "@mongodb-js/mongodb-constants": "^0.8.7",
     "@mongodb-js/mongodb-redux-common": "^2.0.17",

packages/compass-aggregations/package.json

@@ -1,5 +1,5 @@
 import React from 'react';
-import { render, screen } from '@testing-library/react';
+import { cleanup, render, screen } from '@testing-library/react';
 import { expect } from 'chai';
 import { Provider } from 'react-redux';
 import configureStore from '../../../../test/configure-store';
@@ -25,6 +25,8 @@ const renderPipelineBuilderUIWorkspace = (props = {}, options = {}) => {
 };
 
 describe('PipelineBuilderUIWorkspace [Component]', function () {
+  afterEach(cleanup);
+
   it('renders', function () {
     expect(() => renderPipelineBuilderUIWorkspace()).to.not.throw;
   });