Merge pull request #227 from Distributive-Network/caleb/fix/this

Caleb/fix/this

Author: philippedistributive

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

@@ -8,6 +8,17 @@ on:
       - '*'
   workflow_call:
   workflow_dispatch:
+    inputs:
+      debug_enabled:
+        type: boolean
+        description: 'Run the build with tmate debugging enabled (https://github.com/marketplace/actions/debugging-with-tmate)'
+        required: false
+        default: false
+      dump_cores:
+        type: boolean
+        description: 'Include core dumps in CI artifacts'
+        required: false
+        default: false
   pull_request:
 
 env:
@@ -31,17 +42,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 +65,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' }}
@@ -104,12 +115,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
@@ -138,11 +149,11 @@ jobs:
           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: |
@@ -167,20 +178,55 @@ jobs:
         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' && github.event_name == 'workflow_dispatch' && inputs.dump_cores }}
+        # 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: |
+          if [[ "$OSTYPE" == "linux-gnu"* || "$OSTYPE" == "darwin"* ]]; then
+          # TODO (Caleb Aikens) figure out how to get Windows core dumps
+            ulimit -c unlimited
+          fi
           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: Upload core dumps as CI artifacts
+        uses: actions/upload-artifact@v3
+        if: ${{ matrix.os != 'windows-2019' && github.event_name == 'workflow_dispatch' && inputs.dump_cores }}
+        # TODO (Caleb Aikens) figure out how to get Windows core dumps
+        with:
+          name: cores-${{ matrix.os }}-${{ matrix.python_version }}
+          path: /cores
+      # Enable tmate debugging of manually-triggered workflows if the input option was provided
+      - name: SSH debug session
+        if: ${{ (success() || failure()) && github.event_name == 'workflow_dispatch' && inputs.debug_enabled }}
+        uses: mxschmitt/action-tmate@v3
+        with:
+          detached: true
+          limit-access-to-actor: true
   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
@@ -203,7 +249,7 @@ jobs:
     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

CMakeLists.txt

@@ -61,6 +61,7 @@ if(CMAKE_PROJECT_NAME STREQUAL PROJECT_NAME)
     set(Python_FIND_VIRTUALENV FIRST) # (require cmake >= v3.15 and this is the default) use the Python version configured by pyenv if available
     set(PYTHON_LIBRARIES ${Python_LIBRARIES})
     set(PYTHON_INCLUDE_DIR ${Python_INCLUDE_DIRS})
+    message("Linux - Using Python:${Python_VERSION_MAJOR}.${Python_VERSION_MINOR} - Libraries:${PYTHON_LIBRARIES} - IncludeDirs: ${PYTHON_INCLUDE_DIR}")
     find_package(SpiderMonkey REQUIRED)
   elseif(WIN32)
     find_package(PythonInterp 3.8 REQUIRED)

README.md

@@ -8,7 +8,8 @@ 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 intermediate stage, approximately 95% to MVP as of March 2024. It is under active development by [Distributive](https://distributive.network/).
+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/).
+
 External contributions and feedback are welcome and encouraged.
 
 ### tl;dr
