Merge branch 'main' into Xmader/feat/npm-py

Author: Xmader

.git-blame-ignore-revs

@@ -5,4 +5,10 @@ aae30e864449442cf0b04e94f8a242b1b667de9a
 16dc3153b3cb684ca72445ed058babc8f5d97f42
 
 # chore(linting): lint all C++ files
-58cd4b45777b046f03a63255c1d93e289e1cab5e
+58cd4b45777b046f03a63255c1d93e289e1cab5e
+
+# chore(linting): lint PyBytesProxyHandler.cc
+d540ed6e0edfe9538dc726cf587dfb2cc76dde34
+
+# chore(linting): lint PyObjectProxyHandler.cc
+1d45ea98e42294cce16deec5454725d4de36f59f

.github/workflows/test-and-publish.yaml

@@ -17,9 +17,8 @@ on:
         - ''
         - 'ubuntu-20.04'
         - 'macos-12'
-        - 'macos-13'
         - 'macos-14'
-        - 'windows-2019'
+        - 'windows-2022'
       debug_enabled_python:
         type: choice
         description: Choose a Python version to run the build with SSH debugging on
@@ -61,42 +60,47 @@ jobs:
       fail-fast: false
       matrix:
         # Use Ubuntu 20.04 / macOS 13 x86_64 / macOS 14 arm64 + Python 3.10 to build SpiderMonkey
-        os: [ 'ubuntu-20.04', 'macos-13', 'macos-14' ] # macOS 14 runner exclusively runs on M1 hardwares
-                                                       # see https://github.blog/changelog/2024-01-30-github-actions-macos-14-sonoma-is-now-available
+        os: [ 'ubuntu-20.04', 'macos-13', 'macos-14', 'pi' ] # macOS 14 runner exclusively runs on M1 hardwares
+                                                             # see https://github.blog/changelog/2024-01-30-github-actions-macos-14-sonoma-is-now-available
         python_version: [ '3.10' ]
     runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python_version }}
