phptest 0.0.6 → 0.0.8

package/.github/workflows/main.yml

@@ -8,10 +8,10 @@ jobs:
 
         strategy:
             matrix:
-                node-version: [12.x, 14.x, 16.x]
+                node-version: [14.x, 16.x, 18.x, 19.x]
 
         steps:
-            # Check out the repository under $GITHUB_WORKSPACE, so this job can access it
+            # Check out the repository under $GITHUB_WORKSPACE, so this job can access it.
             - uses: actions/checkout@v2
 
             - name: Use Node.js ${{ matrix.node-version }}

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.0.6",
+  "version": "0.0.8",
   "name": "phptest",
   "description": "Test helper library for PHP core runtime components",
   "keywords": [
@@ -25,17 +25,16 @@
   "dependencies": {
     "es6-weak-map": "^2.0.3",
     "is-promise": "^4.0.0",
-    "jshint": "^2.13.4",
+    "jshint": "^2.13.6",
     "lie": "^3.3.0",
     "microdash": "^1.4.2",
     "regexp.escape": "^1.1.0",
     "source-map": "^0.8.0-beta.0"
   },
   "devDependencies": {
-    "phpcore": "^7.1.0"
+    "phpcore": "^7.2.0"
   },
   "peerDependencies": {
-    "core-js-pure": "^3.21.1",
     "mocha": "^10.0.0",
     "phptoast": "^9.0.1",
     "phptojs": "^9.0.1"

package/src/createIntegrationTools.js

@@ -24,9 +24,10 @@ var _ = require('microdash'),
  *
  * @param {string} phpCorePath
  * @param {Function=} initRuntime
+ * @param {boolean=} forceOpcodesAsync
  * @returns {Object}
  */
-module.exports = function (phpCorePath, initRuntime) {
+module.exports = function (phpCorePath, initRuntime, forceOpcodesAsync) {
     var
         resolvedPHPCorePath = path.resolve(phpCorePath),
         OpcodeExecutor = require(resolvedPHPCorePath + '/src/Core/Opcode/Handler/OpcodeExecutor'),
@@ -110,6 +111,8 @@ module.exports = function (phpCorePath, initRuntime) {
                 return phpCore;
             });
 
+            // Note that we do not support setting additional module options for PHPCore,
+            // because module-level options are deprecated in favour of environment-level ones.
             if (path !== null) {
                 module = module.using({
                     path: path
@@ -124,6 +127,93 @@ module.exports = function (phpCorePath, initRuntime) {
             return module;
         },
 
+        /**
+         * Forces all opcodes to be async for all async mode tests, to help ensure async handling is in place.
+         *
+         * @param {Runtime} runtime
+         */
+        installForcedAsyncOpcodeHook = function (runtime) {
+            runtime.install({
+                serviceGroups: [
+                    function (internals) {
+                        var get = internals.getServiceFetcher();
+
+                        // As we'll be overriding the "opcode_executor" service.
+                        internals.allowServiceOverride();
+
+                        return {
+                            'opcode_executor': function () {
+                                var controlBridge = get('control_bridge'),
+                                    futureFactory = get('future_factory'),
+                                    referenceFactory = get('reference_factory'),
+                                    valueFactory = get('value_factory');
+
+                                function AsyncOpcodeExecutor() {
+                                }
+
+                                util.inherits(AsyncOpcodeExecutor, OpcodeExecutor);
+
+                                AsyncOpcodeExecutor.prototype.execute = function (opcode) {
+                                    var result = opcode.handle();
+
+                                    if (!opcode.isTraced()) {
+                                        // Don't attempt to make any untraced opcodes pause,
+                                        // as resuming from inside them is not possible.
+                                        return result;
+                                    }
+
+                                    if (controlBridge.isFuture(result) && result.isSettled()) {
+                                        // Wrap settled Futures in a deferring one to force a pause.
+                                        return futureFactory.createAsyncPresent(result);
+                                    }
+
+                                    if (result instanceof Value) {
+                                        return valueFactory.createAsyncPresent(result);
+                                    }
+
+                                    if (result instanceof Reference || result instanceof Variable) {
+                                        return referenceFactory.createAccessor(function () {
+                                            // Defer returning the value of the reference.
+                                            return valueFactory.createAsyncPresent(result.getValue());
+                                        }, function (value) {
+                                            // Defer assignment in a microtask to test for async handling.
+                                            return valueFactory.createAsyncMicrotaskFuture(function (resolve, reject) {
+                                                result.setValue(value).next(resolve, reject);
+                                            });
+                                        }, function () {
+                                            return result.unset();
+                                        }, function () {
+                                            return result.getReference();
+                                        }, function (reference) {
+                                            result.setReference(reference);
+                                        }, function () {
+                                            result.clearReference();
+                                        }, function () {
+                                            return result.isDefined();
+                                        }, function () {
+                                            return result.isReadable();
+                                        }, function () {
+                                            return result.isEmpty();
+                                        }, function () {
+                                            return result.isSet();
+                                        }, function () {
+                                            return result.isReference();
+                                        }, function () {
+                                            return result.raiseUndefined();
+                                        });
+                                    }
+
+                                    return result;
+                                };
+
+                                return new AsyncOpcodeExecutor();
+                            }
+                        };
+                    }
+                ]
+            });
+        },
+
         // Create isolated runtimes to be shared by all tests that don't create their own,
         // to avoid modifying the singleton module exports.
         asyncRuntime = createAsyncRuntime(),
@@ -139,61 +229,9 @@ module.exports = function (phpCorePath, initRuntime) {
         )()
             .match(/<anonymous>:(\d+):\d+/)[1] - 1;
 
-    // Force all opcodes to be async for all async mode tests, to help ensure async handling is in place.
-    asyncRuntime.install({
-        serviceGroups: [
-            function (internals) {
-                var get = internals.getServiceFetcher();
-
-                // As we'll be overriding the "opcode_executor" service.
-                internals.allowServiceOverride();
-
-                return {
-                    'opcode_executor': function () {
-                        var referenceFactory = get('reference_factory'),
-                            valueFactory = get('value_factory');
-
-                        function AsyncOpcodeExecutor() {
-                        }
-
-                        util.inherits(AsyncOpcodeExecutor, OpcodeExecutor);
-
-                        AsyncOpcodeExecutor.prototype.execute = function (opcode) {
-                            var result = opcode.handle();
-
-                            if (!opcode.isTraced()) {
-                                // Don't attempt to make any untraced opcodes pause,
-                                // as resuming from inside them is not possible.
-                                return result;
-                            }
-
-                            if (result instanceof Value) {
-                                return valueFactory.createAsyncPresent(result);
-                            }
-
-                            if (result instanceof Reference || result instanceof Variable) {
-                                return referenceFactory.createAccessor(function () {
-                                    // Defer returning the value of the reference.
-                                    return valueFactory.createAsyncPresent(result.getValue());
-                                }, function (value) {
-                                    // Defer assignment in a microtask to test for async handling.
-                                    return valueFactory.createAsyncMicrotaskFuture(function (resolve, reject) {
-                                        result.setValue(value).next(resolve, reject);
-                                    });
-                                }, function (reference) {
-                                    return result.setReference(reference);
-                                });
-                            }
-
-                            return result;
-                        };
-
-                        return new AsyncOpcodeExecutor();
-                    }
-                };
-            }
-        ]
-    });
+    if (forceOpcodesAsync !== false) {
+        installForcedAsyncOpcodeHook(asyncRuntime);
+    }
 
     return {
         asyncRuntime: asyncRuntime,
@@ -218,6 +256,8 @@ module.exports = function (phpCorePath, initRuntime) {
 
         createSyncRuntime: createSyncRuntime,
 
+        installForcedAsyncOpcodeHook: installForcedAsyncOpcodeHook,
+
         /**
          * Attempts to make this integration test slightly less brittle when future changes occur,
          * by scrubbing out things that are out of our control and likely to change (such as line/column numbers