Merge branch 'Xmader/chore/improve-pminit' into Xmader/docs/debugging-steps

Xmader · Xmader · commit 7d2323ab2293 · 2023-07-10T20:28:35.000Z
diff --git a/.github/workflows/test-and-publish.yaml b/.github/workflows/test-and-publish.yaml
@@ -23,6 +23,7 @@ defaults:
 jobs:
   build-spidermonkey-unix:
     strategy:
+      fail-fast: false
       matrix:
         # Use Ubuntu 20.04 / macOS 12 + Python 3.10 to build SpiderMonkey
         os: [ 'ubuntu-20.04', 'macos-12', 'm2ci' ]
@@ -39,8 +40,13 @@ jobs:
         with:
           path: |
             ./_spidermonkey_install/*
-          key: spidermonkey-${{ runner.os }}-${{ runner.arch }}
+          key: spidermonkey102.13-${{ runner.os }}-${{ runner.arch }}
           lookup-only: true # skip download
+      - name: Setup Poetry
+        if: ${{ steps.cache-spidermonkey.outputs.cache-hit != 'true' }}
+        uses: snok/install-poetry@v1
+        with:
+          version: 1.5.1
       - name: Build spidermonkey
         if: ${{ steps.cache-spidermonkey.outputs.cache-hit != 'true' }}
         run: ./setup.sh
@@ -54,8 +60,13 @@ jobs:
         with:
           path: |
             ./_spidermonkey_install/*
-          key: spidermonkey-${{ runner.os }}-${{ runner.arch }}
+          key: spidermonkey102.13-${{ runner.os }}-${{ runner.arch }}
           lookup-only: true # skip download
+      - name: Setup Poetry
+        if: ${{ steps.cache-spidermonkey.outputs.cache-hit != 'true' }}
+        uses: snok/install-poetry@v1
+        with:
+          version: 1.5.1
       - name: Install dependencies
         if: ${{ steps.cache-spidermonkey.outputs.cache-hit != 'true' }}
         shell: powershell
@@ -124,7 +135,7 @@ jobs:
         with:
           path: |
             ./_spidermonkey_install/*
-          key: spidermonkey-${{ runner.os }}-${{ runner.arch }}
+          key: spidermonkey102.13-${{ runner.os }}-${{ runner.arch }}
           fail-on-cache-miss: true # SpiderMonkey is expected to be cached in its dedicated job
       - name: Build pminit
         run: |
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -38,11 +38,7 @@ if(CMAKE_PROJECT_NAME STREQUAL PROJECT_NAME)
   ### Code block from: https://cliutils.gitlab.io/modern-cmake/chapters/projects/submodule.html
   include(FetchContent)
 
-  if(UNIX)
-    SET(COMPILE_FLAGS "-g -ggdb -O0 -fno-rtti")
-  elseif(WIN32)
-    SET(COMPILE_FLAGS "")
-  endif()
+  SET(COMPILE_FLAGS "-ggdb -Ofast -fno-rtti") # optimize but also emit debug symbols
   SET( CMAKE_CXX_FLAGS  "${CMAKE_CXX_FLAGS} ${COMPILE_FLAGS}" )
 
   set(CMAKE_MODULE_PATH ${CMAKE_SOURCE_DIR}/cmake/modules)
diff --git a/README.md b/README.md
@@ -60,7 +60,7 @@ Read this if you want to build a local version.
     - [Poetry](https://python-poetry.org/docs/#installation)
     - [poetry-dynamic-versioning](https://github.com/mtkennerly/poetry-dynamic-versioning)
 
-2. Run `poetry run pip install --verbose python/pminit ./`. This command automatically compiles the project and installs the project as well as dependencies into the poetry virtualenv.
+2. Run `poetry install`. This command automatically compiles the project and installs the project as well as dependencies into the poetry virtualenv.
 
 If you are using VSCode, you can just press <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>B</kbd> to [run build task](https://code.visualstudio.com/docs/editor/tasks#_custom-tasks) - We have [the `tasks.json` file configured for you](.vscode/tasks.json).
 
diff --git a/examples/use-python-module.py b/examples/use-python-module.py
@@ -5,5 +5,4 @@
 
 import pythonmonkey as pm
 
-require = pm.createRequire(__file__)
-require('./use-python-module');
+pm.require('./use-python-module');
diff --git a/examples/use-require.py b/examples/use-require.py
@@ -5,7 +5,6 @@
 
 import pythonmonkey as pm
 
-require = pm.createRequire(__file__)
-require('./use-require/test1');
+pm.require('./use-require/test1');
 print("Done")
 
diff --git a/js-test-runner b/js-test-runner
@@ -8,8 +8,7 @@ import sys, os
 import pythonmonkey as pm
 
 # Main
-require = pm.createRequire(__file__)
-require('console');
+pm.require('console');
 
 testName = os.path.realpath(sys.argv[1]);
 testDir = os.path.dirname(testName);
diff --git a/pmjs b/pmjs
@@ -8,7 +8,7 @@ import pythonmonkey as pm
 
 globalThis = pm.eval("globalThis;")
 globalThis.python.write = sys.stdout.write
-pm.createRequire(__file__)('./pmjs-require')
+pm.require('./pmjs-require')
 
 pm.eval("""'use strict';
 const cmds = {};
diff --git a/pyproject.toml b/pyproject.toml
@@ -55,6 +55,7 @@ numpy = [
   {version = "^2.0.0.dev0", allow-prereleases = true, source = "anaconda", python = "3.12.*"},
   {version = "^1.24.3", python = "<3.12"},
 ]
+pminit = { path = "./python/pminit", develop = true }
 
 
 [[tool.poetry.source]]
diff --git a/python/pythonmonkey/__init__.py b/python/pythonmonkey/__init__.py
@@ -5,3 +5,6 @@
 # Expose the package version
 import importlib.metadata
 __version__= importlib.metadata.version(__name__)
+
+# Load the module by default to make `console` globally available
+require("console")
diff --git a/python/pythonmonkey/builtin_modules/internal-binding.py b/python/pythonmonkey/builtin_modules/internal-binding.py
@@ -7,4 +7,4 @@
 """
 See function declarations in ./internal-binding.d.ts
 """
-exports = pm.internalBinding
+exports = pm.internalBinding # type: ignore
diff --git a/python/pythonmonkey/global.d.ts b/python/pythonmonkey/global.d.ts
@@ -24,6 +24,9 @@ declare const python: {
 /** see `pm.eval` */
 declare function pmEval(code: string): any;
 
