Skip to content

web: Add possibility to run SWF tests on web #21850

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
+1,040 −7
Open

web: Add possibility to run SWF tests on web #21850

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5e65127
web: Require es2022 for selfhosted
kjarosh Oct 5, 2025
92b7bf3
web: Add test-specific methods to control ticking
kjarosh Oct 5, 2025
7b63475
web: Add possibility to run SWF tests on web
kjarosh Oct 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
529 changes: 529 additions & 0 deletions web/package-lock.json
View file
Open in desktop

Large diffs are not rendered by default.

4 changes: 4 additions & 0 deletions web/packages/core/src/internal/player/impl_v1.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,10 @@ export class PlayerV1Impl implements PlayerV1 {
this.#inner.play();
}

tick(timestamp: number): void {
this.#inner.tick(timestamp);
}

get isPlaying(): boolean {
return this.#inner.isPlaying;
}
Expand Down
16 changes: 16 additions & 0 deletions web/packages/core/src/internal/player/inner.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,6 +190,10 @@ export class InnerPlayer {
// The effective config loaded upon `.load()`.
public loadedConfig?: URLLoadOptions | DataLoadOptions;

// Whether content should tick automatically or
// require manual calls to tick().
public tickAutomatically: boolean = true;

private swfUrl?: URL;
private instance: RuffleHandle | null;
private newZipWriter: (() => ZipWriter) | null;
Expand Down Expand Up @@ -652,6 +656,7 @@ export class InnerPlayer {
this.newZipWriter = zipWriterClass;
configureBuilder(builder, this.loadedConfig || {});
builder.setVolume(this.volumeSettings.get_volume());
builder.setTickAutomatically(this.tickAutomatically);

if (this.loadedConfig?.fontSources) {
for (const url of this.loadedConfig.fontSources) {
Expand Down Expand Up @@ -935,6 +940,11 @@ export class InnerPlayer {
this.loadedConfig.backgroundColor;
}

this.tickAutomatically =
"__tickAutomatically" in options
? options["__tickAutomatically"] === true
: true;

await this.ensureFreshInstance();

if ("url" in options) {
Expand Down Expand Up @@ -972,6 +982,12 @@ export class InnerPlayer {
}
}

tick(timestamp: number): void {
if (this.instance) {
this.instance.tick_pub(timestamp);
}
}

/**
* Whether this player is currently playing.
*
Expand Down
2 changes: 2 additions & 0 deletions web/packages/core/src/public/player/v1.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,4 +189,6 @@ export interface PlayerV1 {
* @returns Any value returned by the callback.
*/
callExternalInterface(name: string, ...args: unknown[]): unknown;

tick(timestamp: number): void;
}
2 changes: 2 additions & 0 deletions web/packages/selfhosted/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@
"@types/chai": "^5.2.2",
"@types/chai-html": "^3.0.0",
"json5": "^2.2.3",
"sharp": "^0.34.4",
"smol-toml": "^1.4.2",
"ts-node": "^10.9.2",
"webpack": "^5.102.0",
"webpack-cli": "^6.0.1",
Expand Down
41 changes: 41 additions & 0 deletions web/packages/selfhosted/test/swf_tests/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
<!doctype>
<html>

<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
</head>

<body>
<div id="container"></div>
<script>
const urlParams = new URLSearchParams(window.location.search);
const swfUrl = urlParams.get('swf');
const name = urlParams.get('name');
document.title = name;
window.RufflePlayer = window.RufflePlayer || {};
window.RufflePlayer.config = {
autoplay: "off",
quality: urlParams.get("config_quality"),
};

window.addEventListener("load", (event) => {
const ruffle = window.RufflePlayer.newest();
const player = ruffle.createPlayer();
const container = document.getElementById("container");
container.appendChild(player);

player.addEventListener("loadedmetadata", () => {
player.style.width = `${player.ruffle().metadata.width}px`;
player.style.height = `${player.ruffle().metadata.height}px`;
});

player.ruffle().load({
url: swfUrl,
__tickAutomatically: false,
});
});
</script>
<script src="/dist/ruffle.js"></script>
</body>

</html>
9 changes: 9 additions & 0 deletions web/packages/selfhosted/test/swf_tests/swf_tests.json5
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
// Tests are loaded from the //tests/tests/swfs directory.
// This file contains web-specific configuration of those tests.
// Please order tests alphabetically.
"tests": {
"visual/edittext/edittext_background_basic": {},
"visual/edittext/edittext_border_basic": {},
},
}
Loading
Loading