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

Author: Xmader

.git-blame-ignore-revs

@@ -0,0 +1,8 @@
+# chore(linting): lint all python files
+aae30e864449442cf0b04e94f8a242b1b667de9a
+
+# chore(linting): lint all JavaScript files
+16dc3153b3cb684ca72445ed058babc8f5d97f42
+
+# chore(linting): lint all C++ files
+58cd4b45777b046f03a63255c1d93e289e1cab5e

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

@@ -8,6 +8,41 @@ on:
       - '*'
   workflow_call:
   workflow_dispatch:
+    inputs:
+      debug_enabled_os:
+        type: choice
+        description: Optionally, choose an OS to run the build with SSH debugging on (https://github.com/fawazahmed0/action-debug)
+        required: false
+        options:
+        - ''
+        - 'ubuntu-20.04'
+        - 'macos-12'
+        - 'macos-13'
+        - 'macos-14'
+        - 'windows-2019'
+      debug_enabled_python:
+        type: choice
+        description: Choose a Python version to run the build with SSH debugging on
+        required: false
+        options:
+        - ''
+        - '3.8'
+        - '3.9'
+        - '3.10'
+        - '3.11'
+        - '3.12'
+      build_type:
+        type: choice
+        description: 'Choose the build type to use'
+        required: false
+        default: 'Debug'
+        options:
+        - 'Debug'
+        - 'Profile'
+        - 'Sanitize'
+        - 'DRelease'
+        - 'Release'
+        - 'None'
   pull_request:
 
 env:
@@ -31,17 +66,17 @@ jobs:
         python_version: [ '3.10' ]
     runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-python@v4
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python_version }}
       - name: Cache spidermonkey build
         id: cache-spidermonkey
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: |
             ./_spidermonkey_install/*
-          key: spidermonkey115.7.0-${{ runner.os }}-${{ runner.arch }}
+          key: spidermonkey115.8.0-${{ 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' }}
@@ -54,14 +89,14 @@ jobs:
   build-spidermonkey-win:
     runs-on: windows-2019
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Cache spidermonkey build
         id: cache-spidermonkey
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: |
             ./_spidermonkey_install/*
-          key: spidermonkey115.7.0-${{ runner.os }}-${{ runner.arch }}
+          key: spidermonkey115.8.0-${{ runner.os }}-${{ runner.arch }}
           lookup-only: true # skip download
       - name: Install dependencies
         if: ${{ steps.cache-spidermonkey.outputs.cache-hit != 'true' }}
@@ -89,11 +124,10 @@ jobs:
       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', 'windows-2019', 'macos-14' ]
+        os: [ 'ubuntu-20.04', 'macos-12', 'macos-13', 'macos-14', 'windows-2019' ]
         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
-          # FIXME: We can't build on macOS 11 for now because our prebuilt `uncrustify` binary requires macOS 12
           - os: 'macos-12'
             python_version: '3.8'
           # actions/setup-python: The version '3.8'/'3.9' with architecture 'arm64' was not found for macOS.
@@ -104,12 +138,12 @@ jobs:
             python_version: '3.9'
     runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           submodules: recursive
           fetch-depth: 0 # fetch all history for all branches and tags
           # poetry-dynamic-versioning needs git tags to produce the correct version number 
-      - uses: actions/setup-python@v4
+      - uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python_version }}
       - name: Setup Poetry
@@ -122,27 +156,21 @@ jobs:
           if [[ "$OSTYPE" == "linux-gnu"* ]]; then # Linux
             sudo apt-get update -y
             sudo apt-get install -y cmake graphviz llvm
-            # 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
           elif [[ "$OSTYPE" == "darwin"* ]]; then # macOS
             brew update || true # allow failure
-            brew install cmake doxygen graphviz pkg-config wget coreutils # `coreutils` installs the `realpath` command
+            brew install cmake pkg-config wget 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 install --no-root --only=dev
           echo "Installed Dependencies"
       - name: Use cached spidermonkey build
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: |
             ./_spidermonkey_install/*
-          key: spidermonkey115.7.0-${{ runner.os }}-${{ runner.arch }}
+          key: spidermonkey115.8.0-${{ runner.os }}-${{ runner.arch }}
           fail-on-cache-miss: true # SpiderMonkey is expected to be cached in its dedicated job
       - name: Build pminit
         run: |
@@ -154,33 +182,62 @@ jobs:
       - name: Build wheel
         run: |
           echo $(poetry run python --version)
-          poetry build --format=wheel
+          WORKFLOW_BUILD_TYPE=${{ inputs.build_type }}
+          BUILD_TYPE=${WORKFLOW_BUILD_TYPE:-"Debug"} poetry build --format=wheel
           ls -lah ./dist/
       - name: Upload wheel 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
-        if: ${{ matrix.os == 'ubuntu-20.04' && matrix.python_version == '3.11' }} # making sure we only upload once
-        with:
-          name: docs-${{ github.run_id }}-${{ github.sha }}
-          path: ./build/docs/html/
+      - name: Set cores to get stored in /cores
+        if: ${{ matrix.os != 'windows-2019' }}
+        # TODO (Caleb Aikens) figure out how to get Windows core dumps
+        run: |
+          sudo mkdir -p /cores
+          sudo chmod 777 /cores
+          # Core filenames will be of the form osname.pythonversion.executable.pid.timestamp:
+          if [[ "$OSTYPE" == "linux-gnu"* ]]; then
+            sudo bash -c 'echo "/cores/${OSTYPE}.$(poetry run python --version).%e.%p.%t" > /proc/sys/kernel/core_pattern'
+          else
+            sudo sysctl kern.corefile="/cores/${OSTYPE}.$(poetry run python --version).%e.%p.%y"
+          fi
       - name: Run Python tests (pytest)
         run: |
-          poetry run python -m pip install --force-reinstall --verbose ./dist/*
+          if [[ "$OSTYPE" == "linux-gnu"* || "$OSTYPE" == "darwin"* ]]; then
+          # TODO (Caleb Aikens) figure out how to get Windows core dumps
+            ulimit -c unlimited
+          fi
+          WORKFLOW_BUILD_TYPE=${{ inputs.build_type }}
+          BUILD_TYPE=${WORKFLOW_BUILD_TYPE:-"Debug"} poetry run python -m pip install --force-reinstall --verbose ./dist/*
           poetry run python -m pytest tests/python
       - name: Run JS tests (peter-jr)
+        if: ${{ (success() || failure()) }}
         run: |
+          if [[ "$OSTYPE" == "linux-gnu"* || "$OSTYPE" == "darwin"* ]]; then
+          # TODO (Caleb Aikens) figure out how to get Windows core dumps
+            ulimit -c unlimited
+          fi
           poetry run bash ./peter-jr ./tests/js/
+      - name: SSH debug session
+        if: ${{ (success() || failure()) && github.event_name == 'workflow_dispatch' && inputs.debug_enabled_os == matrix.os && inputs.debug_enabled_python == matrix.python_version}}
+        uses: fawazahmed0/action-debug@main
+        with:
+          credentials: "admin:admin"
+      - name: Upload core dumps as CI artifacts
+        uses: actions/upload-artifact@v3
+        if: ${{ matrix.os != 'windows-2019' && failure() }}
+        # TODO (Caleb Aikens) figure out how to get Windows core dumps
+        with:
+          name: cores-${{ matrix.os }}-${{ matrix.python_version }}
+          path: /cores
   sdist:
     runs-on: ubuntu-20.04
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      - uses: actions/setup-python@v4
+      - uses: actions/setup-python@v5
         with:
           python-version: '3.9'
       - name: Setup Poetry
@@ -189,21 +246,33 @@ 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
+        with:
+          name: docs-${{ github.run_id }}-${{ github.sha }}
+          path: ./build/docs/html/
   publish:
     needs: [build-and-test, sdist]
     runs-on: ubuntu-20.04
     if: ${{ success() && github.event_name == 'push' && contains(github.ref, 'refs/tags/') }}
     steps:
       # no need to checkout
-      - uses: actions/setup-python@v4
+      - uses: actions/setup-python@v5
         with:
           python-version: '3.9'
       - run: pip install twine

.gitignore

@@ -11,6 +11,10 @@ firefox-*/
 __pycache__
 Testing/Temporary
 _spidermonkey_install
+uncrustify-*.tar.gz
+uncrustify-*/
+uncrustify
+*.uncrustify
 __pycache__/*
 dist
 *.so

.vscode/launch.json

@@ -17,7 +17,7 @@
           "run"
         ],
       },
-      "preLaunchTask": "Build",
+      "preLaunchTask": "Fast build",
       "cwd": "${fileDirname}",
       "environment": [],
       "externalConsole": false,

.vscode/tasks.json

@@ -26,6 +26,22 @@
         "isDefault": true
       }
     },
+    {
+      "label": "Fast build",
+      "type": "process",
+      "command": "poetry",
+      "args": [
+        "run",
+        "python",
+        "./build.py",
+      ],
+      "problemMatcher": [
+        "$gcc"
+      ],
+      "group": {
+        "kind": "build",
+      }
+    },
     // 
     // Test
     //