neo.mjs 4.3.11 → 4.3.12

package/apps/ServiceWorker.mjs

@@ -24,7 +24,11 @@ class ServiceWorker extends ServiceBase {
          * @member {Boolean} singleton=true
          * @protected
          */
-        singleton: true
+        singleton: true,
+        /**
+         * @member {String} version='4.3.11'
+         */
+        version: '4.3.11'
     }}
 }
 

package/buildScripts/injectPackageVersion.mjs

@@ -15,15 +15,19 @@ const
     neoPath     = insideNeo ? './' : './node_modules/neo.mjs/',
     programName = `${packageJson.name} inject-package-version`;
 
-let startDate    = new Date(),
-    configPath   = path.join(__dirname, 'src/DefaultConfig.mjs'),
-    contentArray = fs.readFileSync(configPath).toString().split(os.EOL),
-    i            = 0,
-    len          = contentArray.length,
-    versionString = `'${packageJson.version}'`;
+let startDate            = new Date(),
+    configPath           = path.join(__dirname, 'src/DefaultConfig.mjs'),
+    contentArray         = fs.readFileSync(configPath).toString().split(os.EOL),
+    i                    = 0,
+    len                  = contentArray.length,
+    serviceWorkerFolders = ['apps'],
+    versionString        = `'${packageJson.version}'`,
+    serviceContentArray, serviceWorkerPath
 
 if (!insideNeo) {
     // todo
+} else {
+    serviceWorkerFolders.push('examples');
 }
 
 for (; i < len; i++) {
@@ -37,6 +41,25 @@ for (; i < len; i++) {
 
 fs.writeFileSync(configPath, contentArray.join(os.EOL));
 
+serviceWorkerFolders.forEach(folder => {
+    serviceWorkerPath    = path.join(__dirname, folder, 'ServiceWorker.mjs');
+    serviceContentArray  = fs.readFileSync(serviceWorkerPath).toString().split(os.EOL);
+
+    i   = 0;
+    len = serviceContentArray.length;
+
+    for (; i < len; i++) {
+        if (serviceContentArray[i].includes('version:')) {
+            // we want to update the comment inside ServiceWorker.mjs as well
+            serviceContentArray[i - 2] = serviceContentArray[i - 2].replace(/'\d.+'/, versionString);
+            serviceContentArray[i]     = serviceContentArray[i]    .replace(/'\d.+'/, versionString);
+            break;
+        }
+    }
+
+    fs.writeFileSync(serviceWorkerPath, serviceContentArray.join(os.EOL));
+});
+
 const processTime = (Math.round((new Date - startDate) * 100) / 100000).toFixed(2);
 console.log(`\nTotal time for ${programName}: ${processTime}s`);
 

package/examples/ServiceWorker.mjs

@@ -24,7 +24,11 @@ class ServiceWorker extends ServiceBase {
          * @member {Boolean} singleton=true
          * @protected
          */
-        singleton: true
+        singleton: true,
+        /**
+         * @member {String} version='4.3.11'
+         */
+        version: '4.3.11'
     }}
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "neo.mjs",
-    "version": "4.3.11",
+    "version": "4.3.12",
     "description": "The webworkers driven UI framework",
     "type": "module",
     "repository": {

package/src/DefaultConfig.mjs

@@ -229,12 +229,12 @@ const DefaultConfig = {
     useVdomWorker: true,
     /**
      * buildScripts/injectPackageVersion.mjs will update this value
-     * @default '4.3.10'
+     * @default '4.3.11'
      * @memberOf! module:Neo
      * @name config.version
      * @type String
      */
-    version: '4.3.10'
+    version: '4.3.11'
 };
 
 Object.assign(DefaultConfig, {

package/src/main/addon/ServiceWorker.mjs

@@ -42,10 +42,19 @@ class ServiceWorker extends Base {
                     serviceWorker.ready.then(() => {
                         serviceWorker.onmessage = WorkerManager.onWorkerMessage.bind(WorkerManager);
 
+                        if (!WorkerManager.getWorker('service')) {
+                            /*
+                             * navigator.serviceWorker.controller can be null in case we load a page for the first time
+                             * or in case of a force refresh.
+                             * See: https://www.w3.org/TR/service-workers/#navigator-service-worker-controller
+                             */
+                            WorkerManager.serviceWorker = registration.active;
+                        }
+
                         WorkerManager.sendMessage('service', {
                             action: 'registerNeoConfig',
                             data  : config
-                        });
+                        })
                     });
                 })
         }

package/src/worker/Manager.mjs

@@ -16,6 +16,15 @@ const NeoConfig = Neo.config,
  * @singleton
  */
 class Manager extends Base {
+    /**
+     * navigator.serviceWorker.controller can be null in case we load a page for the first time
+     * or in case of a force refresh.
+     * See: https://www.w3.org/TR/service-workers/#navigator-service-worker-controller
+     * Only in this case main.addon.ServiceWorker will store the active registration once ready here.
+     * @member {ServiceWorker|null} serviceWorker=null
+     */
+    serviceWorker = null
+
     static getConfig() {return {
         /**
          * @member {String} className='Neo.worker.Manager'
@@ -224,7 +233,7 @@ class Manager extends Base {
      */
     getWorker(name) {
         if (name === 'service') {
-            return navigator.serviceWorker?.controller;
+            return navigator.serviceWorker?.controller || this.serviceWorker;
         }
 
         return name instanceof Worker ? name : this.workers[name].worker;

package/src/worker/ServiceBase.mjs

@@ -250,11 +250,17 @@ class ServiceBase extends Base {
      * @param {Object} msg
      * @param {ExtendableMessageEvent} event
      */
-    onRegisterNeoConfig(msg, event) {
+    async onRegisterNeoConfig(msg, event) {
+        let me = this;
+
         Neo.config = Neo.config || {};
         Object.assign(Neo.config, msg.data);
 
-        this.onConnect(event.source);
+        if (me.version !== Neo.config.version) {
+            await me.clearCaches()
+        }
+
+        me.onConnect(event.source);
     }
 
     /**