web: Fix enter key + add input tests

web/packages/selfhosted/package.json

@@ -20,6 +20,7 @@
         "ruffle-core": "^0.1.0"
     },
     "devDependencies": {
+        "webdriverio": "^8.20.4",
         "@wdio/cli": "^8.20.5",
         "json5": "^2.2.3",
         "webpack": "^5.89.0",

web/packages/selfhosted/test/integration_tests/keyboard_input/Test.as

@@ -0,0 +1,28 @@
+package  {
+	import flash.display.MovieClip;
+	import flash.events.KeyboardEvent;
+
+public class Test extends MovieClip {
+		public function Test() {
+			text.addEventListener(KeyboardEvent.KEY_DOWN, onKeyDown);
+			text.addEventListener(KeyboardEvent.KEY_UP, onKeyUp);
+
+			// Magic phrase is expected by "playAndMonitor", tells the test that it's ready
+			trace("Hello from Flash!");
+		}
+
+		function onKeyDown(event: KeyboardEvent) {
+			trace("onKeyDown");
+			trace("event.charCode = " + event.charCode);
+			trace("event.keyCode = " + event.keyCode);
+			trace("");
+		}
+
+		function onKeyUp(event: KeyboardEvent) {
+			trace("onKeyUp");
+			trace("event.charCode = " + event.charCode);
+			trace("event.keyCode = " + event.keyCode);
+			trace("");
+		}
+	}
+}

web/packages/selfhosted/test/integration_tests/keyboard_input/test.js

@@ -0,0 +1,48 @@
+const { jsApiBefore, getTraceOutput } = require("../../utils");
+const { use, expect } = require("chai");
+const chaiHtml = require("chai-html");
+const { Key } = require("webdriverio");
+
+use(chaiHtml);
+
+describe("Key up and down events work", () => {
+    jsApiBefore("/test/integration_tests/keyboard_input/test.swf");
+
+    it("'a' key is recognised", async () => {
+        const player = await browser.$("<ruffle-player>");
+        await player.click();
+
+        await browser.keys("a");
+        const actualOutput = await getTraceOutput(browser, player);
+        expect(actualOutput).to.eql(
+            `onKeyDown
+event.charCode = 97
+event.keyCode = 65
+
+onKeyUp
+event.charCode = 97
+event.keyCode = 65
+
+`,
+        );
+    });
+
+    it("enter key is recognised", async () => {
+        const player = await browser.$("<ruffle-player>");
+        await player.click();
+
+        await browser.keys([Key.Enter]);
+        const actualOutput = await getTraceOutput(browser, player);
+        expect(actualOutput).to.eql(
+            `onKeyDown
+event.charCode = 13
+event.keyCode = 13
+
+onKeyUp
+event.charCode = 13
+event.keyCode = 13
+
+`,
+        );
+    });
+});

web/packages/selfhosted/test/utils.js

@@ -1,4 +1,5 @@
 const path = require("path");
+const { expect } = require("chai");
 
 async function isRuffleLoaded(browser) {
     return await browser.execute(
@@ -75,16 +76,34 @@ async function playAndMonitor(browser, player, expectedOutput) {
         expectedOutput = "Hello from Flash!\n";
     }
 
+    const actualOutput = await getTraceOutput(browser, player);
+    expect(actualOutput).to.eql(expectedOutput);
+}
+
+async function getTraceOutput(browser, player) {
+    // Await any trace output
     await browser.waitUntil(
-        async () =>
-            (await browser.execute(
-                (player) => player.__ruffle_log__,
-                player,
-            )) === expectedOutput,
+        async () => {
+            return (
+                (await browser.execute(
+                    (player) => player.__ruffle_log__,
+                    player,
+                )) !== ""
+            );
+        },
         {
             timeoutMsg: "Expected Ruffle to trace a message",
         },
     );
+
+    // Get the output, and replace it with an empty string for any future test
+    const output = await browser.execute((player) => {
+        const log = player.__ruffle_log__;
+        player.__ruffle_log__ = "";
+        return log;
+    }, player);
+
+    return output;
 }
 
 async function injectRuffleAndWait(browser) {
@@ -120,9 +139,13 @@ function jsApiBefore(swf) {
         });
 
         if (swf) {
-            await browser.execute((player) => {
-                player.load("/test_assets/example.swf");
-            }, player);
+            await browser.execute(
+                async (player, swf) => {
+                    await player.load(swf);
+                },
+                player,
+                swf,
+            );
             await playAndMonitor(browser, player);
         }
     });
@@ -137,4 +160,5 @@ module.exports = {
     openTest,
     setupErrorHandler,
     jsApiBefore,
+    getTraceOutput,
 };

web/src/lib.rs

@@ -1878,6 +1878,7 @@ fn web_key_to_codepoint(key: &str) -> Option<char> {
         match key {
             "Backspace" => Some(8 as char),
             "Delete" => Some(127 as char),
+            "Enter" => Some(13 as char),
             _ => None,
         }
     }