Fix incorrect usage of sync test runner, remove comments, close databases

Author: Luis Pardo

experimental/javascript-wc-indexeddb/dist/src/speedometer-utils/benchmark.mjs

@@ -1,5 +1,5 @@
 /* eslint-disable no-case-declarations */
-import { TestRunner } from "./test-runner.mjs";
+import { TestRunner, AsyncTestRunner } from "./test-runner.mjs";
 import { Params } from "./params.mjs";
 
 /**
@@ -15,7 +15,8 @@ export class BenchmarkStep {
     }
 
     async runAndRecord(params, suite, test, callback) {
-        const testRunner = new TestRunner(null, null, params, suite, test, callback);
+        const TestRunnerClass = params.useAsyncSteps ? AsyncTestRunner : TestRunner;
+        const testRunner = new TestRunnerClass(null, null, params, suite, test, callback);
         const result = await testRunner.runTest();
         return result;
     }
@@ -107,7 +108,6 @@ export class BenchmarkConnector {
                 if (!suite)
                     console.error(`Suite with the name of "${event.data.name}" not found!`);
                 const { result } = await suite.runAndRecord(params, (test) => this.sendMessage({ type: "step-complete", status: "success", appId: this.appId, name: this.name, test }));
-                console.log(result, result.tests);
                 this.sendMessage({ type: "suite-complete", status: "success", appId: this.appId, result });
                 this.disconnect();
                 break;

experimental/javascript-wc-indexeddb/dist/src/storage/base-storage-manager.js

@@ -1,3 +1,5 @@
+// Base class for storage managers that provides common functionality
+// for tracking pending operations and dispatching events.
 class BaseStorageManager {
     constructor() {
         this.dbName = "todoDB";
@@ -6,17 +8,21 @@ class BaseStorageManager {
         this.pendingAdditions = 0;
         this.pendingToggles = 0;
         this.pendingDeletions = 0;
-    }
-
-    async initDB() {
-        throw new Error("initDB method must be implemented by subclass");
+        this.initDB().then(() => {
+            this._dispatchReadyEvent();
+        });
     }
 
     _ensureDbConnection() {
         if (!this.db)
             throw new Error("Database connection is not established");
     }
 
+    // When runner in Speedometer, additions, completions and removals are
+    // triggered synchonously in a tight loop, increasing the pending counters.
+    // The completion events are dispatched only when all pending operations
+    // of that type are complete.
+
     _handleAddComplete() {
         if (--this.pendingAdditions === 0)
             window.dispatchEvent(new CustomEvent("db-add-completed", {}));
@@ -28,8 +34,10 @@ class BaseStorageManager {
     }
 
     _handleRemoveComplete() {
-        if (--this.pendingDeletions === 0)
+        if (--this.pendingDeletions === 0) {
+            this.db.close();
             window.dispatchEvent(new CustomEvent("db-remove-completed", {}));
+        }
     }
 
     _dispatchReadyEvent() {
@@ -48,6 +56,12 @@ class BaseStorageManager {
         this.pendingDeletions++;
     }
 
+    // Abstract methods that must be implemented by subclasses
+
+    async initDB() {
+        throw new Error("initDB method must be implemented by subclass");
+    }
+
     addTodo(todo) {
         throw new Error("addTodo method must be implemented by subclass");
     }

experimental/javascript-wc-indexeddb/dist/src/storage/dexieDB-manager.js

@@ -4,24 +4,18 @@ import BaseStorageManager from "./base-storage-manager.js";
 class DexieDBManager extends BaseStorageManager {
     constructor() {
         super();
-        this.initDB().then(() => {
-            this._dispatchReadyEvent();
-        });
     }
 
     async initDB() {
         // Delete the existing database first for clean state
         await Dexie.delete(this.dbName);
 
-        // Create new Dexie database
         this.db = new Dexie(this.dbName);
 
-        // Define schema
         this.db.version(1).stores({
             todos: "itemNumber, id, title, completed, priority",
         });
 
-        // Open the database
         await this.db.open();
 
         return this.db;
@@ -31,7 +25,6 @@ class DexieDBManager extends BaseStorageManager {
         this._ensureDbConnection();
 
         this._incrementPendingAdditions();
-        // Add todo item to Dexie
         this.db.todos
             .add(todo)
             .then(() => {
@@ -60,17 +53,13 @@ class DexieDBManager extends BaseStorageManager {
 
         this._incrementPendingToggles();
 
-        // Get the todo item and update it
         this.db.todos
             .get(itemNumber)
             .then((todoItem) => {
                 if (!todoItem)
                     throw new Error(`Todo item with itemNumber '${itemNumber}' not found`);
 
-                // Update the completed status
                 todoItem.completed = completed;
-
-                // Save the updated item back to the database
                 return this.db.todos.put(todoItem);
             })
             .then(() => {
@@ -85,7 +74,6 @@ class DexieDBManager extends BaseStorageManager {
         this._ensureDbConnection();
 
         this._incrementPendingDeletions();
-        // Delete the todo item
         this.db.todos
             .delete(itemNumber)
             .then(() => {

experimental/javascript-wc-indexeddb/dist/src/storage/indexedDB-manager.js

@@ -1,14 +1,6 @@
 import BaseStorageManager from "./base-storage-manager.js";
 
 class IndexedDBManager extends BaseStorageManager {
-    constructor() {
-        super();
-        this.dbVersion = 1;
-        this.initDB().then(() => {
-            this._dispatchReadyEvent();
-        });
-    }
-
     initDB() {
         return new Promise((resolve, reject) => {
             // Delete the existing database first for clean state
@@ -29,7 +21,7 @@ class IndexedDBManager extends BaseStorageManager {
     }
 
     openDatabase(resolve, reject) {
-        const request = indexedDB.open(this.dbName, this.dbVersion);
+        const request = indexedDB.open(this.dbName, 1);
 
         request.onerror = (event) => {
             reject(event.target.error);
@@ -43,7 +35,6 @@ class IndexedDBManager extends BaseStorageManager {
         request.onupgradeneeded = (event) => {
             const db = event.target.result;
 
-            // Create object store (since we're always creating a fresh DB now)
             const store = db.createObjectStore(this.storeName, { keyPath: "itemNumber" });
             store.createIndex("id", "id", { unique: true });
             store.createIndex("title", "title", { unique: false });
@@ -55,7 +46,6 @@ class IndexedDBManager extends BaseStorageManager {
     addTodo(todo) {
         this._ensureDbConnection();
 
-        // Add todo item to IndexedDB
         const transaction = this.db.transaction(this.storeName, "readwrite");
         const store = transaction.objectStore(this.storeName);
 
@@ -116,11 +106,9 @@ class IndexedDBManager extends BaseStorageManager {
     toggleTodo(itemNumber, completed) {
         this._ensureDbConnection();
 
-        // Access the todo item directly by its itemNumber (keyPath)
         const transaction = this.db.transaction(this.storeName, "readwrite");
         const store = transaction.objectStore(this.storeName);
 
-        // Get the todo item directly using its primary key (itemNumber)
         const getRequest = store.get(itemNumber);
 
         this._incrementPendingToggles();
@@ -131,9 +119,7 @@ class IndexedDBManager extends BaseStorageManager {
             if (!todoItem)
                 throw new Error(`Todo item with itemNumber '${itemNumber}' not found`);
 
-            // Update the completed status
             todoItem.completed = completed;
-            // Save the updated item back to the database
             const updateRequest = store.put(todoItem);
 
             updateRequest.onerror = (event) => {

experimental/javascript-wc-indexeddb/src/index.mjs

@@ -1,4 +1,4 @@
-import { BenchmarkConnector } from "/node_modules/speedometer-utils/benchmark.mjs";
+import { BenchmarkConnector } from "/src/speedometer-utils/benchmark.mjs";
 import suites, { appName, appVersion } from "/src/workload-test.mjs";
 
 window.workloadPromises = {};

experimental/javascript-wc-indexeddb/src/speedometer-utils/benchmark.mjs

@@ -1,5 +1,5 @@
 /* eslint-disable no-case-declarations */
