Merge branch 'TurboWarp:develop' into develop

Author: LilyMakesThings

.github/workflows/deploy.yml

@@ -0,0 +1,48 @@
+name: Deploy playground
+
+on:
+  workflow_dispatch:
+  push:
+    branches: [develop]
+
+concurrency:
+  group: "deploy"
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: npm
+      - name: Install dependencies
+        run: npm ci
+      - name: Build playground
+        run: npm run build
+      - name: Build docs
+        run: npm run docs
+        # We expect to see syntax errors from the old jsdoc cli not understanding some of our syntax
+        # It will still generate what it can, so it's safe to ignore the error
+        continue-on-error: true
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./playground/
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    permissions:
+      pages: write
+      id-token: write
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+    - name: Deploy to GitHub Pages
+      id: deployment
+      uses: actions/deploy-pages@v4

.github/workflows/node.js.yml

@@ -1,21 +1,20 @@
-name: Node.js CI
+name: CI
 
 on:
   push:
   pull_request:
 
 jobs:
   build:
-
     runs-on: ubuntu-latest
-
     steps:
-    - uses: actions/checkout@v4
-    - name: Install Node.js
-      uses: actions/setup-node@v4
-      with:
-        node-version: 20.x
-    - run: npm ci
-    - run: npm run lint
-    - run: npm run build
-    - run: npm run test
+      - uses: actions/checkout@v4
+      - name: Install Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: npm
+      - run: npm ci
+      - run: npm run lint
+      - run: npm run build
+      - run: npm run test

LICENSE

@@ -24,6 +24,27 @@ For more technical information, read the code in src/compiler.
 
 This section was too out of date to be useful. We hope to re-add it as some point.
 
