add import.meta.hot.events

jsenv · Nov 26, 2024 · 6784321 · 6784321
1 parent e34dae6
commit 6784321
Show file tree

Hide file tree

Showing 12 changed files with 93 additions and 11 deletions.
diff --git a/dist/js/autoreload.js b/dist/js/autoreload.js
@@ -1,5 +1,5 @@
 import { parseSrcSet, stringifySrcSet } from "@jsenv/ast/src/html/html_src_set.js";
-import { urlHotMetas } from "./import_meta_hot.js";
+import { urlHotMetas, dispatchBeforeFullReload, dispatchBeforePartialReload, dispatchAfterPartialReload, dispatchBeforePrune } from "./import_meta_hot.js";
 
 const initAutoreload = ({ mainFilePath }) => {
   const reloader = {
@@ -55,9 +55,11 @@ const initAutoreload = ({ mainFilePath }) => {
         (reloadMessage) => reloadMessage.type === "full",
       );
       if (someEffectIsFullReload) {
+        dispatchBeforeFullReload();
         reloadHtmlPage();
         return;
       }
+      dispatchBeforePartialReload();
       reloader.status.goTo("reloading");
       const onApplied = (reloadMessage) => {
         reloader.changes.remove(reloadMessage);
@@ -67,6 +69,7 @@ const initAutoreload = ({ mainFilePath }) => {
           () => {
             onApplied(reloadMessage);
             reloader.currentExecution = null;
+            dispatchAfterPartialReload();
           },
           (e) => {
             reloader.status.goTo("failed");
@@ -134,6 +137,7 @@ This could be due to syntax errors or importing non-existent modules (see errors
       // - import.meta.hot.accept() is not called (happens for HTML and CSS)
       if (type === "prune") {
         if (urlHotMeta) {
+          dispatchBeforePrune();
           delete urlHotMetas[urlToFetch];
           if (urlHotMeta.disposeCallback) {
             console.groupCollapsed(

diff --git a/dist/js/import_meta_hot.js b/dist/js/import_meta_hot.js
@@ -5,12 +5,40 @@
 
 const urlHotMetas = {};
 
+const createEvent = () => {
+  const callbackSet = new Set();
+  const addCallback = (callback) => {
+    callbackSet.add(callback);
+    return () => {
+      callbackSet.delete(callback);
+    };
+  };
+  const dispatch = () => {
+    for (const callback of callbackSet) {
+      callback();
+    }
+  };
+  return [{ addCallback }, dispatch];
+};
+const [beforePartialReload, dispatchBeforePartialReload] = createEvent();
+const [afterPartialReload, dispatchAfterPartialReload] = createEvent();
+const [beforeFullReload, dispatchBeforeFullReload] = createEvent();
+const [beforePrune, dispatchBeforePrune] = createEvent();
+
+const hotEvents = {
+  beforePartialReload,
+  afterPartialReload,
+  beforeFullReload,
+  beforePrune,
+};
+
 const createImportMetaHot = (importMetaUrl) => {
   const data = {};
   const url = asUrlWithoutHotSearchParam(importMetaUrl);
 
   return {
     data,
+    events: hotEvents,
     accept: (firstArg, secondArg) => {
       if (!firstArg) {
         addUrlMeta(url, {
@@ -80,4 +108,4 @@ const asUrlWithoutHotSearchParam = (url) => {
   return url;
 };
 
-export { createImportMetaHot, urlHotMetas };
+export { createImportMetaHot, dispatchAfterPartialReload, dispatchBeforeFullReload, dispatchBeforePartialReload, dispatchBeforePrune, urlHotMetas };
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@jsenv/core",
-  "version": "39.5.26",
+  "version": "39.6.0",
   "description": "Tool to develop, test and build js projects",
   "license": "MIT",
   "author": {

diff --git a/packages/related/cli/package.json b/packages/related/cli/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@jsenv/cli",
-  "version": "0.2.14",
+  "version": "0.2.15",
   "description": "Command Line Interface for jsenv",
   "license": "MIT",
   "repository": {

diff --git a/packages/related/cli/template-node-package/package.json b/packages/related/cli/template-node-package/package.json
@@ -12,7 +12,7 @@
   },
   "devDependencies": {
     "@jsenv/assert": "4.4.2",
-    "@jsenv/core": "39.5.26",
+    "@jsenv/core": "39.6.0",
     "@jsenv/eslint-config-relax": "1.3.4",
     "@jsenv/test": "3.5.28",
     "eslint": "9.15.0",

diff --git a/packages/related/cli/template-web-components/package.json b/packages/related/cli/template-web-components/package.json
@@ -18,7 +18,7 @@
     "@babel/plugin-syntax-import-attributes": "7.26.0",
     "@jsenv/custom-elements-redefine": "0.0.1",
     "@jsenv/assert": "4.4.2",
-    "@jsenv/core": "39.5.26",
+    "@jsenv/core": "39.6.0",
     "@jsenv/plugin-bundling": "2.7.19",
     "@jsenv/plugin-minification": "1.5.11",
     "@jsenv/eslint-config-relax": "1.3.4",

diff --git a/packages/related/cli/template-web-preact/package.json b/packages/related/cli/template-web-preact/package.json
@@ -21,7 +21,7 @@
     "@babel/plugin-syntax-import-attributes": "7.26.0",
     "@babel/plugin-transform-react-jsx": "7.25.9",
     "@jsenv/assert": "4.4.2",
-    "@jsenv/core": "39.5.26",
+    "@jsenv/core": "39.6.0",
     "@jsenv/plugin-preact": "1.6.28",
     "@jsenv/plugin-bundling": "2.7.19",
     "@jsenv/plugin-minification": "1.5.11",

diff --git a/packages/related/cli/template-web-react/package.json b/packages/related/cli/template-web-react/package.json
@@ -22,7 +22,7 @@
     "@babel/plugin-syntax-import-attributes": "7.26.0",
     "@babel/plugin-transform-react-jsx": "7.25.9",
     "@jsenv/assert": "4.4.2",
-    "@jsenv/core": "39.5.26",
+    "@jsenv/core": "39.6.0",
     "@jsenv/plugin-react": "1.5.47",
     "@jsenv/plugin-bundling": "2.7.19",
     "@jsenv/plugin-minification": "1.5.11",

diff --git a/packages/related/cli/template-web/package.json b/packages/related/cli/template-web/package.json
@@ -16,7 +16,7 @@
   "devDependencies": {
     "@babel/plugin-syntax-import-attributes": "7.26.0",
     "@jsenv/assert": "4.4.2",
-    "@jsenv/core": "39.5.26",
+    "@jsenv/core": "39.6.0",
     "@jsenv/eslint-config-relax": "1.3.4",
     "@jsenv/plugin-bundling": "2.7.19",
     "@jsenv/plugin-minification": "1.5.11",

diff --git a/src/plugins/autoreload/client/autoreload.js b/src/plugins/autoreload/client/autoreload.js
@@ -2,7 +2,13 @@ import {
   parseSrcSet,
   stringifySrcSet,
 } from "@jsenv/ast/src/html/html_src_set.js";
-import { urlHotMetas } from "../../import_meta_hot/client/import_meta_hot.js";
+import {
+  dispatchAfterPartialReload,
+  dispatchBeforeFullReload,
+  dispatchBeforePartialReload,
+  dispatchBeforePrune,
+  urlHotMetas,
+} from "../../import_meta_hot/client/import_meta_hot.js";
 
 export const initAutoreload = ({ mainFilePath }) => {
   let debug = false;
@@ -62,9 +68,11 @@ export const initAutoreload = ({ mainFilePath }) => {
         (reloadMessage) => reloadMessage.type === "full",
       );
       if (someEffectIsFullReload) {
+        dispatchBeforeFullReload();
         reloadHtmlPage();
         return;
       }
+      dispatchBeforePartialReload();
       reloader.status.goTo("reloading");
       const onApplied = (reloadMessage) => {
         reloader.changes.remove(reloadMessage);
@@ -74,6 +82,7 @@ export const initAutoreload = ({ mainFilePath }) => {
           () => {
             onApplied(reloadMessage);
             reloader.currentExecution = null;
+            dispatchAfterPartialReload();
           },
           (e) => {
             reloader.status.goTo("failed");
@@ -141,6 +150,7 @@ This could be due to syntax errors or importing non-existent modules (see errors
       // - import.meta.hot.accept() is not called (happens for HTML and CSS)
       if (type === "prune") {
         if (urlHotMeta) {
+          dispatchBeforePrune();
           delete urlHotMetas[urlToFetch];
           if (urlHotMeta.disposeCallback) {
             console.groupCollapsed(

diff --git a/src/plugins/import_meta_hot/client/import_meta_hot.js b/src/plugins/import_meta_hot/client/import_meta_hot.js
@@ -5,12 +5,46 @@
 
 export const urlHotMetas = {};
 
+const createEvent = () => {
+  const callbackSet = new Set();
+  const addCallback = (callback) => {
+    callbackSet.add(callback);
+    return () => {
+      callbackSet.delete(callback);
+    };
+  };
+  const dispatch = () => {
+    for (const callback of callbackSet) {
+      callback();
+    }
+  };
+  return [{ addCallback }, dispatch];
+};
+const [beforePartialReload, dispatchBeforePartialReload] = createEvent();
+const [afterPartialReload, dispatchAfterPartialReload] = createEvent();
+const [beforeFullReload, dispatchBeforeFullReload] = createEvent();
+const [beforePrune, dispatchBeforePrune] = createEvent();
+export {
+  dispatchAfterPartialReload,
+  dispatchBeforeFullReload,
+  dispatchBeforePartialReload,
+  dispatchBeforePrune,
+};
+
+const hotEvents = {
+  beforePartialReload,
+  afterPartialReload,
+  beforeFullReload,
+  beforePrune,
+};
+
 export const createImportMetaHot = (importMetaUrl) => {
   const data = {};
   const url = asUrlWithoutHotSearchParam(importMetaUrl);
 
   return {
     data,
+    events: hotEvents,
     accept: (firstArg, secondArg) => {
       if (!firstArg) {
         addUrlMeta(url, {

diff --git a/tests/dev_and_build/import_meta/_import_meta_dev.test.mjs/0_chromium/0_chromium.md b/tests/dev_and_build/import_meta/_import_meta_dev.test.mjs/0_chromium/0_chromium.md
@@ -15,7 +15,13 @@ see [./.jsenv/[email protected]/](./.jsenv/[email protected]/)
   "meta": {
     "url": "window.origin/main.js",
     "hot": {
-      "data": {}
+      "data": {},
+      "events": {
+        "beforePartialReload": {},
+        "afterPartialReload": {},
+        "beforeFullReload": {},
+        "beforePrune": {}
+      }
     }
   },
   "url": "window.origin/main.js",