+      - name: Read the mozilla-central commit hash to be used
+        run: echo "MOZCENTRAL_VERSION=$(cat mozcentral.version)" >> $GITHUB_ENV
       - name: Cache spidermonkey build
         id: cache-spidermonkey
         uses: actions/cache@v4
         with:
           path: |
             ./_spidermonkey_install/*
-          key: spidermonkey115.8.0-${{ runner.os }}-${{ runner.arch }}
+          key: spidermonkey-${{ env.MOZCENTRAL_VERSION }}-${{ runner.os }}-${{ runner.arch }}
           lookup-only: true # skip download
       - name: Setup XCode
         if: ${{ (matrix.os == 'macos-13' || matrix.os == 'macos-14') && steps.cache-spidermonkey.outputs.cache-hit != 'true' }}
-        # SpiderMonkey 115 ESR requires XCode SDK version at least 13.3
-        # https://github.com/actions/runner-images/blob/main/images/macos/macos-13-Readme.md#installed-sdks
+        # SpiderMonkey requires XCode SDK version at least 13.3
         run: sudo xcode-select -switch /Applications/Xcode_14.3.app
       - name: Build spidermonkey
         if: ${{ steps.cache-spidermonkey.outputs.cache-hit != 'true' }}
         run: ./setup.sh
   build-spidermonkey-win:
-    runs-on: windows-2019
+    runs-on: windows-2022
+      # SpiderMonkey requires Visual Studio 2022 or newer.
+      # The Windows 2019 runner only has Visual Studio Enterprise 2019 installed.
     steps:
       - uses: actions/checkout@v4
+      - name: Read the mozilla-central commit hash to be used
+        run: echo "MOZCENTRAL_VERSION=$(cat mozcentral.version)" >> $GITHUB_ENV
       - name: Cache spidermonkey build
         id: cache-spidermonkey
         uses: actions/cache@v4
         with:
           path: |
             ./_spidermonkey_install/*
-          key: spidermonkey115.8.0-${{ runner.os }}-${{ runner.arch }}
+          key: spidermonkey-${{ env.MOZCENTRAL_VERSION }}-${{ runner.os }}-${{ runner.arch }}
           lookup-only: true # skip download
       - name: Install dependencies
         if: ${{ steps.cache-spidermonkey.outputs.cache-hit != 'true' }}
@@ -105,7 +109,7 @@ jobs:
           # Already installed in Github Actions runner
           # choco install -y cmake --installargs 'ADD_CMAKE_TO_PATH=System' # add CMake to system PATH
           # choco install -y llvm gnuwin32-m4
-          choco install -y wget make
+          choco install -y wget make unzip
       - name: Install MozillaBuild
         if: ${{ steps.cache-spidermonkey.outputs.cache-hit != 'true' }}
         run: |
@@ -123,19 +127,8 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        # The lowest supported version is Ubuntu 20.04 + Python 3.8 or macOS 12 + Python 3.9
-        os: [ 'ubuntu-20.04', 'macos-12', 'macos-13', 'macos-14', 'windows-2019' ]
+        os: [ 'ubuntu-20.04', 'macos-12', 'macos-14', 'windows-2022', 'pi' ]
         python_version: [ '3.8', '3.9', '3.10', '3.11', '3.12' ]
-        exclude:
-          # macOS 12 comes with Python 3.9 by default, so we drop ci support for Python 3.8 on macOS
-          - os: 'macos-12'
-            python_version: '3.8'
-          # actions/setup-python: The version '3.8'/'3.9' with architecture 'arm64' was not found for macOS.
-          # see https://raw.githubusercontent.com/actions/python-versions/main/versions-manifest.json
-          - os: 'macos-14'
-            python_version: '3.8'
-          - os: 'macos-14'
-            python_version: '3.9'
     runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v4
@@ -146,6 +139,9 @@ jobs:
       - uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python_version }}
+      - name: Remove old poetry cache
+        run: rm -rf ~/.cache/pypoetry
+        if: ${{ matrix.os == 'pi' }}
       - name: Setup Poetry
         uses: snok/install-poetry@v1
         with:
@@ -155,22 +151,42 @@ jobs:
           echo "Installing Dependencies"
           if [[ "$OSTYPE" == "linux-gnu"* ]]; then # Linux
             sudo apt-get update -y
-            sudo apt-get install -y cmake graphviz llvm
+            sudo apt-get install -y cmake llvm
           elif [[ "$OSTYPE" == "darwin"* ]]; then # macOS
             brew update || true # allow failure
-            brew install cmake pkg-config wget coreutils # `coreutils` installs the `realpath` command
+            brew install cmake pkg-config wget unzip coreutils # `coreutils` installs the `realpath` command
           fi
           echo "Installing python deps"
           poetry self add "poetry-dynamic-versioning[plugin]"
-          poetry env use python3 # use the correct Python version we've set up
+          poetry env use python$PYTHON_VERSION || poetry env use python3 # use the correct Python version we've set up
           poetry install --no-root --only=dev
           echo "Installed Dependencies"
+        env:
+          PYTHON_VERSION: ${{ matrix.python_version }}
+      - name: Build Docs # only build docs once
+        if: ${{ matrix.os == 'ubuntu-20.04' && matrix.python_version == '3.11' }}
+        run: |
+            sudo apt-get install -y graphviz 
+            # the newest version in Ubuntu 20.04 repository is 1.8.17, but we need Doxygen 1.9 series
+            wget -c -q https://www.doxygen.nl/files/doxygen-1.9.7.linux.bin.tar.gz
+            tar xf doxygen-1.9.7.linux.bin.tar.gz
+            cd doxygen-1.9.7 && sudo make install && cd -
+            rm -rf doxygen-1.9.7 doxygen-1.9.7.linux.bin.tar.gz
+            BUILD_DOCS=1 BUILD_TYPE=None poetry install
+      - name: Upload Doxygen-generated docs as CI artifacts
+        if: ${{ matrix.os == 'ubuntu-20.04' && matrix.python_version == '3.11' }}
+        uses: actions/upload-artifact@v3
+        with:
+          name: docs-${{ github.run_id }}-${{ github.sha }}
+          path: ./build/docs/html/
+      - name: Read the mozilla-central commit hash to be used
+        run: echo "MOZCENTRAL_VERSION=$(cat mozcentral.version)" >> $GITHUB_ENV
       - name: Use cached spidermonkey build
         uses: actions/cache@v4
         with:
           path: |
             ./_spidermonkey_install/*
-          key: spidermonkey115.8.0-${{ runner.os }}-${{ runner.arch }}
+          key: spidermonkey-${{ env.MOZCENTRAL_VERSION }}-${{ runner.os }}-${{ runner.arch }}
           fail-on-cache-miss: true # SpiderMonkey is expected to be cached in its dedicated job
       - name: Build pminit
         run: |
@@ -185,13 +201,24 @@ jobs:
           WORKFLOW_BUILD_TYPE=${{ inputs.build_type }}
           BUILD_TYPE=${WORKFLOW_BUILD_TYPE:-"Debug"} poetry build --format=wheel
           ls -lah ./dist/
+      - name: Make the wheels we build also support lower versions of macOS
+        if: ${{ matrix.os == 'macos-12' || matrix.os == 'macos-14' }}
+        # Change the platform tag part of the wheel filename to `macosx_11_0_xxx` (means to support macOS 11.0 and above)
+        # See https://packaging.python.org/en/latest/specifications/binary-distribution-format/#file-format
+        # A wheel package file will only be selected by pip to install if the platform tag satisfies, regardless of whether the binary compatibility actually is.
+        # Otherwise, pip would fallback to compile from the source distribution.
+        run: |
+          cd ./dist/
+          for file in *.whl; do
+            mv "$file" "$(echo "$file" | sed -E 's/macosx_[0-9]+_[0-9]+/macosx_11_0/')";
+          done
       - name: Upload wheel as CI artifacts
         uses: actions/upload-artifact@v3
         with:
           name: wheel-${{ github.run_id }}-${{ github.sha }}
           path: ./dist/
       - name: Set cores to get stored in /cores
-        if: ${{ matrix.os != 'windows-2019' }}
+        if: ${{ matrix.os != 'windows-2022' }}
         # TODO (Caleb Aikens) figure out how to get Windows core dumps
         run: |
           sudo mkdir -p /cores
@@ -226,7 +253,7 @@ jobs:
           credentials: "admin:admin"
       - name: Upload core dumps as CI artifacts
         uses: actions/upload-artifact@v3
-        if: ${{ matrix.os != 'windows-2019' && failure() }}
+        if: ${{ matrix.os != 'windows-2022' && failure() }}
         # TODO (Caleb Aikens) figure out how to get Windows core dumps
         with:
           name: cores-${{ matrix.os }}-${{ matrix.python_version }}
@@ -246,26 +273,27 @@ jobs:
           version: 1.5.1
       - name: Build source distribution (sdist) file
         run: |
-          # Install Doxygen
-            # the newest version in Ubuntu 20.04 repository is 1.8.17, but we need Doxygen 1.9 series
-            wget -c -q https://www.doxygen.nl/files/doxygen-1.9.7.linux.bin.tar.gz
-            tar xf doxygen-1.9.7.linux.bin.tar.gz
-            cd doxygen-1.9.7 && sudo make install && cd -
-            rm -rf doxygen-1.9.7 doxygen-1.9.7.linux.bin.tar.gz
           poetry self add "poetry-dynamic-versioning[plugin]"
-          BUILD_DOCS=1 BUILD_TYPE=None poetry install
           poetry build --format=sdist
           ls -lah ./dist/
       - name: Upload sdist as CI artifacts
         uses: actions/upload-artifact@v3
         with:
           name: wheel-${{ github.run_id }}-${{ github.sha }}
           path: ./dist/
-      - name: Upload Doxygen-generated docs as CI artifacts
-        uses: actions/upload-artifact@v3
+  check-install-from-sdist:
+    needs: sdist
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/setup-python@v5
         with:
-          name: docs-${{ github.run_id }}-${{ github.sha }}
-          path: ./build/docs/html/
+          python-version: '3.10'
+      - name: Download wheels built
+        uses: actions/download-artifact@v3
+        with:
+          name: wheel-${{ github.run_id }}-${{ github.sha }}
+          path: ./dist/
+      - run: pip install ./dist/pythonmonkey-*.tar.gz
   publish:
     needs: [build-and-test, sdist]
     runs-on: ubuntu-20.04

.github/workflows/update-mozcentral-version.yaml

@@ -0,0 +1,43 @@
+name: 'Create pull requests to update mozilla-central version to the latest'
+
+on:
+  schedule:
+    - cron: "00 14 */100,1-7 * 1" # run on the first Monday of each month at 14:00 UTC (10:00 Eastern Daylight Time)
+                                  # See https://blog.healthchecks.io/2022/09/schedule-cron-job-the-funky-way/
+  workflow_call:
+  workflow_dispatch: # or you can run it manually
+
+defaults:
+  run:
+    shell: bash
+
+jobs:
+  update:
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v4
+      - name: Check Version
+        # Check the latest changes on mozilla-central via the Mercurial pushlog HTTP API
+        # See https://mozilla-version-control-tools.readthedocs.io/en/latest/hgmo/pushlog.html#hgweb-commands
+        run: |
+          COMMIT_HASH=$(
+            curl -s "https://hg.mozilla.org/mozilla-central/json-pushes?tipsonly=1&version=2" |\
+            jq --join-output '(.lastpushid | tostring) as $pushid | empty, .pushes[$pushid].changesets[0]'
+          )
+          echo "MOZCENTRAL_VERSION=$COMMIT_HASH" >> $GITHUB_ENV
+          echo "MOZCENTRAL_VERSION_SHORT=${COMMIT_HASH:0:7}" >> $GITHUB_ENV
+      - name: Update `mozcentral.version` File
+        run: echo -n $MOZCENTRAL_VERSION > mozcentral.version
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v6
+        with:
+          add-paths: mozcentral.version
+          commit-message: |
+            chore(deps): upgrade SpiderMonkey to `${{ env.MOZCENTRAL_VERSION }}`
+          author: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
+          branch: chore/upgrade-spidermonkey-to-${{ env.MOZCENTRAL_VERSION_SHORT }}
+          title: Upgrade SpiderMonkey to mozilla-central commit `${{ env.MOZCENTRAL_VERSION }}`
+          body: |
+            Changeset: https://hg.mozilla.org/mozilla-central/rev/${{ env.MOZCENTRAL_VERSION }}
+          labels: dependencies
+          assignees: Xmader

