3.0.57

fix(updateManager): Refine cache management for service worker updates.
3.0.56
2025-02-03 00:25:06 +01:00 · 2025-02-03 00:25:05 +01:00 · 2025-02-03 00:16:59 +01:00 · 2025-02-03 00:16:58 +01:00 · 2025-01-28 10:53:43 +01:00 · 2025-01-28 10:53:42 +01:00
7 changed files with 81 additions and 15 deletions
--- a/changelog.md
+++ b/changelog.md
@ -1,5 +1,31 @@
 # Changelog

+## 2025-02-03 - 3.0.57 - fix(updateManager)
+Refine cache management for service worker updates.
+
+- Ensured cache is forcibly updated if older than defined maximum age.
+- Implemented interval checks and forced updates for cache staleness.
+- Updated version information and cache timestamps upon forced updates or validations.
+
+## 2025-02-03 - 3.0.56 - fix(cachemanager)
+Adjust cache control headers and fix redundant code
+
+- Remove duplicate assetbroker URLs in the cache evaluation logic.
+- Update cache control headers to improve caching behavior.
+- Increase the timeout for fetch operations to improve compatibility.
+
+## 2025-01-28 - 3.0.55 - fix(server)
+Fix response content manipulation for HTML files with injectReload
+
+- Moved fileString declaration inside HTML file handling block to prevent unnecessary string conversion for non-HTML files.
+- Corrected responseContent assignment to ensure modified HTML strings are converted back to Buffer format.
+
+## 2025-01-28 - 3.0.54 - fix(servertools)
+Fixed an issue with compression results handling in HandlerStatic where content was always being written even if not compressed.
+
+- Corrected the double writing of response in HandlerStatic.
+- Ensured that file buffers are only conditionally written based on compression availability.
+
 ## 2024-12-26 - 3.0.53 - fix(infohtml)
 Remove Sentry script and logo from HTML template

