add a mechanism for performance testing

added a couple of performance tests
made a couple of performance fixes

Author: JohnBrinkman

npm-shrinkwrap.json

@@ -40,6 +40,7 @@
     "eslint-config-airbnb-base": "^15.0.0",
     "eslint-plugin-import": "^2.29.1",
     "eslint-plugin-jest": "^27.6.0",
+    "express": "^4.18.2",
     "html-inline-script-webpack-plugin": "^3.1.0",
     "html-webpack-plugin": "^5.6.0",
     "jest": "^29.3.1",

package.json

@@ -72,6 +72,7 @@ export default class TreeInterpreter {
     this.toString = toString;
     this.debug = debug;
     this.language = language;
+    this.visitFunctions = this.initVisitFunctions();
   }
 
   search(node, value) {
@@ -93,8 +94,8 @@ export default class TreeInterpreter {
     return null;
   }
 
-  visit(n, v = null) {
-    const visitFunctions = {
+  initVisitFunctions() {
+    return {
       Identifier: this.field.bind(this),
       QuotedIdentifier: this.field.bind(this),
 
@@ -399,7 +400,10 @@ export default class TreeInterpreter {
         return refNode;
       },
     };
-    const fn = n && visitFunctions[n.type];
+  }
+
+  visit(n, v = null) {
+    const fn = n && this.visitFunctions[n.type];
     return fn(n, v);
   }
 

src/TreeInterpreter.js

@@ -56,32 +56,30 @@ function isArray(t) {
 }
 
 export function getType(inputObj) {
-  if (inputObj === null) return TYPE_NULL;
-  // if inputObj is a class, then convert it to its base type via JSON
-  const obj = JSON.parse(JSON.stringify(inputObj));
-  switch (Object.prototype.toString.call(obj)) {
-    case '[object String]':
-      return TYPE_STRING;
-    case '[object Number]':
-      return TYPE_NUMBER;
-    case '[object Array]':
+  function simpleType(obj) {
+    if (obj === null) return TYPE_NULL;
+    const t = typeof obj;
+    if (t === 'string') return TYPE_STRING;
+    if (t === 'number') return TYPE_NUMBER;
+    if (t === 'boolean') return TYPE_BOOLEAN;
+    if (Array.isArray(obj)) {
       if (obj.length === 0) return TYPE_EMPTY_ARRAY;
       if (obj.every(a => isArray(getType(a)))) return TYPE_ARRAY_ARRAY;
       if (obj.every(a => getType(a) === TYPE_NUMBER)) return TYPE_ARRAY_NUMBER;
       if (obj.every(a => getType(a) === TYPE_STRING)) return TYPE_ARRAY_STRING;
       return TYPE_ARRAY;
-    case '[object Boolean]':
-      return TYPE_BOOLEAN;
-    case '[object Null]':
-      return TYPE_NULL;
-    default: // '[object Object]':
-      // Check if it's an expref.  If it has, it's been
-      // tagged with a jmespathType attr of 'Expref';
-      if (obj.jmespathType === TOK_EXPREF) {
-        return TYPE_EXPREF;
-      }
-      return TYPE_OBJECT;
+    }
+    // Check if it's an expref.  If it has, it's been
+    // tagged with a jmespathType attr of 'Expref';
+    if (obj.jmespathType === TOK_EXPREF) return TYPE_EXPREF;
+    return TYPE_OBJECT;
   }
+  let type = simpleType(inputObj);
+  if (type !== TYPE_OBJECT) return type;
+  // if inputObj is a class, then convert it to its base type via JSON
+  const obj = JSON.parse(JSON.stringify(inputObj));
+  type = simpleType(obj);
+  return type;
 }
 
 export function isArrayType(t) {

src/matchType.js

@@ -0,0 +1,15 @@
+# Measure Performance
+
+## Steps
+
+1. Create a function that tests your performance scenario inside performanceTest.js
+e.g. to test sort() we added a function sortPerformance()
+2. Update index.js with a path to test this function. e.g. we added app.get('/test/sort', () => {...}) to call sortPerformance()
+3. Update tests.html to include a link to your new path
+4. run index.js: `node --inspect index.js`
+5. open Chrome and navigate to: localhost:3030
+6. Open the dev tools and click on the green node.js cube on the top left
+7. In the new DevTools window, navigate to the Performance tab and start recording
+8. From the browser, click the link for your test
+9. When the test is complete, stop recording
+10. Look at the "Bottom Up" view to see a table of functions and timings

test/performance/README.md

@@ -0,0 +1,22 @@
+import express from 'express';
+import path from 'path';
+import { sortPerformance, sortByPerformance } from './performanceTest.js';
+
+const app = express();
+
+app.get('/', (req, res) => {
+  res.sendFile(path.join(process.cwd(), 'tests.html'));
+});
+
+app.get('/test/sort', (req, res) => {
+  const str = sortPerformance();
+  res.send(str);
+});
+
+app.get('/test/sortby', (req, res) => {
+  const str = sortByPerformance();
+  res.send(str);
+});
+
+// eslint-disable-next-line no-console
+app.listen(3030, 'localhost', () => console.log('Listening on localhost:3030'));

test/performance/index.js

@@ -0,0 +1,37 @@
+/*
+Copyright 2024 Adobe. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+OF ANY KIND, either express or implied. See the License for the specific language
+governing permissions and limitations under the License.
+*/
+import JsonFormula from '../../src/json-formula.js';
+
+export function sortPerformance() {
+  const data = [];
+  for (let i = 0; i < 1000000; i += 1) {
+    data.push(i.toString());
+  }
+
+  const jsonFormula = new JsonFormula();
+  const t1 = performance.now();
+  jsonFormula.search('sort(@)', data);
+  const t2 = performance.now();
+  return `Time to sort: ${Math.round(t2 - t1)}ms`;
+}
+
+export function sortByPerformance() {
+  const data = [];
+  for (let i = 0; i < 1000000; i += 1) {
+    data.push(i.toString());
+  }
+  const jsonFormula = new JsonFormula();
+  const t1 = performance.now();
+  jsonFormula.search('sortBy(@, &@)', data);
+  const t2 = performance.now();
+  return `Time to sortBy: ${Math.round(t2 - t1)}ms`;
+}

test/performance/performanceTest.js

@@ -0,0 +1,8 @@
+<html>
+    <body>
+        <a href="./test/sort">Test sort</a>
+        <br>
+        <br>
+        <a href="./test/sortBy">Test sortBy</a>
+    </body>
+</html>