.gitignore

@@ -7,13 +7,16 @@ lib/*
 .pytest_cache
 .DS_Store
 firefox-*.tar.xz
+firefox-*.zip
 firefox-*/
+mozilla-central-*
 __pycache__
 Testing/Temporary
-_spidermonkey_install
+_spidermonkey_install*
 uncrustify-*.tar.gz
 uncrustify-*/
 uncrustify
+uncrustify.exe
 *.uncrustify
 __pycache__/*
 dist

.vscode/tasks.json

@@ -38,6 +38,11 @@
       "problemMatcher": [
         "$gcc"
       ],
+      "options": {
+        "env": {
+          "BUILD_TYPE": "Debug"
+        }
+      },
       "group": {
         "kind": "build",
       }

Makefile

@@ -27,7 +27,7 @@ else ifeq ($(BUILD),Debug)
 PYTHON_BUILD_ENV += BUILD_TYPE=Debug
 else ifeq ($(BUILD),DRelease)
 PYTHON_BUILD_ENV += BUILD_TYPE=DRelease
-else ifeq($(BUILD), None)
+else ifeq ($(BUILD), None)
 PYTHON_BUILD_ENV += BUILD_TYPE=None
 else # Release build
 PYTHON_BUILD_ENV += BUILD_TYPE=Release

README.md

@@ -1,14 +1,14 @@
 # PythonMonkey
 
-![Testing Suite](https://github.com/Kings-Distributed-Systems/PythonMonkey/actions/workflows/tests.yaml/badge.svg)
+[![Test and Publish Suite](https://github.com/Distributive-Network/PythonMonkey/actions/workflows/test-and-publish.yaml/badge.svg)](https://github.com/Distributive-Network/PythonMonkey/actions/workflows/test-and-publish.yaml)
 
 ## About
 [PythonMonkey](https://pythonmonkey.io) is a Mozilla [SpiderMonkey](https://firefox-source-docs.mozilla.org/js/index.html) JavaScript engine embedded into the Python Runtime,
 using the Python engine to provide the Javascript host environment.
 
 We feature JavaScript Array and Object methods implemented on Python List and Dictionaries using the cPython C API, and the inverse using the Mozilla Firefox Spidermonkey JavaScript C++ API.
 
-This product is in an advanced stage, approximately 95% to MVP as of March 2024. It is under active development by [Distributive](https://distributive.network/).
+This project has reached MVP as of September 2024. It is under maintenance by [Distributive](https://distributive.network/).
 
 External contributions and feedback are welcome and encouraged.
 
@@ -68,12 +68,12 @@ Read this if you want to build a local version.
 1. You will need the following installed (which can be done automatically by running `./setup.sh`):
     - bash
     - cmake
-    - Doxygen 1.9 series
-    - graphviz
+    - Doxygen 1.9 series (if you want to build the docs)
+    - graphviz  (if you want to build the docs)
     - llvm
     - rust
     - python3.8 or later with header files (python3-dev)
-    - spidermonkey 115.1.0 or later
+    - spidermonkey latest from mozilla-central
     - [Poetry](https://python-poetry.org/docs/#installation)
     - [poetry-dynamic-versioning](https://github.com/mtkennerly/poetry-dynamic-versioning)
 
@@ -163,11 +163,11 @@ They are largely based on SpiderMonkey's `CompileOptions`. The supported option
 - `filename`: set the filename of this code for the purposes of generating stack traces etc.
 - `lineno`: set the line number offset of this code for the purposes of generating stack traces etc.
 - `column`: set the column number offset of this code for the purposes of generating stack traces etc.
-- `mutedErrors`: experimental
-- `noScriptRval`: experimental
-- `selfHosting`: experimental
-- `strict`: experimental
-- `module`: experimental
+- `mutedErrors`: if set to `True`, eval errors or unhandled rejections are ignored ("muted"). Default `False`.
+- `noScriptRval`: if `False`, return the last expression value of the script as the result value to the caller. Default `False`.
+- `selfHosting`: *experimental*
+- `strict`: forcibly evaluate in strict mode (`"use strict"`). Default `False`.
+- `module`: indicate the file is an ECMAScript module (always strict mode code and disallow HTML comments). Default `False`.
 - `fromPythonFrame`: generate the equivalent of filename, lineno, and column based on the location of
   the Python call to eval. This makes it possible to evaluate Python multiline string literals and
   generate stack traces in JS pointing to the error in the Python source file.
@@ -461,7 +461,7 @@ List of commands:
 ```console
 $ pmjs
 
-Welcome to PythonMonkey v0.4.0.
+Welcome to PythonMonkey v1.0.0.
 Type ".help" for more information.
 > .python import sys
 > .python sys.path