--- a/package.json
+++ b/package.json
@ -1,6 +1,6 @@
 {
  "name": "@api.global/typedserver",
-  "version": "3.0.53",
+  "version": "3.0.57",
  "description": "A TypeScript-based project for easy serving of static files with support for live reloading, compression, and typed requests.",
  "type": "module",
  "exports": {
--- a/ts/00_commitinfo_data.ts
+++ b/ts/00_commitinfo_data.ts
@ -3,6 +3,6 @@
 */
 export const commitinfo = {
  name: '@api.global/typedserver',
-  version: '3.0.53',
+  version: '3.0.57',
  description: 'A TypeScript-based project for easy serving of static files with support for live reloading, compression, and typed requests.'
 }
--- a/ts/classes.typedserver.ts
+++ b/ts/classes.typedserver.ts
@ -135,8 +135,8 @@ export class TypedServer {
        '/*',
        new servertools.HandlerStatic(this.options.serveDir, {
          responseModifier: async (responseArg) => {
-            let fileString = responseArg.responseContent.toString();
            if (plugins.path.parse(responseArg.path).ext === '.html') {
+              let fileString = responseArg.responseContent.toString();
              const fileStringArray = fileString.split('<head>');
              if (this.options.injectReload && fileStringArray.length === 2) {
                fileStringArray[0] = `${fileStringArray[0]}<head>
@ -152,6 +152,7 @@ export class TypedServer {
                `;
                fileString = fileStringArray.join('');
                console.log('injected typedserver script.');
+                responseArg.responseContent = Buffer.from(fileString);
              } else if (this.options.injectReload) {
                console.log('Could not insert typedserver script');
              }
@ -164,7 +165,7 @@ export class TypedServer {
            return {
              headers,
              path: responseArg.path,
-              responseContent: Buffer.from(fileString),
+              responseContent: responseArg.responseContent,
            };
          },
          serveIndexHtmlDefault: true,
--- a/ts/servertools/classes.handlerstatic.ts
+++ b/ts/servertools/classes.handlerstatic.ts
@ -134,8 +134,10 @@ export class HandlerStatic extends Handler {
      res.status(200);
      if (compressionResult?.compressionMethod) {
        res.header('Content-Encoding', compressionResult.compressionMethod);
+        res.write(compressionResult.result);
+      } else {
+        res.write(fileBuffer);
      }
-      res.write(compressionResult.result);
      res.end();
    });
  }
--- a/ts_web_serviceworker/classes.cachemanager.ts
+++ b/ts_web_serviceworker/classes.cachemanager.ts
@ -98,8 +98,6 @@ export class CacheManager {
            !originalRequest.url.includes('/api/') &&
            !originalRequest.url.includes('smartserve/reloadcheck'))) ||
        originalRequest.url.includes('https://assetbroker.') ||
-        originalRequest.url.includes('https://assetbroker.') ||
-        originalRequest.url.includes('https://assetbroker.') ||
        originalRequest.url.includes('https://unpkg.com') ||
        originalRequest.url.includes('https://fonts.googleapis.com') ||
        originalRequest.url.includes('https://fonts.gstatic.com')
@ -150,9 +148,11 @@ export class CacheManager {
              headers.set(key, value);
            }
          });
-          headers.set('Cache-Control', 'no-cache, no-store, must-revalidate');
+          // Prevent browser caching while allowing service worker caching
+          headers.set('Cache-Control', 'no-store, no-cache, must-revalidate, proxy-revalidate');
          headers.set('Pragma', 'no-cache');
          headers.set('Expires', '0');
+          headers.set('Surrogate-Control', 'no-store');
          await cache.put(matchRequest, new Response(responseToPutToCache.body, {
            ...responseToPutToCache,
            headers
@ -215,7 +215,7 @@ export class CacheManager {

      // lets get a new response for comparison
      const clonedRequest = requestArg.clone();
-      const response = await plugins.smartpromise.timeoutWrap(fetch(clonedRequest), 1000);
+      const response = await plugins.smartpromise.timeoutWrap(fetch(clonedRequest), 5000); // Increased timeout for better mobile compatibility
      if (response && response.status >= 200 && response.status < 300) {
        await runtimeCache.delete(requestArg);
        await runtimeCache.put(requestArg, response);
--- a/ts_web_serviceworker/classes.updatemanager.ts
+++ b/ts_web_serviceworker/classes.updatemanager.ts
@ -17,24 +17,42 @@ export class UpdateManager {
  /**
   * checks wether an update is needed
   */
+  private readonly MAX_CACHE_AGE = 24 * 60 * 60 * 1000; // 24 hours in milliseconds
+  private readonly MIN_CHECK_INTERVAL = 100000; // 100 seconds in milliseconds
+  private lastCacheTimestamp: number = 0;
+
  public async checkUpdate(cacheManager: CacheManager): Promise<boolean> {
    const lswVersionInfoKey = 'versionInfo';
+    const cacheTimestampKey = 'cacheTimestamp';
+
+    // Initialize or load version info
    if (!this.lastVersionInfo && !(await this.serviceworkerRef.store.check(lswVersionInfoKey))) {
      this.lastVersionInfo = {
        appHash: '',
        appSemVer: 'v0.0.0',
      };
-    } else if (
-      !this.lastVersionInfo &&
-      (await this.serviceworkerRef.store.check(lswVersionInfoKey))
-    ) {
+    } else if (!this.lastVersionInfo && (await this.serviceworkerRef.store.check(lswVersionInfoKey))) {
      this.lastVersionInfo = await this.serviceworkerRef.store.get(lswVersionInfoKey);
    }

+    // Load or initialize cache timestamp
+    if (await this.serviceworkerRef.store.check(cacheTimestampKey)) {
+      this.lastCacheTimestamp = await this.serviceworkerRef.store.get(cacheTimestampKey);
+    }
+
    const now = Date.now();
    const millisSinceLastCheck = now - this.lastUpdateCheck;
-    if (millisSinceLastCheck < 100000) {
-      // TODO account for being offline
+    const cacheAge = now - this.lastCacheTimestamp;
+
+    // Force update if cache is too old
+    if (cacheAge > this.MAX_CACHE_AGE) {
+      logger.log('info', `Cache is older than ${this.MAX_CACHE_AGE}ms, forcing update...`);
+      await this.forceUpdate(cacheManager);
+      return true;
+    }
+
+    // Regular update check interval
+    if (millisSinceLastCheck < this.MIN_CHECK_INTERVAL && cacheAge < this.MAX_CACHE_AGE) {
      return false;
    }
    logger.log('info', 'checking for update of the app by comparing app hashes...');
@ -49,9 +67,17 @@ export class UpdateManager {
      this.performAsyncUpdateDebouncedTask.trigger();
      this.lastVersionInfo = currentVersionInfo;
      await this.serviceworkerRef.store.set(lswVersionInfoKey, this.lastVersionInfo);
+      
+      // Update cache timestamp
+      this.lastCacheTimestamp = now;
+      await this.serviceworkerRef.store.set('cacheTimestamp', now);
    } else {
      logger.log('ok', 'caches are still valid, performing revalidation in a bit...');
      this.performAsyncCacheRevalidationDebouncedTask.trigger();
+      
+      // Update cache timestamp after successful revalidation
+      this.lastCacheTimestamp = now;
+      await this.serviceworkerRef.store.set('cacheTimestamp', now);
    }
  }

@ -70,6 +96,17 @@ export class UpdateManager {
  /**
   * this task is executed once we know that there is a new version available
   */
+  private async forceUpdate(cacheManager: CacheManager) {
+    logger.log('info', 'Forcing cache update due to staleness');
+    await this.serviceworkerRef.cacheManager.cleanCaches('Cache is stale, forcing update.');
+    const currentVersionInfo = await this.getVersionInfoFromServer();
+    this.lastVersionInfo = currentVersionInfo;
+    await this.serviceworkerRef.store.set('versionInfo', this.lastVersionInfo);
+    this.lastCacheTimestamp = Date.now();
+    await this.serviceworkerRef.store.set('cacheTimestamp', this.lastCacheTimestamp);
+    await this.serviceworkerRef.leleServiceWorkerBackend.triggerReloadAll();
+  }
+
  public performAsyncUpdateDebouncedTask = new plugins.taskbuffer.TaskDebounced({
    name: 'performAsyncUpdate',
    taskFunction: async () => {
Author	SHA1	Message	Date
Philipp Kunz	aebcbe4a61	3.0.57	2025-02-03 00:25:06 +01:00
Philipp Kunz	c5cb8c1f01	fix(updateManager): Refine cache management for service worker updates.	2025-02-03 00:25:05 +01:00
Philipp Kunz	8202ce6227	3.0.56	2025-02-03 00:16:59 +01:00
Philipp Kunz	4598bd0e25	fix(cachemanager): Adjust cache control headers and fix redundant code	2025-02-03 00:16:58 +01:00
Philipp Kunz	021c980a4f	3.0.55	2025-01-28 10:53:43 +01:00
Philipp Kunz	c7dca75827	fix(server): Fix response content manipulation for HTML files with injectReload	2025-01-28 10:53:42 +01:00
Philipp Kunz	4f7b2888ab	3.0.54	2025-01-28 10:32:17 +01:00
Philipp Kunz	e552a48c02	fix(servertools): Fixed an issue with compression results handling in HandlerStatic where content was always being written even if not compressed.	2025-01-28 10:32:17 +01:00