@atlaspack/runtime-browser-hmr 2.15.20-dev-9ef951846.0 → 2.15.20

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @atlaspack/runtime-browser-hmr
 
+## 2.15.20
+
+### Patch Changes
+
+- [#1076](https://github.com/atlassian-labs/atlaspack/pull/1076) [`c4a3b39`](https://github.com/atlassian-labs/atlaspack/commit/c4a3b399c70a434625626af3f7e9b666045cdf39) Thanks [@alexzherdev](https://github.com/alexzherdev)! - Alternative HMR versioning behind feature flag
+
+- Updated dependencies [[`c4a3b39`](https://github.com/atlassian-labs/atlaspack/commit/c4a3b399c70a434625626af3f7e9b666045cdf39)]:
+  - @atlaspack/feature-flags@2.31.3
+  - @atlaspack/utils@3.4.5
+  - @atlaspack/plugin@2.14.63
+
 ## 2.15.19
 
 ### Patch Changes

package/dist/HMRRuntime.js

@@ -4,6 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const plugin_1 = require("@atlaspack/plugin");
+const feature_flags_1 = require("@atlaspack/feature-flags");
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 // Without this, the hmr-runtime.js is transpiled with the React Refresh swc transform because it
@@ -42,6 +43,7 @@ exports.default = new plugin_1.Runtime({
                 `var HMR_USE_SSE = ${JSON.stringify(
                 // @ts-expect-error TS2339
                 !!(process.env.ATLASPACK_BUILD_REPL && process.browser))};` +
+                `var HMR_ENABLE_BUNDLE_VERSION = ${JSON.stringify((0, feature_flags_1.getFeatureFlag)('hmrBundleVersioning'))};` +
                 `module.bundle.HMR_BUNDLE_ID = ${JSON.stringify(bundle.id)};` +
                 HMR_RUNTIME,
             isEntry: true,

package/dist/loaders/hmr-runtime.js

@@ -1,8 +1,9 @@
 "use strict";
-/* global HMR_HOST, HMR_PORT, HMR_ENV_HASH, HMR_SECURE, HMR_USE_SSE, chrome, browser, __parcel__import__, __parcel__importScripts__, ServiceWorkerGlobalScope */
+/* global HMR_HOST, HMR_PORT, HMR_ENV_HASH, HMR_SECURE, HMR_USE_SSE, chrome, browser, __parcel__import__, __parcel__importScripts__, ServiceWorkerGlobalScope, HMR_ENABLE_BUNDLE_VERSION */
 Object.defineProperty(exports, "__esModule", { value: true });
 // /flow-to-ts helpers
 var OVERLAY_ID = '__parcel__error__overlay__';
+var HMR_BUNDLE_VERSION = '__parcel__hmrBundleVersion';
 // @ts-expect-error TS2339
 var OldModule = module.bundle.Module;
 function Module(moduleName) {
@@ -38,6 +39,32 @@ disposedAssets /*: {|[string]: boolean|} */,
 assetsToDispose /*: Array<[ParcelRequire, string]> */, 
 // @ts-expect-error TS7034
 assetsToAccept /*: Array<[ParcelRequire, string]> */;
+function getBundleVersion() {
+    // @ts-expect-error TS7017
+    return globalThis[HMR_BUNDLE_VERSION];
+}
+function bumpBundleVersion() {
+    // @ts-expect-error TS2304
+    if (!HMR_ENABLE_BUNDLE_VERSION) {
+        return;
+    }
+    let version = getBundleVersion();
+    let nextVersion = typeof version === 'number' && Number.isFinite(version) ? version + 1 : 1;
+    // @ts-expect-error TS7017
+    globalThis[HMR_BUNDLE_VERSION] = nextVersion;
+    return nextVersion;
+}
+function appendBundleVersion(url) {
+    // @ts-expect-error TS2304
+    if (!HMR_ENABLE_BUNDLE_VERSION) {
+        return url + (url.includes('?') ? '&' : '?') + 't=' + Date.now();
+    }
+    let version = getBundleVersion();
+    if (version == null) {
+        return url;
+    }
+    return url + (url.includes('?') ? '&' : '?') + 't=' + version;
+}
 function getHostname() {
     return (
     // @ts-expect-error TS2304
@@ -124,6 +151,7 @@ if ((!parent || !parent.isParcelRequire) && typeof WebSocket !== 'undefined') {
                         hmrAcceptCheck(module.bundle.root, asset.id, asset.depsByBundle)));
             });
             if (handled) {
+                bumpBundleVersion();
                 console.clear();
                 // Dispatch custom event so other runtimes (e.g React Refresh) are aware.
                 if (typeof window !== 'undefined' &&
@@ -267,7 +295,7 @@ function updateLink(link) {
         }
     };
     // @ts-expect-error TS2339
-    newLink.setAttribute('href', href.split('?')[0] + '?' + Date.now());
+    newLink.setAttribute('href', appendBundleVersion(href));
     // @ts-expect-error TS18047
     link.parentNode.insertBefore(newLink, link.nextSibling);
 }
@@ -307,7 +335,7 @@ function hmrDownload(asset) {
     if (asset.type === 'js') {
         if (typeof document !== 'undefined') {
             let script = document.createElement('script');
-            script.src = asset.url + '?t=' + Date.now();
+            script.src = appendBundleVersion(asset.url);
             if (asset.outputFormat === 'esmodule') {
                 script.type = 'module';
             }
@@ -322,13 +350,13 @@ function hmrDownload(asset) {
             // Worker scripts
             if (asset.outputFormat === 'esmodule') {
                 // @ts-expect-error TS2304
-                return __parcel__import__(asset.url + '?t=' + Date.now());
+                return __parcel__import__(appendBundleVersion(asset.url));
             }
             else {
                 return new Promise((resolve, reject) => {
                     try {
                         // @ts-expect-error TS2304
-                        __parcel__importScripts__(asset.url + '?t=' + Date.now());
+                        __parcel__importScripts__(appendBundleVersion(asset.url));
                         // @ts-expect-error TS2794
                         resolve();
                     }

package/lib/HMRRuntime.js

@@ -11,6 +11,13 @@ function _plugin() {
   };
   return data;
 }
+function _featureFlags() {
+  const data = require("@atlaspack/feature-flags");
+  _featureFlags = function () {
+    return data;
+  };
+  return data;
+}
 function _fs() {
   const data = _interopRequireDefault(require("fs"));
   _fs = function () {
@@ -54,7 +61,7 @@ var _default = exports.default = new (_plugin().Runtime)({
       // in watch mode or if hmr port != serve port
       !options.serveOptions || options.serveOptions.port !== port) ? port : null)};` + `var HMR_SECURE = ${JSON.stringify(!!(options.serveOptions && options.serveOptions.https))};` + `var HMR_ENV_HASH = "${bundle.env.id}";` + `var HMR_USE_SSE = ${JSON.stringify(
       // @ts-expect-error TS2339
-      !!(process.env.ATLASPACK_BUILD_REPL && process.browser))};` + `module.bundle.HMR_BUNDLE_ID = ${JSON.stringify(bundle.id)};` + HMR_RUNTIME,
+      !!(process.env.ATLASPACK_BUILD_REPL && process.browser))};` + `var HMR_ENABLE_BUNDLE_VERSION = ${JSON.stringify((0, _featureFlags().getFeatureFlag)('hmrBundleVersioning'))};` + `module.bundle.HMR_BUNDLE_ID = ${JSON.stringify(bundle.id)};` + HMR_RUNTIME,
       isEntry: true,
       env: {
         sourceType: 'module'

package/lib/loaders/hmr-runtime.js

@@ -1,6 +1,6 @@
 "use strict";
 
-/* global HMR_HOST, HMR_PORT, HMR_ENV_HASH, HMR_SECURE, HMR_USE_SSE, chrome, browser, __parcel__import__, __parcel__importScripts__, ServiceWorkerGlobalScope */
+/* global HMR_HOST, HMR_PORT, HMR_ENV_HASH, HMR_SECURE, HMR_USE_SSE, chrome, browser, __parcel__import__, __parcel__importScripts__, ServiceWorkerGlobalScope, HMR_ENABLE_BUNDLE_VERSION */
 
 /*::
 import type {
@@ -42,6 +42,7 @@ declare var HMR_PORT: string;
 declare var HMR_ENV_HASH: string;
 declare var HMR_SECURE: boolean;
 declare var HMR_USE_SSE: boolean;
+declare var HMR_ENABLE_BUNDLE_VERSION: boolean;
 declare var chrome: ExtensionContext;
 declare var browser: ExtensionContext;
 declare var __parcel__import__: (string) => Promise<void>;
@@ -55,6 +56,7 @@ declare var ServiceWorkerGlobalScope: Object;
 // /flow-to-ts helpers
 
 var OVERLAY_ID = '__parcel__error__overlay__';
+var HMR_BUNDLE_VERSION = '__parcel__hmrBundleVersion';
 
 // @ts-expect-error TS2339
 var OldModule = module.bundle.Module;
@@ -92,6 +94,32 @@ var checkedAssets /*: {|[string]: boolean|} */,
   assetsToDispose /*: Array<[ParcelRequire, string]> */,
   // @ts-expect-error TS7034
   assetsToAccept /*: Array<[ParcelRequire, string]> */;
+function getBundleVersion() {
+  // @ts-expect-error TS7017
+  return globalThis[HMR_BUNDLE_VERSION];
+}
+function bumpBundleVersion() {
+  // @ts-expect-error TS2304
+  if (!HMR_ENABLE_BUNDLE_VERSION) {
+    return;
+  }
+  let version = getBundleVersion();
+  let nextVersion = typeof version === 'number' && Number.isFinite(version) ? version + 1 : 1;
+  // @ts-expect-error TS7017
+  globalThis[HMR_BUNDLE_VERSION] = nextVersion;
+  return nextVersion;
+}
+function appendBundleVersion(url) {
+  // @ts-expect-error TS2304
+  if (!HMR_ENABLE_BUNDLE_VERSION) {
+    return url + (url.includes('?') ? '&' : '?') + 't=' + Date.now();
+  }
+  let version = getBundleVersion();
+  if (version == null) {
+    return url;
+  }
+  return url + (url.includes('?') ? '&' : '?') + 't=' + version;
+}
 function getHostname() {
   return (
     // @ts-expect-error TS2304
@@ -173,6 +201,7 @@ if ((!parent || !parent.isParcelRequire) && typeof WebSocket !== 'undefined') {
         hmrAcceptCheck(module.bundle.root, asset.id, asset.depsByBundle);
       });
       if (handled) {
+        bumpBundleVersion();
         console.clear();
 
         // Dispatch custom event so other runtimes (e.g React Refresh) are aware.
@@ -304,7 +333,7 @@ function updateLink(link) {
     }
   };
   // @ts-expect-error TS2339
-  newLink.setAttribute('href', href.split('?')[0] + '?' + Date.now());
+  newLink.setAttribute('href', appendBundleVersion(href));
   // @ts-expect-error TS18047
   link.parentNode.insertBefore(newLink, link.nextSibling);
 }
@@ -345,7 +374,7 @@ function hmrDownload(asset) {
   if (asset.type === 'js') {
     if (typeof document !== 'undefined') {
       let script = document.createElement('script');
-      script.src = asset.url + '?t=' + Date.now();
+      script.src = appendBundleVersion(asset.url);
       if (asset.outputFormat === 'esmodule') {
         script.type = 'module';
       }
@@ -360,12 +389,12 @@ function hmrDownload(asset) {
       // Worker scripts
       if (asset.outputFormat === 'esmodule') {
         // @ts-expect-error TS2304
-        return __parcel__import__(asset.url + '?t=' + Date.now());
+        return __parcel__import__(appendBundleVersion(asset.url));
       } else {
         return new Promise((resolve, reject) => {
           try {
             // @ts-expect-error TS2304
-            __parcel__importScripts__(asset.url + '?t=' + Date.now());
+            __parcel__importScripts__(appendBundleVersion(asset.url));
             // @ts-expect-error TS2794
             resolve();
           } catch (err) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaspack/runtime-browser-hmr",
-  "version": "2.15.20-dev-9ef951846.0",
+  "version": "2.15.20",
   "license": "(MIT OR Apache-2.0)",
   "publishConfig": {
     "access": "public"
@@ -16,12 +16,12 @@
     "node": ">= 16.0.0"
   },
   "dependencies": {
-    "@atlaspack/plugin": "2.14.63-dev-9ef951846.0",
-    "@atlaspack/utils": "3.4.5-dev-9ef951846.0"
+    "@atlaspack/feature-flags": "2.31.3",
+    "@atlaspack/plugin": "2.14.63",
+    "@atlaspack/utils": "3.4.5"
   },
   "type": "commonjs",
   "scripts": {
     "build:lib": "gulp build --gulpfile ../../../gulpfile.js --cwd ."
-  },
-  "gitHead": "9ef951846054ca4eacd2d24047ae09e451f72824"
+  }
 }

package/src/HMRRuntime.ts

@@ -1,4 +1,5 @@
 import {Runtime} from '@atlaspack/plugin';
+import {getFeatureFlag} from '@atlaspack/feature-flags';
 import fs from 'fs';
 import path from 'path';
 
@@ -55,6 +56,9 @@ export default new Runtime({
           // @ts-expect-error TS2339
           !!(process.env.ATLASPACK_BUILD_REPL && process.browser),
         )};` +
+        `var HMR_ENABLE_BUNDLE_VERSION = ${JSON.stringify(
+          getFeatureFlag('hmrBundleVersioning'),
+        )};` +
         `module.bundle.HMR_BUNDLE_ID = ${JSON.stringify(bundle.id)};` +
         HMR_RUNTIME,
       isEntry: true,

package/src/loaders/hmr-runtime.ts

@@ -1,4 +1,4 @@
-/* global HMR_HOST, HMR_PORT, HMR_ENV_HASH, HMR_SECURE, HMR_USE_SSE, chrome, browser, __parcel__import__, __parcel__importScripts__, ServiceWorkerGlobalScope */
+/* global HMR_HOST, HMR_PORT, HMR_ENV_HASH, HMR_SECURE, HMR_USE_SSE, chrome, browser, __parcel__import__, __parcel__importScripts__, ServiceWorkerGlobalScope, HMR_ENABLE_BUNDLE_VERSION */
 
 /*::
 import type {
@@ -40,6 +40,7 @@ declare var HMR_PORT: string;
 declare var HMR_ENV_HASH: string;
 declare var HMR_SECURE: boolean;
 declare var HMR_USE_SSE: boolean;
+declare var HMR_ENABLE_BUNDLE_VERSION: boolean;
 declare var chrome: ExtensionContext;
 declare var browser: ExtensionContext;
 declare var __parcel__import__: (string) => Promise<void>;
@@ -57,6 +58,7 @@ export type Diff<T extends U, U extends object> = Pick<
 // /flow-to-ts helpers
 
 var OVERLAY_ID = '__parcel__error__overlay__';
+var HMR_BUNDLE_VERSION = '__parcel__hmrBundleVersion';
 
 // @ts-expect-error TS2339
 var OldModule = module.bundle.Module;
@@ -96,6 +98,39 @@ var checkedAssets /*: {|[string]: boolean|} */,
   // @ts-expect-error TS7034
   assetsToAccept /*: Array<[ParcelRequire, string]> */;
 
+function getBundleVersion() {
+  // @ts-expect-error TS7017
+  return globalThis[HMR_BUNDLE_VERSION];
+}
+
+function bumpBundleVersion() {
+  // @ts-expect-error TS2304
+  if (!HMR_ENABLE_BUNDLE_VERSION) {
+    return;
+  }
+
+  let version = getBundleVersion();
+  let nextVersion =
+    typeof version === 'number' && Number.isFinite(version) ? version + 1 : 1;
+  // @ts-expect-error TS7017
+  globalThis[HMR_BUNDLE_VERSION] = nextVersion;
+  return nextVersion;
+}
+
+function appendBundleVersion(url: string) {
+  // @ts-expect-error TS2304
+  if (!HMR_ENABLE_BUNDLE_VERSION) {
+    return url + (url.includes('?') ? '&' : '?') + 't=' + Date.now();
+  }
+
+  let version = getBundleVersion();
+  if (version == null) {
+    return url;
+  }
+
+  return url + (url.includes('?') ? '&' : '?') + 't=' + version;
+}
+
 function getHostname() {
   return (
     // @ts-expect-error TS2304
@@ -199,6 +234,7 @@ if ((!parent || !parent.isParcelRequire) && typeof WebSocket !== 'undefined') {
       });
 
       if (handled) {
+        bumpBundleVersion();
         console.clear();
 
         // Dispatch custom event so other runtimes (e.g React Refresh) are aware.
@@ -389,7 +425,7 @@ function updateLink(link: HTMLElement) {
     }
   };
   // @ts-expect-error TS2339
-  newLink.setAttribute('href', href.split('?')[0] + '?' + Date.now());
+  newLink.setAttribute('href', appendBundleVersion(href));
   // @ts-expect-error TS18047
   link.parentNode.insertBefore(newLink, link.nextSibling);
 }
@@ -437,7 +473,7 @@ function hmrDownload(asset: HMRAsset) {
   if (asset.type === 'js') {
     if (typeof document !== 'undefined') {
       let script = document.createElement('script');
-      script.src = asset.url + '?t=' + Date.now();
+      script.src = appendBundleVersion(asset.url);
       if (asset.outputFormat === 'esmodule') {
         script.type = 'module';
       }
@@ -458,7 +494,7 @@ function hmrDownload(asset: HMRAsset) {
       // Worker scripts
       if (asset.outputFormat === 'esmodule') {
         // @ts-expect-error TS2304
-        return __parcel__import__(asset.url + '?t=' + Date.now());
+        return __parcel__import__(appendBundleVersion(asset.url));
       } else {
         return new Promise(
           (
@@ -467,7 +503,7 @@ function hmrDownload(asset: HMRAsset) {
           ) => {
             try {
               // @ts-expect-error TS2304
-              __parcel__importScripts__(asset.url + '?t=' + Date.now());
+              __parcel__importScripts__(appendBundleVersion(asset.url));
               // @ts-expect-error TS2794
               resolve();
             } catch (err: any) {

package/tsconfig.json

@@ -11,6 +11,9 @@
     },
     {
       "path": "../../core/utils/tsconfig.json"
+    },
+    {
+      "path": "../../core/feature-flags/tsconfig.json"
     }
   ]
 }