Merge branch 'main' into Xmader/feat/python-3.13-support

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

@@ -5,7 +5,7 @@ on:
     branches:
       - main
     tags:
-      - '*'
+      - 'v*'
   workflow_call:
   workflow_dispatch:
     inputs:
@@ -55,6 +55,10 @@ defaults:
     # run with Git Bash on Windows
     shell: bash
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
   build-spidermonkey-unix:
     strategy:
@@ -130,13 +134,6 @@ jobs:
       matrix:
         os: [ 'ubuntu-20.04', 'macos-12', 'macos-14', 'windows-2022', 'pi' ]
         python_version: [ '3.8', '3.9', '3.10', '3.11', '3.12', '3.13-dev' ]
-        exclude:
-          # 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
@@ -209,6 +206,17 @@ 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:
@@ -294,7 +302,7 @@ jobs:
   publish:
     needs: [build-and-test, sdist]
     runs-on: ubuntu-20.04
-    if: ${{ success() && github.event_name == 'push' && contains(github.ref, 'refs/tags/') }}
+    if: ${{ success() && github.event_name == 'push' && github.ref_type == 'tag' }}
     steps:
       # no need to checkout
       - uses: actions/setup-python@v5
@@ -317,7 +325,7 @@ jobs:
     # and deploy the static files to GitHub Pages
     needs: [build-and-test, sdist]
     runs-on: ubuntu-20.04
-    if: ${{ (success() || failure()) && github.ref_name == 'main' }} # publish nightly builds regardless of tests failure
+    if: ${{ (success() || failure()) && (github.ref_name == 'main' || github.ref_type == 'tag') }} # publish nightly builds regardless of tests failure
     permissions: # grant GITHUB_TOKEN the permissions required to make a Pages deployment
       pages: write
       id-token: write
@@ -372,3 +380,45 @@ jobs:
       - name: Deploy to GitHub Pages
         id: deployment
         uses: actions/deploy-pages@v2
