@contrast/esm-hooks 2.3.0 → 2.4.0

package/lib/hooks.mjs

@@ -33,6 +33,8 @@ let loaderAgent;
  * @param {{
  *   modes: string[],
  *   port: import('node:worker_threads').MessagePort,
+ *   appInfo: import('@contrast/common').AppInfo,
+ *   agentVersion: string,
  * }} data
  */
 async function initialize(data = {}) {
@@ -129,7 +131,7 @@ async function load(url, context, nextLoad) {
         inject: true,
         wrap: type !== 'module', // cannot wrap modules
       };
-      result = loaderAgent.rewriter.rewrite(source, rewriteOptions);
+      result = await loaderAgent.rewriter.rewrite(source, rewriteOptions);
 
       if (process.env.CSI_EXPOSE_CORE) {
         // only do this in testing scenarios (todo: compose this functionality into test agents instead)

package/lib/index.mjs

@@ -46,6 +46,8 @@ export default function init(core) {
       const data = {
         port: workerPort,
         modes: esmHooks.getActiveModes(),
+        appInfo: core.appInfo,
+        agentVersion: core.agentVersion,
       };
 
       // Instantiate loader agent via register (if available) or manually.

package/lib/loader-agent.mjs

@@ -14,17 +14,26 @@
  */
 
 import Module from 'node:module';
+import { IntentionalError } from '@contrast/common';
 import { default as debugMethods } from './debug-methods.mjs';
 import { default as portClient } from './post-message/loader-client.mjs';
 const require = Module.createRequire(import.meta.url);
-const messages = require('@contrast/core/lib/messages');
-const config = require('@contrast/config');
-const logger = require('@contrast/logger').default;
-const rewriter = require('@contrast/rewriter');
 
+// TODO: language
+const ERROR_MESSAGE = 'An error prevented the Contrast agent from initializing in the loader thread.';
 
-export default function init({ port, modes }) {
+/**
+ * @param {{
+ *   modes: string[],
+ *   port: import('node:worker_threads').MessagePort,
+ *   appInfo: import('@contrast/common').AppInfo,
+ *   agentVersion: string,
+ * }} data
+ */
+export default function init({ appInfo, agentVersion, port, modes }) {
   const core = {
+    appInfo,
+    agentVersion,
     // this will toggle functionality in hooks.mjs e.g. redirects/rewriting
     enable: true,
     // stub for debugMethods
@@ -46,11 +55,24 @@ export default function init({ port, modes }) {
     },
   };
 
-  messages(core);
-  config(core);
-  logger(core);
-  rewriter(core);
-  portClient(core, { port });
+  try {
+    require('@contrast/core/lib/messages')(core);
+    require('@contrast/config')(core);
+    require('@contrast/logger').default(core);
+    require('@contrast/rewriter')(core);
+    portClient(core, { port });
+
+    return core;
+  } catch (err) {
+    core.enable = false;
 
-  return core;
+    // ignore intentional errors
+    if (!(err instanceof IntentionalError)) {
+      if (core.logger) {
+        core.logger.error({ err }, ERROR_MESSAGE);
+      } else {
+        console.error(new Error(ERROR_MESSAGE, { cause: err }));
+      }
+    }
+  }
 }

package/lib/post-message/loader-client.mjs

@@ -13,13 +13,17 @@
  * way not consistent with the End User License Agreement.
  */
 
+import { Event } from '@contrast/common';
 import { send } from './send.mjs';
 
 /**
  * Handles loader agent communication with the main agent's port client.
  * Has API to send status messages to main agent e.g. for when it installs/uninstalls.
  * Also listens for for TS settings updates and messages from main agent instructing it to disable.
- */
+ * @param {any} core
+ * @param {Object} opts
+ * @param {import('node:worker_threads').MessagePort} opts.port
+*/
 export default function init(core, { port }) {
   const portClient = core.esmHooks.portClient = {
     _port: port,

package/lib/post-message/main-client.mjs

@@ -13,19 +13,23 @@
  * way not consistent with the End User License Agreement.
  */
 
+import { Event } from '@contrast/common';
 import { send } from './send.mjs';
 
 /**
  * Handles main agent communication with the loader agent's port client.
  * Has API to forward events, and for sending RPC-like messages e.g. for instructing it to disable.
  * Will listen for status messages from the loader agent and log them.
+ * @param {any} core
+ * @param {Object} opts
+ * @param {import('node:worker_threads').MessagePort} opts.port
  */
 export default function init(core, { port }) {
   const portClient = core.esmHooks.portClient = {
     _port: port,
     _handlers: {
-      status(msg) {
-        core.logger.debug(msg, 'loader agent status report');
+      status(msg, data) {
+        core.logger.trace({ name: 'contrast:esm:loader', data }, msg);
       },
     },
     /**
@@ -45,7 +49,7 @@ export default function init(core, { port }) {
   // handling messages from loader agent
   portClient._port.on('message', (raw) => {
     if (raw?.type == 'status') {
-      portClient._handlers.status(raw.msg);
+      portClient._handlers.status(raw.msg, raw.data);
     }
   });
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrast/esm-hooks",
-  "version": "2.3.0",
+  "version": "2.4.0",
   "type": "module",
   "description": "Support for loading and instrumenting ECMAScript modules",
   "license": "SEE LICENSE IN LICENSE",