Add basic wasm32-unknown-unknown support #148

huangjj27 · 2019-12-17T13:18:30Z

Simple version of web logger support

Update 2020-01-10 23:31:15

This PR is to add basic, ugly but work support for the wasm32-unknown-unknown target, with default features disable. Tests can be used as:

wasm-pack test --headless --firefox -- --no-default-features --test web
wasm-pack test --node -- --no-default-features --test node

Issues remain

To separate color, style(maybe still parts of fmt) and writer
To make wasm support independent to other features

compile

modified example default.rs:


#[macro_use]
extern crate log;

use env_logger::Env;

#[cfg(target="wasm32-unknown-unknown")]
use wasm_bindgen::prelude::*;

fn main() {
    // The `Env` lets us tweak what the environment
    // variables to read are and what the default
    // value is if they're missing
    let env = Env::default()
        .filter_or("MY_LOG_LEVEL", "trace")
        .write_style_or("MY_LOG_STYLE", "always");

    env_logger::init_from_env(env);

    trace!("some trace log");
    debug!("some debug log");
    info!("some information log");
    warn!("some warning log");
    error!("some error log");
}

#[cfg(target="wasm32-unknown-unknown")]
#[wasm_bindgen(start)]
fn start() {
    main();
}

compile the example and generate bindgen:

cargo build --example default --no-default-features
wasm-bindgen ./target/wasm32-unknown-unknown/debug/examples/default.wasm --out-dir=./wasm --web

add index.html to ./wasm directory:

<!DOCTYPE html>
<html>
  <head>
    <meta http-equiv="Content-type" content="text/html; charset=utf-8"/>
    <title>Tour - Iced</title>
  </head>
  <body>
    <script type="module">
      import init from "./default.js";

      init('./default_bg.wasm');
    </script>
  </body>
</html>

open the index.html from a browser(I used Firefox 71). It's expected to see logs on the console(F12)

huangjj27 · 2019-12-19T23:27:37Z

While implementing this feature, I found the lost of level after formatted, then I have to re parse the level message, Otherwise I have to log all message with console.log. Any better way to get the level message so that we could seperate different levels' message?

huangjj27 · 2019-12-22T06:42:14Z

related to #102 #149

KodrAus

Thanks for working on this @huangjj27!

