Don't use reflect in webidl dictionary setters #3898

Davidster · 2024-03-19T02:46:40Z

Implements solution 1 from #3468 (comment).

Solution 3 will come after assuming this goes smoothly

Davidster · 2024-03-19T02:57:59Z

woops, looks like the CI is failing. will check that tmrw.

Davidster · 2024-03-20T23:17:55Z

I've run into the following error with the codegen:

it generates some shim functions now such as:

#![allow(unused_imports)]
#![allow(clippy::all)]
use super::*;
use wasm_bindgen::prelude::*;
#[wasm_bindgen]
extern "C" {
    # [wasm_bindgen (extends = :: js_sys :: Object , js_name = RequestInit)]
    #[derive(Debug, Clone, PartialEq, Eq)]
    #[doc = "The `RequestInit` dictionary."]
    #[doc = ""]
    #[doc = "*This API requires the following crate features to be activated: `RequestInit`*"]
    pub type RequestInit;
    # [wasm_bindgen (method , setter = body)]
    fn body_shim(this: &RequestInit, val: Option<&::wasm_bindgen::JsValue>);
    #[cfg(feature = "RequestCache")]
    # [wasm_bindgen (method , setter = cache)]
    fn cache_shim(this: &RequestInit, val: RequestCache);
    #[cfg(feature = "RequestCredentials")]
    # [wasm_bindgen (method , setter = credentials)]
    fn credentials_shim(this: &RequestInit, val: RequestCredentials);
    # [wasm_bindgen (method , setter = headers)]
    fn headers_shim(this: &RequestInit, val: &::wasm_bindgen::JsValue);
    # [wasm_bindgen (method , setter = integrity)]
    fn integrity_shim(this: &RequestInit, val: &str);
    # [wasm_bindgen (method , setter = method)]
    fn method_shim(this: &RequestInit, val: &str);
    #[cfg(feature = "RequestMode")]
    # [wasm_bindgen (method , setter = mode)]
    fn mode_shim(this: &RequestInit, val: RequestMode);
    #[cfg(feature = "ObserverCallback")]
    # [wasm_bindgen (method , setter = observe)]
    fn observe_shim(this: &RequestInit, val: &ObserverCallback);
    #[cfg(feature = "RequestRedirect")]
    # [wasm_bindgen (method , setter = redirect)]
    fn redirect_shim(this: &RequestInit, val: RequestRedirect);
    # [wasm_bindgen (method , setter = referrer)]
    fn referrer_shim(this: &RequestInit, val: &str);
    #[cfg(feature = "ReferrerPolicy")]
    # [wasm_bindgen (method , setter = referrerPolicy)]
    fn referrer_policy_shim(this: &RequestInit, val: ReferrerPolicy);
    #[cfg(feature = "AbortSignal")]
    # [wasm_bindgen (method , setter = signal)]
    fn signal_shim(this: &RequestInit, val: Option<&AbortSignal>);
}
impl RequestInit {
    #[doc = "Construct a new `RequestInit`."]
    #[doc = ""]
    #[doc = "*This API requires the following crate features to be activated: `RequestInit`*"]
    pub fn new() -> Self {
        #[allow(unused_mut)]
        let mut ret: Self = ::wasm_bindgen::JsCast::unchecked_into(::js_sys::Object::new());
        ret
    }
    #[doc = "Change the `body` field of this object."]
    #[doc = ""]
    #[doc = "*This API requires the following crate features to be activated: `RequestInit`*"]
    pub fn body(&mut self, val: Option<&::wasm_bindgen::JsValue>) -> &mut Self {
        self.body_shim(val);
        self
    }
    #[cfg(feature = "RequestCache")]
    #[doc = "Change the `cache` field of this object."]
    #[doc = ""]
    #[doc = "*This API requires the following crate features to be activated: `RequestCache`, `RequestInit`*"]
    pub fn cache(&mut self, val: RequestCache) -> &mut Self {
        self.cache_shim(val);
        self
    }
    #[cfg(feature = "RequestCredentials")]
    #[doc = "Change the `credentials` field of this object."]
    #[doc = ""]
    #[doc = "*This API requires the following crate features to be activated: `RequestCredentials`, `RequestInit`*"]
    pub fn credentials(&mut self, val: RequestCredentials) -> &mut Self {
        self.credentials_shim(val);
        self
    }
    #[doc = "Change the `headers` field of this object."]
    #[doc = ""]
    #[doc = "*This API requires the following crate features to be activated: `RequestInit`*"]
    pub fn headers(&mut self, val: &::wasm_bindgen::JsValue) -> &mut Self {
        self.headers_shim(val);
        self
    }
    #[doc = "Change the `integrity` field of this object."]
    #[doc = ""]
    #[doc = "*This API requires the following crate features to be activated: `RequestInit`*"]
    pub fn integrity(&mut self, val: &str) -> &mut Self {
        self.integrity_shim(val);
        self
    }
    #[doc = "Change the `method` field of this object."]
    #[doc = ""]
    #[doc = "*This API requires the following crate features to be activated: `RequestInit`*"]
    pub fn method(&mut self, val: &str) -> &mut Self {
        self.method_shim(val);
        self
    }
    #[cfg(feature = "RequestMode")]
    #[doc = "Change the `mode` field of this object."]
    #[doc = ""]
    #[doc = "*This API requires the following crate features to be activated: `RequestInit`, `RequestMode`*"]
    pub fn mode(&mut self, val: RequestMode) -> &mut Self {
        self.mode_shim(val);
        self
    }
    #[cfg(feature = "ObserverCallback")]
    #[doc = "Change the `observe` field of this object."]
    #[doc = ""]
    #[doc = "*This API requires the following crate features to be activated: `ObserverCallback`, `RequestInit`*"]
    pub fn observe(&mut self, val: &ObserverCallback) -> &mut Self {
        self.observe_shim(val);
        self
    }
    #[cfg(feature = "RequestRedirect")]
    #[doc = "Change the `redirect` field of this object."]
    #[doc = ""]
    #[doc = "*This API requires the following crate features to be activated: `RequestInit`, `RequestRedirect`*"]
    pub fn redirect(&mut self, val: RequestRedirect) -> &mut Self {
        self.redirect_shim(val);
        self
    }
    #[doc = "Change the `referrer` field of this object."]
    #[doc = ""]
    #[doc = "*This API requires the following crate features to be activated: `RequestInit`*"]
    pub fn referrer(&mut self, val: &str) -> &mut Self {
        self.referrer_shim(val);
        self
    }
    #[cfg(feature = "ReferrerPolicy")]
    #[doc = "Change the `referrerPolicy` field of this object."]
    #[doc = ""]
    #[doc = "*This API requires the following crate features to be activated: `ReferrerPolicy`, `RequestInit`*"]
    pub fn referrer_policy(&mut self, val: ReferrerPolicy) -> &mut Self {
        self.referrer_policy_shim(val);
        self
    }
    #[cfg(feature = "AbortSignal")]
    #[doc = "Change the `signal` field of this object."]
    #[doc = ""]
    #[doc = "*This API requires the following crate features to be activated: `AbortSignal`, `RequestInit`*"]
    pub fn signal(&mut self, val: Option<&AbortSignal>) -> &mut Self {
        self.signal_shim(val);
        self
    }
}
impl Default for RequestInit {
    fn default() -> Self {
        Self::new()
    }
}

