fix(cli): #1723 gate import.meta.url bundling on js content-type so unsupported resource skip acorn parsing #1724
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| /* | ||
|
Member
There was a problem hiding this comment. nit: I wonder if it might make more sense to combine both of these test cases? Seems like the are pretty related and we could just all the same related behavior under one suite. Just thinking out loud. |
||
| * Use Case | ||
| * Run Greenwood build command with an unsupported direct `import ... from "./add.wasm"`. | ||
| * | ||
| * User Result | ||
| * The build should fail, but NOT with the misleading acorn `SyntaxError` thrown from inside the | ||
| * `greenwood-import-meta-url` Rollup plugin (which pointed users at internal plugin code when the | ||
| * wasm binary was fed to the JavaScript parser). A clear, Rollup-native parse error is acceptable. | ||
| * | ||
| * User Command | ||
| * greenwood build | ||
| * | ||
| * User Config | ||
| * None (Greenwood Default) | ||
| * | ||
| * User Workspace | ||
| * src/ | ||
| * pages/ | ||
| * index.html | ||
| * scripts/ | ||
| * add.wasm | ||
| * main.js | ||
| */ | ||
| import { expect } from "chai"; | ||
| import path from "node:path"; | ||
| import { getOutputTeardownFiles } from "../../../../../test/utils.js"; | ||
| import { Runner } from "gallinago"; | ||
| import { fileURLToPath } from "node:url"; | ||
|
|
||
| describe("Build Greenwood With: ", function () { | ||
| const cliPath = path.join(process.cwd(), "packages/cli/src/bin.js"); | ||
| const outputPath = fileURLToPath(new URL(".", import.meta.url)); | ||
| let runner; | ||
| let buildError; | ||
|
|
||
| before(function () { | ||
| this.context = { | ||
| publicDir: path.join(outputPath, "public"), | ||
| }; | ||
| runner = new Runner(); | ||
| }); | ||
|
|
||
| describe("An unsupported direct import of a .wasm module", function () { | ||
| before(async function () { | ||
| await runner.setup(outputPath); | ||
|
|
||
| try { | ||
| await runner.runCommand(cliPath, "build"); | ||
| } catch (error) { | ||
| buildError = `${error}`; | ||
| } | ||
| }); | ||
|
|
||
| it("should fail the build", function () { | ||
| expect(buildError).to.not.equal(undefined); | ||
| }); | ||
|
|
||
| // https://github.com/ProjectEvergreen/greenwood/issues/1723 | ||
| it("should not crash with the acorn SyntaxError from the greenwood-import-meta-url plugin", function () { | ||
| expect(buildError).to.not.contain("greenwood-import-meta-url"); | ||
| }); | ||
| }); | ||
|
|
||
| after(async function () { | ||
| await runner.teardown(getOutputTeardownFiles(outputPath)); | ||
| }); | ||
| }); | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| <!doctype html> | ||
| <html> | ||
| <head> | ||
| <title>wasm direct import</title> | ||
| <script type="module" src="../scripts/main.js"></script> | ||
| </head> | ||
| <body> | ||
| <h1>wasm</h1> | ||
| <span id="out"></span> | ||
| </body> | ||
| </html> |
Binary file not shown.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| import * as wasm from "./add.wasm"; | ||
|
|
||
| document.getElementById("out").textContent = `add(2,3)=${wasm.add(2, 3)}`; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,91 @@ | ||
| /* | ||
| * Use Case | ||
| * Run Greenwood build command referencing a .wasm asset via the supported | ||
| * `new URL("./add.wasm", import.meta.url)` pattern. | ||
| * | ||
| * User Result | ||
| * Should generate a Greenwood build that emits the .wasm as a content-hashed, | ||
| * byte-identical asset, without crashing the JavaScript parser on the binary. | ||
| * | ||
| * User Command | ||
| * greenwood build | ||
| * | ||
| * User Config | ||
| * None (Greenwood Default) | ||
| * | ||
| * User Workspace | ||
| * src/ | ||
| * pages/ | ||
| * index.html | ||
| * scripts/ | ||
| * add.wasm | ||
| * main.js | ||
| */ | ||
| import { expect } from "chai"; | ||
| import fs from "node:fs/promises"; | ||
| import path from "node:path"; | ||
| import { runSmokeTest } from "../../../../../test/smoke-test.js"; | ||
| import { getOutputTeardownFiles } from "../../../../../test/utils.js"; | ||
| import { Runner } from "gallinago"; | ||
| import { fileURLToPath } from "node:url"; | ||
|
|
||
| // https://github.com/ProjectEvergreen/greenwood/issues/1723 | ||
| describe("Build Greenwood With: ", function () { | ||
| const LABEL = "Referencing a .wasm asset with new URL and import.meta.url"; | ||
| const cliPath = path.join(process.cwd(), "packages/cli/src/bin.js"); | ||
| const outputPath = fileURLToPath(new URL(".", import.meta.url)); | ||
| let runner; | ||
|
|
||
| before(function () { | ||
| this.context = { | ||
| publicDir: path.join(outputPath, "public"), | ||
| }; | ||
| runner = new Runner(); | ||
| }); | ||
|
|
||
| describe(LABEL, function () { | ||
| before(async function () { | ||
| await runner.setup(outputPath); | ||
| await runner.runCommand(cliPath, "build"); | ||
| }); | ||
|
|
||
| runSmokeTest(["public"], LABEL); | ||
|
|
||
| describe("WASM asset output", function () { | ||
| let wasmFiles; | ||
|
|
||
| before(async function () { | ||
| wasmFiles = await Array.fromAsync( | ||
| fs.glob("add.*.wasm", { cwd: new URL("./public/", import.meta.url) }), | ||
| ); | ||
| }); | ||
|
|
||
| it("should emit exactly one content-hashed .wasm asset", function () { | ||
| expect(wasmFiles.length).to.equal(1); | ||
| }); | ||
|
|
||
| it("should emit the .wasm asset byte-identical to the source", async function () { | ||
| const emitted = await fs.readFile(new URL(`./public/${wasmFiles[0]}`, import.meta.url)); | ||
| const source = await fs.readFile(new URL("./src/scripts/add.wasm", import.meta.url)); | ||
|
|
||
| expect(emitted.equals(source)).to.equal(true); | ||
| }); | ||
|
|
||
| it("should reference the content-hashed .wasm filename from the bundled script", async function () { | ||
| const scripts = await Array.fromAsync( | ||
| fs.glob("main.*.js", { cwd: new URL("./public/", import.meta.url) }), | ||
| ); | ||
| const contents = await fs.readFile( | ||
| new URL(`./public/${scripts[0]}`, import.meta.url), | ||
| "utf-8", | ||
| ); | ||
|
|
||
| expect(contents).to.contain(wasmFiles[0]); | ||
| }); | ||
| }); | ||
| }); | ||
|
|
||
| after(async function () { | ||
| await runner.teardown(getOutputTeardownFiles(outputPath)); | ||
| }); | ||
| }); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| <!doctype html> | ||
| <html> | ||
| <head> | ||
| <title>wasm import.meta.url</title> | ||
| <script type="module" src="../scripts/main.js"></script> | ||
| </head> | ||
| <body> | ||
| <h1>wasm</h1> | ||
| <span id="out"></span> | ||
| </body> | ||
| </html> |
Binary file not shown.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| const wasmUrl = new URL("./add.wasm", import.meta.url); | ||
| const { instance } = await WebAssembly.instantiateStreaming(fetch(wasmUrl)); | ||
|
|
||
| document.getElementById("out").textContent = `add(2,3)=${instance.exports.add(2, 3)}`; |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I see yeah, this makes sense to me.