@jsenv/core 27.3.2 → 27.4.0

package/src/helpers/event_source/event_source.js

@@ -1,8 +1,13 @@
 /* eslint-env browser */
 
+const STATUSES = {
+  CONNECTING: "connecting",
+  CONNECTED: "connected",
+  DISCONNECTED: "disconnected",
+}
+
 export const createEventSourceConnection = (
   eventSourceUrl,
-  events = {},
   { retryMaxAttempt = Infinity, retryAllocatedMs = Infinity, lastEventId } = {},
 ) => {
   const { EventSource } = window
@@ -10,18 +15,26 @@ export const createEventSourceConnection = (
     return () => {}
   }
 
+  let eventSource
+  const events = {}
   const eventSourceOrigin = new URL(eventSourceUrl).origin
-  Object.keys(events).forEach((eventName) => {
-    const eventCallback = events[eventName]
-    events[eventName] = (e) => {
-      if (e.origin === eventSourceOrigin) {
-        if (e.lastEventId) {
-          lastEventId = e.lastEventId
+  const addEventCallbacks = (eventCallbacks) => {
+    Object.keys(eventCallbacks).forEach((eventName) => {
+      const eventCallback = eventCallbacks[eventName]
+      events[eventName] = (e) => {
+        if (e.origin === eventSourceOrigin) {
+          if (e.lastEventId) {
+            lastEventId = e.lastEventId
+          }
+          eventCallback(e)
         }
-        eventCallback(e)
       }
-    }
-  })
+      if (eventSource) {
+        eventSource.addEventListener(eventName, events[eventName])
+      }
+    })
+  }
+  addEventCallbacks(events)
 
   const status = {
     value: "default",
@@ -37,11 +50,14 @@ export const createEventSourceConnection = (
   let _disconnect = () => {}
 
   const attemptConnection = (url) => {
-    const eventSource = new EventSource(url, {
+    eventSource = new EventSource(url, {
       withCredentials: true,
     })
     _disconnect = () => {
-      if (status.value !== "connecting" && status.value !== "connected") {
+      if (
+        status.value !== STATUSES.CONNECTING &&
+        status.value !== STATUSES.CONNECTED
+      ) {
         console.warn(
           `disconnect() ignored because connection is ${status.value}`,
         )
@@ -52,7 +68,8 @@ export const createEventSourceConnection = (
       Object.keys(events).forEach((eventName) => {
         eventSource.removeEventListener(eventName, events[eventName])
       })
-      status.goTo("disconnected")
+      eventSource = null
+      status.goTo(STATUSES.DISCONNECTED)
     }
     let retryCount = 0
     let firstRetryMs = Date.now()
@@ -78,7 +95,7 @@ export const createEventSourceConnection = (
         }
 
         retryCount++
-        status.goTo("connecting")
+        status.goTo(STATUSES.CONNECTING)
         return
       }
 
@@ -88,7 +105,7 @@ export const createEventSourceConnection = (
       }
     }
     eventSource.onopen = () => {
-      status.goTo("connected")
+      status.goTo(STATUSES.CONNECTED)
     }
     Object.keys(events).forEach((eventName) => {
       eventSource.addEventListener(eventName, events[eventName])
@@ -100,7 +117,7 @@ export const createEventSourceConnection = (
         }
       })
     }
-    status.goTo("connecting")
+    status.goTo(STATUSES.CONNECTING)
   }
 
   let connect = () => {
@@ -115,7 +132,10 @@ export const createEventSourceConnection = (
   }
 
   const removePageUnloadListener = listenPageUnload(() => {
-    if (status.value === "connecting" || status.value === "connected") {
+    if (
+      status.value === STATUSES.CONNECTING ||
+      status.value === STATUSES.CONNECTED
+    ) {
       _disconnect()
     }
   })
@@ -128,6 +148,7 @@ export const createEventSourceConnection = (
   return {
     status,
     connect,
+    addEventCallbacks,
     disconnect: () => _disconnect(),
     destroy,
   }

package/src/omega/errors.js

@@ -1,4 +1,5 @@
 import { createDetailedMessage } from "@jsenv/log"
+import { stringifyUrlSite } from "@jsenv/urls"
 
 export const createResolveUrlError = ({
   pluginController,
@@ -15,7 +16,7 @@ export const createResolveUrlError = ({
         reason,
         ...details,
         "specifier": `"${reference.specifier}"`,
-        "specifier trace": reference.trace,
+        "specifier trace": reference.trace.message,
         ...detailsFromPluginController(pluginController),
       }),
     )
@@ -46,19 +47,23 @@ export const createFetchUrlContentError = ({
     reason,
     ...details
   }) => {
-    const fetchContentError = new Error(
+    const fetchError = new Error(
       createDetailedMessage(`Failed to fetch url content`, {
         reason,
         ...details,
         "url": urlInfo.url,
-        "url reference trace": reference.trace,
+        "url reference trace": reference.trace.message,
         ...detailsFromPluginController(pluginController),
       }),
     )
-    fetchContentError.name = "FETCH_URL_CONTENT_ERROR"
-    fetchContentError.code = code
-    fetchContentError.reason = reason
-    return fetchContentError
+    fetchError.name = "FETCH_URL_CONTENT_ERROR"
+    fetchError.code = code
+    fetchError.reason = reason
+    fetchError.url = reference.trace.url
+    fetchError.line = reference.trace.line
+    fetchError.column = reference.trace.column
+    fetchError.contentFrame = reference.trace.message
+    return fetchError
   }
 
   if (error.code === "EPERM") {
@@ -103,7 +108,7 @@ export const createTransformUrlContentError = ({
           reason,
           ...details,
           "url": urlInfo.url,
-          "url reference trace": reference.trace,
+          "url reference trace": reference.trace.message,
           ...detailsFromPluginController(pluginController),
         },
       ),
@@ -111,6 +116,33 @@ export const createTransformUrlContentError = ({
     transformError.name = "TRANSFORM_URL_CONTENT_ERROR"
     transformError.code = code
     transformError.reason = reason
+    transformError.url = reference.trace.url
+    transformError.line = reference.trace.line
+    transformError.column = reference.trace.column
+    transformError.stack = error.stack
+    transformError.contentFrame = reference.trace.message
+    if (code === "PARSE_ERROR") {
+      transformError.reason = error.message
+      if (urlInfo.isInline) {
+        transformError.line = reference.trace.line + error.line - 1
+        transformError.column = reference.trace.column + error.column
+        transformError.contentFrame = stringifyUrlSite({
+          url: urlInfo.inlineUrlSite.url,
+          line: transformError.line,
+          column: transformError.column,
+          content: urlInfo.inlineUrlSite.content,
+        })
+      } else {
+        transformError.line = error.line
+        transformError.column = error.column
+        transformError.contentFrame = stringifyUrlSite({
+          url: urlInfo.url,
+          line: transformError.line,
+          column: transformError.column,
+          content: urlInfo.content,
+        })
+      }
+    }
     return transformError
   }
   return createFailedToTransformError({
@@ -130,7 +162,7 @@ export const createFinalizeUrlContentError = ({
       "reason": `An error occured during "finalizeUrlContent"`,
       ...detailsFromValueThrown(error),
       "url": urlInfo.url,
-      "url reference trace": reference.trace,
+      "url reference trace": reference.trace.message,
       ...detailsFromPluginController(pluginController),
     }),
   )

package/src/omega/kitchen.js

@@ -221,7 +221,10 @@ export const createKitchen = ({
     sourcemapsRelativeSources,
     injectSourcemapPlaceholder: ({ urlInfo, specifier }) => {
       const sourcemapReference = createReference({
-        trace: `sourcemap comment placeholder for ${urlInfo.url}`,
+        trace: {
+          message: `sourcemap comment placeholder`,
+          url: urlInfo.url,
+        },
         type: "sourcemap_comment",
         subtype: urlInfo.contentType === "text/javascript" ? "js" : "css",
         parentUrl: urlInfo.url,
@@ -238,15 +241,14 @@ export const createKitchen = ({
       specifierLine,
       specifierColumn,
     }) => {
+      const sourcemapUrlSite = adjustUrlSite(urlInfo, {
+        urlGraph,
+        url: urlInfo.url,
+        line: specifierLine,
+        column: specifierColumn,
+      })
       const sourcemapReference = createReference({
-        trace: stringifyUrlSite(
-          adjustUrlSite(urlInfo, {
-            urlGraph,
-            url: urlInfo.url,
-            line: specifierLine,
-            column: specifierColumn,
-          }),
-        ),
+        trace: traceFromUrlSite(sourcemapUrlSite),
         type,
         parentUrl: urlInfo.url,
         specifier,
@@ -273,7 +275,7 @@ export const createKitchen = ({
             `no plugin has handled url during "fetchUrlContent" hook -> url will be ignored`,
             {
               "url": urlInfo.url,
-              "url reference trace": reference.trace,
+              "url reference trace": reference.trace.message,
             },
           ),
         )
@@ -408,7 +410,7 @@ export const createKitchen = ({
         },
         found: ({ trace, ...rest }) => {
           if (trace === undefined) {
-            trace = stringifyUrlSite(
+            trace = traceFromUrlSite(
               adjustUrlSite(urlInfo, {
                 urlGraph,
                 url: urlInfo.url,
@@ -423,7 +425,12 @@ export const createKitchen = ({
             ...rest,
           })
         },
-        foundInline: ({ isOriginalPosition, line, column, ...rest }) => {
+        foundInline: ({
+          isOriginalPosition,
+          specifierLine,
+          specifierColumn,
+          ...rest
+        }) => {
           const parentUrl = isOriginalPosition
             ? urlInfo.url
             : urlInfo.generatedUrl
@@ -431,15 +438,15 @@ export const createKitchen = ({
             ? urlInfo.originalContent
             : urlInfo.content
           return addReference({
-            trace: stringifyUrlSite({
+            trace: traceFromUrlSite({
               url: parentUrl,
               content: parentContent,
-              line,
-              column,
+              line: specifierLine,
+              column: specifierColumn,
             }),
             isOriginalPosition,
-            line,
-            column,
+            specifierLine,
+            specifierColumn,
             isInline: true,
             ...rest,
           })
@@ -487,7 +494,7 @@ export const createKitchen = ({
             ? urlInfo.originalContent
             : urlInfo.content
           return referenceUtils.update(reference, {
-            trace: stringifyUrlSite({
+            trace: traceFromUrlSite({
               url: parentUrl,
               content: parentContent,
               line: specifierLine,
@@ -505,7 +512,7 @@ export const createKitchen = ({
         inject: ({ trace, ...rest }) => {
           if (trace === undefined) {
             const { url, line, column } = getCallerPosition()
-            trace = stringifyUrlSite({
+            trace = traceFromUrlSite({
               url,
               line,
               column,
@@ -722,6 +729,15 @@ const memoizeCook = (cook) => {
   }
 }
 
+const traceFromUrlSite = (urlSite) => {
+  return {
+    message: stringifyUrlSite(urlSite),
+    url: urlSite.url,
+    line: urlSite.line,
+    column: urlSite.column,
+  }
+}
+
 const applyReferenceEffectsOnUrlInfo = (reference, urlInfo, context) => {
   if (reference.shouldHandle) {
     urlInfo.shouldHandle = true

package/src/omega/omega_server.js

@@ -7,8 +7,12 @@ import {
   pluginCORS,
 } from "@jsenv/server"
 import { convertFileSystemErrorToResponseProperties } from "@jsenv/server/src/internal/convertFileSystemErrorToResponseProperties.js"
-import { createCallbackListNotifiedOnce } from "@jsenv/abort"
+import {
+  createCallbackListNotifiedOnce,
+  createCallbackList,
+} from "@jsenv/abort"
 
+import { createSSEService } from "@jsenv/core/src/helpers/event_source/sse_service.js"
 import { createFileService } from "./server/file_service.js"
 
 export const startOmegaServer = async ({
@@ -33,12 +37,60 @@ export const startOmegaServer = async ({
   kitchen,
 }) => {
   const serverStopCallbackList = createCallbackListNotifiedOnce()
+
+  const serverEventCallbackList = createCallbackList()
+  const sseService = createSSEService({ serverEventCallbackList })
+  const sendServerEvent = ({ type, data }) => {
+    serverEventCallbackList.notify({
+      type,
+      data: JSON.stringify(data),
+    })
+  }
+
+  kitchen.pluginController.addHook("registerServerEvents")
+  kitchen.pluginController.callHooks(
+    "registerServerEvents",
+    { sendServerEvent },
+    {
+      rootDirectoryUrl,
+      urlGraph,
+      scenario,
+    },
+    () => {},
+  )
+
+  const sendServerErrorEvent = (event) => {
+    // setTimeout display first the error
+    // dispatched on window by browser
+    // then display the jsenv error
+    setTimeout(() => {
+      sendServerEvent(event)
+    }, 10)
+  }
+
   const coreServices = {
+    "service:server_events": (request) => {
+      const { accept } = request.headers
+      if (accept && accept.includes("text/event-stream")) {
+        const room = sseService.getOrCreateSSERoom(request)
+        return room.join(request)
+      }
+      return null
+    },
     "service:file": createFileService({
       rootDirectoryUrl,
       urlGraph,
       kitchen,
       scenario,
+      onFileNotFound: (data) => {
+        sendServerErrorEvent({ type: "file_not_found", data })
+      },
+      onParseError: (data) => {
+        sendServerErrorEvent({ type: "parse_error", data })
+      },
+      onUnexpectedError: (data) => {
+        sendServerErrorEvent({ type: "unexpected_error", data })
+      },
     }),
   }
   const server = await startServer({
@@ -119,6 +171,7 @@ export const startOmegaServer = async ({
     }),
     onStop: (reason) => {
       onStop()
+      sseService.destroy()
       serverStopCallbackList.notify(reason)
     },
   })

package/src/omega/server/file_service.js

@@ -12,6 +12,9 @@ export const createFileService = ({
   urlGraph,
   kitchen,
   scenario,
+  onParseError,
+  onFileNotFound,
+  onUnexpectedError,
 }) => {
   kitchen.pluginController.addHook("serve")
   kitchen.pluginController.addHook("augmentResponse")
@@ -51,7 +54,7 @@ export const createFileService = ({
     }
     if (!reference) {
       const entryPoint = kitchen.injectReference({
-        trace: parentUrl || rootDirectoryUrl,
+        trace: { message: parentUrl || rootDirectoryUrl },
         parentUrl: parentUrl || rootDirectoryUrl,
         type: "http_request",
         specifier: request.ressource,
@@ -135,10 +138,17 @@ export const createFileService = ({
     } catch (e) {
       const code = e.code
       if (code === "PARSE_ERROR") {
-        // let the browser re-throw the syntax error
+        onParseError({
+          reason: e.reason,
+          message: e.message,
+          url: e.url,
+          line: e.line,
+          column: e.column,
+          contentFrame: e.contentFrame,
+        })
         return {
           url: reference.url,
-          status: 200,
+          status: 200, // let the browser re-throw the syntax error
           statusText: e.reason,
           statusMessage: e.message,
           headers: {
@@ -166,6 +176,14 @@ export const createFileService = ({
         }
       }
       if (code === "NOT_FOUND") {
+        onFileNotFound({
+          reason: e.reason,
+          message: e.message,
+          url: e.url,
+          line: e.line,
+          column: e.column,
+          contentFrame: e.contentFrame,
+        })
         return {
           url: reference.url,
           status: 404,
@@ -173,6 +191,15 @@ export const createFileService = ({
           statusMessage: e.message,
         }
       }
+      onUnexpectedError({
+        reason: e.reason,
+        message: e.message,
+        stack: e.stack,
+        url: e.url,
+        line: e.line,
+        column: e.column,
+        contentFrame: e.contentFrame,
+      })
       return {
         url: reference.url,
         status: 500,

package/src/omega/url_graph/url_graph_report.js

@@ -11,7 +11,6 @@ ${createRepartitionMessage(graphReport)}
 }
 
 const createUrlGraphReport = (urlGraph) => {
-  const { urlInfos } = urlGraph
   const countGroups = {
     sourcemaps: 0,
     html: 0,
@@ -30,11 +29,10 @@ const createUrlGraphReport = (urlGraph) => {
     other: 0,
     total: 0,
   }
-  Object.keys(urlInfos).forEach((url) => {
-    if (url.startsWith("data:")) {
+  urlGraph.urlInfoMap.forEach((urlInfo) => {
+    if (urlInfo.url.startsWith("data:")) {
       return
     }
-    const urlInfo = urlInfos[url]
     // ignore:
     // - inline files: they are already taken into account in the file where they appear
     // - ignored files: we don't know their content

package/src/omega/url_graph.js

@@ -5,12 +5,12 @@ export const createUrlGraph = ({
   clientFileChangeCallbackList,
   clientFilesPruneCallbackList,
 } = {}) => {
-  const urlInfos = {}
-  const getUrlInfo = (url) => urlInfos[url]
+  const urlInfoMap = new Map()
+  const getUrlInfo = (url) => urlInfoMap.get(url)
   const deleteUrlInfo = (url) => {
-    const urlInfo = urlInfos[url]
+    const urlInfo = urlInfoMap.get(url)
     if (urlInfo) {
-      delete urlInfos[url]
+      urlInfoMap.delete(url)
       if (urlInfo.sourcemapReference) {
         deleteUrlInfo(urlInfo.sourcemapReference.url)
       }
@@ -18,14 +18,14 @@ export const createUrlGraph = ({
   }
 
   const reuseOrCreateUrlInfo = (url) => {
-    const existingUrlInfo = urlInfos[url]
+    const existingUrlInfo = getUrlInfo(url)
     if (existingUrlInfo) return existingUrlInfo
     const urlInfo = createUrlInfo(url)
-    urlInfos[url] = urlInfo
+    urlInfoMap.set(url, urlInfo)
     return urlInfo
   }
   const inferReference = (specifier, parentUrl) => {
-    const parentUrlInfo = urlInfos[parentUrl]
+    const parentUrlInfo = getUrlInfo(parentUrl)
     if (!parentUrlInfo) {
       return null
     }
@@ -37,13 +37,13 @@ export const createUrlGraph = ({
     return firstReferenceOnThatUrl
   }
   const findDependent = (url, predicate) => {
-    const urlInfo = urlInfos[url]
+    const urlInfo = getUrlInfo(url)
     if (!urlInfo) {
       return null
     }
     const visitDependents = (urlInfo) => {
       for (const dependentUrl of urlInfo.dependents) {
-        const dependent = urlInfos[dependentUrl]
+        const dependent = getUrlInfo(dependentUrl)
         if (predicate(dependent)) {
           return dependent
         }
@@ -90,7 +90,7 @@ export const createUrlGraph = ({
     const removeDependencies = (urlInfo, urlsToPrune) => {
       urlsToPrune.forEach((urlToPrune) => {
         urlInfo.dependencies.delete(urlToPrune)
-        const dependency = urlInfos[urlToPrune]
+        const dependency = getUrlInfo(urlToPrune)
         if (!dependency) {
           return
         }
@@ -122,7 +122,7 @@ export const createUrlGraph = ({
 
   if (clientFileChangeCallbackList) {
     clientFileChangeCallbackList.push(({ url }) => {
-      const urlInfo = urlInfos[url]
+      const urlInfo = getUrlInfo(url)
       if (urlInfo) {
         considerModified(urlInfo, Date.now())
       }
@@ -139,12 +139,18 @@ export const createUrlGraph = ({
       urlInfo.modifiedTimestamp = modifiedTimestamp
       urlInfo.contentEtag = undefined
       urlInfo.dependents.forEach((dependentUrl) => {
-        const dependentUrlInfo = urlInfos[dependentUrl]
+        const dependentUrlInfo = getUrlInfo(dependentUrl)
         const { hotAcceptDependencies = [] } = dependentUrlInfo.data
         if (!hotAcceptDependencies.includes(urlInfo.url)) {
           iterate(dependentUrlInfo)
         }
       })
+      urlInfo.dependencies.forEach((dependencyUrl) => {
+        const dependencyUrlInfo = getUrlInfo(dependencyUrl)
+        if (dependencyUrlInfo.isInline) {
+          iterate(dependencyUrlInfo)
+        }
+      })
     }
     iterate(urlInfo)
   }
@@ -164,7 +170,7 @@ export const createUrlGraph = ({
   }
 
   return {
-    urlInfos,
+    urlInfoMap,
     reuseOrCreateUrlInfo,
     getUrlInfo,
     deleteUrlInfo,
@@ -174,12 +180,19 @@ export const createUrlGraph = ({
     considerModified,
     getRelatedUrlInfos,
 
+    toObject: () => {
+      const data = {}
+      urlInfoMap.forEach((urlInfo) => {
+        data[urlInfo.url] = urlInfo
+      })
+      return data
+    },
     toJSON: (rootDirectoryUrl) => {
       const data = {}
-      Object.keys(urlInfos).forEach((url) => {
-        const dependencyUrls = Array.from(urlInfos[url].dependencies)
+      urlInfoMap.forEach((urlInfo) => {
+        const dependencyUrls = Array.from(urlInfo.dependencies)
         if (dependencyUrls.length) {
-          const relativeUrl = urlToRelativeUrl(url, rootDirectoryUrl)
+          const relativeUrl = urlToRelativeUrl(urlInfo.url, rootDirectoryUrl)
           data[relativeUrl] = dependencyUrls.map((dependencyUrl) =>
             urlToRelativeUrl(dependencyUrl, rootDirectoryUrl),
           )

package/src/plugins/autoreload/dev_sse/client/event_source_client.js

@@ -157,21 +157,21 @@ const addReloadMessage = (reloadMessage) => {
 
 const eventsourceConnection = createEventSourceConnection(
   document.location.href,
-  {
-    reload: ({ data }) => {
-      const reloadMessage = JSON.parse(data)
-      addReloadMessage(reloadMessage)
-    },
-  },
   {
     retryMaxAttempt: Infinity,
     retryAllocatedMs: 20 * 1000,
   },
 )
-
-const { status, connect, disconnect } = eventsourceConnection
+const { status, connect, addEventCallbacks, disconnect } = eventsourceConnection
+eventsourceConnection.addEventCallbacks({
+  reload: ({ data }) => {
+    const reloadMessage = JSON.parse(data)
+    addReloadMessage(reloadMessage)
+  },
+})
 connect()
 window.__jsenv_event_source_client__ = {
+  addEventCallbacks,
   status,
   connect,
   disconnect,