]> git.ipfire.org Git - thirdparty/sqlite.git/commitdiff
Add a small test app demonstrating cooperative semi-concurrency of the opfs-sahpool...
authorstephan <stephan@noemail.net>
Fri, 31 Jan 2025 16:25:18 +0000 (16:25 +0000)
committerstephan <stephan@noemail.net>
Fri, 31 Jan 2025 16:25:18 +0000 (16:25 +0000)
FossilOrigin-Name: 09570c55a23e5af76dd2153a5b28a493f498d7d4a08b0089f3074d0a2c5d3d29

ext/wasm/index.html
ext/wasm/tests/opfs/sahpool/index.html [new file with mode: 0644]
ext/wasm/tests/opfs/sahpool/sahpool-pausing.js [new file with mode: 0644]
ext/wasm/tests/opfs/sahpool/sahpool-worker.js [new file with mode: 0644]
manifest
manifest.uuid

index 5d53b62d48914026e81e8f7260fd80a16fd772f5..78ff1d91a8115b42457fe9c437100ad8e1dbfc5a 100644 (file)
             <li><a href='tests/opfs/concurrency/index.html'>OPFS concurrency</a>
               tests using multiple workers.
             </li>
+            <li><a href='tests/opfs/sahpool/index.html'>OPFS SAHPool cooperative semi-concurrency</a>
+              demonstrates usage of the OPFS SAHPool VFS's "pause" feature to coordinate
+              access to a database.
+            </li>
           </ul>
         </li>
         <li><strong>WASMFS</strong>-specific tests which require that
