ext/wasm/demo-worker1-promiser.c-pp.js

   1 /*
   2   2022-08-23
   3
   4   The author disclaims copyright to this source code.  In place of a
   5   legal notice, here is a blessing:
   6
   7   *   May you do good and not evil.
   8   *   May you find forgiveness for yourself and forgive others.
   9   *   May you share freely, never taking more than you give.
  10
  11   ***********************************************************************
  12
  13   Demonstration of the sqlite3 Worker API #1 Promiser: a Promise-based
  14   proxy for for the sqlite3 Worker #1 API.
  15 */
  16 //#if target=es6-module
  17 import {default as promiserFactory} from "./jswasm/sqlite3-worker1-promiser.mjs";
  18 //#else
  19 "use strict";
  20 const promiserFactory = globalThis.sqlite3Worker1Promiser.v2;
  21 delete globalThis.sqlite3Worker1Promiser;
  22 //#endif
  23 (async function(){
  24   const T = globalThis.SqliteTestUtil;
  25   const eOutput = document.querySelector('#test-output');
  26   const warn = console.warn.bind(console);
  27   const error = console.error.bind(console);
  28   const log = console.log.bind(console);
  29   const logHtml = async function(cssClass,...args){
  30     log.apply(this, args);
  31     const ln = document.createElement('div');
  32     if(cssClass) ln.classList.add(cssClass);
  33     ln.append(document.createTextNode(args.join(' ')));
  34     eOutput.append(ln);
  35   };
  36
  37   let startTime;
  38   const testCount = async ()=>{
  39     logHtml("","Total test count:",T.counter+". Total time =",(performance.now() - startTime),"ms");
  40   };
  41
  42   const promiserConfig = {
  43 //#ifnot target=es6-module
  44     /**
  45        The v1 interfaces uses an onready function. The v2 interface optionally
  46        accepts one but does not require it. If provided, it is called _before_
  47        the promise is resolved, and the promise is rejected if onready() throws.
  48     */
  49     onready: function(f){
  50       /* f === the function returned by promiserFactory().
  51          Ostensibly (f === workerPromise) but this function is
  52          called before the promiserFactory() Promise resolves, so
  53          before workerPromise is set. */
  54       console.warn("This is the v2 interface - you don't need an onready() function.");
  55     },
  56 //#endif
  57     debug: 1 ? undefined : (...args)=>console.debug('worker debug',...args),
  58     onunhandled: function(ev){
  59       error("Unhandled worker message:",ev.data);
  60     },
  61     onerror: function(ev){
  62       error("worker1 error:",ev);
  63     }
  64   };
  65   const workerPromise = await promiserFactory(promiserConfig)
  66         .then((func)=>{
  67           console.log("Init complete. Starting tests momentarily.");
  68           globalThis.sqlite3TestModule.setStatus(null)/*hide the HTML-side is-loading spinner*/;
  69           return func;
  70         });
  71
  72   const wtest = async function(msgType, msgArgs, callback){
  73     if(2===arguments.length && 'function'===typeof msgArgs){
  74       callback = msgArgs;
  75       msgArgs = undefined;
  76     }
  77     const p = 1
  78           ? workerPromise({type: msgType, args:msgArgs})
  79           : workerPromise(msgType, msgArgs);
  80     return callback ? p.then(callback).finally(testCount) : p;
  81   };
  82
  83   let sqConfig;
  84   const runTests = async function(){
  85     const dbFilename = '/testing2.sqlite3';
  86     startTime = performance.now();
  87
  88     await wtest('config-get', (ev)=>{
  89       const r = ev.result;
  90       log('sqlite3.config subset:', r);
  91       T.assert('boolean' === typeof r.bigIntEnabled);
  92       sqConfig = r;
  93     });
  94     logHtml('',
  95             "Sending 'open' message and waiting for its response before continuing...");
  96
  97     await wtest('open', {
  98       filename: dbFilename,
  99       simulateError: 0 /* if true, fail the 'open' */,
 100     }, function(ev){
 101       const r = ev.result;
 102       log("then open result",r);
 103       T.assert(ev.dbId === r.dbId)
 104         .assert(ev.messageId)
 105         .assert('string' === typeof r.vfs);
 106       promiserConfig.dbId = ev.dbId;
 107     }).then(runTests2);
 108   };
 109
 110   const runTests2 = async function(){
 111     const mustNotReach = ()=>toss("This is not supposed to be reached.");
 112
 113     await wtest('exec',{
 114       sql: ["create table t(a,b)",
 115             "insert into t(a,b) values(1,2),(3,4),(5,6)"
 116            ].join(';'),
 117       resultRows: [], columnNames: [],
 118       countChanges: sqConfig.bigIntEnabled ? 64 : true
 119     }, function(ev){
 120       ev = ev.result;
 121       T.assert(0===ev.resultRows.length)
 122         .assert(0===ev.columnNames.length)
 123         .assert(sqConfig.bigIntEnabled
 124                 ? (3n===ev.changeCount)
 125                 : (3===ev.changeCount));
 126     });
 127
 128     await wtest('exec',{
 129       sql: 'select a a, b b from t order by a',
 130       resultRows: [], columnNames: [],
 131     }, function(ev){
 132       ev = ev.result;
 133       T.assert(3===ev.resultRows.length)
 134         .assert(1===ev.resultRows[0][0])
 135         .assert(6===ev.resultRows[2][1])
 136         .assert(2===ev.columnNames.length)
 137         .assert('b'===ev.columnNames[1]);
 138     });
 139
 140     await wtest('exec',{
 141       sql: 'select a a, b b from t order by a',
 142       resultRows: [], columnNames: [],
 143       rowMode: 'object',
 144       countChanges: true
 145     }, function(ev){
 146       ev = ev.result;
 147       T.assert(3===ev.resultRows.length)
 148         .assert(1===ev.resultRows[0].a)
 149         .assert(6===ev.resultRows[2].b)
 150         .assert(0===ev.changeCount);
 151     });
 152
 153     await wtest(
 154       'exec',
 155       {sql:'intentional_error'},
 156       mustNotReach
 157     ).catch((e)=>{
 158       warn("Intentional error:",e);
 159     });
 160
 161     await wtest('exec',{
 162       sql:'select 1 union all select 3',
 163       resultRows: []
 164     }, function(ev){
 165       ev = ev.result;
 166       T.assert(2 === ev.resultRows.length)
 167         .assert(1 === ev.resultRows[0][0])
 168         .assert(3 === ev.resultRows[1][0])
 169         .assert(undefined === ev.changeCount);
 170     });
 171
 172     const resultRowTest1 = function f(ev){
 173       if(undefined === f.counter) f.counter = 0;
 174       if(null === ev.rowNumber){
 175         /* End of result set. */
 176         T.assert(undefined === ev.row)
 177           .assert(2===ev.columnNames.length)
 178           .assert('a'===ev.columnNames[0])
 179           .assert('B'===ev.columnNames[1]);
 180       }else{
 181         T.assert(ev.rowNumber > 0);
 182         ++f.counter;
 183       }
 184       log("exec() result row:",ev);
 185       T.assert(null === ev.rowNumber || 'number' === typeof ev.row.B);
 186     };
 187     await wtest('exec',{
 188       sql: 'select a a, b B from t order by a limit 3',
 189       callback: resultRowTest1,
 190       rowMode: 'object'
 191     }, function(ev){
 192       T.assert(3===resultRowTest1.counter);
 193       resultRowTest1.counter = 0;
 194     });
 195
 196     const resultRowTest2 = function f(ev){
 197       if(null === ev.rowNumber){
 198         /* End of result set. */
 199         T.assert(undefined === ev.row)
 200           .assert(1===ev.columnNames.length)
 201           .assert('a'===ev.columnNames[0])
 202       }else{
 203         T.assert(ev.rowNumber > 0);
 204         f.counter = ev.rowNumber;
 205       }
 206       log("exec() result row:",ev);
 207       T.assert(null === ev.rowNumber || 'number' === typeof ev.row);
 208     };
 209     await wtest('exec',{
 210       sql: 'select a a from t limit 3',
 211       callback: resultRowTest2,
 212       rowMode: 0
 213     }, function(ev){
 214       T.assert(3===resultRowTest2.counter);
 215     });
 216
 217     const resultRowTest3 = function f(ev){
 218       if(null === ev.rowNumber){
 219         T.assert(3===ev.columnNames.length)
 220           .assert('foo'===ev.columnNames[0])
 221           .assert('bar'===ev.columnNames[1])
 222           .assert('baz'===ev.columnNames[2]);
 223       }else{
 224         f.counter = ev.rowNumber;
 225         T.assert('number' === typeof ev.row);
 226       }
 227     };
 228     await wtest('exec',{
 229       sql: "select 'foo' foo, a bar, 'baz' baz  from t limit 2",
 230       callback: resultRowTest3,
 231       columnNames: [],
 232       rowMode: '$bar'
 233     }, function(ev){
 234       log("exec() result row:",ev);
 235       T.assert(2===resultRowTest3.counter);
 236     });
 237
 238     await wtest('exec',{
 239       sql:[
 240         'pragma foreign_keys=0;',
 241         // ^^^ arbitrary query with no result columns
 242         'select a, b from t order by a desc; select a from t;'
 243         // exec() only honors SELECT results from the first
 244         // statement with result columns (regardless of whether
 245         // it has any rows).
 246       ],
 247       rowMode: 1,
 248       resultRows: []
 249     },function(ev){
 250       const rows = ev.result.resultRows;
 251       T.assert(3===rows.length).
 252         assert(6===rows[0]);
 253     });
 254
 255     await wtest('exec',{sql: 'delete from t where a>3'});
 256
 257     await wtest('exec',{
 258       sql: 'select count(a) from t',
 259       resultRows: []
 260     },function(ev){
 261       ev = ev.result;
 262       T.assert(1===ev.resultRows.length)
 263         .assert(2===ev.resultRows[0][0]);
 264     });
 265
 266     await wtest('export', function(ev){
 267       ev = ev.result;
 268       T.assert('string' === typeof ev.filename)
 269         .assert(ev.byteArray instanceof Uint8Array)
 270         .assert(ev.byteArray.length > 1024)
 271         .assert('application/x-sqlite3' === ev.mimetype);
 272     });
 273
 274     /***** close() tests must come last. *****/
 275     await wtest('close',{},function(ev){
 276       T.assert('string' === typeof ev.result.filename);
 277     });
 278
 279     await wtest('close', (ev)=>{
 280       T.assert(undefined === ev.result.filename);
 281     }).finally(()=>logHtml('',"That's all, folks!"));
 282   }/*runTests2()*/;
 283
 284   runTests();
 285 })();