+  publish-archive:
+    # Publish to ⊇istributive's archive server (https://archive.distributed.computer/releases/pythonmonkey/)
+    needs: [build-and-test, sdist]
+    runs-on: ubuntu-20.04
+    if: ${{ (success() || failure()) && (github.ref_name == 'main' || github.ref_type == 'tag') }}
+    environment:
+      name: archive
+      url: https://archive.distributed.computer/releases/pythonmonkey/${{ steps.get_path.outputs.ARCHIVE_PATH }}
+    steps:
+      # no need to checkout
+      - name: Download wheels built
+        uses: actions/download-artifact@v3
+        with:
+          name: wheel-${{ github.run_id }}-${{ github.sha }}
+          path: ./
+      - name: Download docs html generated by Doxygen
+        uses: actions/download-artifact@v3
+        with:
+          name: docs-${{ github.run_id }}-${{ github.sha }}
+          path: ./docs/
+      - name: Get the pythonmonkey/pminit version number
+        run: |
+          file=$(ls ./pminit*.tar.gz | head -1)
+          pm_version=$(basename "${file%.tar.gz}" | cut -d- -f2) # match /pminit-([^-]+).tar.gz/
+          echo "PM_VERSION=$pm_version" >> $GITHUB_ENV
+      - name: Get the archive type (nightly or releases) and path
+        id: get_path
+        run: |
+          path="$ARCHIVE_TYPE/$PM_VERSION/"
+          echo "$path"
+          echo "ARCHIVE_PATH=$path" >> $GITHUB_OUTPUT
+        env:
+          ARCHIVE_TYPE: ${{ (github.ref_type == 'tag' && 'releases') || 'nightly' }}
+      - name: SCP to the archive server
+        uses: appleboy/[email protected]
+        with:
+          host: ${{ secrets.ARCHIVE_HOST }}
+          username: pythonmonkey
+          key: ${{ secrets.ARCHIVE_KEY }}
+          source: ./*
+          target: archive/${{ steps.get_path.outputs.ARCHIVE_PATH }}
+          overwrite: true

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

@@ -2,7 +2,8 @@ name: 'Create pull requests to update mozilla-central version to the latest'
 
 on:
   schedule:
-    - cron: "00 14 * * 1" # run every Monday at 14:00 UTC (10:00 Eastern Daylight Time)
+    - 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
 
@@ -33,8 +34,10 @@ jobs:
           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

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 98% to MVP as of August 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.
 
@@ -73,7 +73,7 @@ Read this if you want to build a local version.
     - llvm
     - rust
     - python3.8 or later with header files (python3-dev)
-    - spidermonkey 115.1.0 or later
+    - spidermonkey latest from mozilla-central
     - npm (nodejs)
     - [Poetry](https://python-poetry.org/docs/#installation)
     - [poetry-dynamic-versioning](https://github.com/mtkennerly/poetry-dynamic-versioning)
@@ -136,6 +136,15 @@ $ poetry build --format=wheel
 ```
 and install them by `pip install ./dist/*`.
 
+## Uninstallation
+
+Installing `pythonmonkey` will also install the `pminit` package as a dependency. However, `pip uninstall`ing a package won't automatically remove its dependencies.  
+If you want to cleanly remove `pythonmonkey` from your system, do the following:
+
+```bash
+$ pip uninstall pythonmonkey pminit
+```
+
 ## Debugging Steps
 
 1. [build the project locally](#build-instructions)
@@ -462,7 +471,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

include/JSStringProxy.hh

@@ -15,6 +15,8 @@
 
 #include <Python.h>
 
+#include <unordered_set>
+
 /**
  * @brief The typedef for the backing store that will be used by JSStringProxy objects. All it contains is a pointer to the JSString
  *
@@ -24,6 +26,8 @@ typedef struct {
   JS::PersistentRootedValue *jsString;
 } JSStringProxy;
 
+extern std::unordered_set<JSStringProxy *> jsStringProxies; // a collection of all JSStringProxy objects, used during a GCCallback to ensure they continue to point to the correct char buffer
+
 /**
  * @brief This struct is a bundle of methods used by the JSStringProxy type
  *
@@ -37,7 +41,7 @@ public:
    */
   static void JSStringProxy_dealloc(JSStringProxy *self);
 
-   /**
+  /**
    * @brief copy protocol method for both copy and deepcopy
    *
    * @param self - The JSObjectProxy
@@ -49,13 +53,13 @@ public:
 // docs for methods, copied from cpython
 PyDoc_STRVAR(stringproxy_deepcopy__doc__,
   "__deepcopy__($self, memo, /)\n"
-"--\n"
-"\n");
+  "--\n"
+  "\n");
 
 PyDoc_STRVAR(stringproxy_copy__doc__,
-"__copy__($self, /)\n"
-"--\n"
-"\n");
+  "__copy__($self, /)\n"
+  "--\n"
+  "\n");
 
 /**
  * @brief Struct for the other methods

mozcentral.version

@@ -1 +1 @@
-8a28ad54f9f516c41ceddfa7ea32368fccf4a0eb
+a283127a5d0aa005c54d339e8ca27414b55f079b

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

@@ -46,6 +46,9 @@ export declare function request(
   // callbacks for known exceptions
   onTimeoutError: (err: Error) => void,
   onNetworkError: (err: Error) => void,
+  // the debug logging function
+  /** See `pm.bootstrap.require("debug")` */
+  debug: (selector: string) => ((...args: string[]) => void),
 ): Promise<void>;
 
 /**

python/pythonmonkey/builtin_modules/XMLHttpRequest-internal.py

@@ -44,9 +44,10 @@ async def request(
     # callbacks for known exceptions
     onTimeoutError: Callable[[asyncio.TimeoutError], None],
     onNetworkError: Callable[[aiohttp.ClientError], None],
+    # the debug logging function, see `pm.bootstrap.require("debug")`
+    debug: Callable[[str], Callable[..., None]],
     /
 ):
-  debug = pm.bootstrap.require("debug")
 
   # to support HTTP-Keep-Alive
   global keepAliveConnector