Which seems to look ok except that it produces the following error:

5 | #[wasm_bindgen]
  | ^^^^^^^^^^^^^^^ the trait `OptionIntoWasmAbi` is not implemented for `&wasm_bindgen::JsValue`

Looks like this is a case of #2139. I'm not quite sure how to solve it. Any ideas?

Davidster · 2024-03-20T23:48:43Z

Found a way to workaround the issue with some dark magic... let me know what you think. It basically modifies the shim from Option to JsValue and calls val.unwrap_or(&::wasm_bindgen::JsValue::NULL) to convert the Option into a JsValue in the body.

… the same type

Davidster · 2024-03-21T02:24:25Z

I will fix the merge conflict once this is ready to be merged. I needed to work on an older version in order be able to build my engine against my wasm_bindgen fork

Davidster · 2024-03-24T17:57:00Z

I noticed when compiling my engine against this branch that the generated js file got substantially larger since the new 'shim' functions added by the generator are getting added regardless of whether the function is actually used. Any idea about how to mitigate this?

Davidster · 2024-03-24T19:13:14Z

Ran into another problem with this approach...

error: expected `,`
  --> crates/web-sys/src/features/gen_WidevineCdmManifest.rs:19:42
   |
19 |     # [wasm_bindgen (method , setter = x - cdm - codecs)]
   |                                          ^
error: expected `,`
  --> crates/web-sys/src/features/gen_WidevineCdmManifest.rs:21:42
   |
21 |     # [wasm_bindgen (method , setter = x - cdm - host - versions)]
   |                                          ^
error: expected `,`
  --> crates/web-sys/src/features/gen_WidevineCdmManifest.rs:23:42
   |
23 |     # [wasm_bindgen (method , setter = x - cdm - interface - versions)]
   |                                          ^
error: expected `,`
  --> crates/web-sys/src/features/gen_WidevineCdmManifest.rs:25:42
   |