+// Expose our own `console` as a property of the global object
+declare const console: import("console").Console;
+
 // Keep this in sync with both https://hg.mozilla.org/releases/mozilla-esr102/file/a03fde6/js/public/Promise.h#l331
 //                        and  https://github.com/nodejs/node/blob/v20.2.0/deps/v8/include/v8-promise.h#L30
 declare enum PromiseState { Pending = 0, Fulfilled = 1, Rejected = 2 }
diff --git a/python/pythonmonkey/require.py b/python/pythonmonkey/require.py
@@ -23,13 +23,23 @@
 # @date         May 2023
 #
 
-import sys, os, types
-from typing import Union, Dict, Callable
+import sys, os
+from typing import Union, Dict
 import importlib
+import importlib.util
 from importlib import machinery
-from importlib import util
+import inspect
+import functools
 
 from . import pythonmonkey as pm 
+node_modules = os.path.abspath(
+  os.path.join(
+    importlib.util.find_spec("pminit").submodule_search_locations[0],
+    "..",
+    "pythonmonkey",
+    "node_modules"
+  )
+)
 
 # Add some python functions to the global python object for code in this file to use.
 globalThis = pm.eval("globalThis;");
@@ -153,6 +163,7 @@ def statSync_inner(filename: str) -> Union[Dict[str, int], bool]:
         Union[Dict[str, int], False]: The mode of the file or False if the file doesn't exist.
     """
     from os import stat
+    filename = os.path.normpath(filename)
     if (os.path.exists(filename)):
         sb = stat(filename)
         return { 'mode': sb.st_mode }
@@ -165,18 +176,23 @@ def readFileSync(filename, charset) -> str:
     Returns:
         str: The contents of the file
     """
+    filename = os.path.normpath(filename)
     with open(filename, "r", encoding=charset) as fileHnd:
         return fileHnd.read()
 
