Feat: Write console API in JS+Python

CMakeLists.txt

@@ -26,7 +26,7 @@ function(pythonmonkey_add_external PYTHONMONKEY_EXTERNAL)
   set(PYTHONMONKEY_EXTERNAL_FILES ${PYTHONMONKEY_EXTERNAL_FILES} PARENT_SCOPE)
 endfunction()
 
-file (GLOB SOURCE_FILES "src/*.cc") # Find all C++ files in the src directory
+file (GLOB SOURCE_FILES "src/*.cc" "src/internalBinding/*.cc") # Find all C++ files in the src directory
 file (GLOB HEADER_FILES "include/*.hh") # Find all header files in the include directory
 file (GLOB PYTHON_FILES "python/*.cc" "python/*.hh") # Find all the python bindings in the python directory
 

include/internalBinding.hh

@@ -0,0 +1,23 @@
+/**
+ * @file internalBinding.hh
+ * @author Tom Tang (xmader@distributive.network)
+ * @brief
+ * @version 0.1
+ * @date 2023-05-16
+ *
+ * @copyright Copyright (c) 2023 Distributive Corp.
+ *
+ */
+
+#include <jsapi.h>
+#include <Python.h>
+
+namespace InternalBinding {
+  extern JSFunctionSpec utils[];
+}
+
+JSObject *createInternalBindingsForNamespace(JSContext *cx, JSFunctionSpec *methodSpecs);
+JSObject *getInternalBindingsByNamespace(JSContext *cx, JSLinearString *namespaceStr);
+
+JSFunction *createInternalBinding(JSContext *cx);
+PyObject *getInternalBindingPyFn(JSContext *cx);

python/pythonmonkey/__init__.py

@@ -1,3 +1,4 @@
+# Export public PythonMonkey APIs
 from .pythonmonkey import *
 from .require import *
 

python/pythonmonkey/builtin_modules/console.js

@@ -1,19 +1,74 @@
 /**
  * @file     console.js
- *           Temporary implementation of console.log etc.
- * @author   Wes Garland, wes@distributive.network
+ * @author   Tom Tang <xmader@distributive.network>
  * @date     June 2023
  */
-function Console(print)
-{
-  this.log   = print;
-  this.debug = print;
-  this.error = print;
-  this.warn  = print;
-  this.info  = print;
+
+const { customInspectSymbol, format } = require("util");
+
+/** @typedef {(str: string) => void} WriteFn */
+
+/**
+ * @see https://developer.mozilla.org/en-US/docs/Web/API/Console_API
+ */
+// TODO (Tom Tang): It's easier to copy implementations from Node.js version 8 than Node.js 20,
+//                  see https://github.com/nodejs/node/blob/v8.17.0/lib/console.js
+// TODO (Tom Tang): adhere https://console.spec.whatwg.org/
+class Console {
+  /** @type {WriteFn} */
+  #writeToStdout;
+  /** @type {WriteFn} */
+  #writeToStderr;
+
+  /**
+   * @param {WriteFn} writeToStdout 
+   * @param {WriteFn} writeToStderr 
+   */
+  constructor(writeToStdout, writeToStderr) {
+    this.#writeToStdout = writeToStdout
+    this.#writeToStderr = writeToStderr
+  }
+
+  /**
+   * @return {string}
+   */
+  #formatToStr(...args) {
+    return format(...args) + "\n"
+  }
+
+  log(...args) {
+    this.#writeToStdout(this.#formatToStr(...args))
+  }
+
+  warn(...args) {
+    this.#writeToStderr(this.#formatToStr(...args))
+  }
+
+  // TODO (Tom Tang): implement more methods
+
+  /**
+   * Re-export the `Console` constructor as global `console.Console`, like in Node.js
+   */
+  get Console() {
+    return Console
+  }
+
+  /**
+   * Export the `nodejs.util.inspect.custom` symbol as a static property of `Console`
+   */
+  static customInspectSymbol = customInspectSymbol;
 }
 
-if (!globalThis.console)
-  globalThis.console = new Console(python.print);
+// https://github.com/nodejs/node/blob/v20.1.0/lib/internal/console/constructor.js#L681-L685
+Console.prototype.debug = Console.prototype.log;
+Console.prototype.info = Console.prototype.log;
+Console.prototype.error = Console.prototype.warn;
+
+if (!globalThis.console) {
+  globalThis.console = new Console(
+    python.stdout_write /* sys.stdout.write */,
+    python.stderr_write /* sys.stderr.write */
+  );
+}
 
 exports.Console = Console;

python/pythonmonkey/builtin_modules/internal-binding.d.ts

@@ -0,0 +1,33 @@
+/**
+ * @file     internal-binding.d.ts
+ * @author   Tom Tang <xmader@distributive.network>
+ * @date     June 2023
+ */
+
+/**
+ * Note: `internalBinding` APIs are generally unsafe as they do not perform argument type checking, etc.
+ *       Argument checking should be done in JavaScript side.
+ */
+declare function internalBinding(namespace: string): any; // catch-all
+
+declare function internalBinding(namespace: "utils"): {
+  defineGlobal(name: string, value: any): void;
+
+  isAnyArrayBuffer(obj: any): obj is (ArrayBuffer | SharedArrayBuffer);
+  isPromise<T>(obj: any): obj is Promise<T>;
+  isRegExp(obj: any): obj is RegExp;
+  isTypedArray(obj: any): obj is TypedArray;
+
+  /**
+   * Get the promise state (fulfilled/rejected/pending) and result (either fulfilled resolution or rejection reason)
+   */
+  getPromiseDetails(promise: Promise<any>): [state: PromiseState.Pending] | [state: PromiseState.Fulfilled | PromiseState.Rejected, result: any];
+
+  /**
+   * Get the proxy target object and handler
+   * @return `undefined` if it's not a proxy
+   */
+  getProxyDetails<T extends object>(proxy: T): undefined | [target: T, handler: ProxyHandler<T>];
+};
+
+export = internalBinding;

python/pythonmonkey/builtin_modules/internal-binding.py

@@ -0,0 +1,10 @@
+"""
+Re-export `internalBinding` to JS
+"""
+
+import pythonmonkey as pm 
+
+"""
+See function declarations in ./internal-binding.d.ts
+"""
+exports = pm.internalBinding