@jsenv/core 37.0.5 → 37.1.0

package/src/plugins/autoreload/jsenv_plugin_hot_search_param.js

@@ -1,24 +1,17 @@
-export const jsenvPluginHotSearchParam = () => {
-  const shouldInjectHotSearchParam = (reference) => {
-    if (reference.isImplicit) {
-      return false;
-    }
-    if (reference.original && reference.original.searchParams.has("hot")) {
-      return true;
-    }
-    // parent is using ?hot -> propagate
-    const { ownerUrlInfo } = reference;
-    const lastReference = ownerUrlInfo.context.reference;
-    if (
-      lastReference &&
-      lastReference.original &&
-      lastReference.original.searchParams.has("hot")
-    ) {
-      return true;
-    }
-    return false;
-  };
+/*
+ * When client wants to hot reload, it wants to be sure it can reach the server
+ * and bypass any cache. This is done thanks to "hot" search param
+ * being injected by the client: file.js?hot=Date.now()
+ * When it happens server must:
+ * 1. Consider it's a regular request to "file.js" and not a variation
+ * of it (not like file.js?as_js_classic that creates a separate urlInfo)
+ * -> This is done by redirectReference deleting the search param.
+ *
+ * 2. Inject ?hot= into all urls referenced by this one
+ * -> This is done by transformReferenceSearchParams
+ */
 
+export const jsenvPluginHotSearchParam = () => {
   return {
     name: "jsenv:hot_search_param",
     appliesDuring: "dev",
@@ -32,20 +25,45 @@ export const jsenvPluginHotSearchParam = () => {
       // We get rid of this params so that urlGraph and other parts of the code
       // recognize the url (it is not considered as a different url)
       urlObject.searchParams.delete("hot");
-      urlObject.searchParams.delete("v");
       return urlObject.href;
     },
     transformReferenceSearchParams: (reference) => {
-      if (!shouldInjectHotSearchParam(reference)) {
+      if (reference.isImplicit) {
+        return null;
+      }
+      if (reference.original && reference.original.searchParams.has("hot")) {
+        return {
+          hot: reference.original.searchParams.get("hot"),
+        };
+      }
+      const request = reference.ownerUrlInfo.context.request;
+      const parentHotParam = request ? request.searchParams.get("hot") : null;
+      if (!parentHotParam) {
         return null;
       }
+      // At this stage the parent is using ?hot and we are going to decide if
+      // we propagate the search param to child.
       const referencedUrlInfo = reference.urlInfo;
-      if (!referencedUrlInfo.modifiedTimestamp) {
+      const { modifiedTimestamp, dereferencedTimestamp } = referencedUrlInfo;
+      if (!modifiedTimestamp && !dereferencedTimestamp) {
         return null;
       }
+      // The goal is to send an url that will bypass client (the browser) cache
+      // more precisely the runtime cache of js modules, but also any http cache
+      // that could prevent re-execution of js code
+      // In order to achieve this, this plugin inject ?hot=timestamp
+      // - The browser will likely not have it in cache
+      //   and refetch lastest version from server + re-execute it
+      // - If the browser have it in cache, he will not get it from server
+      // We use the latest timestamp to ensure it's fresh
+      // The dereferencedTimestamp is needed because when a js module is re-referenced
+      // browser must re-execute it, even if the code is not modified
+      const latestTimestamp =
+        dereferencedTimestamp && modifiedTimestamp
+          ? Math.max(dereferencedTimestamp, modifiedTimestamp)
+          : dereferencedTimestamp || modifiedTimestamp;
       return {
-        hot: "",
-        v: referencedUrlInfo.modifiedTimestamp,
+        hot: latestTimestamp,
       };
     },
   };

package/src/plugins/import_meta_hot/client/import_meta_hot.js

@@ -75,7 +75,6 @@ const asUrlWithoutHotSearchParam = (url) => {
   const urlObject = new URL(url);
   if (urlObject.searchParams.has("hot")) {
     urlObject.searchParams.delete("hot");
-    urlObject.searchParams.delete("v");
     return urlObject.href;
   }
   return url;

package/src/plugins/plugins.js

@@ -33,9 +33,7 @@ export const getCorePlugins = ({
   transpilation = true,
   inlining = true,
 
-  clientAutoreload = false,
-  clientFileChangeCallbackList,
-  clientFilesPruneCallbackList,
+  clientAutoreload,
   cacheControl,
   scenarioPlaceholders = true,
   ribbon = true,
@@ -46,9 +44,6 @@ export const getCorePlugins = ({
   if (supervisor === true) {
     supervisor = {};
   }
-  if (clientAutoreload === true) {
-    clientAutoreload = {};
-  }
   if (ribbon === true) {
     ribbon = {};
   }
@@ -85,14 +80,8 @@ export const getCorePlugins = ({
     jsenvPluginNodeRuntime({ runtimeCompat }),
 
     jsenvPluginImportMetaHot(),
-    ...(clientAutoreload
-      ? [
-          jsenvPluginAutoreload({
-            ...clientAutoreload,
-            clientFileChangeCallbackList,
-            clientFilesPruneCallbackList,
-          }),
-        ]
+    ...(clientAutoreload && clientAutoreload.enabled
+      ? [jsenvPluginAutoreload(clientAutoreload)]
       : []),
     ...(cacheControl ? [jsenvPluginCacheControl(cacheControl)] : []),
     ...(ribbon ? [jsenvPluginRibbon({ rootDirectoryUrl, ...ribbon })] : []),