chore: hide __safeContent__ field COMPASS-5780 (#3045)

addaleax · web-flow · commit 2bc9054fa3e5 · 2022-05-04T11:22:00.000+02:00
Grey out the field in the CRUD view, mark it non-editable, and
deselect it by default when exporting from a collection.
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/compass-components/src/components/document-list/element.tsx b/packages/compass-components/src/components/document-list/element.tsx
@@ -149,6 +149,7 @@ function useHadronElement(el: HadronElementType) {
     level: el.level,
     parentType: el.parent?.currentType,
     removed: el.isRemoved(),
+    internal: el.isInternalField(),
   };
 }
 const buttonReset = css({
@@ -240,6 +241,10 @@ const elementKey = css({
   maxWidth: '60%',
 });
 
+const elementKeyInternal = css({
+  color: uiColors.gray.base,
+});
+
 const elementDivider = css({
   flex: 'none',
   userSelect: 'none',
@@ -312,6 +317,7 @@ export const HadronElement: React.FunctionComponent<{
     level,
     parentType,
     removed,
+    internal,
   } = useHadronElement(element);
 
   useEffect(() => {
@@ -346,6 +352,10 @@ export const HadronElement: React.FunctionComponent<{
     onClick: onLineClick,
   };
 
+  const keyProps = {
+    className: cx(elementKey, internal && elementKeyInternal),
+  };
+
   return (
     <>
       <div
@@ -435,7 +445,7 @@ export const HadronElement: React.FunctionComponent<{
             </button>
           )}
         </div>
-        <div className={elementKey} data-testid="hadron-document-element-key">
+        <div {...keyProps} data-testid="hadron-document-element-key">
           {key.editable ? (
             <KeyEditor
               value={key.value}
diff --git a/packages/compass-crud/src/components/document-table-view.jsx b/packages/compass-crud/src/components/document-table-view.jsx
@@ -116,7 +116,8 @@ class DocumentTableView extends React.Component {
    * @param {Object} data - The data object.
    */
   handleClone(data) {
-    this.props.openInsertDocumentDialog(data.hadronDocument.generateObject(), true);
+    const clonedDoc = data.hadronDocument.generateObject({ excludeInternalFields: true });
+    this.props.openInsertDocumentDialog(clonedDoc, true);
   }
 
   /**
diff --git a/packages/compass-crud/src/components/editable-document.jsx b/packages/compass-crud/src/components/editable-document.jsx
@@ -159,7 +159,8 @@ class EditableDocument extends React.Component {
    * Handle cloning of the document.
    */
   handleClone() {
-    this.props.openInsertDocumentDialog(this.props.doc.generateObject(), true);
+    const clonedDoc = this.props.doc.generateObject({ excludeInternalFields: true });
+    this.props.openInsertDocumentDialog(clonedDoc, true);
   }
 
   /**
diff --git a/packages/compass-crud/src/components/json-editor.jsx b/packages/compass-crud/src/components/json-editor.jsx
@@ -157,7 +157,8 @@ class EditableJson extends React.Component {
    * Handle cloning of the json document.
    */
   handleClone() {
-    this.props.openInsertDocumentDialog(this.props.doc.generateObject(), true);
+    const clonedDoc = this.props.doc.generateObject({ excludeInternalFields: true });
+    this.props.openInsertDocumentDialog(clonedDoc, true);
   }
 
   /**
diff --git a/packages/compass-crud/src/components/readonly-document.jsx b/packages/compass-crud/src/components/readonly-document.jsx
@@ -35,7 +35,8 @@ class ReadonlyDocument extends React.Component {
   }
 
   handleClone = () => {
-    this.props.openInsertDocumentDialog(this.props.doc.generateObject(), true);
+    const clonedDoc = this.props.doc.generateObject({ excludeInternalFields: true });
+    this.props.openInsertDocumentDialog(clonedDoc, true);
   }
 
   /**
diff --git a/packages/compass-import-export/src/modules/load-fields.js b/packages/compass-import-export/src/modules/load-fields.js
@@ -1,6 +1,7 @@
 import util from 'util';
 import dotnotation from '../utils/dotnotation';
 import createLoggerAndTelemetry from '@mongodb-js/compass-logging';
+import { isInternalFieldPath } from 'hadron-document';
 
 const { log, mongoLogId } = createLoggerAndTelemetry(
   'COMPASS-IMPORT-EXPORT-UI'
@@ -54,5 +55,10 @@ export function getSelectableFields(fields, { maxDepth } = {}) {
   const selectableFields = Object.keys(fields).map((field) =>
     truncateFieldToDepth(field, maxDepth)
   );
-  return Object.fromEntries(selectableFields.map((field) => [field, ENABLED]));
+  return Object.fromEntries(
+    selectableFields.map((field) => {
+      const enabled = !isInternalFieldPath(field);
+      return [field, +enabled];
+    })
+  );
 }
diff --git a/packages/compass-import-export/src/modules/load-fields.spec.js b/packages/compass-import-export/src/modules/load-fields.spec.js
@@ -138,4 +138,16 @@ describe('getSelectableFields', function () {
       });
     }
   });
+
+  it('excludes driver/server-internal fields by default', function () {
+    const allFields = { a: 1, __safeContent__: 1, '__safeContent__.0': 1 };
+
+    const fields = getSelectableFields(allFields, { maxDepth: 2 });
+
+    expect(fields).to.deep.equal({
+      a: 1,
+      __safeContent__: 0,
+      '__safeContent__.0': 0,
+    });
+  });
 });
diff --git a/packages/compass-schema/package.json b/packages/compass-schema/package.json
@@ -61,6 +61,7 @@
     "bson": "*",
     "d3": "^3.5.17",
     "debug": "^3.0.1",
+    "hadron-document": "^7.10.0",
     "hadron-ipc": "^2.10.0",
     "hadron-react-buttons": "^5.8.0",
     "hadron-react-components": "^5.14.0",
@@ -96,6 +97,7 @@
     "enzyme": "^3.11.0",
     "eslint": "^7.25.0",
     "hadron-app-registry": "^8.11.0",
+    "hadron-document": "^7.10.0",
     "hadron-ipc": "^2.10.0",
     "hadron-react-buttons": "^5.8.0",
     "hadron-react-components": "^5.14.0",
diff --git a/packages/compass-schema/src/modules/schema-analysis.js b/packages/compass-schema/src/modules/schema-analysis.js
@@ -1,6 +1,7 @@
 import util from 'util';
-
+import { isInternalFieldPath } from 'hadron-document';
 import createLoggerAndTelemetry from '@mongodb-js/compass-logging';
+
 const { log, mongoLogId, debug } = createLoggerAndTelemetry('COMPASS-SCHEMA');
 
 import mongodbSchema from 'mongodb-schema';
@@ -67,6 +68,9 @@ class SchemaAnalysis {
         .toArray()
         .catch((err) => Promise.reject(promoteMongoErrorCode(err)));
       const schemaData = await analyzeDocuments(docs);
+      schemaData.fields = schemaData.fields.filter(
+        ({ path }) => !isInternalFieldPath(path)
+      );
       log.info(mongoLogId(1001000090), 'Schema', 'Schema analysis completed', {
         ns: this._ns,
       });
diff --git a/packages/compass-schema/src/modules/schema-analysis.spec.js b/packages/compass-schema/src/modules/schema-analysis.spec.js
@@ -9,7 +9,11 @@ describe('schema-analyis', function () {
     it('returns the schema', async function () {
       const dataService = {
         sample: () => ({
-          toArray: () => Promise.resolve([{ x: 1 }, { y: 2 }]),
+          toArray: () =>
+            Promise.resolve([
+              { x: 1 },
+              { y: 2, __safeContent__: [new bson.Binary('aaaa')] },
+            ]),
         }),
       };
 
diff --git a/packages/hadron-document/src/document.ts b/packages/hadron-document/src/document.ts
@@ -3,6 +3,7 @@ import type { Element } from './element';
 import { LinkedList, Events as ElementEvents } from './element';
 import EventEmitter from 'eventemitter3';
 import { EJSON, UUID } from 'bson';
+import type { ObjectGeneratorOptions } from './object-generator';
 import ObjectGenerator from './object-generator';
 import type { BSONObject, BSONValue } from './utils';
 import { objectToIdiomaticEJSON } from './utils';
@@ -90,17 +91,17 @@ export class Document extends EventEmitter {
    *
    * @returns {Object} The javascript object.
    */
-  generateObject(): BSONObject {
-    return ObjectGenerator.generate(this.elements);
+  generateObject(options?: ObjectGeneratorOptions): BSONObject {
+    return ObjectGenerator.generate(this.elements, options);
   }
 
   /**
    * Generate the javascript object with the original elements in this document.
    *
    * @returns {Object} The original javascript object.
    */
-  generateOriginalObject(): BSONObject {
-    return ObjectGenerator.generateOriginal(this.elements);
+  generateOriginalObject(options?: ObjectGeneratorOptions): BSONObject {
+    return ObjectGenerator.generateOriginal(this.elements, options);
   }
 
   /**
diff --git a/packages/hadron-document/src/element.ts b/packages/hadron-document/src/element.ts
@@ -6,6 +6,7 @@ import isObject from 'lodash.isplainobject';
 import isArray from 'lodash.isarray';
 import isEqual from 'lodash.isequal';
 import isString from 'lodash.isstring';
+import type { ObjectGeneratorOptions } from './object-generator';
 import ObjectGenerator from './object-generator';
 import TypeChecker from 'hadron-type-checker';
 import { UUID } from 'bson';
@@ -25,6 +26,14 @@ export { Events };
  */
 const ID = '_id';
 
+/**
+ * Is this the path to a field that is used internally by the
+ * MongoDB driver or server and not for user consumption?
+ */
+export function isInternalFieldPath(path: string | number): boolean {
+  return typeof path === 'string' && /^__safeContent__($|\.)/.test(path);
+}
+
 /**
  * Types that are not editable.
  */
@@ -281,12 +290,12 @@ export class Element extends EventEmitter {
    *
    * @returns {Object} The javascript object.
    */
-  generateObject(): BSONValue {
+  generateObject(options?: ObjectGeneratorOptions): BSONValue {
     if (this.currentType === 'Array') {
-      return ObjectGenerator.generateArray(this.elements!);
+      return ObjectGenerator.generateArray(this.elements!, options);
     }
     if (this.currentType === 'Object') {
-      return ObjectGenerator.generate(this.elements!);
+      return ObjectGenerator.generate(this.elements!, options);
     }
     return this.currentValue;
   }
@@ -297,18 +306,18 @@ export class Element extends EventEmitter {
    *
    * @returns {Object} The javascript object.
    */
-  generateOriginalObject(): BSONValue {
+  generateOriginalObject(options?: ObjectGeneratorOptions): BSONValue {
     if (this.type === 'Array') {
       const originalElements = this._generateElements(
         this.originalExpandableValue as BSONArray
       );
-      return ObjectGenerator.generateOriginalArray(originalElements);
+      return ObjectGenerator.generateOriginalArray(originalElements, options);
     }
     if (this.type === 'Object') {
       const originalElements = this._generateElements(
         this.originalExpandableValue as BSONObject
       );
-      return ObjectGenerator.generateOriginal(originalElements);
+      return ObjectGenerator.generateOriginal(originalElements, options);
     }
 
     return this.value;
@@ -551,7 +560,10 @@ export class Element extends EventEmitter {
    * @returns {Boolean} If no action can be taken.
    */
   isNotActionable(): boolean {
-    return (this.key === ID && !this.isAdded()) || !this.isRemovable();
+    return (
+      ((this.key === ID || this.isInternalField()) && !this.isAdded()) ||
+      !this.isRemovable()
+    );
   }
 
   /**
@@ -630,7 +642,8 @@ export class Element extends EventEmitter {
 
   _isKeyLegallyEditable(): boolean {
     return (
-      this.isParentEditable() && (this.isAdded() || this.currentKey !== ID)
+      this.isParentEditable() &&
+      (this.isAdded() || (this.currentKey !== ID && !this.isInternalField()))
     );
   }
 
@@ -643,6 +656,23 @@ export class Element extends EventEmitter {
     return this._isKeyLegallyEditable() && !this.containsDecryptedChildren();
   }
 
+  /**
+   * Is this a field that is used internally by the MongoDB driver or server
+   * and not for user consumption?
+   *
+   * @returns {Boolean}
+   */
+  isInternalField(): boolean {
+    if (!this.parent) return false;
+    if (!this.parent.isRoot() && this.parent.isInternalField()) {
+      return true;
+    }
+    if (this.parent.isRoot() && isInternalFieldPath(this.currentKey)) {
+      return true;
+    }
+    return false;
+  }
+
   /**
    * Determine if the element is modified at all.
    *
diff --git a/packages/hadron-document/src/index.ts b/packages/hadron-document/src/index.ts
@@ -1,5 +1,8 @@
 import Document, { Events as DocumentEvents } from './document';
-import Element, { Events as ElementEvents } from './element';
+import Element, {
+  Events as ElementEvents,
+  isInternalFieldPath,
+} from './element';
 import ElementEditor, { Editor } from './editor';
 
 export default Document;
@@ -10,4 +13,5 @@ export {
   ElementEvents,
   ElementEditor,
   Editor,
+  isInternalFieldPath,
 };
diff --git a/packages/hadron-document/src/object-generator.ts b/packages/hadron-document/src/object-generator.ts
diff --git a/packages/hadron-document/test/object-generator.test.ts b/packages/hadron-document/test/object-generator.test.ts

Original file line number	Diff line number	Diff line change
`@@ -116,7 +116,8 @@ class DocumentTableView extends React.Component {`
`116`	`116`	`* @param {Object} data - The data object.`
`117`	`117`	`*/`
`118`	`118`	`handleClone(data) {`
`119`		`- this.props.openInsertDocumentDialog(data.hadronDocument.generateObject(), true);`
	`119`	`+ const clonedDoc = data.hadronDocument.generateObject({ excludeInternalFields: true });`
	`120`	`+ this.props.openInsertDocumentDialog(clonedDoc, true);`
`120`	`121`	`}`
`121`	`122`
`122`	`123`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -159,7 +159,8 @@ class EditableDocument extends React.Component {`
`159`	`159`	`* Handle cloning of the document.`
`160`	`160`	`*/`
`161`	`161`	`handleClone() {`
`162`		`- this.props.openInsertDocumentDialog(this.props.doc.generateObject(), true);`
	`162`	`+ const clonedDoc = this.props.doc.generateObject({ excludeInternalFields: true });`
	`163`	`+ this.props.openInsertDocumentDialog(clonedDoc, true);`
`163`	`164`	`}`
`164`	`165`
`165`	`166`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -157,7 +157,8 @@ class EditableJson extends React.Component {`
`157`	`157`	`* Handle cloning of the json document.`
`158`	`158`	`*/`
`159`	`159`	`handleClone() {`
`160`		`- this.props.openInsertDocumentDialog(this.props.doc.generateObject(), true);`
	`160`	`+ const clonedDoc = this.props.doc.generateObject({ excludeInternalFields: true });`
	`161`	`+ this.props.openInsertDocumentDialog(clonedDoc, true);`
`161`	`162`	`}`
`162`	`163`
`163`	`164`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,8 @@ class ReadonlyDocument extends React.Component {`
`35`	`35`	`}`
`36`	`36`
`37`	`37`	`handleClone = () => {`
`38`		`- this.props.openInsertDocumentDialog(this.props.doc.generateObject(), true);`
	`38`	`+ const clonedDoc = this.props.doc.generateObject({ excludeInternalFields: true });`
	`39`	`+ this.props.openInsertDocumentDialog(clonedDoc, true);`
`39`	`40`	`}`
`40`	`41`
`41`	`42`	`/**`