Html: postMessage, WebAssembly.Memory, and undetachable ArrayBuffers

[ajklein]

There's a difference in behavior between Firefox and Chrome for the following code:

postMessage('foo', '*', [new WebAssembly.Memory({initial: 4}).buffer]);

Firefox throws a TypeError, while Chrome happily "transfers" the buffer. Except it doesn't transfer, but rather is silently copied. This is because the ArrayBuffer objects returned from the buffer getter are not allowed to be detached, except when the WebAssembly.Memory is grown (there are more details here, of course, but I don't think they're relevant to HTML).

It seems that neither of these behaviors is specified, e.g., there's no check about "non-detachability" or "wasm memory association" in the postMessage transfer algorithm.

The infrastructure for handling it is already available: when WebAssembly [creates a WebAssembly.Memory](https://webassembly.github.io/spec/js-api/index.html#create-a-memory-buffer] object, it sets [[ArrayBufferDetachKey]] to "WebAssembly.Memory". And ECMAScript allows passing a key to DetachArrayBuffer.

So, having looked at all that, I think this may be a trivial fix: since HTML does not pass a key argument to DetachArrayBuffer, it defaults to undefined. And therefore step 4 of DetachArrayBuffer will throw a TypeError, since SameValue("WebAssembly.Memory", undefined) is false.

Therefore, I think the fix is to replace ! with ? preceding the call to DetachArrayBuffer in step 5.4.4 of the transfer algorithm (2.8.7), and DetachArrayBuffer itself will do the right thing.

All of this is assuming the Firefox behavior is what we want, of course.

@Ms2ger @littledan @domenic @dtig @binji

[domenic]

Thanks for the detailed issue report!

I'm guessing some of the folks CCed are the ones who would be involved in determining for Chrome whether or not to adopt the Firefox behavior. Do you personally believe the Firefox behavior is better? Also, do you know who to ping from Safari?

Therefore, I think the fix is to replace ! with ? preceding the call to DetachArrayBuffer in step 5.4.4 of the transfer algorithm (2.8.7), and DetachArrayBuffer itself will do the right thing.

If the fix is indeed this simple, I think we should also add a note explaining why it might throw, as this is pretty subtle :).

[ajklein]

I prefer the Firefox behavior, but Chrome has been shipping its copy-instead-of-transfer behavior for long enough that I'd want to do some investigation before changing it in a stable release.

@kmiller68 is the main Safari person who I've been interacting with around wasm stuff.

[binji]

Yeah, the current Chrome behavior is possible to implement (by copying yourself), and is also surprising. But it also seems like the kind of thing that websites could be relying on. Do we have any UMA stats for when this happens? If not, can we add some?

[ajklein]

After some digging in the code, I think this behavior goes all the way back to 2014 (before WebAssembly, this behavior was present for asm.js), and isn't currently UMA-counted. We can add a counter, but given how long we've had this behavior in the wild it may be hard to change.

[binji]

How many ways can you create a undetachable ArrayBuffer? (just wasm and asm.js?)

[ajklein]

I'm actually pretty fuzzy on the asm.js case: it seems from code inspection that at that time, in V8, it _was_ true of asm.js memories, but those are no longer special.

[littledan]

Thanks for filing this issue. The Firefox semantics sound ideal to me, if they are web-compatible. This was an unintentional omission of mine when formalizing the WebAssembly/JS interface; I was misunderstanding that the serialize algorithm would handle this.

[kmiller68]

Safari also throws a TypeError if you try to transfer a WebAssembly.Memory generated ArrayBuffer. I agree with others that throwing seems like the ideal semantics.

[littledan]

Note, I added this throwing behavior in https://github.com/tc39/ecma262/pull/1112 + https://github.com/WebAssembly/spec/pull/712 . We discussed it in the March 2018 TC39 meeting. The only real oversight seems to be ? vs ! (and the lack of tests!), as #4603 fixes.

[annevk]

I filed https://github.com/heycam/webidl/issues/724 and https://github.com/WebAudio/web-audio-api/issues/1861 as follow-ups.

[domenic]

Also https://github.com/whatwg/streams/issues/1001