Skip to content

feat(tests): add tests for browser JSPI & asyncify #3

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
vados-cosmonic wants to merge 1 commit into
base: test-base
Choose a base branch
from
Open

feat(tests): add tests for browser JSPI & asyncify #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
227 changes: 227 additions & 0 deletions test/async.browser.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,227 @@
import { dirname, join, resolve } from "node:path";
import { execArgv } from "node:process";
import { deepStrictEqual, ok, strictEqual, fail } from "node:assert";
import { mkdir, readFile, rm, symlink, writeFile } from "node:fs/promises";

import { fileURLToPath, pathToFileURL } from "url";
import puppeteer from "puppeteer";

import {
exec,
jcoPath,
getTmpDir,
setupAsyncTest,
startTestWebServer,
loadTestPage,
} from "./helpers.js";

const multiMemory = execArgv.includes("--experimental-wasm-multi-memory")
? ["--multi-memory"]
: [];

const AsyncFunction = (async () => {}).constructor;

export async function asyncBrowserTest(_fixtures) {
suite("Async", () => {
var tmpDir;
var outDir;
var outFile;

suiteSetup(async function () {
tmpDir = await getTmpDir();
outDir = resolve(tmpDir, "out-component-dir");
outFile = resolve(tmpDir, "out-component-file");

const modulesDir = resolve(tmpDir, "node_modules", "@bytecodealliance");
await mkdir(modulesDir, { recursive: true });
await symlink(
fileURLToPath(new URL("../packages/preview2-shim", import.meta.url)),
resolve(modulesDir, "preview2-shim"),
"dir",
);
});

suiteTeardown(async function () {
try {
await rm(tmpDir, { recursive: true });
} catch {}
});

teardown(async function () {
try {
await rm(outDir, { recursive: true });
await rm(outFile);
} catch {}
});

test("Transpile async (browser, asyncify)", async () => {
const componentName = "async-call";
const {
instance,
cleanup: componentCleanup,
outputDir,
} = await setupAsyncTest({
asyncMode: "asyncify",
component: {
name: "async_call",
path: resolve("test/fixtures/components/async_call.component.wasm"),
imports: {
"something:test/test-interface": {
callAsync: async () => "called async",
callSync: () => "called sync",
},
},
},
jco: {
transpile: {
extraArgs: {
asyncImports: ["something:test/test-interface#call-async"],
asyncExports: ["run-async"],
},
},
},
});
const moduleName = componentName.toLowerCase().replaceAll("-", "_");
const moduleRelPath = `${moduleName}/${moduleName}.js`;

// Start a test web server
const {
server,
serverPort,
cleanup: webServerCleanup,
} = await startTestWebServer({
routes: [
// NOTE: the goal here is to serve relative paths via the browser hash
//
// (1) browser visits test page (served by test web server)
// (2) browser requests component itself by looking at URL hash fragment
// (i.e. "#transpiled:async_call/async_call.js" -> , "/transpiled/async_call/async_call.js")
// (i.e. "/transpiled/async_call/async_call.js" -> file read of /tmp/xxxxxx/async_call/async_call.js)
{
urlPrefix: "/transpiled/",
basePathURL: pathToFileURL(`${outputDir}/`),
},
// Serve all other files (ex. the initial HTML for the page)
{ basePathURL: import.meta.url },
],
});

// Start a browser to visit the test server
const browser = await puppeteer.launch();

// Load the test page in the browser, which will trigger tests against
// the component and/or related browser polyfills
const {
page,
output: { json },
} = await loadTestPage({
browser,
serverPort,
path: "fixtures/browser/test-pages/something__test.async.html",
hash: `transpiled:${moduleRelPath}`,
});

// Check the output expected to be returned from handle of the
// guest export (this depends on the component)
deepStrictEqual(json, { responseText: "callAsync" });

await browser.close();
await webServerCleanup();
await componentCleanup();
});

test("Transpile async (browser, JSPI)", async () => {
const componentName = "async-call";
const {
instance,
cleanup: componentCleanup,
outputDir,
} = await setupAsyncTest({
asyncMode: "jspi",
component: {
name: "async_call",
path: resolve("test/fixtures/components/async_call.component.wasm"),
imports: {
"something:test/test-interface": {
callAsync: async () => "called async",
callSync: () => "called sync",
},
},
},
jco: {
transpile: {
extraArgs: {
asyncImports: ["something:test/test-interface#call-async"],
asyncExports: ["run-async"],
},
},
},
});
const moduleName = componentName.toLowerCase().replaceAll("-", "_");
const moduleRelPath = `${moduleName}/${moduleName}.js`;

strictEqual(
instance.runSync instanceof AsyncFunction,
false,
"runSync() should be a sync function",
);
strictEqual(
instance.runAsync instanceof AsyncFunction,
true,
"runAsync() should be an async function",
);

// Start a test web server
const {
server,
serverPort,
cleanup: webServerCleanup,
} = await startTestWebServer({
routes: [
// NOTE: the goal here is to serve relative paths via the browser hash
//
// (1) browser visits test page (served by test web server)
// (2) browser requests component itself by looking at URL hash fragment
// (i.e. "#transpiled:async_call/async_call.js" -> , "/transpiled/async_call/async_call.js")
// (i.e. "/transpiled/async_call/async_call.js" -> file read of /tmp/xxxxxx/async_call/async_call.js)
{
urlPrefix: "/transpiled/",
basePathURL: pathToFileURL(`${outputDir}/`),
},
// Serve all other files (ex. the initial HTML for the page)
{ basePathURL: import.meta.url },
],
});

// Start a browser to visit the test server
const browser = await puppeteer.launch({
args: [
"--enable-experimental-webassembly-jspi",
"--flag-switches-begin",
"--enable-features=WebAssemblyExperimentalJSPI",
"--flag-switches-end",
],
});

// Load the test page in the browser, which will trigger tests against
// the component and/or related browser polyfills
const {
page,
output: { json },
} = await loadTestPage({
browser,
serverPort,
path: "fixtures/browser/test-pages/something__test.async.html",
hash: `transpiled:${moduleRelPath}`,
});

// Check the output expected to be returned from handle of the
// guest export (this depends on the component)
deepStrictEqual(json, { responseText: "callAsync" });

await browser.close();
await webServerCleanup();
await componentCleanup();
});
});
}
68 changes: 14 additions & 54 deletions test/async.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,19 @@
import { join, resolve } from "node:path";
import { dirname, join, resolve } from "node:path";
import { execArgv } from "node:process";
import { deepStrictEqual, ok, strictEqual, fail } from "node:assert";
import {
mkdir,
readFile,
rm,
symlink,
writeFile,
} from "node:fs/promises";
import { mkdir, readFile, rm, symlink, writeFile } from "node:fs/promises";