-import { TestRunner } from "./test-runner.mjs";
+import { TestRunner, AsyncTestRunner } from "./test-runner.mjs";
 import { Params } from "./params.mjs";
 
 /**
@@ -15,7 +15,8 @@ export class BenchmarkStep {
     }
 
     async runAndRecord(params, suite, test, callback) {
-        const testRunner = new TestRunner(null, null, params, suite, test, callback);
+        const TestRunnerClass = params.useAsyncSteps ? AsyncTestRunner : TestRunner;
+        const testRunner = new TestRunnerClass(null, null, params, suite, test, callback);
         const result = await testRunner.runTest();
         return result;
     }
@@ -107,7 +108,6 @@ export class BenchmarkConnector {
                 if (!suite)
                     console.error(`Suite with the name of "${event.data.name}" not found!`);
                 const { result } = await suite.runAndRecord(params, (test) => this.sendMessage({ type: "step-complete", status: "success", appId: this.appId, name: this.name, test }));
-                console.log(result, result.tests);
                 this.sendMessage({ type: "suite-complete", status: "success", appId: this.appId, result });
                 this.disconnect();
                 break;

experimental/javascript-wc-indexeddb/src/storage/base-storage-manager.js

@@ -1,7 +1,5 @@
-/**
- * Base class for storage managers that provides common functionality
- * for tracking pending operations and dispatching events.
- */
+// Base class for storage managers that provides common functionality
+// for tracking pending operations and dispatching events.
 class BaseStorageManager {
     constructor() {
         this.dbName = "todoDB";
@@ -10,117 +8,72 @@ class BaseStorageManager {
         this.pendingAdditions = 0;
         this.pendingToggles = 0;
         this.pendingDeletions = 0;
+        this.initDB().then(() => {
+            this._dispatchReadyEvent();
+        });
     }
 
-    /**
-     * Initialize the database. This method should be implemented by subclasses.
-     * @returns {Promise} Promise that resolves when the database is initialized
-     */
-    async initDB() {
-        throw new Error("initDB method must be implemented by subclass");
-    }
-
-    /**
-     * Check if the database connection is established
-     * @throws {Error} If database connection is not established
-     */
     _ensureDbConnection() {
         if (!this.db)
             throw new Error("Database connection is not established");
     }
 
-    /**
-     * Handle completion of add operations
-     * @protected
-     */
+    // When runner in Speedometer, additions, completions and removals are
+    // triggered synchonously in a tight loop, increasing the pending counters.
+    // The completion events are dispatched only when all pending operations
+    // of that type are complete.
+
     _handleAddComplete() {
         if (--this.pendingAdditions === 0)
             window.dispatchEvent(new CustomEvent("db-add-completed", {}));
     }
 
-    /**
-     * Handle completion of toggle operations
-     * @protected
-     */
     _handleToggleComplete() {
         if (--this.pendingToggles === 0)
             window.dispatchEvent(new CustomEvent("db-toggle-completed", {}));
     }
 
-    /**
-     * Handle completion of remove operations
-     * @protected
-     */
     _handleRemoveComplete() {
-        if (--this.pendingDeletions === 0)
+        if (--this.pendingDeletions === 0) {
+            this.db.close();
             window.dispatchEvent(new CustomEvent("db-remove-completed", {}));
+        }
     }
 
-    /**
-     * Dispatch the db-ready event when initialization is complete
-     * @protected
-     */
     _dispatchReadyEvent() {
         window.dispatchEvent(new CustomEvent("db-ready", {}));
     }
 
-    /**
-     * Increment the pending additions counter
-     * @protected
-     */
     _incrementPendingAdditions() {
         this.pendingAdditions++;
     }
 
-    /**
-     * Increment the pending toggles counter
-     * @protected
-     */
     _incrementPendingToggles() {
         this.pendingToggles++;
     }
 
-    /**
-     * Increment the pending deletions counter
-     * @protected
-     */
     _incrementPendingDeletions() {
         this.pendingDeletions++;
     }
 
     // Abstract methods that must be implemented by subclasses
 
-    /**
-     * Add a todo item to the database
-     * @param {Object} todo - The todo item to add
-     */
+    async initDB() {
+        throw new Error("initDB method must be implemented by subclass");
+    }
+
     addTodo(todo) {
         throw new Error("addTodo method must be implemented by subclass");
     }
 
-    /**
-     * Get todos from the database
-     * @param {number} upperItemNumber - Upper bound for item numbers (exclusive)
-     * @param {number} count - Maximum number of items to retrieve
-     * @returns {Promise<Array>} Promise that resolves to an array of todo items
-     */
     async getTodos(upperItemNumber, count) {
         throw new Error("getTodos method must be implemented by subclass");
     }
 
-    /**
-     * Toggle the completed status of a todo item
-     * @param {number} itemNumber - The item number to toggle
-     * @param {boolean} completed - The new completed status
-     */
     toggleTodo(itemNumber, completed) {
         throw new Error("toggleTodo method must be implemented by subclass");
     }
 
-    /**
-     * Remove a todo item from the database
-     * @param {number} itemNumber - The item number to remove
-     */
     removeTodo(itemNumber) {
         throw new Error("removeTodo method must be implemented by subclass");
     }