Log metadata in worker errors (#943)

* export ErrorWithContext
* log error metadata if present

Author: seefeldb

background-charm-service/src/worker.ts

@@ -2,6 +2,7 @@ import { type Charm, CharmManager } from "@commontools/charm";
 import {
   Cell,
   idle,
+  isErrorWithContext,
   isStream,
   onError,
   setBobbyServerUrl,
@@ -144,7 +145,9 @@ async function runCharm(data: { charmId: string }) {
     console.log(`Worker: Successfully executed charm ${spaceId}/${charmId}`);
     return { success: true, charmId };
   } catch (error) {
-    const errorMessage = error instanceof Error ? error.message : String(error);
+    const errorMessage = isErrorWithContext(error)
+      ? `${error.message} @ ${error.space}:${error.charmId} running ${error.recipeId}`
+      : String(error);
     console.error(
       `Worker error executing charm ${spaceId}/${charmId}: ${errorMessage}`,
     );

runner/src/index.ts

@@ -1,8 +1,8 @@
 export { run, stop } from "./runner.ts";
 export { addModuleByRef, raw } from "./module.ts";
 export {
-  type Action,
   idle,
+  isErrorWithContext,
   onError,
   run as addAction,
   unschedule as removeAction,
@@ -11,7 +11,7 @@ export { getRecipeEnvironment, setRecipeEnvironment } from "./env.ts";
 export type { DocImpl } from "./doc.ts";
 export type { Cell, CellLink, Stream } from "./cell.ts";
 export type { QueryResult } from "./query-result-proxy.ts";
-export type { ReactivityLog } from "./scheduler.ts";
+export type { Action, ErrorWithContext, ReactivityLog } from "./scheduler.ts";
 export * as StorageInspector from "./storage/inspector.ts";
 export { getDoc, isDoc } from "./doc.ts";
 export {
@@ -59,8 +59,8 @@ export {
   setBlobbyServerUrl,
 } from "./blobby-storage.ts";
 export { tsToExports } from "./local-build.ts";
-export { 
+export {
   addCommonIDfromObjectID,
   followAliases,
-  maybeGetCellLink
+  maybeGetCellLink,
 } from "./utils.ts";

runner/src/scheduler.ts

@@ -169,6 +169,11 @@ export type ErrorWithContext = Error & {
   recipeId: string;
 };
 
+export function isErrorWithContext(error: unknown): error is ErrorWithContext {
+  return error instanceof Error && "action" in error && "charmId" in error &&
+    "space" in error && "recipeId" in error;
+}
+
 function handleError(error: Error, action: any) {
   // TODO(seefeld): This is a rather hacky way to get the context, based on the
   // unsafe_binding pattern. Once we replace that mechanism, let's add nicer