25 |     # [wasm_bindgen (method , setter = x - cdm - module - versions)]
   |

is there any way to escape the - characters here?

daxpedda · 2024-03-27T14:44:53Z

is there any way to escape the - characters here?

You will have to use quotation marks and parse it as a string instead of an ident.

Why are the *_shim functions necessary?

Davidster · 2024-03-27T14:50:07Z

Wouldn't adding quotation marks be a breaking change though?

I didn't consider whether the shims were needed or not tbh. But they would be necessary for the conversion from Option to JsValue since OptionIntoWasmAbi is not implemented for JsValue, like for RequestInit::body()

daxpedda · 2024-03-27T14:54:22Z

Wouldn't adding quotation marks be a breaking change though?

You don't have to require it, just supporting it.
I didn't look deeper in whats going on though and I don't know why you would need - in the first place.

I didn't consider whether the shims were needed or not tbh. But they would be necessary for the conversion from Option to JsValue since OptionIntoWasmAbi is not implemented for JsValue, like for RequestInit::body()

I'm not following.
But I remembered why this was necessary: to keep the API the same by returning &mut Self.
So all good there!

Davidster · 2024-03-27T15:04:15Z

the - is required because the WidevineCDMManifest webidl type has some attributes with - in the name 😢 see

wasm-bindgen/crates/web-sys/webidls/enabled/WidevineCDMManifest.webidl

Line 11 in 88efe46

required DOMString x-cdm-module-versions;

Edit: 👍 about not requiring it. I will give that a shot.

For the Option thing, it's like I described in my comment: #3898 (comment).

I'm not 100% sure I understand the compile error completely, but my guess is that the wasm-bindgen macro for body shim:

#[wasm_bindgen(method, setter = body)]
fn body_shim(this: &RequestInit, val: Option<&::wasm_bindgen::JsValue>);

Is trying to use the OptionIntoWasmAbi trait on the val parameter in order to be able to pass it to JS. So the fix was to change the signature to this:

#[wasm_bindgen(method, setter = body)]
fn body_shim(this: &RequestInit, val: &::wasm_bindgen::JsValue);

And convert from Option -> JsValue before calling the shim, like this:

#[doc = "Change the `body` field of this object."]
#[doc = ""]
#[doc = "*This API requires the following crate features to be activated: `RequestInit`*"]
pub fn body(&mut self, val: Option<&::wasm_bindgen::JsValue>) -> &mut Self {
    self.body_shim(val.unwrap_or(&::wasm_bindgen::JsValue::NULL));
    self
}

This sadly requires a special check for Option<&::wasm_bindgen::JsValue> in the code:

c67717d#diff-d8976bd33550e367803742179ae21879225e06a871ccfe1e29d8b89af9106d02R697

Davidster · 2024-03-29T02:05:16Z

I've added support for the hyphens, this PR should be ready for review now 😄 thanks!

daxpedda

LGTM so far.

Are you having issues generating the WebIDL?
That's still the last step missing.

CHANGELOG.md

crates/webidl/Cargo.toml

Davidster · 2024-04-01T12:48:13Z

Nope I'm all good with the webidl, it's just a huge diff and I wasn't sure if those are generated by the CI. I'll commit them

daxpedda

Small nits, otherwise LGTM!

This is a rather large change, so I will pull in @Liamolucko for a second approval as well.

CHANGELOG.md

crates/webidl/Cargo.toml

Liamolucko

LGTM!

crates/webidl/src/generator.rs

Liamolucko · 2024-04-03T01:22:45Z

I noticed when compiling my engine against this branch that the generated js file got substantially larger since the new 'shim' functions added by the generator are getting added regardless of whether the function is actually used. Any idea about how to mitigate this?

