@open-xchange/vite-plugin-project-meta 0.0.1 → 0.0.3

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## [0.0.3] - 2024-07-30
+
+- changed: e-tag hash depends on build date instead of package version
+
+## [0.0.2] - 2024-07-30
+
+- added: generate `<meta name="etag-fix" ...>` for HTML entry files
+
 ## [0.0.1] - 2024-07-30
 
 - initial release

package/README.md

@@ -2,6 +2,14 @@
 
 A Vite plugin providing a virtual import for project metadata with build information.
 
+The metadata object can simply be imported in source code as following:
+
+```js
+import metadata from "virtual:metadata"
+```
+
+Additionally, while bundling the project, the plugin will insert a `<meta>` element into all HTML entry files containing a string with random length and contents. This is needed to workaround sticky browser cache when the HTML entry files are being served with weak e-tags that depend on the file size only but not on the file contents.
+
 ## Usage
 
 Add the plugin to your Vite configuration:

package/dist/index.js

@@ -6,6 +6,7 @@
 */
 import { join } from "node:path";
 import { readFileSync } from "node:fs";
+import { createHash } from "node:crypto";
 // constants ==================================================================
 export const PROJECT_NAME = "@open-xchange/vite-plugin-project-meta";
 // plugin =====================================================================
@@ -45,5 +46,19 @@ export default function vitePluginProjectMeta(options) {
             const code = `export default ${JSON.stringify(metadata)};`;
             return { code, map: { mappings: "" } };
         },
+        transformIndexHtml(_html, context) {
+            if (!context.bundle) {
+                return;
+            }
+            const hash = createHash("md5").update(metadata.builddate).digest("hex");
+            const len = Number.parseInt(hash.slice(0, 4), 16) % 99 + 42;
+            const count = Math.ceil(len / hash.length);
+            const content = hash.repeat(count).slice(0, len);
+            return [{
+                    tag: "meta",
+                    attrs: { name: "etag-fix", content },
+                    injectTo: "head",
+                }];
+        },
     };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@open-xchange/vite-plugin-project-meta",
-    "version": "0.0.1",
+    "version": "0.0.3",
     "description": "Vite plugin providing a virtual import for project metadata",
     "repository": {
         "url": "https://gitlab.open-xchange.com/fspd/npm-packages/vite-plugin-project-meta"