import { fileURLToPath, pathToFileURL } from "url";
import puppeteer from "puppeteer";

import { exec, jcoPath, getTmpDir, setupAsyncTest } from "./helpers.js";
import {
exec,
jcoPath,
getTmpDir,
setupAsyncTest,
startTestWebServer,
loadTestPage,
} from "./helpers.js";

const multiMemory = execArgv.includes("--experimental-wasm-multi-memory")
? ["--multi-memory"]
Expand All @@ -35,7 +37,7 @@ export async function asyncTest(_fixtures) {
await symlink(
fileURLToPath(new URL("../packages/preview2-shim", import.meta.url)),
resolve(modulesDir, "preview2-shim"),
"dir"
"dir",
);
});

Expand Down Expand Up @@ -69,7 +71,7 @@ export async function asyncTest(_fixtures) {
ok(source.toString().includes("export { test"));
});

test("Transpile async (JSPI)", async () => {
test("Transpile async (NodeJS, JSPI)", async () => {
const { instance, cleanup, component } = await setupAsyncTest({
asyncMode: "jspi",
component: {
Expand Down Expand Up @@ -105,7 +107,7 @@ export async function asyncTest(_fixtures) {
await cleanup();
});

test("Transpile async (asyncify)", async () => {
test("Transpile async (NodeJS, asyncify)", async () => {
const { instance, cleanup } = await setupAsyncTest({
asyncMode: "asyncify",
component: {
Expand Down Expand Up @@ -140,47 +142,5 @@ export async function asyncTest(_fixtures) {

await cleanup();
});

// TODO: fill out `RequestOption` impl (browser-async/http/types)
// TODO: allow `Pollable` to be re-used (when poll is called again?? how is this triggered?)
// TODO: fill out browser-async sockets with "not implemented" errors (we don't have much choice but to trap here)

test("Transpile async (asyncify)", async () => {
const { instance, cleanup } = await setupAsyncTest({
asyncMode: "asyncify",
component: {
name: "async_call",
path: resolve("test/fixtures/components/async_call.component.wasm"),
imports: {
'something:test/test-interface': {
callAsync: async () => "called async",
callSync: () => "called sync",
},
},
},
jco: {
transpile: {
extraArgs: {
asyncImports: [
"something:test/test-interface#call-async",
],
asyncExports: [
"run-async",
],
},
}
},
});

strictEqual(instance.runSync instanceof AsyncFunction, false, "runSync() should be a sync function");
strictEqual(instance.runAsync instanceof AsyncFunction, true, "runAsync() should be an async function");

strictEqual(instance.runSync(), "called sync");
strictEqual(await instance.runAsync(), "called async");

await cleanup();
});

});
}

Loading