diff --git a/ext/wasm/tests/opfs/sahpool/index.html b/ext/wasm/tests/opfs/sahpool/index.html
new file mode 100644 (file)
index 0000000..f3d07f4
--- /dev/null
@@ -0,0 +1,31 @@
+<!doctype html>
+<html lang="en-us">
+  <head>
+    <meta charset="utf-8">
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+    <link rel="shortcut icon" href="data:image/x-icon;," type="image/x-icon">
+    <link rel="stylesheet" href="../../../common/emscripten.css"/>
+    <link rel="stylesheet" href="../../../common/testing.css"/>
+    <title>sqlite3 tester: OpfsSAHPool Pausing</title>
+    <style></style>
+  </head>
+  <body><h1 id='color-target'></h1>
+
+    <p>
+      This page provides a <em>very basic</em> demonstration of
+      "pausing" and "unpausing" the OPFS SAHPool VFS such that
+      multiple pages or workers can use it by coordinating which
+      handler may have it open at any given time.
+    </p>
+    <div class='input-wrapper'>
+      <input type='checkbox' id='cb-log-reverse'>
+      <label for='cb-log-reverse'>Reverse log order?</label>
+    </div>
+    <div id='test-output'></div>
+    <script>(function(){
+      document.querySelector('h1').innerHTML =
+        document.querySelector('title').innerHTML;
+    })();</script>
+    <script src="sahpool-pausing.js"></script>
+  </body>
+</html>
diff --git a/ext/wasm/tests/opfs/sahpool/sahpool-pausing.js b/ext/wasm/tests/opfs/sahpool/sahpool-pausing.js
new file mode 100644 (file)
index 0000000..737b2e8
--- /dev/null
@@ -0,0 +1,172 @@
+/*
+  2022-10-12
+
+  The author disclaims copyright to this source code.  In place of a
+  legal notice, here is a blessing:
+
+  *   May you do good and not evil.
+  *   May you find forgiveness for yourself and forgive others.
+  *   May you share freely, never taking more than you give.
+
+  ***********************************************************************
+
+  These tests are specific to the opfs-sahpool VFS and are limited to
+  demonstrating its pause/unpause capabilities.
+*/
+'use strict';
+(function(self){
+  let logClass;
+
+  const mapToString = (v)=>{
+    switch(typeof v){
+      case 'number': case 'string': case 'boolean':
+      case 'undefined': case 'bigint':
+        return ''+v;
+      default: break;
+    }
+    if(null===v) return 'null';
+    if(v instanceof Error){
+      v = {
+        message: v.message,
+        stack: v.stack,
+        errorClass: v.name
+      };
+    }
+    return JSON.stringify(v,undefined,2);
+  };
+  const normalizeArgs = (args)=>args.map(mapToString);
+  console.log("Running in the UI thread.");
+  const logTarget = document.querySelector('#test-output');
+  logClass = function(cssClass,...args){
+    const ln = document.createElement('div');
+    if(cssClass){
+      for(const c of (Array.isArray(cssClass) ? cssClass : [cssClass])){
+        ln.classList.add(c);
+      }
+    }
+    ln.append(document.createTextNode(normalizeArgs(args).join(' ')));
+    logTarget.append(ln);
+  };
+  const cbReverse = document.querySelector('#cb-log-reverse');
+  //cbReverse.setAttribute('checked','checked');
+  const cbReverseKey = 'tester1:cb-log-reverse';
+  const cbReverseIt = ()=>{
+    logTarget.classList[cbReverse.checked ? 'add' : 'remove']('reverse');
+    //localStorage.setItem(cbReverseKey, cbReverse.checked ? 1 : 0);
+  };
+  cbReverse.addEventListener('change', cbReverseIt, true);
+  /*if(localStorage.getItem(cbReverseKey)){
+    cbReverse.checked = !!(+localStorage.getItem(cbReverseKey));
+    }*/
+  cbReverseIt();
+
+  const log = (...args)=>{
+    //console.log(...args);
+    logClass('',...args);
+  }
+  const warn = (...args)=>{
+    console.warn(...args);
+    logClass('warning',...args);
+  }
+  const error = (...args)=>{
+    console.error(...args);
+    logClass('error',...args);
+  };
+
+  const toss = (...args)=>{
+    error(...args);
+    throw new Error(args.join(' '));
+  };
+
+  const nextHandlerQueue = [];
+
+  const endOfWork = (passed=true)=>{
+    const eH = document.querySelector('#color-target');
+    const eT = document.querySelector('title');
+    if(passed){
+      log("End of work chain. If you made it this far, you win.");
+      eH.innerText = 'PASS: '+eH.innerText;
+      eH.classList.add('tests-pass');
+      eT.innerText = 'PASS: '+eT.innerText;
+    }else{
+      eH.innerText = 'FAIL: '+eH.innerText;
+      eH.classList.add('tests-fail');
+      eT.innerText = 'FAIL: '+eT.innerText;
+    }
+  };
+
+  const nextHandler = function(workerId,...msg){
+    log(workerId,...msg);
+    (nextHandlerQueue.shift())();
+  };
+
+  const postThen = function(W, msgType, callback){
+    nextHandlerQueue.push(callback);
+    W.postMessage({type:msgType});
+  };
+
+  const runTriangleOfDeath = function(W1, W2){
+    postThen(W1, 'vfs-acquire', function(){
+      postThen(W1, 'db-init', function(){
+        postThen(W1, 'db-query', function(){
+          postThen(W1, 'vfs-pause', function(){
+            postThen(W2, 'vfs-acquire', function(){
+              postThen(W2, 'db-query', function(){
+                postThen(W2, 'vfs-remove', endOfWork);
+              });
+            });
+          });
+        });
+      });
+    });
+  };
+
+  const runTests = function(){
+    log("Running sahpool pausing tests...");
+    const wjs = 'sahpool-worker.js?sqlite3.dir=../../../jswasm';
+    const W1 = new Worker(wjs+'&workerId=w1'),
+          W2 = new Worker(wjs+'&workerId=w2');
+    W1.workerId = 'w1';
+    W2.workerId = 'w2';
+    let initCount = 0;
+    const onmessage = function({data}){
+      //log("onmessage:",data);
+      switch(data.type){
+        case 'vfs-acquired':
+          nextHandler(data.workerId, "VFS acquired");
+          break;
+        case 'vfs-paused':
+          nextHandler(data.workerId, "VFS paused");
+          break;
+        case 'vfs-unpaused':
+          nextHandler(data.workerId, 'VFS unpaused');
+          break;
+        case 'vfs-removed':
+          nextHandler(data.workerId, 'VFS removed');
+          break;
+        case 'db-inited':
+          nextHandler(data.workerId, 'db initialized');
+          break;
+        case 'query-result':
+          nextHandler(data.workerId, 'query result', data.payload);
+          break;
+        case 'log':
+          log(data.workerId, ':', ...data.payload);
+          break;
+        case 'error':
+          error(data.workerId, ':', ...data.payload);
+          endOfWork(false);
+          break;
+        case 'initialized':
+          log(data.workerId, ': Worker initialized',...data.payload);
+          if( 2===++initCount ){
+            runTriangleOfDeath(W1, W2);
+          }
+          break;
+      }
+    };
+    W1.onmessage = W2.onmessage = onmessage;
+  };
+
+  runTests();
+})(globalThis);
diff --git a/ext/wasm/tests/opfs/sahpool/sahpool-worker.js b/ext/wasm/tests/opfs/sahpool/sahpool-worker.js
new file mode 100644 (file)
index 0000000..11815f1
--- /dev/null
@@ -0,0 +1,89 @@
+const searchParams = new URL(self.location.href).searchParams;
+const workerId = searchParams.get('workerId');
+const wPost = (type,...args)=>postMessage({type, workerId, payload:args});
+const log = (...args)=>wPost('log',...args);
+let capi, wasm, S, poolUtil;
+
+const sahPoolConfig = {
+  name: 'opfs-sahpool-pausable',
+  clearOnInit: false,
+  initialCapacity: 3
+};
+
+importScripts(searchParams.get('sqlite3.dir') + '/sqlite3.js');
+
+const sqlExec = function(sql){
+  const db = new poolUtil.OpfsSAHPoolDb('/my.db');
+  try{
+    return db.exec(sql);
+  }finally{
+    db.close();
+  }
+};
+
+const clog = console.log.bind(console);
+globalThis.onmessage = function({data}){
+  clog(workerId+": onmessage:",data);
+  switch(data.type){
+    case 'vfs-acquire':
+      if( poolUtil ){
+        poolUtil.unpauseVfs().then(()=>wPost('vfs-unpaused'));
+      }else{
+        S.installOpfsSAHPoolVfs(sahPoolConfig).then(pu=>{
+          poolUtil = pu;
+          wPost('vfs-acquired');
+        });
+      }
+      break;
+    case 'db-init':
+      try{
+        sqlExec([
+          "DROP TABLE IF EXISTS mytable;",
+          "CREATE TABLE mytable(a);",
+          "INSERT INTO mytable(a) VALUES(11),(22),(33)"
+        ]);
+        wPost('db-inited');
+      }catch(e){
+        wPost('error',e.message);
+      }
+      break;
+    case 'db-query': {
+      const rc = sqlExec({
+        sql: 'select * from mytable order by a',
+        rowMode: 'array',
+        returnValue: 'resultRows'
+      });
+      wPost('query-result',rc);
+      break;
+    }
+    case 'vfs-remove':
+      poolUtil.removeVfs().then(()=>wPost('vfs-removed'));
+      break;
+    case 'vfs-pause':
+      poolUtil.pauseVfs();
+      wPost('vfs-paused');
+      break;
+  }
+};
+
+const hasOpfs = ()=>{
+  return globalThis.FileSystemHandle
+    && globalThis.FileSystemDirectoryHandle
+    && globalThis.FileSystemFileHandle
+    && globalThis.FileSystemFileHandle.prototype.createSyncAccessHandle
+    && navigator?.storage?.getDirectory;
+};
+if( !hasOpfs() ){
+  wPost('error',"OPFS not detected");
+}else{
+  globalThis.sqlite3InitModule().then(async function(sqlite3){
+    S = sqlite3;
+    capi = S.capi;
+    wasm = S.wasm;
+    log("sqlite3 version:",capi.sqlite3_libversion(),
+        capi.sqlite3_sourceid());
+    //return sqlite3.installOpfsSAHPoolVfs(sahPoolConfig).then(pu=>poolUtil=pu);
+  }).then(()=>{
+    wPost('initialized');
+  });
+}
index 6b7707a1c3de755ea47d1f035420407528574cf4..66f90cf80556008835fbad3f3d13e24db456d4cf 100644 (file)
--- a/manifest
+++ b/manifest
@@ -1,5 +1,5 @@
-C Cleanups\sin\sthe\sopfs-sahpool\sVFS\spause/unpause\sfeature\sand\sits\stests.
-D 2025-01-31T14:25:38.298
+C Add\sa\ssmall\stest\sapp\sdemonstrating\scooperative\ssemi-concurrency\sof\sthe\sopfs-sahpool\sVFS\susing\sits\sun/pauseVfs()\sAPIs.
+D 2025-01-31T16:25:18.083
 F .fossil-settings/empty-dirs dbb81e8fc0401ac46a1491ab34a7f2c7c0452f2f06b54ebb845d024ca8283ef1
 F .fossil-settings/ignore-glob 35175cdfcf539b2318cb04a9901442804be81cd677d8b889fcc9149c21f239ea
 F LICENSE.md e108e1e69ae8e8a59e93c455654b8ac9356a11720d3345df2a4743e9590fb20d
