refactor: new format marker %O which try calling String

This marker replaces the %e format which is exclusivelly for errors. The advantage of %O over %e is that it never fails. This is handy because formatting is often use for debugging so we avoid reporting error while reporting another error (harder to understand). Note that %O can trigger arbitrary code whereas %o is always safe to use.

components/abomination/default/index.mjs

@@ -54,7 +54,7 @@ export default (dependencies) => {
               await unlinkAsync(link);
               await symlinkAsync(`${path}.cjs`, link, "file");
             })(),
-            "Something went wrong when resolving the missing file extension issue >> %e",
+            "Something went wrong when resolving the missing file extension issue >> %O",
           );
         }
       }

components/batch/default/index.mjs

@@ -71,7 +71,7 @@ export default (dependencies) => {
               resolve({ signal, status });
             });
           }),
-          "Child error %j >> %e",
+          "Child error %j >> %O",
           description,
         );
         subprocess = null;

components/configuration-accessor/default/index.mjs

@@ -181,7 +181,7 @@ export default (dependencies) => {
       const { scenarios, scenario } = configuration;
       const regexp = expectSuccess(
         () => new _RegExp(scenario, "u"),
-        "Scenario configuration field is not a valid regexp: %j >> %e",
+        "Scenario configuration field is not a valid regexp: %j >> %O",
         scenario,
       );
       return scenarios

components/configuration-environment/default/index.mjs

@@ -16,7 +16,7 @@ export default (dependencies) => {
       const { APPMAP_CONFIGURATION: content } = env;
       const configuration = expectSuccess(
         () => parseJSON(content),
-        "failed to parse 'APPMAP_CONFIGURATION' environment variable >> %e",
+        "failed to parse 'APPMAP_CONFIGURATION' environment variable >> %O",
       );
       validateConfiguration(configuration);
       return configuration;

components/configuration-process/node/index.mjs

@@ -43,15 +43,15 @@ export default (dependencies) => {
       const { code } = error;
       expect(
         code === "ENOENT",
-        "Cannot read configuration file at %j >> %e",
+        "Cannot read configuration file at %j >> %O",
         url,
         error,
       );
       return {};
     }
     return expectSuccess(
       () => parse(content),
-      "Failed to parse configuration file at %j >> %e",
+      "Failed to parse configuration file at %j >> %O",
       url,
     );
   };

components/expect-inner/default/index.test.mjs

@@ -33,7 +33,7 @@ try {
 }
 
 assertEqual(
-  expectSuccess(() => 123, "%e"),
+  expectSuccess(() => 123, "%O"),
   123,
 );
 
@@ -42,19 +42,19 @@ try {
     () => {
       throw new Error("foo");
     },
-    "%s %e",
+    "%s %O",
     "bar",
   );
   assertFail();
 } catch ({ message }) {
-  assertEqual(message, "bar foo");
+  assertEqual(message, "bar Error: foo");
 }
 
-await expectSuccessAsync(Promise.resolve(123), "%e");
+await expectSuccessAsync(Promise.resolve(123), "%O");
 
 try {
-  await expectSuccessAsync(Promise.reject(new Error("foo")), "%s %e", "bar");
+  await expectSuccessAsync(Promise.reject(new Error("foo")), "%s %O", "bar");
   assertFail();
 } catch ({ message }) {
-  assertEqual(message, "bar foo");
+  assertEqual(message, "bar Error: foo");
 }

components/expect/debug/index.test.mjs

@@ -7,7 +7,7 @@ const { expect, expectSuccess, expectSuccessAsync } = Expect(
 );
 assertEqual(expect(true, "%s", "foo"), undefined);
 assertEqual(
-  expectSuccess(() => 123, "%e"),
+  expectSuccess(() => 123, "%O"),
   123,
 );
-await expectSuccessAsync(Promise.resolve(123), "%e");
+await expectSuccessAsync(Promise.resolve(123), "%O");

components/hook-query/node/require.mjs

