Added @rgrove/parse-xml to the benchmark

Author: jameslan

benchmark/index.mts

@@ -4,6 +4,7 @@ import * as os from 'node:os';
 import * as libxmljs2 from 'libxmljs2';
 import { XMLParser } from 'fast-xml-parser';
 import { XmlDocument } from 'xmldoc';
+import { parseXml } from '@rgrove/parse-xml';
 import { parseXmlBuffer, parseXmlString } from 'libxml2-wasm';
 
 console.log(`Environment: NodeJs ${process.version} on ${os.type()} ${os.arch()} ${os.cpus()[0].model}\n`);
@@ -16,13 +17,16 @@ for (const fixture of ['fixtures/small.xml', 'fixtures/medium.xml', 'fixtures/la
             const doc = parseXmlString(xmlString);
             doc.dispose();
         }),
-            benny.add('libxml2-wasm(buffer api)', () => {
-                const doc = parseXmlBuffer(xmlBuffer);
-                doc.dispose();
-            }),
+        benny.add('libxml2-wasm(buffer api)', () => {
+            const doc = parseXmlBuffer(xmlBuffer);
+            doc.dispose();
+        }),
         benny.add('libxmljs2', () => {
             libxmljs2.parseXmlString(xmlString);
         }),
+        benny.add('@rgrove/parse-xml', () => {
+            parseXml(xmlString);
+        }),
         benny.add('fast-xml-parser', () => {
             new XMLParser({ ignoreAttributes: false, processEntities: false}).parse(xmlString)
         }),

benchmark/package-lock.json

@@ -4,11 +4,12 @@
   "description": "Benchmark for libxml2-wasm",
   "main": "index.js",
   "scripts": {
-    "test": "ts-node --esm index.mts"
+    "test": "node --loader ts-node/esm index.mts"
   },
   "author": "",
   "license": "MIT",
   "dependencies": {
+    "@rgrove/parse-xml": "^4.1.0",
     "benny": "^3.7.1",
     "fast-xml-parser": "^4.2.7",
     "libxml2-wasm": "file:..",
@@ -18,6 +19,7 @@
     "xmldoc": "^1.3.0"
   },
   "devDependencies": {
+    "@types/benchmark": "^2.1.5",
     "@types/xmldoc": "^1.1.6"
   }
 }

benchmark/package.json

@@ -1,14 +1,28 @@
 # Performance
 
-Javascript internally uses UTF-16/UCS-2 encoding for strings while libxml uses UTF-8.
-This means when we need to convert them on every function invocation.
-Among these invocations, parsing is most impacted because the entire xml needs to be converted.
+One of the challenges of working with Javascript and libxml is that they use different encodings for strings.
+Javascript uses UTF-16/UCS-2, while libxml uses UTF-8.
+This means that we have to convert the strings every time we call a function from libxml.
 
-This library provides two set of parsing functions: String API and Buffer API.
-Please use the **Buffer API** whenever possible to get best throughput.
+To avoid this overhead, this library offers two types of parsing functions: String API and Buffer API.
+The String API takes a Javascript string as input and converts it to a UTF-8 buffer before parsing.
+The Buffer API takes a UTF-8 buffer as input and parses it directly.
+The Buffer API is faster than the String API, especially for large XML documents.
+Therefore, we recommend using the Buffer API whenever possible to improve the performance of your code.
 
 ## Benchmark
 
+The benchmark report below is for the performance of DOM tree parsing, among the following libraries
+
+- Bindings of libxml
+  - String API of libxml2-wasm
+  - Buffer API of libxml2-wasm
+  - [libxmljs2](https://www.npmjs.com/package/libxmljs2)
+- Pure javascript implementation
+  - [@rgrove/parse-xml](https://www.npmjs.com/package/@rgrove/parse-xml)
+  - [fast-xml-parser](https://www.npmjs.com/package/fast-xml-parser)
+  - [xmldoc](https://www.npmjs.com/package/xmldoc)
+
 To run the benchmark, build the lib first,
 
 ```sh
@@ -22,62 +36,70 @@ cd benchmark && npm ci
 npm test
 ```
 
-`libxmljs2` is js binding to native library libxml2; while `fast-xml` and `xmldoc` are pure javascript implementations.
 
 ```
-Environment: NodeJs v18.17.1 on Darwin x64 Intel(R) Core(TM) i9-9880H CPU @ 2.30GHz
+Environment: NodeJs v18.19.0 on Darwin arm64 Apple M3 Max
 
-Running "fixtures/small.xml: 787 bytes" suite...
+Running "fixtures/small.xml: 780 bytes" suite...
 Progress: 100%
 
   libxml2-wasm:
-    64 645 ops/s, ±1.22%    | 44.35% slower
+    120 578 ops/s, ±0.12%   | 28% slower
 
   libxml2-wasm(buffer api):
-    116 157 ops/s, ±0.67%   | fastest
+    167 479 ops/s, ±0.37%   | fastest
 
   libxmljs2:
-    28 240 ops/s, ±9.20%    | 75.69% slower
+    78 688 ops/s, ±1.05%    | 53.02% slower
+
+  @rgrove/parse-xml:
+    78 790 ops/s, ±0.19%    | 52.96% slower
 
   fast-xml-parser:
-    18 091 ops/s, ±7.90%    | 84.43% slower
+    52 077 ops/s, ±0.27%    | 68.91% slower
 
   xmldoc:
-    14 310 ops/s, ±1.88%    | slowest, 87.68% slower
+    41 125 ops/s, ±0.42%    | slowest, 75.44% slower
 
 Running "fixtures/medium.xml: 35562 bytes" suite...
 Progress: 100%
 
   libxml2-wasm:
-    2 706 ops/s, ±0.79%    | 73.57% slower
+    6 013 ops/s, ±0.10%    | 64.87% slower
 
   libxml2-wasm(buffer api):
-    10 237 ops/s, ±0.48%   | fastest
+    17 114 ops/s, ±0.14%   | fastest
 
   libxmljs2:
-    4 779 ops/s, ±8.57%    | 53.32% slower
+    12 414 ops/s, ±1.82%   | 27.46% slower
+
+  @rgrove/parse-xml:
+    5 049 ops/s, ±0.20%    | 70.5% slower
 
   fast-xml-parser:
-    995 ops/s, ±2.09%      | 90.28% slower
+    2 708 ops/s, ±0.46%    | 84.18% slower
 
   xmldoc:
-    844 ops/s, ±1.33%      | slowest, 91.76% slower
+    1 912 ops/s, ±0.41%    | slowest, 88.83% slower
 
 Running "fixtures/large.xml: 2337522 bytes" suite...
 Progress: 100%
 
   libxml2-wasm:
-    22 ops/s, ±1.29%   | 37.14% slower
+    43 ops/s, ±0.11%   | 30.65% slower
 
   libxml2-wasm(buffer api):
-    35 ops/s, ±0.88%   | fastest
+    62 ops/s, ±0.27%   | fastest
 
   libxmljs2:
-    21 ops/s, ±14.92%   | 40% slower
+    50 ops/s, ±1.41%   | 19.35% slower
+
+  @rgrove/parse-xml:
+    19 ops/s, ±0.93%   | 69.35% slower
 
   fast-xml-parser:
-    6 ops/s, ±5.99%    | 82.86% slower
+    16 ops/s, ±0.37%   | 74.19% slower
 
   xmldoc:
-    4 ops/s, ±3.67%    | slowest, 88.57% slower
+    11 ops/s, ±1.13%   | slowest, 82.26% slower
 ```