ci: add web cache version build script automation

Author: abose

.github/workflows/patch-version-bump.yml

@@ -36,6 +36,8 @@ jobs:
           add-paths: |
             package.json
             src/config.json
+            src-node/package.json
+            src/index.html
           body: |
             Bump patch version to ${{ env.PHOENIX_VERSION }}
             - Auto-generated by `patch-version-bump.yml` action

.github/workflows/yearly-major-version-bump.yml

@@ -33,6 +33,8 @@ jobs:
           add-paths: |
             package.json
             src/config.json
+            src-node/package.json
+            src/index.html
           body: |
             Bump patch version to ${{ env.PHOENIX_VERSION }}
             - Auto-generated by `patch-version-bump.yml` action

.gitignore

@@ -56,6 +56,7 @@ test/thirdparty/jasmine-reporters
 
 # ignore compiled files
 /dist
+/dist-web-cache
 /dist-test
 /distToDeploy
 /src/.index.html

gulpfile.js/index.js

@@ -100,6 +100,21 @@ function makeDistNonJS() {
         .pipe(dest('dist'));
 }
 
+function makeDistWebCache() {
+    return new Promise((resolve)=> {
+        fs.rmSync("./dist/web-cache", {recursive: true, force: true});
+        fs.rmSync("./dist-web-cache", {recursive: true, force: true});
+        fs.cpSync("./dist", "./dist-web-cache", {
+            recursive: true,
+            force: true
+        });
+        let config = JSON.parse(fs.readFileSync('./package.json', 'utf8'));
+        fs.mkdirSync("./dist/web-cache");
+        fs.renameSync("./dist-web-cache", `./dist/web-cache/${config.apiVersion}`);
+        resolve();
+    });
+}
+
 function serve() {
     return src('.')
         .pipe(webserver({
@@ -184,20 +199,38 @@ function _majorVersionBumpConfigFile(fileName) {
     fs.writeFileSync(fileName, JSON.stringify(config, null, 4));
 }
 
+function _patchIndexHTML() {
+    let indexHtmlPath = './src/index.html';
+    let config = JSON.parse(fs.readFileSync('./package.json', 'utf8'));
+    let indexHTML = fs.readFileSync(indexHtmlPath, 'utf8');
+    let version = config.apiVersion;
+    const replaceStr = '<script>window.PHOENIX_APP_CACHE_VERSION="LATEST";</script>';
+    if(!indexHTML.includes(replaceStr)){
+        throw new Error("Expected index.html to include "+ replaceStr);
+    }
+    indexHTML = indexHTML.replace(replaceStr,
+        `<script>window.PHOENIX_APP_CACHE_VERSION="${version}";</script>`);
+    fs.writeFileSync(indexHtmlPath, indexHTML);
+}
+
 function patchVersionBump() {
+    // adding anything here should be added to patch-version-bump.yml and yearly-major-version-bump.yml
     return new Promise((resolve)=> {
         _patchBumpConfigFile('./package.json');
         _patchBumpConfigFile('./src-node/package.json');
         _patchBumpConfigFile('./src/config.json');
+        _patchIndexHTML();
         resolve();
     });
 }
 
 function majorVersionBump() {
+    // adding anything here should be added to patch-version-bump.yml and yearly-major-version-bump.yml
     return new Promise((resolve)=> {
         _majorVersionBumpConfigFile('./package.json');
         _majorVersionBumpConfigFile('./src-node/package.json');
         _majorVersionBumpConfigFile('./src/config.json');
+        _patchIndexHTML();
         resolve();
     });
 }
@@ -636,6 +669,7 @@ exports.releaseStaging = series(cleanDist, exports.build, makeBracketsConcatJS,
 exports.releaseProd = series(cleanDist, exports.build, makeBracketsConcatJS, _compileLessSrc,
     makeDistNonJS, makeJSDist, _renameBracketsConcatAsBracketsJSInDist, _patchMinifiedCSSInDistIndex, releaseProd,
     createDistCacheManifest, createDistTest, _cleanReleaseBuildArtefactsInSrc);
+exports.releaseWebCache = series(makeDistWebCache);
 exports.serve = series(exports.build, serve);
 exports.zipTestFiles = series(zipTestFiles);
 exports.serveExternal = series(exports.build, serveExternal);

package.json

@@ -67,11 +67,12 @@
         "release:dev": "gulp releaseDev",
         "release:staging": "gulp releaseStaging",
         "release:prod": "gulp releaseProd",
+        "_releaseWebCache": "gulp releaseWebCache",
         "_patchVersionBump": "gulp patchVersionBump",
         "_majorVersionBump": "gulp majorVersionBump",
         "serve": "http-server . -p 8000 -c-1",
         "serveWithWebCache": "http-server ./src -p 8000 -c-1",
-        "serveExternal": "http-server . -p 8000 -a 0.0.0.0 --log-ip true -c-1",
+        "serveExternal": "npm run _releaseWebCache && http-server . -p 8000 -a 0.0.0.0 --log-ip true -c-1",
         "createJSDocs": "gulp createJSDocs && git add docs",
         "_translateStrings": "gulp translateStrings",
         "_minify": "r.js -o require.min.config.js && echo this is untested see https://stackoverflow.com/questions/14337970/minifying-requirejs-javascript-codebase-to-a-single-file"

src/index.html

@@ -48,6 +48,9 @@
     </style>
     <!-- start inline javascript and non module bootstrap scripts. you must add module scripts to the
      javascript module section only!!-->
+<!--    The app cache version is set by the pipeline version update script. Do not update manually.-->
+    <script>window.PHOENIX_APP_CACHE_VERSION="LATEST";</script>
+<!--    The app cache version is set by the pipeline version update script. Do not update manually.-->
     <script>
         if(location.href.startsWith("tauri://") || location.href.startsWith('https://tauri.localhost')){
             const errorMessage = `You should use custom protocol phtauri:// instead of tauri protocol ${location.href} .`;