@@ -677,7 +677,7 @@ F ext/wasm/fiddle/fiddle-worker.js 850e66fce39b89d59e161d1abac43a181a4caa89ddeea
 F ext/wasm/fiddle/fiddle.js b444a5646a9aac9f3fc06c53d78af5e1912eb235d69a8e6010723e4eb0e9d4a1
 F ext/wasm/fiddle/index.html c79b1741cbeba78f88af0a84cf5ec7de87a909a6a8d10a369b1f4824c66c2088
 F ext/wasm/index-dist.html 56132399702b15d70c474c3f1952541e25cb0922942868f70daf188f024b3730
-F ext/wasm/index.html 10ff3ad190aadccb713109fa55a38e5c1f3c2a8cf05cd31783745bab3f184079
+F ext/wasm/index.html fd3b5185ae5c436626c939b40c274110f7a1d0c1d7c50588c1f449f9a038a9d8
 F ext/wasm/jaccwabyt/jaccwabyt.js 1264710db3cfbcb6887d95665b7aeba60c1126eaef789ca4cf1a4a17d5bc7f54
 F ext/wasm/jaccwabyt/jaccwabyt.md 59a20df389abcc3606eb4eaea7fb7ba14504beb3e345dbea9b99a0618ba3bec8
 F ext/wasm/mkwasmbuilds.c d5885bacf2253bed913cdc7eb16b44f9c9e782133e10600652d1a78841c337af
