fix: try and preserve Double and Long/Int64 types in the json editor COMPASS-8337 (#7119)

try and preserve Double and Long/Int64 types in the json editor

Author: lerouxb

packages/compass-crud/src/components/json-editor.tsx

@@ -136,7 +136,9 @@ const JSONEditor: React.FunctionComponent<JSONEditorProps> = ({
   }, []);
 
   const onUpdate = useCallback(() => {
-    doc.apply(HadronDocument.FromEJSON(value || ''));
+    const newDoc = HadronDocument.FromEJSON(value || '');
+    newDoc.preserveTypes(doc);
+    doc.apply(newDoc);
     void replaceDocument?.(doc);
   }, [doc, replaceDocument, value]);
 

packages/hadron-document/src/document.ts

@@ -97,6 +97,20 @@ export class Document extends EventEmitter<
     }
   }
 
+  preserveTypes(other: Document): void {
+    const thisDoc = this.generateObject();
+
+    for (const key of Object.keys(thisDoc)) {
+      const thisElement = this.get(key);
+      const otherElement = other.get(key);
+      if (!thisElement || !otherElement) {
+        continue;
+      }
+
+      thisElement.preserveType(otherElement);
+    }
+  }
+
   /**
    * Generate the javascript object for this document.
    *

packages/hadron-document/src/element.ts

@@ -194,12 +194,46 @@ export class Element extends EventEmitter {
       this.currentValue = value;
       this.elements = undefined;
     } else {
+      // if they are both integer types and equal if made the previous type, don't update.
       this.currentValue = value;
     }
     this.setValid();
     this._bubbleUp(ElementEvents.Edited, this);
   }
 
+  preserveType(otherElement: Element): void {
+    switch (this.currentType) {
+      case 'Object': {
+        if (!this.elements) {
+          return;
+        }
+        for (const child of this.elements) {
+          const otherChild = otherElement.get(child.currentKey);
+          if (!otherChild) {
+            continue;
+          }
+          child.preserveType(otherChild);
+        }
+        break;
+      }
+      case 'Int32': {
+        const otherType = otherElement.currentType;
+        if (otherType === 'Double') {
+          this.changeType('Double');
+        }
+        if (otherType === 'Int64') {
+          this.changeType('Int64');
+        }
+        break;
+      }
+      default:
+        // NOTE: Purposefully leaving Array elements alone because deciding
+        // whether to turn on Int32 into a Double or Int64 or not is complex and
+        // error-prone. Also leaving every other type alone.
+        break;
+    }
+  }
+
   changeType(newType: TypeCastTypes): void {
     if (newType === 'Object') {
       this._convertToEmptyObject();

packages/hadron-document/test/document.test.ts

@@ -2392,6 +2392,72 @@ describe('Document', function () {
         );
       });
     });
+
+    describe('#preserveTypes', function () {
+      it('keeps unnecessary double type', function () {
+        const oldDoc = new Document({
+          number: new Double(1),
+          different: new Double(1),
+          sameArray: [new Double(1), new Double(2)],
+          mixedArray: ['foo', new Double(1), new Int32(2), new Long(3)],
+          object: {
+            number: new Double(1),
+            different: new Double(1),
+          },
+        });
+        const newDoc = new Document({
+          number: new Double(2),
+          different: new Long(1),
+          sameArray: [new Int32(1), new Double(2.2)],
+          mixedArray: ['foo', new Double(1), new Int32(2), new Long(3)],
+          object: {
+            number: new Int32(1),
+            different: new Long(3),
+          },
+        });
+
+        newDoc.preserveTypes(oldDoc);
+
+        expect(newDoc.get('number')?.currentType).to.equal('Double');
+        expect(newDoc.get('different')?.currentType).to.equal('Int64');
+        expect(newDoc.get('object')?.get('number')?.currentType).to.equal(
+          'Double'
+        );
+        expect(newDoc.get('object')?.get('different')?.currentType).to.equal(
+          'Int64'
+        );
+      });
+
+      it('keeps unnecessary long type', function () {
+        const oldDoc = new Document({
+          number: new Long(1),
+          different: new Long(1),
+          object: {
+            number: new Long(1),
+            different: new Long(1),
+          },
+        });
+        const newDoc = new Document({
+          number: new Int32(2),
+          different: new Double(1),
+          object: {
+            number: new Int32(1),
+            different: new Double(3),
+          },
+        });
+
+        newDoc.preserveTypes(oldDoc);
+
+        expect(newDoc.get('number')?.currentType).to.equal('Int64');
+        expect(newDoc.get('different')?.currentType).to.equal('Double');
+        expect(newDoc.get('object')?.get('number')?.currentType).to.equal(
+          'Int64'
+        );
+        expect(newDoc.get('object')?.get('different')?.currentType).to.equal(
+          'Double'
+        );
+      });
+    });
   });
 
   context('when a document is expanded/collapsed', function () {