convert long numbers to strings in response

jwillinghalpern · jwillinghalpern · commit a1453bf9b710 · 2022-02-03T22:13:06.000-08:00
diff --git a/README.md b/README.md
@@ -220,18 +220,19 @@ connect('nedb://memory');
 
 After connecting to a datastore you can import and create clients. A client is created using the create method on the Filemaker class. The FileMaker class accepts an object with the following properties:
 
-| Property      |         Type         |                                     Description                                     |
-| ------------- | :------------------: | :---------------------------------------------------------------------------------: |
-| database      | <code>String</code>  |                        The FileMaker database to connect to                         |
-| server        | <code>String</code>  | The FileMaker server to use as the host. **Note:** Must be an http or https Domain. |
-| user          | <code>String</code>  |     The FileMaker user account to be used when authenticating into the Data API     |
-| password      | <code>String</code>  |                       The FileMaker user account's password.                        |
-| [name]        | <code>String</code>  |                               A name for the client.                                |
-| [usage]       | <code>Boolean</code> |          Track Data API usage for this client. **Note:** Default is `true`          |
-| [timeout]     | <code>Number</code>  |     The default timeout time for requests **Note:** Default is 0, (no timeout)      |
-| [concurrency] | <code>Number</code>  |          The number of concurrent requests that will be made to FileMaker           |
-| [proxy]       | <code>Object</code>  |                             settings for a proxy server                             |
-| [agent]       | <code>Object</code>  |                         settings for a custom request agent                         |
+| Property                      |         Type         |                                     Description                                     |
+| ----------------------------- | :------------------: | :---------------------------------------------------------------------------------: |
+| database                      | <code>String</code>  |                        The FileMaker database to connect to                         |
+| server                        | <code>String</code>  | The FileMaker server to use as the host. **Note:** Must be an http or https Domain. |
+| user                          | <code>String</code>  |     The FileMaker user account to be used when authenticating into the Data API     |
+| password                      | <code>String</code>  |                       The FileMaker user account's password.                        |
+| [name]                        | <code>String</code>  |                               A name for the client.                                |
+| [usage]                       | <code>Boolean</code> |          Track Data API usage for this client. **Note:** Default is `true`          |
+| [timeout]                     | <code>Number</code>  |     The default timeout time for requests **Note:** Default is 0, (no timeout)      |
+| [concurrency]                 | <code>Number</code>  |          The number of concurrent requests that will be made to FileMaker           |
+| [proxy]                       | <code>Object</code>  |                             settings for a proxy server                             |
+| [agent]                       | <code>Object</code>  |                         settings for a custom request agent                         |
+| [convertLongNumbersToStrings] | <code>Boolean</code> |   Converts long numbers like Get(UUIDNumber) and Random() to strings in responses   |
 
 :warning: You should only use the agent parameter when absolutely necessary. The Data API was designed to be used on https. Deviating from the intended use should be done with caution.
 
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -43,6 +43,7 @@
     "axios-cookiejar-support": "^1.0.0",
     "form-data": "^3.0.0",
     "into-stream": "^5.1.1",
+    "json-bigint": "^1.0.0",
     "lodash": "^4.17.15",
     "marpat": "^3.0.5",
     "mime-types": "^2.1.26",
diff --git a/src/models/agent.model.js b/src/models/agent.model.js
@@ -11,6 +11,7 @@ const { Connection } = require('./connection.model');
 const axios = require('axios');
 const axiosCookieJarSupport = require('axios-cookiejar-support').default;
 const { omit } = require('../utilities');
+const JSONbig = require('json-bigint')({ storeAsString: true });
 
 const instance = axios.create();
 
@@ -111,6 +112,15 @@ class Agent extends EmbeddedDocument {
        */
       proxy: {
         type: Object
+      },
+      /**
+       * return long numbers as strings instead of truncated e notation.
+       * @member Agent#proxy
+       * @type Boolean
+       */
+      convertLongNumbersToStrings: {
+        type: Boolean,
+        default: () => false
       }
     });
   }