+## License
+
+This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+This program is based on [scratchfoundation/scratch-vm](https://github.com/scratchfoundation/scratch-vm), which is under this license:
+
+```
+Copyright (c) 2016, Massachusetts Institute of Technology
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+```
+
 <!--
 
 ## scratch-vm

README.md

@@ -3,7 +3,7 @@
   "version": "2.1.46",
   "description": "Virtual Machine for Scratch 3.0",
   "author": "Massachusetts Institute of Technology",
-  "license": "BSD-3-Clause",
+  "license": "MPL-2.0",
   "homepage": "https://github.com/scratchfoundation/scratch-vm#readme",
   "repository": {
     "type": "git",
@@ -12,9 +12,9 @@
   "main": "./src/index.js",
   "browser": "./src/index.js",
   "scripts": {
-    "build": "npm run docs && webpack --progress --colors --bail",
+    "build": "webpack --progress --colors --bail",
     "coverage": "tap ./test/{unit,integration}/*.js --coverage --coverage-report=lcov",
-    "docs": "exit 0 || jsdoc -c .jsdoc.json",
+    "docs": "jsdoc -c .jsdoc.json",
     "i18n:src": "mkdirp translations/core && format-message extract --out-file translations/core/en.json src/extensions/**/index.js",
     "i18n:push": "tx-push-src scratch-editor extensions translations/core/en.json",
     "lint": "eslint .",
@@ -35,7 +35,7 @@
   },
   "dependencies": {
     "@turbowarp/json": "^0.1.2",
-    "@turbowarp/nanolog": "^0.1.0",
+    "@turbowarp/nanolog": "^0.2.0",
     "@vernier/godirect": "1.5.0",
     "arraybuffer-loader": "^1.0.6",
     "atob": "2.1.2",

package-lock.json

@@ -316,12 +316,22 @@ class Thread {
         let blockID = this.peekStack();
         while (blockID !== null) {
             const block = this.target.blocks.getBlock(blockID);
-            if (
-                (typeof block !== 'undefined' && block.opcode === 'procedures_call') ||
-                this.peekStackFrame().waitingReporter
-            ) {
+
+            // Reporter form of procedures_call
+            if (this.peekStackFrame().waitingReporter) {
                 break;
             }
+
+            // Command form of procedures_call
+            if (typeof block !== 'undefined' && block.opcode === 'procedures_call') {
+                // By definition, if we get here, the procedure is done, so skip ahead so
+                // the arguments won't be re-evaluated and then discarded as frozen state
+                // about which arguments have been evaluated is lost.
+                // This fixes https://github.com/TurboWarp/scratch-vm/issues/201
+                this.goToNextBlock();
+                break;
+            }
+
             this.popStack();
             blockID = this.peekStack();
         }

package.json

@@ -131,6 +131,8 @@ const setupUnsandboxedExtensionAPI = vm => new Promise(resolve => {
 
     global.Scratch = Scratch;
     global.ScratchExtensions = createScratchX(Scratch);
+
+    vm.emit('CREATE_UNSANDBOXED_EXTENSION_API', Scratch);
 });
 
 /**

src/engine/thread.js

@@ -269,8 +269,6 @@ class WeDo2Motor {
      * Turn this motor on indefinitely.
      */
     turnOn () {
-        if (this._power === 0) return;
-
         const cmd = this._parent.generateOutputCommand(
             this._index + 1,
             WeDo2Command.MOTOR_POWER,

src/extension-support/tw-unsandboxed-extension-runner.js

@@ -24,11 +24,8 @@ class Base64Util {
      * @return {string} - the base64 encoded string.
      */
     static uint8ArrayToBase64 (array) {
-        if (Array.isArray(array)) {
-            array = new Uint8Array(array);
-        }
         let binary = '';
-        const len = array.byteLength;
+        const len = array.length;
         for (let i = 0; i < len; i++) {
             binary += String.fromCharCode(array[i]);
         }

src/extensions/scratch3_wedo2/index.js

@@ -0,0 +1,25 @@
+// TW Snapshot
+// Input SHA-256: fd981742e0e4299bad5a89349635d3a7d0467d8163ae77ba4bafe43c97849bae
+
+// Sprite1 script
+(function factoryXYZ(thread) { const target = thread.target; const runtime = target.runtime; const stage = runtime.getTargetForStage();
+const b0 = runtime.getOpcodeFunction("looks_say");
+return function* genXYZ () {
+yield* executeInCompatibilityLayer({"MESSAGE":"plan 0",}, b0, false, false, "d", null);
+thread.procedures["Zfoo %s"]("");
+yield* executeInCompatibilityLayer({"MESSAGE":"end",}, b0, false, false, "g", null);
+retire(); return;
+}; })
+
+// Sprite1 foo %s
+(function factoryXYZ(thread) { const target = thread.target; const runtime = target.runtime; const stage = runtime.getTargetForStage();
+return function funXYZ_foo_ (p0) {
+return "";
+return "";
+}; })
+
+// Sprite1 no op
+(function factoryXYZ(thread) { const target = thread.target; const runtime = target.runtime; const stage = runtime.getTargetForStage();
+return function funXYZ_no_op () {
+return "";
+}; })

src/util/base64-util.js

@@ -0,0 +1,25 @@
+// TW Snapshot
+// Input SHA-256: fd981742e0e4299bad5a89349635d3a7d0467d8163ae77ba4bafe43c97849bae
+
+// Sprite1 script
+(function factoryXYZ(thread) { const target = thread.target; const runtime = target.runtime; const stage = runtime.getTargetForStage();
+const b0 = runtime.getOpcodeFunction("looks_say");
+return function* genXYZ () {
+yield* executeInCompatibilityLayer({"MESSAGE":"plan 0",}, b0, false, false, "d", null);
+thread.procedures["Zfoo %s"]("");
+yield* executeInCompatibilityLayer({"MESSAGE":"end",}, b0, false, false, "g", null);
+retire(); return;
+}; })
+
+// Sprite1 foo %s
+(function factoryXYZ(thread) { const target = thread.target; const runtime = target.runtime; const stage = runtime.getTargetForStage();
+return function funXYZ_foo_ (p0) {
+return "";
+return "";
+}; })
+
+// Sprite1 no op
+(function factoryXYZ(thread) { const target = thread.target; const runtime = target.runtime; const stage = runtime.getTargetForStage();
+return function funXYZ_no_op () {
+return "";
+}; })

test/fixtures/execute/tw-gh-201-stop-script-does-not-reevaluate-arguments.sb3

@@ -223,7 +223,7 @@ test('stopThisScript', t => {
     th.pushStack('arbitraryString');
     th.pushStack('secondString');
     th.stopThisScript();
-    t.strictEquals(th.peekStack(), 'secondString');
+    t.strictEquals(th.peekStack(), null);
 
     t.end();
 });

test/snapshot/__snapshots__/tw-gh-201-stop-script-does-not-reevaluate-arguments.sb3.tw-snapshot

@@ -0,0 +1,52 @@
+const {test} = require('tap');
+const Thread = require('../../src/engine/thread');
+const Runtime = require('../../src/engine/runtime');
+const Target = require('../../src/engine/target');
+
+test('stopThisScript procedures_call reporter form', t => {
+    const rt = new Runtime();
+    const target = new Target(rt, null);
+
+    target.blocks.createBlock({
+        id: 'reporterCall',
+        opcode: 'procedures_call',
+        inputs: {},
+        fields: {},
+        mutation: {
+            return: '1'
+        },
+        shadow: false,
+        topLevel: true,
+        parent: null,
+        next: 'afterReporterCall'
+    });
+    target.blocks.createBlock({
+        id: 'afterReporterCall',
+        opcode: 'motion_ifonedgebounce',
+        inputs: {},
+        fields: {},
+        mutation: null,
+        shadow: false,
+        topLevel: false,
+        parent: null,
+        next: null
+    });
+
+    const thread = new Thread('reporterCall');
+    thread.target = target;
+
+    // pretend to run reporterCall
+    thread.pushStack('reporterCall');
+    thread.peekStackFrame().waitingReporter = true;
+
+    // pretend to run scripts inside of the procedure
+    thread.pushStack('fakeBlock');
+
+    // stopping or returning should always return to reporterCall, not the block after
+    thread.stopThisScript();
+    t.same(thread.stack, [
+        'reporterCall'
+    ]);
+
+    t.end();
+});

test/snapshot/__snapshots__/warp-timer/tw-gh-201-stop-script-does-not-reevaluate-arguments.sb3.tw-snapshot

@@ -417,3 +417,13 @@ test('canEmbed', async t => {
 
     t.end();
 });
+
+test('CREATE_UNSANDBOXED_EXTENSION_API', t => {
+    const vm = new VirtualMachine();
+    vm.on('CREATE_UNSANDBOXED_EXTENSION_API', api => {
+        api.extraStuff = 'aaaa';
+    });
+    UnsandboxedExtensionRunner.setupUnsandboxedExtensionAPI(vm);
+    t.equal(global.Scratch.extraStuff, 'aaaa');
+    t.end();
+});