+def existsSync(filename: str) -> bool:
+    filename = os.path.normpath(filename)
+    return os.path.exists(filename)
+
 bootstrap.modules.fs.statSync_inner = statSync_inner
 bootstrap.modules.fs.readFileSync   = readFileSync
-bootstrap.modules.fs.existsSync     = os.path.exists
+bootstrap.modules.fs.existsSync     = existsSync
 
 # Read ctx-module module from disk and invoke so that this file is the "main module" and ctx-module has
 # require and exports symbols injected from the bootstrap object above. Current PythonMonkey bugs
 # prevent us from injecting names properly so they are stolen from trail left behind in the global
 # scope until that can be fixed.
-with open(os.path.dirname(__file__) + "/node_modules/ctx-module/ctx-module.js", "r") as ctxModuleSource:
+with open(node_modules + "/ctx-module/ctx-module.js", "r") as ctxModuleSource:
     initCtxModule = pm.eval("""'use strict';
 (function moduleWrapper_forCtxModule(broken_require, broken_exports)
 {
@@ -200,6 +216,7 @@ def load(filename: str) -> Dict:
         : The loaded python module
     """
 
+    filename = os.path.normpath(filename)
     name = os.path.basename(filename)
     if name not in sys.modules:
         sourceFileLoader = machinery.SourceFileLoader(name, filename)
@@ -223,7 +240,9 @@ def load(filename: str) -> Dict:
   require = createRequire(__file__)
   require('./my-javascript-module')
 """
-def createRequire(filename):
+# We cache the return value of createRequire to always use the same require for the same filename
+@functools.lru_cache(maxsize=None) # unbounded function cache that won't remove any old values
+def createRequire(filename: str):
     createRequireInner = pm.eval("""'use strict';(
 function createRequire(filename, bootstrap_broken)
 {
@@ -245,3 +264,11 @@ def createRequire(filename):
   return module.require;
 })""")
     return createRequireInner(filename)
+
+def require(moduleIdentifier: str):
+    # Retrieve the caller’s filename from the call stack
+    filename = inspect.stack()[1].filename
+    # From the REPL, the filename is "<stdin>", which is not a valid path
+    if not os.path.exists(filename):
+      filename = os.path.join(os.getcwd(), "__main__") # use the CWD instead
+    return createRequire(filename)(moduleIdentifier)
diff --git a/setup.sh b/setup.sh
@@ -11,7 +11,7 @@ if [[ "$OSTYPE" == "linux-gnu"* ]]; then # Linux
   sudo apt-get update --yes
   sudo apt-get install cmake doxygen graphviz llvm g++ pkg-config m4 wget --yes
 elif [[ "$OSTYPE" == "darwin"* ]]; then # macOS
-  brew update
+  brew update || true # allow failure
   brew install cmake doxygen graphviz pkg-config wget coreutils # `coreutils` installs the `realpath` command
 elif [[ "$OSTYPE" == "msys"* ]]; then # Windows
   echo "Dependencies are not going to be installed automatically on Windows."
@@ -27,9 +27,9 @@ poetry self add "poetry-dynamic-versioning[plugin]"
 echo "Done installing dependencies"
 
 echo "Downloading spidermonkey source code"
-wget -c -q https://ftp.mozilla.org/pub/firefox/releases/102.11.0esr/source/firefox-102.11.0esr.source.tar.xz
+wget -c -q https://ftp.mozilla.org/pub/firefox/releases/102.13.0esr/source/firefox-102.13.0esr.source.tar.xz
 mkdir -p firefox-source
-tar xf firefox-102.11.0esr.source.tar.xz -C firefox-source --strip-components=1 # strip the root folder
+tar xf firefox-102.13.0esr.source.tar.xz -C firefox-source --strip-components=1 # strip the root folder
 echo "Done downloading spidermonkey source code"
 
 echo "Building spidermonkey"

Original file line number	Diff line number	Diff line change
`@@ -55,6 +55,7 @@ numpy = [`
`55`	`55`	`{version = "^2.0.0.dev0", allow-prereleases = true, source = "anaconda", python = "3.12.*"},`
`56`	`56`	`{version = "^1.24.3", python = "<3.12"},`
`57`	`57`	`]`
	`58`	`+pminit = { path = "./python/pminit", develop = true }`
`58`	`59`
`59`	`60`
`60`	`61`	`[[tool.poetry.source]]`