fix: make $out options more clear in agg pipeline builder COMPASS-6304 (#3913)

Author: alenakhineika

package-lock.json

@@ -43,7 +43,7 @@
     "@mongodb-js/compass-logging": "^1.1.1",
     "@mongodb-js/compass-utils": "^0.1.2",
     "@mongodb-js/explain-plan-helper": "^1.0.1",
-    "@mongodb-js/mongodb-constants": "^0.1.4",
+    "@mongodb-js/mongodb-constants": "^0.1.5",
     "@mongodb-js/mongodb-redux-common": "^2.0.3",
     "bson": "^4.4.1",
     "compass-preferences-model": "^2.4.0",
@@ -99,7 +99,7 @@
     "@mongodb-js/compass-logging": "^1.1.1",
     "@mongodb-js/compass-utils": "^0.1.2",
     "@mongodb-js/explain-plan-helper": "^1.0.1",
-    "@mongodb-js/mongodb-constants": "^0.1.4",
+    "@mongodb-js/mongodb-constants": "^0.1.5",
     "@mongodb-js/mongodb-redux-common": "^2.0.3",
     "bson": "^4.4.1",
     "compass-preferences-model": "^2.4.0",

packages/compass-aggregations/package.json

@@ -152,7 +152,6 @@ function EnvAwareStageOperatorSelect({
       serverVersion,
       env,
       isTimeSeries,
-      isReadonly,
       preferencesReadOnly,
       sourceName
     });

packages/compass-aggregations/src/components/stage-editor-toolbar/stage-operator-select.tsx

@@ -37,9 +37,9 @@ export function isAtlasOnly(operatorEnv) {
   return operatorEnv?.every(env => env === ATLAS);
 }
 
-function disallowOutputStagesOnCompassReadonly(operator, isEditable) {
+function disallowOutputStagesOnCompassReadonly(operator, preferencesReadOnly) {
   if (operator?.outputStage) {
-    return isEditable;
+    return !preferencesReadOnly;
   }
 
   return true;
@@ -56,7 +56,7 @@ function disallowOutputStagesOnCompassReadonly(operator, isEditable) {
  *
  * @returns {Array} Stage operators supported by the current version of the server.
  */
-export const filterStageOperators = ({ serverVersion, env, isTimeSeries, sourceName, isReadonly, preferencesReadOnly }) => {
+export const filterStageOperators = ({ serverVersion, env, isTimeSeries, sourceName, preferencesReadOnly }) => {
   const namespaceType =
     isTimeSeries ? TIME_SERIES :
 
@@ -65,9 +65,8 @@ export const filterStageOperators = ({ serverVersion, env, isTimeSeries, sourceN
     sourceName ? VIEW :
     COLLECTION;
 
-  const isEditable = !isReadonly && !preferencesReadOnly;
   return STAGE_OPERATORS
-    .filter((op) => disallowOutputStagesOnCompassReadonly(op, isEditable))
+    .filter((op) => disallowOutputStagesOnCompassReadonly(op, preferencesReadOnly))
     .filter((op) => supportsVersion(op, serverVersion))
     .filter((op) => supportsNamespace(op, namespaceType))
 

packages/compass-aggregations/src/utils/stage.js

@@ -6,7 +6,6 @@ describe('utils', function() {
     const defaultFilter = {
       env: 'on-prem',
       isTimeSeries: false,
-      isReadonly: false,
       preferencesReadOnly: false,
       sourceName: null,
       serverVersion: '4.2.0'
@@ -79,7 +78,7 @@ describe('utils', function() {
       });
 
       it('does not return full-text search stages for views', function() {
-        const searchStages = filterStageOperators({ ...filter, isReadonly: true, sourceName: 'simple.sample' })
+        const searchStages = filterStageOperators({ ...filter, sourceName: 'simple.sample' })
           .filter((o) => (['$search', '$searchMeta', '$documents'].includes(o.name)));
 
         expect(searchStages.length).to.be.equal(0);
@@ -119,30 +118,24 @@ describe('utils', function() {
     });
 
     context('when is not a read-only distribution of Compass', function() {
-      it('returns output stages if isReadonly is false', function() {
-        const searchStages = filterStageOperators({ ...defaultFilter, env: 'adl', serverVersion: '6.0.0', isReadonly: false })
-          .filter((o) => (['$out', '$merge'].includes(o.name)));
-
-        expect(searchStages.length).to.be.equal(2);
-      });
-
-      it('returns output stages if isReadonly is undefined', function() {
-        const searchStages = filterStageOperators({ ...defaultFilter, env: 'adl', serverVersion: '6.0.0' })
+      it('returns output stages', function() {
+        const searchStages = filterStageOperators({ ...defaultFilter, env: 'adl', serverVersion: '6.0.0', preferencesReadOnly: false })
           .filter((o) => (['$out', '$merge'].includes(o.name)));
 
         expect(searchStages.length).to.be.equal(2);
       });
     });
 
     context('when is a read-only distribution of Compass', function() {
-      it('filters out output stages if isEditable is true', function() {
+      it('filters out output stages', function() {
         const searchStages = filterStageOperators({ ...defaultFilter, env: 'adl', serverVersion: '6.0.0', preferencesReadOnly: true })
           .filter((o) => (['$out', '$merge'].includes(o.name)));
 
         expect(searchStages.length).to.be.equal(0);
       });
     });
   });
+
   context('findAtlasOperator', function() {
     it('returns atlas only stage operator', function() {
       expect(

packages/compass-aggregations/src/utils/stage.spec.js

@@ -65,7 +65,7 @@
   },
   "dependencies": {
     "@mongodb-js/compass-components": "^1.4.0",
-    "@mongodb-js/mongodb-constants": "^0.1.4",
+    "@mongodb-js/mongodb-constants": "^0.1.5",
     "ace-builds": "^1.11.2",
     "react": "^16.14.0",
     "react-ace": "^9.5.0",

packages/compass-editor/package.json

@@ -60,7 +60,7 @@
     "@mongodb-js/compass-components": "^1.4.0",
     "@mongodb-js/compass-editor": "^0.3.0",
     "@mongodb-js/compass-logging": "^1.1.1",
-    "@mongodb-js/mongodb-constants": "^0.1.4",
+    "@mongodb-js/mongodb-constants": "^0.1.5",
     "compass-preferences-model": "^2.4.0",
     "react": "^16.14.0"
   },
@@ -98,7 +98,7 @@
     "@mongodb-js/compass-components": "^1.4.0",
     "@mongodb-js/compass-editor": "^0.3.0",
     "@mongodb-js/compass-logging": "^1.1.1",
-    "@mongodb-js/mongodb-constants": "^0.1.4",
+    "@mongodb-js/mongodb-constants": "^0.1.5",
     "compass-preferences-model": "^2.4.0",
     "react": "^16.14.0"
   }