textbrowser 0.54.9 → 0.54.11

package/CHANGES.md

@@ -1,5 +1,13 @@
 # CHANGES to `textbrowser`
 
+## 0.54.11
+
+- fix: max concurrent prefetches
+
+## 0.54.10
+
+- fix: more logging
+
 ## 0.54.9
 
 - fix: logging worker issues

package/dist/activateCallback-es.js

@@ -55,10 +55,12 @@ async function activateCallback ({
   //  anyways); also important to avoid conflicts with
   //  already-running versions upon future sw updates
   log('Activate: Callback called');
+  log('Activate: Fetching files manifest', files);
   const r = await fetch(files);
   const {groups} = /** @type {import('./utils/WorkInfo.js').FilesObject} */ (
     await r.json()
   );
+  log('Activate: Manifest loaded; groups:', groups.length);
 
   /* eslint-disable jsdoc/reject-any-type -- Generic */
   /**
@@ -67,6 +69,7 @@ async function activateCallback ({
    */
   const addJSONFetch = (arr, path) => {
     /* eslint-enable jsdoc/reject-any-type -- Generic */
+    log('Activate: Queueing JSON fetch', basePath + path);
     arr.push(
       (async () => (await fetch(basePath + path)).json())()
     );
@@ -89,6 +92,13 @@ async function activateCallback ({
   const metadataFiles = [];
   groups.forEach(
     ({files: fileObjs, metadataBaseDirectory, schemaBaseDirectory}) => {
+      log(
+        'Activate: Processing group',
+        metadataBaseDirectory,
+        schemaBaseDirectory,
+        'files:',
+        fileObjs.length
+      );
       fileObjs.forEach(({file: {$ref: filePath}, metadataFile, schemaFile, name}) => {
         // We don't i18nize the name here
         dataFileNames.push(name);
@@ -98,6 +108,7 @@ async function activateCallback ({
       });
     }
   );
+  log('Activate: Awaiting queued fetches; works:', dataFiles.length);
   const promises = await Promise.all([
     ...dataFiles, ...schemaFiles, ...metadataFiles
   ]);
@@ -109,11 +120,14 @@ async function activateCallback ({
 
   log('Activate: Files fetched');
   const dbName = namespace + '-textbrowser-cache-data';
+  log('Activate: Deleting existing database', dbName);
   indexedDB.deleteDatabase(dbName);
   return new Promise((resolve, reject) => {
+    log('Activate: Opening database', dbName);
     const req = indexedDB.open(dbName);
     // @ts-expect-error Ok
     req.addEventListener('upgradeneeded', ({target: {result: db}}) => {
+      log('Activate: Database upgrade needed', dbName);
       db.onversionchange = () => {
         db.close();
         const err = /** @type {Error & {type: string}} */ (new Error('versionchange'));
@@ -122,6 +136,7 @@ async function activateCallback ({
       };
       dataFileResponses.forEach(({data: tableRows}, i) => {
         const dataFileName = dataFileNames[i];
+        log('Activate: Creating object store', dataFileName, 'rows:', tableRows.length);
         const store = db.createObjectStore('files-to-cache-' + dataFileName);
 
         const schemaFileResponse = schemaFileResponses[i];
@@ -180,6 +195,12 @@ async function activateCallback ({
         });
 
         const uniqueColumnIndexes = [...new Set(columnIndexes)];
+        log(
+          'Activate: Preparing rows for store',
+          dataFileName,
+          'unique indexes:',
+          uniqueColumnIndexes.length
+        );
 
         tableRows.forEach((tableRow, j) => {
           // Todo: Optionally send notice when complete
@@ -203,6 +224,7 @@ async function activateCallback ({
           // log('objRow', objRow);
           store.put(objRow, j);
         });
+        log('Activate: Finished object store population', dataFileName);
       });
     });
 
@@ -218,6 +240,7 @@ async function activateCallback ({
      * @param {Event & {error?: Error}} ev
      */
     const onerr = (ev) => {
+      log('Activate: Database request error event fired');
       const error = /** @type {Error & {type: string}} */ (
         ev.error ?? new Error('dbError')
       );

package/dist/sw-helper.js

@@ -184,7 +184,7 @@ function swHelper (self) {
    * @returns {Promise<void>}
    */
   async function install (time) {
-    post({type: 'beginInstall'});
+    await post({type: 'beginInstall'});
     log(`Install: Trying, attempt ${time}`);
     const now = Date.now();
     const json = await getJSON(/** @type {string} */ (pathToUserJSON));
@@ -249,7 +249,9 @@ function swHelper (self) {
     }, 10000);
     // .map((url) => url === 'index.html' ? new Request(url, {cache: 'reload'}) : url)
     try {
-      const cachePromises = urlsToPrefetch.map(async (urlToPrefetch, idx) => {
+      const maxConcurrentPrefetches = 8;
+      const prefetchTimeoutMs = 120000;
+      const fetchAndCacheAsset = async (urlToPrefetch, idx) => {
         // This constructs a new URL object using the service worker's script
         //   location as the base for relative URLs.
         pendingAssets.add(urlToPrefetch);
@@ -260,8 +262,14 @@ function swHelper (self) {
         const url = new URL(urlToPrefetch, location.href);
         url.search += (url.search ? '&' : '?') + 'cache-bust=' + now;
         const request = new Request(url, {mode: 'no-cors'});
+        const controller = new AbortController();
+        const timeout = setTimeout(() => {
+          controller.abort();
+        }, prefetchTimeoutMs);
         try {
-          const response = await fetch(request);
+          const response = await fetch(request, {
+            signal: controller.signal
+          });
           if (response.status >= 400) {
             throw new Error('request for ' + urlToPrefetch +
                         ' failed with status ' + response.statusText);
@@ -272,15 +280,36 @@ function swHelper (self) {
           return;
         } catch (error) {
           pendingAssets.delete(urlToPrefetch);
+          if (
+            error && typeof error === 'object' && 'name' in error &&
+            error.name === 'AbortError'
+          ) {
+            error = new Error(
+              `Timed out after ${prefetchTimeoutMs}ms while fetching ${urlToPrefetch}`
+            );
+          }
           logError(
             /** @type {Error} */
             (error),
             `Not caching ${urlToPrefetch} due to ${error}`
           );
           throw error;
+        } finally {
+          clearTimeout(timeout);
+        }
+      };
+
+      let nextAssetIndex = 0;
+      const workers = Array.from({
+        length: Math.min(maxConcurrentPrefetches, urlsToPrefetch.length)
+      }, async () => {
+        while (nextAssetIndex < urlsToPrefetch.length) {
+          const idx = nextAssetIndex;
+          nextAssetIndex++;
+          await fetchAndCacheAsset(urlsToPrefetch[idx], idx);
         }
       });
-      await Promise.all(cachePromises);
+      await Promise.all(workers);
       log('Install: Pre-fetching complete.');
     } catch (error) {
       logError(
@@ -300,7 +329,7 @@ function swHelper (self) {
 
     // Although we only need one client to which to send
     //   arguments, we want to signal phase complete to all
-    post({type: 'finishedInstall'});
+    await post({type: 'finishedInstall'});
   }
 
   /**
@@ -309,7 +338,12 @@ function swHelper (self) {
    * @returns {Promise<void>}
    */
   async function activate (time) {
-    post({type: 'beginActivate'});
+    console.log('Activate event worker callback entered', time);
+    await post({
+      type: 'log',
+      message: `Activate: Event callback entered (attempt ${time})`
+    });
+    await post({type: 'beginActivate'});
     log(`Activate: Trying, attempt ${time}`);
     const [json, cacheNames] = await Promise.all([
       getJSON(/** @type {string} */ (pathToUserJSON)),
@@ -329,9 +363,12 @@ function swHelper (self) {
     await activateCallback({namespace, files, basePath, log});
     log('Activate: Database changes completed');
 
+    await self.clients.claim();
+    log('Activate: Clients claimed');
+
     log(`Activate: Posting finished message to clients`);
     // Signal phase complete to all clients
-    post({type: 'finishedActivate'});
+    await post({type: 'finishedActivate'});
   }
 
   // @ts-expect-error Ok
@@ -348,6 +385,7 @@ function swHelper (self) {
   });
 
   self.addEventListener('activate', (e) => {
+    console.log('sw activate event fired');
     // Erring is of no present use here:
     //   https://github.com/w3c/ServiceWorker/issues/659#issuecomment-384919053
     e.waitUntil(tryAndRetry(activate, 5 * minutes, 'Error activating'));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "textbrowser",
-  "version": "0.54.9",
+  "version": "0.54.11",
   "description": "Multilinear text browser",
   "type": "module",
   "main": "dist/index-es.min.js",

package/resources/activateCallback.js

@@ -55,10 +55,12 @@ export default async function activateCallback ({
   //  anyways); also important to avoid conflicts with
   //  already-running versions upon future sw updates
   log('Activate: Callback called');
+  log('Activate: Fetching files manifest', files);
   const r = await fetch(files);
   const {groups} = /** @type {import('./utils/WorkInfo.js').FilesObject} */ (
     await r.json()
   );
+  log('Activate: Manifest loaded; groups:', groups.length);
 
   /* eslint-disable jsdoc/reject-any-type -- Generic */
   /**
@@ -67,6 +69,7 @@ export default async function activateCallback ({
    */
   const addJSONFetch = (arr, path) => {
     /* eslint-enable jsdoc/reject-any-type -- Generic */
+    log('Activate: Queueing JSON fetch', basePath + path);
     arr.push(
       (async () => (await fetch(basePath + path)).json())()
     );
@@ -89,6 +92,13 @@ export default async function activateCallback ({
   const metadataFiles = [];
   groups.forEach(
     ({files: fileObjs, metadataBaseDirectory, schemaBaseDirectory}) => {
+      log(
+        'Activate: Processing group',
+        metadataBaseDirectory,
+        schemaBaseDirectory,
+        'files:',
+        fileObjs.length
+      );
       fileObjs.forEach(({file: {$ref: filePath}, metadataFile, schemaFile, name}) => {
         // We don't i18nize the name here
         dataFileNames.push(name);
@@ -98,6 +108,7 @@ export default async function activateCallback ({
       });
     }
   );
+  log('Activate: Awaiting queued fetches; works:', dataFiles.length);
   const promises = await Promise.all([
     ...dataFiles, ...schemaFiles, ...metadataFiles
   ]);
@@ -109,11 +120,14 @@ export default async function activateCallback ({
 
   log('Activate: Files fetched');
   const dbName = namespace + '-textbrowser-cache-data';
+  log('Activate: Deleting existing database', dbName);
   indexedDB.deleteDatabase(dbName);
   return new Promise((resolve, reject) => {
+    log('Activate: Opening database', dbName);
     const req = indexedDB.open(dbName);
     // @ts-expect-error Ok
     req.addEventListener('upgradeneeded', ({target: {result: db}}) => {
+      log('Activate: Database upgrade needed', dbName);
       db.onversionchange = () => {
         db.close();
         const err = /** @type {Error & {type: string}} */ (new Error('versionchange'));
@@ -122,6 +136,7 @@ export default async function activateCallback ({
       };
       dataFileResponses.forEach(({data: tableRows}, i) => {
         const dataFileName = dataFileNames[i];
+        log('Activate: Creating object store', dataFileName, 'rows:', tableRows.length);
         const store = db.createObjectStore('files-to-cache-' + dataFileName);
 
         const schemaFileResponse = schemaFileResponses[i];
@@ -180,6 +195,12 @@ export default async function activateCallback ({
         });
 
         const uniqueColumnIndexes = [...new Set(columnIndexes)];
+        log(
+          'Activate: Preparing rows for store',
+          dataFileName,
+          'unique indexes:',
+          uniqueColumnIndexes.length
+        );
 
         tableRows.forEach((tableRow, j) => {
           // Todo: Optionally send notice when complete
@@ -203,6 +224,7 @@ export default async function activateCallback ({
           // log('objRow', objRow);
           store.put(objRow, j);
         });
+        log('Activate: Finished object store population', dataFileName);
       });
     });
 
@@ -218,6 +240,7 @@ export default async function activateCallback ({
      * @param {Event & {error?: Error}} ev
      */
     const onerr = (ev) => {
+      log('Activate: Database request error event fired');
       const error = /** @type {Error & {type: string}} */ (
         ev.error ?? new Error('dbError')
       );