It would be great to at least build for the wasm target in CI, if not also run all the tests (looks like there's a wasm-bindgen-test crate we could use for that).

Cargo.toml

examples/default.rs

huangjj27 · 2020-07-05T00:55:19Z

@KodrAus Thanks for your sugesstion! I have committed some codes for that.

Another point is that，how could we parse the logging levels on web as we do on native runtime? I think it is better to make use of the logging levels from the web console

huangjj27 · 2020-07-05T00:56:49Z

~~block the merge with the logging levels issue~~ I finally decided to “make it work first", because parsing the logging levels might need some refactor work.

jplatte · 2020-10-16T18:11:46Z

Hey @huangjj27, it's a little hard to tell what the current state of this is. Is there more work to be done?

huangjj27 · 2020-10-17T08:24:14Z

Is there more work to be done?

Hi @jplatte , I think there is:

When I wrote this PR, I hadn't considered how to log with the browsers' logging level, all message is at the log level now. I think that integrating with the browser can be improved.
the CI seems blocked, we need to pass through it

jplatte · 2020-10-17T17:44:14Z

When I wrote this PR, I hadn't considered how to log with the browsers' logging level, all message is at the log level now. I think that integrating with the browser can be improved.

Do you plan to work on this?

the CI seems blocked, we need to pass through it

I'd expect CI to run properly after a rebase.

Update from upstream

huangjj27 · 2020-11-06T15:02:12Z

Do you plan to work on this?

@jplatte Hi! I rebased and it passed all checks now. I'm glad that someone will help with this issue. I think it needs much refactoring to the current formatter?

KodrAus · 2020-11-08T09:40:19Z

We could refactor things to pass the log::Level all the way through the writer so that web::print can pick the right console function to call.

huangjj27 · 2021-01-04T14:48:17Z

I think this will pending until refactoring for this is done, for there are information of level and some other meta data we can make use of.

Update from upstream

KodrAus · 2021-01-12T00:02:00Z

@huangjj27 Support for structured logging is something we could add at any time, but is absolutely desirable.

I think all we need to do here is add some CI support for WebAssembly. I've got an example from another project, and there's also the wasm-bindgen docs.

If you'd like a hand getting this up and running let me know!

huangjj27 · 2021-01-12T00:07:12Z

If you'd like a hand getting this up and running let me know!

Ok, I will take this at the weekend, or as soon as I’ get spare time

update from upstream before rebasing branch

huangjj27 · 2021-01-14T15:06:58Z

CI is added but it seems not to test. Will fix it as soon

huangjj27 · 2021-01-14T15:25:25Z

Aha! here is the document.

huangjj27 · 2021-01-15T15:02:35Z

encounter with this bug. To work around this, I think we have to disable the default feature when we compile to the wasm32-unknown-unknown target, whose time should be provided by the browser/node.

huangjj27 · 2021-01-16T07:35:50Z

@KodrAus I get it worked, but there is some issue: when I tried to compile with the wasm32-unknown-unknown target, it still prevented me from compiling, showing this denied warning:

error: function is never used: `print`
   --> src\fmt\writer\wasm.rs:13:31
    |
13  | pub(in crate::fmt::writer) fn print(msg: &str, t: Target) {
    |                               ^^^^^
    |
note: lint level defined here
   --> src\lib.rs:280:54
    |
280 | #![deny(missing_debug_implementations, missing_docs, warnings)]
    |                                                      ^^^^^^^^
    = note: `#[deny(dead_code)]` implied by `#[deny(warnings)]`

error: aborting due to previous error

although the wasm::print function is use in termcolor::shim_impl :

  // termcolor/shim_impl.rs: 32-48
   pub(in crate::fmt::writer) fn print(&self, buf: &Buffer) -> io::Result<()> {
        // This impl uses the `eprint` and `print` macros
        // instead of using the streams directly.
        // This is so their output can be captured by `cargo test`
        let log = String::from_utf8_lossy(&buf.0);

        #[cfg(all(target_arch = "wasm32", target_vendor = "unknown"))]
        wasm::print(&log, self.target);

        #[cfg(not(all(target_arch = "wasm32", target_vendor = "unknown")))]
        match self.target {
            Target::Stderr => eprint!("{}", log),
            Target::Stdout => print!("{}", log),
        }

        Ok(())
    }

So I have to comment out the "deny warning" parts.
I think there is something I don't know or I mess up so here is the error. If you have some advice please let me know, thanks!

only enable when termcolor feature is disabled

huangjj27 · 2021-01-16T12:42:00Z

Hi @KodrAus, basic implement and basic CI are committed. Any Advice?

jplatte · 2021-01-16T13:52:32Z

I've just removed deny(warnings) on master, we really shouldn't do that. CI will still fail with rustc or clippy emitting warnings though, since pass -- -D warnings. Could it be that (without deny(warnings)) the function that termcolor::shim_impl::print is also marked unused? IIRC, rustc will complain about transitively dead code too.

sunfishcode · 2022-11-27T15:36:05Z

I'm curious why it's desirable to use env_logger on wasm32-unknown-unknown. The motivation here seems to be for use on the Web, but the Web embedding doesn't have environment variables, and its stdin and stderr don't print anything. The log facade is intended to make it easy to plug in different logging backends; would it make sense to write a new backend rather than porting env_logger?

huangjj27 · 2022-12-02T07:50:54Z

would it make sense to write a new backend rather than porting env_logger?

Thanks for advice! I'll abandon this PR.

huangjj27 mentioned this pull request Dec 18, 2019

First-class support for bin crates rustwasm/wasm-bindgen#1630

Closed

huangjj27 changed the title ~~WIP: Add a simple implement~~ Add a simple implement Dec 22, 2019

KodrAus reviewed Jul 1, 2020

View reviewed changes

Cargo.toml Outdated Show resolved Hide resolved

examples/default.rs Outdated Show resolved Hide resolved

KodrAus changed the title ~~Add a simple implement~~ Add wasm32-unknown-unknown support Jul 1, 2020

huangjj27 changed the title ~~Add wasm32-unknown-unknown support~~ WIP: Add wasm32-unknown-unknown support Jul 5, 2020

huangjj27 changed the title ~~WIP: Add wasm32-unknown-unknown support~~ Add wasm32-unknown-unknown support Jul 11, 2020

Merge pull request #1 from env-logger-rs/master

00dcde6

Update from upstream

huangjj27 force-pushed the feat#102-wasm-bindgen branch from c4c503e to bc6d841 Compare November 6, 2020 14:04

huangjj27 force-pushed the feat#102-wasm-bindgen branch from 52ccb01 to 7c3ef4a Compare November 6, 2020 15:26

Merge pull request #2 from env-logger-rs/master

1a3762f

Update from upstream

huangjj27 and others added 6 commits January 14, 2021 21:03

Merge pull request #3 from env-logger-rs/master

3de7888

update from upstream before rebasing branch

Add a simple implement

a5cd6f0

runnable version with out default features

9d54848

bugfix(use web): fix unfound module web

fb75784

recover default example and add new one for wasm

e7be2ad

fix fmt

b36f7ce

huangjj27 force-pushed the feat#102-wasm-bindgen branch from 7c3ef4a to b36f7ce Compare January 14, 2021 13:11

update test with basic wasm support

d76d675

try to fix ci

7c61799

huangjj27 changed the title ~~Add wasm32-unknown-unknown support~~ WIP: Add wasm32-unknown-unknown support Jan 14, 2021

complete with the ci

d05bff1

huangjj27 force-pushed the feat#102-wasm-bindgen branch from 475a4cb to d05bff1 Compare January 15, 2021 13:33

checkout on each job

d82284f

huangjj27 force-pushed the feat#102-wasm-bindgen branch from a9cfe94 to d82284f Compare January 15, 2021 13:59

refactor modules

416fe02

work around the bug about time's implement

043403a

huangjj27 marked this pull request as draft January 16, 2021 06:41

comment out the deny warning to show the result

0f5d2bd

huangjj27 added 4 commits January 16, 2021 15:38

not to fail fast with different browser

5204c1c

No need to test with safari

e433508

fix ci problem

d2f97c3

fix the used warning

8313446

only enable when termcolor feature is disabled

huangjj27 force-pushed the feat#102-wasm-bindgen branch from 61af00e to 8313446 Compare January 16, 2021 12:32

huangjj27 marked this pull request as ready for review January 16, 2021 12:34

huangjj27 changed the title ~~WIP: Add wasm32-unknown-unknown support~~ Add basic wasm32-unknown-unknown support Jan 16, 2021

huangjj27 closed this Dec 2, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add basic wasm32-unknown-unknown support #148

Add basic wasm32-unknown-unknown support #148

huangjj27 commented Dec 17, 2019 •

edited

huangjj27 commented Dec 19, 2019

huangjj27 commented Dec 22, 2019

KodrAus left a comment

huangjj27 commented Jul 5, 2020

huangjj27 commented Jul 5, 2020 •

edited

jplatte commented Oct 16, 2020

huangjj27 commented Oct 17, 2020

jplatte commented Oct 17, 2020

huangjj27 commented Nov 6, 2020

KodrAus commented Nov 8, 2020

huangjj27 commented Jan 4, 2021

KodrAus commented Jan 12, 2021

huangjj27 commented Jan 12, 2021

huangjj27 commented Jan 14, 2021

huangjj27 commented Jan 14, 2021

huangjj27 commented Jan 15, 2021 •

edited

huangjj27 commented Jan 16, 2021 •

edited

huangjj27 commented Jan 16, 2021

jplatte commented Jan 16, 2021

sunfishcode commented Nov 27, 2022

huangjj27 commented Dec 2, 2022

Add basic wasm32-unknown-unknown support #148

Add basic wasm32-unknown-unknown support #148

Conversation

huangjj27 commented Dec 17, 2019 • edited

Update 2020-01-10 23:31:15

Issues remain

compile

huangjj27 commented Dec 19, 2019

huangjj27 commented Dec 22, 2019

KodrAus left a comment

Choose a reason for hiding this comment

huangjj27 commented Jul 5, 2020

huangjj27 commented Jul 5, 2020 • edited

jplatte commented Oct 16, 2020

huangjj27 commented Oct 17, 2020

jplatte commented Oct 17, 2020

huangjj27 commented Nov 6, 2020

KodrAus commented Nov 8, 2020

huangjj27 commented Jan 4, 2021

KodrAus commented Jan 12, 2021

huangjj27 commented Jan 12, 2021

huangjj27 commented Jan 14, 2021

huangjj27 commented Jan 14, 2021

huangjj27 commented Jan 15, 2021 • edited

huangjj27 commented Jan 16, 2021 • edited

huangjj27 commented Jan 16, 2021

jplatte commented Jan 16, 2021

sunfishcode commented Nov 27, 2022

huangjj27 commented Dec 2, 2022

huangjj27 commented Dec 17, 2019 •

edited

huangjj27 commented Jul 5, 2020 •

edited

huangjj27 commented Jan 15, 2021 •

edited

huangjj27 commented Jan 16, 2021 •

edited