@@ -14,7 +14,7 @@ export default (dependencies) => {
       try {
         return createRequire(url)(name);
       } catch (error) {
-        logWarning("Could not load %j from %j >> %e", name, directory, error);
+        logWarning("Could not load %j from %j >> %O", name, directory, error);
         return null;
       }
     },

components/hook-response/node/index.mjs

@@ -212,7 +212,7 @@ export default (dependencies) => {
         recorder,
         regexp: expectSuccess(
           () => new _RegExp(intercept_track_port, "u"),
-          "Failed to compile the 'intercept-track-port' configuration field %j as regexp >> %e",
+          "Failed to compile the 'intercept-track-port' configuration field %j as regexp >> %O",
           intercept_track_port,
         ),
       };

components/instrumentation/default/index.mjs

@@ -86,7 +86,7 @@ export default (dependencies) => {
                   ecmaVersion: configuration.language.version,
                   locations: true,
                 }),
-              "failed to parse file %j >> %e",
+              "failed to parse file %j >> %O",
               url,
             ),
             {

components/receptor-file/default/index.mjs

@@ -34,7 +34,7 @@ export default (dependencies) => {
       const { code } = error;
       expect(
         code === "ENOENT",
-        "cannot read directory status %j >> %e",
+        "cannot read directory status %j >> %O",
         directory,
         error,
       );

components/recorder-api/default/index.mjs

@@ -36,7 +36,7 @@ export default (dependencies) => {
     url = _String(url);
     expectSuccess(
       () => new _URL(url),
-      "the second argument of appmap.recordScript should be a valid url, got: %j >> %e",
+      "the second argument of appmap.recordScript should be a valid url, got: %j >> %O",
       url,
     );
     return { type, url, content };

components/repository/node/git.mjs

@@ -28,7 +28,7 @@ export default (dependencies) => {
     const error = coalesce(result, "error", null);
     expect(
       error === null,
-      `command %j on cwd %j threw an error >> %e`,
+      `command %j on cwd %j threw an error >> %O`,
       command,
       url,
       error || { message: "dummy" },
@@ -74,7 +74,7 @@ export default (dependencies) => {
       if (
         !expectSuccess(
           () => readdirSync(new _URL(url)),
-          "could not read repository directory %j >> %e",
+          "could not read repository directory %j >> %O",
           url,
         ).includes(".git")
       ) {

components/repository/node/index.mjs

@@ -21,7 +21,7 @@ export default (dependencies) => {
       const { code } = { code: null, ...error };
       expect(
         code === "ENOENT",
-        "failed to attempt reading package.json >> %e",
+        "failed to attempt reading package.json >> %O",
         error,
       );
       return false;
@@ -35,14 +35,14 @@ export default (dependencies) => {
         "utf8",
       );
     } catch (error) {
-      logWarning("Cannot read package.json file at %j >> %e", url, error);
+      logWarning("Cannot read package.json file at %j >> %O", url, error);
       return null;
     }
     let json;
     try {
       json = parseJSON(content);
     } catch (error) {
-      logWarning("Failed to parse package.json file at %j >> %e", url, error);
+      logWarning("Failed to parse package.json file at %j >> %O", url, error);
       return null;
     }
     const { name, version, homepage } = {
@@ -75,7 +75,7 @@ export default (dependencies) => {
       let url = pathToFileURL(
         expectSuccess(
           () => resolve(segments.join("/")),
-          "could not resolve %j from %j >> %e",
+          "could not resolve %j from %j >> %O",
           segments,
           home,
         ),

components/serialization/default/index.mjs

@@ -121,7 +121,7 @@ export default (dependencies) => {
             try {
               serial.print = value.toString();
             } catch (error) {
-              logWarning("%o.toString() failed with %e", value, error);
+              logWarning("%o.toString() failure >> %O", value, error);
               serial.print = apply(toString, value, noargs);
             }
           } else {

components/service/default/index.mjs

@@ -19,7 +19,7 @@ export default (dependencies) => {
         sockets.add(socket);
         /* c8 ignore start */
         socket.on("error", (error) => {
-          logWarning("Socket error >> %e", error);
+          logWarning("Socket error >> %O", error);
         });
         /* c8 ignore stop */
         socket.on("close", () => {

components/source/default/index.mjs

@@ -76,7 +76,7 @@ export default (dependencies) => {
         url,
         expectSuccess(
           () => parseJSON(content),
-          "Invalid JSON format for source map at %j >> %e",
+          "Invalid JSON format for source map at %j >> %O",
           url,
         ),
       );

components/specifier/default/index.mjs

@@ -21,7 +21,7 @@ export default (dependencies) => {
     } else {
       const regexp = expectSuccess(
         () => new _RegExp(source, flags),
-        "failed to compile regexp source = %j flags = %j >> %e",
+        "failed to compile regexp source = %j flags = %j >> %O",
         source,
         flags,
       );

components/trace/appmap/classmap/estree/parse.mjs

@@ -60,12 +60,12 @@ export default (dependencies) => {
           attachComment: true,
         });
       } catch (error) {
-        logError("Unrecoverable parsing error at file %j >> %e", path, error);
+        logError("Unrecoverable parsing error at file %j >> %O", path, error);
         return { type: "Program", body: [], sourceType: "script" };
       }
       const { errors, program: node } = result;
       for (const error of errors) {
-        logWarning("Recoverable parsing error at file %j >> %e", path, error);
+        logWarning("Recoverable parsing error at file %j >> %O", path, error);
       }
       return node;
     },

components/util/default/format.mjs

@@ -1,8 +1,7 @@
 import { assert } from "./assert.mjs";
 import { print } from "./print.mjs";
 
-const { getOwnPropertyDescriptor } = Reflect;
-const _undefined = undefined;
+const _String = String;
 const { stringify } = JSON;
 
 export const format = (template, values) => {
@@ -21,27 +20,16 @@ export const format = (template, values) => {
         assert(typeof value === "string", "expected a string for format");
         return value;
       }
-      if (marker === "e") {
-        assert(
-          typeof value === "object" && value !== null,
-          "expected an object",
-        );
-        const descriptor = getOwnPropertyDescriptor(value, "message");
-        assert(descriptor !== _undefined, "missing 'message' property");
-        assert(
-          getOwnPropertyDescriptor(descriptor, "value") !== _undefined,
-          "'message' property is an accessor",
-        );
-        const { value: message } = descriptor;
-        assert(
-          typeof message === "string",
-          "expected 'message' property value to be a string",
-        );
-        return message;
-      }
       if (marker === "j") {
         return stringify(value);
       }
+      if (marker === "O") {
+        try {
+          return _String(value);
+        } catch {
+          return print(value);
+        }
+      }
       if (marker === "o") {
         return print(value);
       }

components/util/default/format.test.mjs

@@ -28,18 +28,17 @@ assertEqual(format("%j", [[123]]), "[123]");
 
 assertEqual(format("%o", [() => {}]), "[object Function]");
 
-// %e //
-
-assertEqual(format("%e", [new Error("foo")]), "foo");
-
-assertThrow(() => format("%e", [null]), /^AssertionError: expected an object/u);
-
-assertThrow(
-  () => format("%e", [{}]),
-  /^AssertionError: missing 'message' property/u,
-);
-
-assertThrow(
-  () => format("%e", [{ message: 123 }]),
-  /^AssertionError: expected 'message' property value to be a string/u,
+// %O //
+
+assertEqual(format("%O", [{ toString: () => "foo" }]), "foo");
+
+assertEqual(
+  format("%O", [
+    {
+      toString: () => {
+        throw new Error("BOUM");
+      },
+    },
+  ]),
+  "[object Object]",
 );

components/validate-appmap/on/index.mjs

@@ -10,7 +10,7 @@ export default (dependencies) => {
     validateAppmap: (data) => {
       expectSuccess(
         () => validateAppmap(data, { version: "1.6.0" }),
-        "failed to validate appmap\n%j\n%e",
+        "failed to validate appmap\n%j\n%O",
         data,
       );
     },