Skip to content
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.

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

Improve WASI support #898

Open
hyf0 opened this issue Apr 17, 2024 · 7 comments
Open

Improve WASI support #898

hyf0 opened this issue Apr 17, 2024 · 7 comments
Labels
help wanted Extra attention is needed scope: wasi

Comments

@hyf0
Copy link
Member

hyf0 commented Apr 17, 2024

This is a followed up of #832.

With the hard work of @Brooooooklyn, we now are ok to compile to wasi successfully and run wasi rolldown successfully in some simple cases.

However, there are still a lot of hard and wired problems to be solved.

As #894 showed

  • In unbuntu
    • The wasi rolldown could compile the basic example successfully
    • Can't pass tests due to being hang while running
  • In windows/macos
    • Unsupported Operation error was throwed in rust even in the basic example case

Other problems

# Node.js wasi runtime has bug with `std::fs::read_link`
run: |
touch .npmrc
echo "node-linker=hoisted" >> .npmrc
pnpm install

#[cfg(target_family = "wasm")]
// if we don't perform this warmup, the following call to `std::fs` will stuck
if let Ok(_) = std::fs::metadata(std::env::current_dir()?) {};

Update: oh no! When set RUST_LOG=trace, pnpm --filter=@example/basic build success, fails if unset RUST_LOG, so strange! #898 (comment)

  1. Running a playground on the browser is blocked by: tokio: enable rt-multi-thread for wasm32-wasi-preview1-threads target tokio-rs/tokio#6510. Because the fs polyfill crosses the main thread/ web worker is using Atomic.wait, any std::fs operations within the async fn will block tokio current_thread runtime forever.
@hyf0 hyf0 added help wanted Extra attention is needed scope: wasi labels Apr 17, 2024
@hyf0 hyf0 pinned this issue Apr 17, 2024
@toyobayashi
Copy link

@Brooooooklyn @hyf0

I can build successfully on Windows by manually make following changes:

examples/basic-vue/rolldown.config.js

  import { defineConfig } from 'rolldown'
  
  export default defineConfig({
    input: './index.js',
+   // set posix path for WASI, not native platform path
+   // map to C:\\Users\\toyobayashi\\Projects\\rolldown\\examples\\basic-vue
+   cwd: '/Users/toyobayashi/Projects/rolldown/examples/basic-vue',
    resolve: {
      // This needs to be explicitly set for now because oxc resolver doesn't
      // assume default exports conditions. Rolldown will ship with a default that
      // aligns with Vite in the future.
      conditionNames: ['import'],
    },
  })

packages/rolldown/dist/shared/rolldown-binding.wasi.cjs:

  const __wasi = new __nodeWASI({
    version: 'preview1',
    env: process.env,
    preopens: {
-     '/': '/'
+     '/': 'C:\\'
    }
  })

packages/rolldown/dist/shared/wasi-worker.mjs:

const handler = new MessageHandler({
  onLoad({ wasmModule, wasmMemory }) {
    const wasi = new WASI({
      version: 'preview1',
      env: process.env,
      preopens: {
-        '/': '/'
+        '/': 'C:\\',
      },
    });

@hyf0
Copy link
Member Author

hyf0 commented Apr 17, 2024

@toyobayashi Thanks. This should be a windows-specific problem. I guess we should give a sensible default value for windows.

@toyobayashi
Copy link

toyobayashi commented Apr 17, 2024

Just now I also built basic example successfully on macOS without modify anything (b5b06bf). Just ensure the vue in node_modules is a real directory instead of a symlink :)

Update: oh no! When set RUST_LOG=trace, pnpm --filter=@example/basic build success, fails if unset RUST_LOG, so strange!

@Brooooooklyn
Copy link
Contributor

Update: oh no! When set RUST_LOG=trace, pnpm --filter=@example/basic build success, fails if unset RUST_LOG, so strange!

We observed this issue too, and this line is also strange:

#[cfg(target_family = "wasm")]
// if we don't perform this warmup, the following call to `std::fs` will stuck
if let Ok(_) = std::fs::metadata(std::env::current_dir()?) {};

@Brooooooklyn
Copy link
Contributor

Can confirm there are some compiler bugs in Rust. Switch to nightly-2024-04-18 can make the example work without RUST_LOG=trace

@hyf0
Copy link
Member Author

hyf0 commented Apr 25, 2024

Sorry to say that #975 breaks building basic-example in unbuntu. I can't figure out why with the changed code should not affect wasm.

@mdarrik
Copy link

mdarrik commented May 21, 2024

So I was able to repair the symlink stuff for MacOS by using the same canonicalize logic that oxc-resolver uses in their fs implementation. It seems that dunce uses std::fs::canonicalize on non windows targets, which isn't available on WASI yet.

// modified from oxc-project/oxc-resolver/src/file_system.rs

    #[cfg(not(target_family = "wasm"))]
    {
      dunce::canonicalize(path)
    }
    #[cfg(target_family = "wasm")]
    {
      let meta = std::fs::symlink_metadata(path)?;

      if meta.file_type().is_symlink() {
        let link = std::fs::read_link(path)?;

        let mut path_buf = path.to_path_buf();
        path_buf.pop();
        for segment in link.iter() {
          match segment.to_str() {
            Some("..") => {
              path_buf.pop();
            }
            Some(".") | None => {}
            Some(seg) => {
              // Need to trim the extra \0 introduces by rust std rust-lang/rust#123727
              path_buf.push(seg.trim_end_matches('\0'));
            }
          }
        }
        Ok(path_buf)
      } else {
        Ok(path.to_path_buf())
      }
    }

No luck yet on tracking down the need for RD_LOG to get WASI builds to run.

I did notice I get a different panic if I force WASM to init the tracing-subscriber by skipping the short-circuit return None in the tracing subscriber.

  • Without any changes so WASM doesn't init a tracing_subscriber, I get RangeError: Invalid atomic access index
  • With changes so WASM always inits a changing subscriber, I get Error [RuntimeError]: null function or function signature mismatch.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed scope: wasi
Projects
None yet
Development

No branches or pull requests

4 participants