@@ -250,6 +251,7 @@ generated by enumerating the global variable in the current SpiderMonkey context
 ## Built-In Functions
 
 See definitions in [python/pythonmonkey/global.d.ts](https://github.com/Distributive-Network/PythonMonkey/blob/main/python/pythonmonkey/global.d.ts).
+Including:
 
 - `console`
 - `atob`
@@ -307,11 +309,11 @@ JavaScript Array and Object methods are implemented on Python List and Dictionar
 
 | JavaScript Type      | Python Type     |
 |:---------------------|:----------------|
-| string               | String
+| string               | pythonmonkey.JSStringProxy (String)
 | number               | Float
 | bigint               | pythonmonkey.bigint (Integer)
 | boolean              | Bool
-| function             | Function
+| function             | pythonmonkey.JSFunctionProxy || pythonmonkey.JSMethodProxy (Function || Method)
 | object - most        | pythonmonkey.JSObjectProxy (Dict)
 | object - Date        | datetime
 | object - Array       | pythonmonkey.JSArrayProxy (List)
@@ -386,10 +388,10 @@ in Python. Simply decorate a Dict named `exports` inside a file with a `.py` ext
 loaded by `require()` -- in either JavaScript or Python.
 
 ### Program Module
-The program module, or main module, is a special module in CommonJS. In a program module,
+The program module, or main module, is a special module in CommonJS. In a program module:
  - variables defined in the outermost scope are properties of `globalThis`
  - returning from the outermost scope is a syntax error
- - the `arguments` variable in an Array-like object which holds your program's argument vector
+ - the `arguments` variable in an Array which holds your program's argument vector
    (command-line arguments)
 
 ```console
@@ -416,7 +418,7 @@ exports['today'] = date.today()
 # Troubleshooting Tips
 
 ## CommonJS (require)
-If you are having trouble with the CommonJS require function, set environment variable `DEBUG='ctx-module*'` and you can see the filenames it tries to laod.
+If you are having trouble with the CommonJS require function, set environment variable `DEBUG='ctx-module*'` and you can see the filenames it tries to load.
 
 ## pmdb
 
@@ -453,7 +455,7 @@ List of commands:
 ```console
 $ pmjs
 
-Welcome to PythonMonkey v0.2.0.
+Welcome to PythonMonkey v0.4.0.
 Type ".help" for more information.
 > .python import sys
 > .python sys.path

build.py

@@ -2,7 +2,9 @@
 #              Main PythonMonkey build automation script. Run with `poetry build`.
 # @author      Hamada Gasmallah, [email protected]
 # @date        April 2023
+# @copyright Copyright (c) 2023 Distributive Corp.
 #
+
 import subprocess
 import os, sys
 import platform

include/BoolType.hh

@@ -2,10 +2,9 @@
  * @file BoolType.hh
  * @author Caleb Aikens ([email protected])
  * @brief Struct for representing python bools
- * @version 0.1
  * @date 2022-12-02
  *
- * @copyright Copyright (c) 2022
+ * @copyright Copyright (c) 2022 Distributive Corp.
  *
  */
 

include/BufferType.hh

@@ -2,7 +2,6 @@
  * @file BufferType.hh
  * @author Tom Tang ([email protected])
  * @brief Struct for representing ArrayBuffers
- * @version 0.1
  * @date 2023-04-27
  *
  * @copyright Copyright (c) 2023 Distributive Corp.

include/DateType.hh

@@ -2,10 +2,9 @@
  * @file DateType.hh
  * @author Caleb Aikens ([email protected])
  * @brief Struct for representing python dates
- * @version 0.1
  * @date 2022-12-21
  *
- * @copyright Copyright (c) 2022
+ * @copyright Copyright (c) 2022 Distributive Corp.
  *
  */
 

include/DictType.hh

@@ -2,10 +2,9 @@
  * @file DictType.hh
  * @author Caleb Aikens ([email protected]) & Giovanni Tedesco ([email protected])
  * @brief Struct representing python dictionaries
- * @version 0.1
  * @date 2022-08-10
  *
- * @copyright Copyright (c) 2022
+ * @copyright Copyright (c) 2022 Distributive Corp.
  *
  */
 

include/ExceptionType.hh

@@ -2,7 +2,6 @@
  * @file ExceptionType.hh
  * @author Tom Tang ([email protected]) and Philippe Laporte ([email protected])
  * @brief Struct for representing Python Exception objects from a corresponding JS Error object
- * @version 0.1
  * @date 2023-04-11
  *
  * @copyright Copyright (c) 2023-2024 Distributive Corp.

include/FloatType.hh

@@ -2,10 +2,9 @@
  * @file FloatType.hh
  * @author Caleb Aikens ([email protected])
  * @brief Struct for representing python floats
- * @version 0.1
  * @date 2022-12-02
  *
- * @copyright Copyright (c) 2022
+ * @copyright Copyright (c) 2022 Distributive Corp.
  *
  */