@@ -126,6 +136,8 @@ class Agent extends EmbeddedDocument {
   preInit({ agent, protocol, timeout, concurrency, connection }) {
     this.concurrency = concurrency > 0 ? concurrency : 1;
 
+    this.convertLongNumbersToStrings = !!this.convertLongNumbersToStrings;
+
     this.connection = Connection.create(connection);
     if (agent) this.globalize(protocol, agent);
   }
@@ -213,6 +225,8 @@ class Agent extends EmbeddedDocument {
     const id = uuidv4();
     const interceptor = instance.interceptors.request.use(
       ({ httpAgent, httpsAgent, ...request }) => {
+        if (this.convertLongNumbersToStrings)
+          request.transformResponse = data => JSONbig.parse(data);
         instance.interceptors.request.eject(interceptor);
         return new Promise((resolve, reject) =>
           this.push({
@@ -384,7 +398,7 @@ class Agent extends EmbeddedDocument {
     if (token) {
       this.connection.deactivate(token, id);
     }
-    
+
     this.connection.confirm();
 
     if (error.code) {
diff --git a/src/models/client.model.js b/src/models/client.model.js
@@ -80,6 +80,7 @@ class Client extends Document {
       threshold,
       usage,
       proxy,
+      convertLongNumbersToStrings,
       ...connection
     } = data;
     const protocol = data.server.startsWith('https') ? 'https' : 'http';
@@ -91,6 +92,7 @@ class Client extends Document {
       threshold,
       concurrency,
       protocol,
+      convertLongNumbersToStrings,
       connection
     });
   }
@@ -387,7 +389,9 @@ class Client extends Document {
         .then(response => response.data)
         .then(body => this.data.outgoing(body))
         .then(body => this._save(body))
-        .then(body => parseScriptResult(body))
+        .then(body =>
+          parseScriptResult(body, this.agent.convertLongNumbersToStrings)
+        )
         .then(result => resolve(result))
         .catch(error => this._save(reject(error)))
     );
@@ -450,7 +454,9 @@ class Client extends Document {
         .then(response => response.data)
         .then(body => this.data.outgoing(body))
         .then(body => this._save(body))
-        .then(body => parseScriptResult(body))
+        .then(body =>
+          parseScriptResult(body, this.agent.convertLongNumbersToStrings)
+        )
         .then(response =>
           resolve(parameters.merge ? Object.assign(data, response) : response)
         )
@@ -505,7 +511,9 @@ class Client extends Document {
         .then(response => response.data)
         .then(body => this.data.outgoing(body))
         .then(body => this._save(body))
-        .then(body => parseScriptResult(body))
+        .then(body =>
+          parseScriptResult(body, this.agent.convertLongNumbersToStrings)
+        )
         .then(body =>
           resolve(
             parameters.merge
@@ -555,7 +563,9 @@ class Client extends Document {
         .then(response => response.data)
         .then(body => this.data.outgoing(body))
         .then(body => this._save(body))
-        .then(body => parseScriptResult(body))
+        .then(body =>
+          parseScriptResult(body, this.agent.convertLongNumbersToStrings)
+        )
         .then(result => resolve(result))
         .catch(error => this._save(reject(error)))
     );
@@ -605,7 +615,9 @@ class Client extends Document {
         .then(response => response.data)
         .then(body => this.data.outgoing(body))
         .then(body => this._save(body))
-        .then(body => parseScriptResult(body))
+        .then(body =>
+          parseScriptResult(body, this.agent.convertLongNumbersToStrings)
+        )
         .then(result => resolve(result))
         .catch(error => this._save(reject(error)))
     );
@@ -659,7 +671,9 @@ class Client extends Document {
         .then(response => response.data)
         .then(body => this.data.outgoing(body))
         .then(body => this._save(body))
-        .then(body => parseScriptResult(body))
+        .then(body =>
+          parseScriptResult(body, this.agent.convertLongNumbersToStrings)
+        )
         .then(result => resolve(result))
         .catch(error => this._save(reject(error)))
     );
@@ -716,7 +730,9 @@ class Client extends Document {
         .then(response => response.data)
         .then(body => this.data.outgoing(body))
         .then(body => this._save(body))
-        .then(body => parseScriptResult(body))
+        .then(body =>
+          parseScriptResult(body, this.agent.convertLongNumbersToStrings)
+        )
         .then(result => resolve(result))
         .catch(error => {
           this._save();
@@ -829,7 +845,9 @@ class Client extends Document {
             .then(response => response.data)
             .then(body => this.data.outgoing(body))
             .then(body => this._save(body))
-            .then(body => parseScriptResult(body))
+            .then(body =>
+              parseScriptResult(body, this.agent.convertLongNumbersToStrings)
+            )
             .then(response => Object.assign(response, { recordId: resolvedId }))
         )
         .then(response => resolve(response))
@@ -895,7 +913,12 @@ class Client extends Document {
         .then(response => response.data)
         .then(body => this.data.outgoing(body))
         .then(body => this._save(body))
-        .then(body => pick(parseScriptResult(body), 'scriptResult'))
+        .then(body =>
+          pick(
+            parseScriptResult(body, this.agent.convertLongNumbersToStrings),
+            'scriptResult'
+          )
+        )
         .then(result => resolve(result))
         .catch(error => this._save(reject(error)))
     );
diff --git a/src/utilities/conversion.utilities.js b/src/utilities/conversion.utilities.js
@@ -1,6 +1,7 @@
 'use strict';
 
 const _ = require('lodash');
+const JSONbig = require('json-bigint')({ storeAsString: true });
 
 /**
  * @class Conversion Utilities
@@ -109,6 +110,17 @@ const omit = (data, properties) =>
  */
 const parse = value => (isJSON(value) ? JSON.parse(value) : value);
 
+/**
+ * @function parseBigInt
+ * @public
+ * @memberof Conversion Utilities
+ * @description The parseBigInt function performs a try catch before attempting to parse the value as JSON. If the value is not valid JSON it wil return the value. Long numbers are returned as strings.
+ * @see isJSON
+ * @param  {Any} value The value to attempt to parse.
+ * @return {Object|Any} A JSON object or array of objects without the properties passed to it
+ */
+const parseBigInt = value => (isJSON(value) ? JSONbig.parse(value) : value);
+
 /**
  * @function pick
  * @public
@@ -158,5 +170,6 @@ module.exports = {
   omit,
   pick,
   parse,
+  parseBigInt,
   deepMapKeys
 };
diff --git a/src/utilities/filemaker.utilities.js b/src/utilities/filemaker.utilities.js
@@ -1,7 +1,7 @@
 'use strict';
 
 const _ = require('lodash');
-const { stringify, parse } = require('./conversion.utilities');
+const { stringify, parse, parseBigInt } = require('./conversion.utilities');
 
 /** @class Filemaker Utilities */
 
@@ -111,19 +111,22 @@ const sanitizeParameters = (parameters, safeParameters) =>
   );
 
 /**
- * @function parseScriptResults
+ * @function parseScriptResult
  * @public
  * @memberof Filemaker Utilities
  * @description The parseScriptResults function filters the FileMaker DAPI response by testing if a script was triggered
  * with the request, then either selecting the response, script error, and script result from the
  * response or selecting just the response.
  * @param  {Object} data The response recieved from the FileMaker DAPI.
+ * @param  {boolean} convertLongNumbersToStrings convert long numbers to strings
  * @return {Object}      A json object containing the selected data from the Data API Response.
  */
-const parseScriptResult = data =>
+const parseScriptResult = (data, convertLongNumbersToStrings) =>
   _.mapValues(data.response, (value, property, object) =>
     property.includes('scriptResult')
-      ? (object[property] = parse(value))
+      ? (object[property] = convertLongNumbersToStrings
+          ? parseBigInt(value)
+          : parse(value))
       : value
   );
 
diff --git a/test/agent.test.js b/test/agent.test.js
diff --git a/test/utilities.test.js b/test/utilities.test.js
