JavaScript SDK: Implement loadJSON as a temporary measure for Notebook development (#4179)

* Implement `loadJSON`
* Drop support for key parameter

Author: robbear

client/src/sdk/RelAPIMixin.js

@@ -4,6 +4,8 @@ import {
   LabeledAction,
   ListEdbAction,
   ListSourceAction,
+  LoadData,
+  LoadDataAction,
   ModifyWorkspaceAction,
   QueryAction,
   Source,
@@ -171,6 +173,30 @@ function RelAPIMixin(Base) {
       return this.createLabeledAction(actionName, action);
     }
 
+    /**
+     * Constructs an action to load JSON data
+     *
+     * @param {String} name - Name for this action
+     * @param {String} data - String data in JSON format
+     * @param {String} path - Path or url to JSON file if `data` is null
+     * @param {String} relname - Relation name
+     * @returns {LabledAction}
+     */
+     loadJSONAction(name, data, path, relname) {
+      let loadData = new LoadData();
+      loadData.content_type = 'application/json';
+      loadData.data = data;
+      loadData.path = path;
+      loadData.key = [];
+
+      let action = new LoadDataAction();
+      action.rel = relname;
+      action.value = loadData;
+      action.type = 'LoadDataAction';
+
+      return this.createLabeledAction(name, action)
+    }
+
     /**
      * Query the database `dbname`
      *
@@ -325,6 +351,25 @@ function RelAPIMixin(Base) {
       return this.runAction(dbname, action, true, Transaction.ModeEnum.OPEN);
     }
 
+    /**
+     * Import a JSON string or a JSON file
+     * Deprecated - Use the language-internal query instead.
+     *
+     * @param {String} dbname - The name of the database
+     * @param {String} data - A string representing the JSON to import. Provide either `data` or `path`
+     * @param {String} path - Path to a JSON file. Provide either `data` or `path`
+     * @param {String} relname - The relation name to use for referencing the JSON data
+     * @returns {Promise} - Resolves to object: {error, result, response} where
+     * `result` is a `TransactionResult`.
+     */
+    loadJSON(dbname, data, path, relname, actionName = 'action') {
+      console.warn('loadJSON is deprecated. Use the language-internal query instead.');
+
+      const action = this.loadJSONAction(actionName, data, path, relname);
+
+      return this.runAction(dbname, action, false, Transaction.ModeEnum.OPEN);
+    }
+
     //
     // Internal helper calling `transactionPost` while managing
     // the transaction version.

client/test/sdk/RelAPIMixin.test.js

@@ -1,4 +1,6 @@
 const assert = require('assert');
+const fs = require('fs').promises;
+const os = require('os');
 import LocalConnection from '../../src/sdk/LocalConnection.js';
 
 const defaultSources = ["intrinsics", "stdlib", "ml"];
@@ -426,4 +428,114 @@ describe('RelAPIMixin', () => {
       });
     }).timeout(60000);
   });
+
+  describe('#loadJSON from data', () => {
+    const dbname = createUniqueName('db');
+    initializeDatabase(dbname);
+
+    const relname = 'people';
+    const jsonString = JSON.stringify({
+      name: {
+        first: "William",
+        last: "Shakespeare"
+      },
+      age: 100
+    });
+
+    const tempFileName = `${os.tmpdir()}/${dbname}.json`;
+
+    it(`loads the JSON string, ${jsonString}`, () => {
+      return lc.loadJSON(dbname, jsonString, null, relname).then(res => {
+        assert.strictEqual(res.error, null);
+        assert.strictEqual(res.result.problems.length, 0);
+      });
+    }).timeout(60000);
+    it(`finds the relation that was loaded`, () => {
+      return lc.query(dbname, `def output=${relname}`).then(res => {
+        assert.strictEqual(res.error, null);
+        assert.strictEqual(res.result.problems.length, 0);
+        assert.notStrictEqual(res.result.output, null);
+        assert.strictEqual(res.result.output.length, 3);
+      });
+    }).timeout(60000);
+    it(`queries to export_json to ${tempFileName}`, () => {
+      return lc.query(dbname, `def export=export_json[(:path, "${tempFileName}");(:data,${relname})]`).then(res => {
+        assert.strictEqual(res.error, null);
+      });
+    }).timeout(60000);
+    it(`loads the expected JSON from file ${tempFileName}`, () => {
+      return fs.readFile(tempFileName, 'utf-8').then(result => {
+        let json;
+        try {
+          json = JSON.parse(result);
+        }
+        catch(e) {
+          assert.notStrictEqual('The loaded JSON does not parse', null);
+        }
+        const jsonInput = JSON.parse(jsonString);
+        assert.strictEqual(json.name.first, jsonInput.name.first);
+        assert.strictEqual(json.name.last, jsonInput.name.last);
+        assert.strictEqual(json.age, jsonInput.age);
+      });
+    }).timeout(60000);
+  });
+
+  describe('#loadJSON from path', () => {
+    const dbname = createUniqueName('db');
+    initializeDatabase(dbname);
+
+    const relname = 'people';
+    const jsonString = JSON.stringify({
+      name: {
+        first: "William",
+        last: "Shakespeare"
+      },
+      age: 100
+    });
+
+    const tempFileName = `${os.tmpdir()}/${dbname}.json`;
+    const tempFileName1 = `${os.tmpdir()}/${dbname}1.json`;
+
+    it(`writes the JSON string to temp file ${tempFileName}`, () => {
+      return fs.writeFile(tempFileName, jsonString).then(() => {
+        assert(true);
+      }).catch(error => {
+        assert.strictEqual(error, null);
+      });
+    }).timeout(60000);
+    it(`loads the JSON file, ${tempFileName}`, () => {
+      return lc.loadJSON(dbname, null, tempFileName, relname).then(res => {
+        assert.strictEqual(res.error, null);
+        assert.strictEqual(res.result.problems.length, 0);
+      });
+    }).timeout(60000);
+    it(`finds the relation that was loaded`, () => {
+      return lc.query(dbname, `def output=${relname}`).then(res => {
+        assert.strictEqual(res.error, null);
+        assert.strictEqual(res.result.problems.length, 0);
+        assert.notStrictEqual(res.result.output, null);
+        assert.strictEqual(res.result.output.length, 3);
+      });
+    }).timeout(60000);
+    it(`queries to export_json to ${tempFileName1}`, () => {
+      return lc.query(dbname, `def export=export_json[(:path, "${tempFileName1}");(:data,${relname})]`).then(res => {
+        assert.strictEqual(res.error, null);
+      });
+    }).timeout(60000);
+    it(`loads the expected JSON from file ${tempFileName1}`, () => {
+      return fs.readFile(tempFileName1, 'utf-8').then(result => {
+        let json;
+        try {
+          json = JSON.parse(result);
+        }
+        catch(e) {
+          assert.notStrictEqual('The loaded JSON does not parse', null);
+        }
+        const jsonInput = JSON.parse(jsonString);
+        assert.strictEqual(json.name.first, jsonInput.name.first);
+        assert.strictEqual(json.name.last, jsonInput.name.last);
+        assert.strictEqual(json.age, jsonInput.age);
+      });
+    }).timeout(60000);
+  });
 });