[RFC] Starting the debugging API

Author: mbouaziz

skipruntime-ts/native/src/Debug.sk

@@ -0,0 +1,50 @@
+/**
+ * Functions used by the debugging API
+ */
+
+module SkipRuntime;
+
+private fun dirInfo(
+  dirNameDir: readonly (SKStore.DirName, SKStore.Dir),
+): SKJSON.CJSON {
+  (dirName, dir) = dirNameDir;
+  fields = mutable Vector<(.String, SKJSON.CJSON)>[];
+  fields.push(("name", SKJSON.CJString(dirName.toString())));
+  fields.push(("isInput", SKJSON.CJBool(dir.isInput())));
+  fields.push(("time", SKJSON.CJInt(dir.getTime().value)));
+  dir match {
+  | SKStore.EagerDir{totalSize, creator} ->
+    fields.push(("kind", SKJSON.CJString("eager")));
+    fields.push(("totalSize", SKJSON.CJInt(totalSize)));
+    creator match {
+    | None() -> void
+    | Some(SKStore.ArrowKey(parentName, childName, key)) ->
+      fields.push(
+        (
+          "creator",
+          SKJSON.CJObject(
+            SKJSON.CJFields::create(
+              Array[
+                ("key", SKJSON.CJString(key.toString())),
+                ("parent", SKJSON.CJString(parentName.toString())),
+                ("child", SKJSON.CJString(childName.toString())),
+              ],
+              x -> x,
+            ),
+          ),
+        ),
+      )
+    }
+  | SKStore.LazyDir _ -> fields.push(("kind", SKJSON.CJString("lazy")))
+  | SKStore.DeletedDir _ -> fields.push(("kind", SKJSON.CJString("deleted")))
+  };
+  SKJSON.CJObject(SKJSON.CJFields::create(fields.toArray(), x -> x))
+}
+
+private fun contextDirList(
+  context: readonly SKStore.Context,
+): Array<SKJSON.CJSON> {
+  context.dirs.state.items().map(dirInfo).collect(Array)
+}
+
+module end;

skipruntime-ts/native/src/Extern.sk

@@ -764,4 +764,14 @@ fun closeSkipRuntimeService(): Float {
   };
 }
 
+/************ debugging ****************/
+
+@export("SkipRuntime_Debug__dirList")
+fun dirList(): SKJSON.CJSON {
+  SKStore.runWithResult(contextDirList) match {
+  | Success(result) -> SKJSON.CJArray(result)
+  | Failure(err) -> SKJSON.CJFloat(getErrorHdl(err))
+  }
+}
+
 module end;

skipruntime-ts/server/src/rest.ts

@@ -109,6 +109,17 @@ export function controlService(service: ServiceInstance): express.Express {
     }
   });
 
+  // DEBUGGING
+  app.get("/v1/debug/row/dirs", (_req, res) => {
+    try {
+      const result = service.dirList();
+      res.status(200).json(result);
+    } catch (e: unknown) {
+      console.log(e);
+      res.status(500).json(e instanceof Error ? e.message : e);
+    }
+  });
+
   return app;
 }
 

skipruntime-ts/wasm/src/internals/skipruntime_module.ts

@@ -373,6 +373,12 @@ export interface FromWasm {
   ): ptr<Internal.Request>;
 
   SkipRuntime_createChecker(ref: Handle<Checker>): ptr<Internal.Request>;
+
+  // Debug
+
+  SkipRuntime_Debug__dirList(): ptr<
+    Internal.CJFloat | Internal.CJArray<Internal.CJObject>
+  >;
 }
 
 interface ToWasm {
@@ -1442,6 +1448,22 @@ export class ServiceInstance {
       throw this.refs.handles.deleteAsError(result);
     }
   }
+
+  /**
+   * Debugging
+   */
+
+  dirList(): DirList {
+    const result = this.refs.skjson.runWithGC(() => {
+      return this.refs.skjson.importJSON(
+        this.refs.fromWasm.SkipRuntime_Debug__dirList(),
+      );
+    });
+    if (typeof result == "number") {
+      throw this.refs.handles.deleteAsError(result as Handle<ErrorObject>);
+    }
+    return result as DirList;
+  }
 }
 
 class NonEmptyIteratorImpl<T> implements NonEmptyIterator<T> {
@@ -1489,6 +1511,16 @@ class NonEmptyIteratorImpl<T> implements NonEmptyIterator<T> {
   }
 }
 
+type DirList = ({ name: string; isInput: boolean; time: int } & (
+  | {
+      kind: "eager";
+      totalSize: int;
+      creator?: { parent: string; child: string; key: string };
+    }
+  | { kind: "lazy" }
+  | { kind: "deleted" }
+))[];
+
 class Manager implements ToWasmManager {
   constructor(private readonly env: Environment) {}