@@ -700,6 +700,9 @@ F ext/wasm/tester1.c-pp.js 0cda9a3180e743f4a42500cbcde1a14da920b34697eb4b05adeda
 F ext/wasm/tests/opfs/concurrency/index.html 657578a6e9ce1e9b8be951549ed93a6a471f4520a99e5b545928668f4285fb5e
 F ext/wasm/tests/opfs/concurrency/test.js d08889a5bb6e61937d0b8cbb78c9efbefbf65ad09f510589c779b7cc6a803a88
 F ext/wasm/tests/opfs/concurrency/worker.js 0a8c1a3e6ebb38aabbee24f122693f1fb29d599948915c76906681bb7da1d3d2
+F ext/wasm/tests/opfs/sahpool/index.html be736567fd92d3ecb9754c145755037cbbd2bca01385e2732294b53f4c842328
+F ext/wasm/tests/opfs/sahpool/sahpool-pausing.js cd64dc1ea91e99a296eafffd806ce84b540b60010bc344f3ed2b95885a6a9900
+F ext/wasm/tests/opfs/sahpool/sahpool-worker.js a3c5ced52d34675cb2b413461c3ed185b1e9aef41eda1f5d22550ff737d057cd
 F ext/wasm/wasmfs.make 68999f5bd8c489239592d59a420f8c627c99169bbd6fa16a404751f757b9f702
 F magic.txt 5ade0bc977aa135e79e3faaea894d5671b26107cc91e70783aa7dc83f22f3ba0
 F main.mk 043987843e8365dbaf74dce60c11683b62e2bcfcb3122574c14a0324d37a72f3
@@ -2209,8 +2212,8 @@ F tool/version-info.c 3b36468a90faf1bbd59c65fd0eb66522d9f941eedd364fabccd7227350
 F tool/warnings-clang.sh bbf6a1e685e534c92ec2bfba5b1745f34fb6f0bc2a362850723a9ee87c1b31a7
 F tool/warnings.sh 49a486c5069de041aedcbde4de178293e0463ae9918ecad7539eedf0ec77a139
 F tool/win/sqlite.vsix deb315d026cc8400325c5863eef847784a219a2f
-P 775a547eca2b0b3dbb6c03990236128a095cc34d28caec44b9a5072510c75b63
-R af1dcaea4b1a4f1eb6d1dba2bd937843
+P 184ba37702f63196deca91d273e798ca895fbb301938e6264bc82815a4e33149
+R 811999f4e14055835b34337c582dd5f9
 U stephan
-Z 577676d1355d687b76945b6366664411
+Z 6cecf310c2a5b350f628459d87398b50
 # Remove this line to create a well-formed Fossil manifest.
index 77c111648216b824f093744e1f08568d0b90ba39..56f7745c3d9eb81a056b0b8372af9e73e7a02f1b 100644 (file)
@@ -1 +1 @@
-184ba37702f63196deca91d273e798ca895fbb301938e6264bc82815a4e33149
+09570c55a23e5af76dd2153a5b28a493f498d7d4a08b0089f3074d0a2c5d3d29