Could you elaborate a bit more? I'm not sure if you mean that the shims are never even referenced in Rust (in which case no JS for them should be getting generated), or that they could theoretically be used but aren't in practice (in which case I don't really have a good solution).

Davidster · 2024-04-03T02:06:05Z

Looking at it again I think I was just confused at the time. It makes sense that a bunch of shims would get added to my JS file since they are indeed referenced from rust.

The part that confused me was that even the non-shim versions weren't showing up in my JS file before the changes from this PR. But this makes sense because those are compiled into the wasm, not the JS 😄

CHANGELOG.md

daxpedda

Thank you!

Davidster changed the title ~~don't use reflect in webidl dictionary setters~~ Don't use reflect in webidl dictionary setters Mar 19, 2024

Davidster marked this pull request as draft March 19, 2024 03:01

Davidster added 4 commits March 20, 2024 22:12

don't use reflect in webidl dictionary setters

74c84c9

fix clippy

8bcd2bc

add cfg feature to shim function

7ff7470

workaround Option<JSValue> issue by treating None and Option<null> as…

c67717d

… the same type

Davidster force-pushed the no_reflect_in_webidl_dictionary_setters branch from 75b3058 to c67717d Compare March 21, 2024 02:22

support hyphens in js name for getter/setter js import syntax

007cce8

Davidster marked this pull request as ready for review March 29, 2024 02:00

fix clippies

fe6300a

Davidster added 2 commits March 28, 2024 22:54

Merge branch 'main' into no_reflect_in_webidl_dictionary_setters

79ca12d

update changelog

47a2eb5

daxpedda requested changes Apr 1, 2024

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

daxpedda added the waiting for author Waiting for author to respond label Apr 1, 2024

daxpedda reviewed Apr 1, 2024

View reviewed changes

crates/webidl/Cargo.toml Outdated Show resolved Hide resolved

Davidster added 2 commits April 1, 2024 12:44

update changelog

faec40a

commit result of webidl rust types gen

7032b48

Davidster requested a review from daxpedda April 1, 2024 17:27

daxpedda requested changes Apr 2, 2024

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

crates/webidl/Cargo.toml Outdated Show resolved Hide resolved

daxpedda requested a review from Liamolucko April 2, 2024 07:30

Davidster added 3 commits April 2, 2024 17:44

update changelog

49a2479

update changelog

a2efd9e

remove use of extra-traits syn feature in webidl

590b06a

Davidster requested a review from daxpedda April 2, 2024 22:58

Liamolucko approved these changes Apr 3, 2024

View reviewed changes

crates/webidl/src/generator.rs Outdated Show resolved Hide resolved

use explicit type instead of interpolation for clarity

4358711

daxpedda reviewed Apr 3, 2024

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

Update CHANGELOG.md

a9ddd56

daxpedda approved these changes Apr 3, 2024

View reviewed changes

daxpedda merged commit d25a68e into rustwasm:main Apr 3, 2024
23 checks passed

daxpedda pushed a commit to daxpedda/wasm-bindgen that referenced this pull request May 21, 2024

Don't use reflect in webidl dictionary setters (rustwasm#3898)

d48af8e

daxpedda mentioned this pull request May 29, 2024

new constructors for WebIDL bindings introduce undefined behavior by not setting default values #3937

Closed

daxpedda mentioned this pull request Jun 12, 2024

web_sys: Dictionaries don't have getters #2921

Closed

daxpedda mentioned this pull request Jul 20, 2024

Web: avoid using js_sys::Reflect rust-windowing/winit#3804

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Don't use reflect in webidl dictionary setters #3898

Don't use reflect in webidl dictionary setters #3898

Davidster commented Mar 19, 2024

Davidster commented Mar 19, 2024

Davidster commented Mar 20, 2024

Davidster commented Mar 20, 2024 •

edited

Loading

Davidster commented Mar 21, 2024

Davidster commented Mar 24, 2024

Davidster commented Mar 24, 2024

daxpedda commented Mar 27, 2024

Davidster commented Mar 27, 2024

daxpedda commented Mar 27, 2024

Davidster commented Mar 27, 2024 •

edited

Loading

Davidster commented Mar 29, 2024

daxpedda left a comment

Davidster commented Apr 1, 2024

daxpedda left a comment

Liamolucko left a comment

Liamolucko commented Apr 3, 2024

Davidster commented Apr 3, 2024

daxpedda left a comment

Don't use reflect in webidl dictionary setters #3898

Don't use reflect in webidl dictionary setters #3898

Conversation

Davidster commented Mar 19, 2024

Davidster commented Mar 19, 2024

Davidster commented Mar 20, 2024

Davidster commented Mar 20, 2024 • edited Loading

Davidster commented Mar 21, 2024

Davidster commented Mar 24, 2024

Davidster commented Mar 24, 2024

daxpedda commented Mar 27, 2024

Davidster commented Mar 27, 2024

daxpedda commented Mar 27, 2024

Davidster commented Mar 27, 2024 • edited Loading

Davidster commented Mar 29, 2024

daxpedda left a comment

Choose a reason for hiding this comment

Davidster commented Apr 1, 2024

daxpedda left a comment

Choose a reason for hiding this comment

Liamolucko left a comment

Choose a reason for hiding this comment

Liamolucko commented Apr 3, 2024

Davidster commented Apr 3, 2024

daxpedda left a comment

Choose a reason for hiding this comment

Davidster commented Mar 20, 2024 •

edited

Loading

Davidster commented Mar 27, 2024 •

edited

Loading