Add optional password param to runPerformanceTests for encryption benchmarking (#8135)

* Initial plan

* Add optional password param to runPerformanceTests for encryption support and add test:performance:memory:crypto-js npm script

Co-authored-by: pubkey <8926560+pubkey@users.noreply.github.com>

* Simplify STORAGE_PASSWORD ternary per code review

Co-authored-by: pubkey <8926560+pubkey@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: pubkey <8926560+pubkey@users.noreply.github.com>

Author: Copilot

package.json

@@ -476,6 +476,7 @@
     "test:performance:dexie": "npm run transpile && cross-env DEFAULT_STORAGE=dexie CI=true karma start ./config/karma.performance.conf.cjs --single-run",
     "test:performance:memory:browser": "npm run transpile && cross-env DEFAULT_STORAGE=memory CI=true karma start ./config/karma.performance.conf.cjs --single-run",
     "test:performance:memory:node": "npm run transpile && cross-env DEFAULT_STORAGE=memory mocha --config ./config/.mocharc.cjs ./test_tmp/performance.test.js --unhandled-rejections=strict --expose-gc",
+    "test:performance:memory:crypto-js": "npm run transpile && cross-env DEFAULT_STORAGE=memory STORAGE_PASSWORD=test-password mocha --config ./config/.mocharc.cjs ./test_tmp/performance.test.js --unhandled-rejections=strict --expose-gc",
     "test:performance:memory:bun": "npm run transpile && cross-env DEFAULT_STORAGE=memory bun run ./node_modules/mocha/bin/mocha test_tmp/performance.test.js --bail",
     "test:performance:memory:deno": "npm run transpile && cross-env DEFAULT_STORAGE=memory deno run --allow-env --allow-read -A npm:mocha test/performance.test.ts --bail",
     "test:performance:foundationdb": "npm run transpile && cross-env DEFAULT_STORAGE=foundationdb mocha --config ./config/.mocharc.cjs ./test_tmp/performance.test.js --unhandled-rejections=strict --expose-gc",

src/plugins/test-utils/config.ts

@@ -40,7 +40,8 @@ function getEnvVariables() {
         const ret: any = {};
         [
             'DEFAULT_STORAGE',
-            'NODE_ENV'
+            'NODE_ENV',
+            'STORAGE_PASSWORD'
         ].forEach(k => {
             ret[k] = Deno.env.get(k);
         });

src/plugins/test-utils/performance.ts

@@ -53,6 +53,11 @@ export type PerformanceTestConfig = {
      * @default true
      */
     log?: boolean;
+    /**
+     * If set, the database will be created with encryption
+     * and the schema will mark applicable fields as encrypted.
+     */
+    password?: any;
 };
 
 export type PerformanceTestResult = {
@@ -84,7 +89,8 @@ export async function runPerformanceTests(
         parallelQueryAmount = 4,
         insertBatches = 6,
         waitBetweenTests = 100,
-        log = true
+        log = true,
+        password
     } = config;
 
     const totalTimes: { [k: string]: number[]; } = {};
@@ -121,6 +127,15 @@ export async function runPerformanceTests(
 
         // create database
         const schema = averageSchema();
+        if (password) {
+            schema.encrypted = ['deep', 'list'];
+            schema.indexes = schema.indexes!.filter(index => {
+                if (typeof index === 'string') {
+                    return !index.startsWith('deep.');
+                }
+                return !index.some(field => field.startsWith('deep.'));
+            });
+        }
         let collection: RxCollection<AverageSchemaDocumentType>;
         async function createDbWithCollections() {
             if (collection) {
@@ -137,7 +152,8 @@ export async function runPerformanceTests(
                  * creation time.
                 */
                 multiInstance: false,
-                storage
+                storage,
+                password
             });
 
             // create collections

test/performance.test.ts

@@ -3,6 +3,8 @@ import {
 } from '../plugins/core/index.mjs';
 import * as assert from 'assert';
 import {
+    ENV_VARIABLES,
+    getEncryptedStorage,
     isFastMode,
     isDeno,
     runPerformanceTests
@@ -31,10 +33,13 @@ describe('performance.test.ts', () => {
         this.timeout(500 * 1000);
         const runs = isFastMode() ? 1 : 40;
         const perfStorage = config.storage.getPerformanceStorage();
+        const password = ENV_VARIABLES.STORAGE_PASSWORD || undefined;
+        const storage = password ? getEncryptedStorage(perfStorage.storage) : perfStorage.storage;
+        const description = password ? perfStorage.description + '-encrypted' : perfStorage.description;
         await runPerformanceTests(
-            perfStorage.storage,
-            perfStorage.description,
-            { runs }
+            storage,
+            description,
+            { runs, password }
         );
     });
     /**