Intent to Ship: TextEncoderStream and TextDecoderStream APIs

[Adam Rice]

Contact emails ri...@chromium.org, yhi...@chromium.org Spec

WHATWG Standard: https://encoding.spec.whatwg.org/

Explainer: https://github.com/ricea/encoding-streams/blob/master/stream-explainer.md.

Extensive discussion has taken place on the Encoding Standard repository: https://github.com/whatwg/encoding/issues/72

TAG review: https://github.com/w3ctag/design-reviews/issues/282 Summary Integration of the Encoding Standard with the Stream Standard. This enables developers to easily convert streams of binary data to text and vice-versa. This is generally useful when working with streams of text, and fills a vital need when used with the Fetch API. Motivation Without these objects developers will be forced to roll their own. See the explainer for why this is problematic. Interoperability risk Firefox: Public support Edge: Public support Safari: No public signals Web developers: Supportive

Two new constructors will be added to the global object. This has been the conclusion of discussions on the Encoding Standard repository and has rough consensus from the participants there. The behaviour of the new objects is based on elements of the Encoding Standard and Stream Standard that are already stable, and so changes are unlikely to be required.

Compatibility risk Very low. I am not aware of any existing use of these names in Javascript. Ongoing technical constraints None. Will this feature be supported on all six Blink platforms (Windows, Mac, Linux, Chrome OS, Android, and Android WebView)? Yes or no. Yes. OWP launch tracking bug https://bugs.chromium.org/p/chromium/issues/detail?id=845427 Link to entry on the Chrome Platform Status https://www.chromestatus.com/features/4881011259211776 Requesting approval to ship? Yes.

[Yoav Weiss]

Thanks for making streamed text encoding/decoding possible! :)

On Tue, Sep 4, 2018 at 4:21 AM Adam Rice <ri...@chromium.org> wrote:

Contact emails ri...@chromium.org, yhi...@chromium.org Spec

WHATWG Standard: https://encoding.spec.whatwg.org/

Explainer: https://github.com/ricea/encoding-streams/blob/master/stream-explainer.md.

Extensive discussion has taken place on the Encoding Standard repository: https://github.com/whatwg/encoding/issues/72

TAG review: https://github.com/w3ctag/design-reviews/issues/282 Summary Integration of the Encoding Standard with the Stream Standard. This enables developers to easily convert streams of binary data to text and vice-versa. This is generally useful when working with streams of text, and fills a vital need when used with the Fetch API. Motivation Without these objects developers will be forced to roll their own. See the explainer for why this is problematic. Interoperability risk Firefox: Public support Edge: Public support Safari: No public signals Web developers: Supportive

Can you link to public support from Firefox and Edge? Have you tried to reach out to Safari/WebKit folks?

 

Two new constructors will be added to the global object. This has been the conclusion of discussions on the Encoding Standard repository and has rough consensus from the participants there. The behaviour of the new objects is based on elements of the Encoding Standard and Stream Standard that are already stable, and so changes are unlikely to be required.

Compatibility risk Very low. I am not aware of any existing use of these names in Javascript. Ongoing technical constraints None. Will this feature be supported on all six Blink platforms (Windows, Mac, Linux, Chrome OS, Android, and Android WebView)? Yes or no. Yes. OWP launch tracking bug https://bugs.chromium.org/p/chromium/issues/detail?id=845427 Link to entry on the Chrome Platform Status https://www.chromestatus.com/features/4881011259211776

Looking at the "intent" template, I'm missing some sections here:

* Can you elaborate on the ergonomics and activation risks, if any?

* Debuggability - will this require specific support from dev tools?

* WPT - does this feature have a WPT test suite?

Requesting approval to ship? Yes.

--
You received this message because you are subscribed to the Google Groups "blink-dev" group.
To unsubscribe from this group and stop receiving emails from it, send an email to blink-dev+...@chromium.org.
To view this discussion on the web visit https://groups.google.com/a/chromium.org/d/msgid/blink-dev/CAC_ixdyh1-9Hqp%2Bq5BAQvGZgVUyuyr%3D_j6PwHOTPPnEFLXrXmw%40mail.gmail.com.

[Adam Rice]

Can you link to public support from Firefox and Edge? Have you tried to reach out to Safari/WebKit folks?

Both from the PR to the encoding standard: https://github.com/whatwg/encoding/pull/149#issuecomment-412876950 and https://github.com/whatwg/encoding/pull/149#issuecomment-415103236. Strictly speaking it's support for the standard change rather than any kind of promise to implement.

I filed a WebKit issue at https://bugs.webkit.org/show_bug.cgi?id=189066. No response so far.

Looking at the "intent" template, I'm missing some sections here:

I copied it from the I2I, which I think I originally got from chromestatus.com. Sorry I missed some sections.

Design doc: https://docs.google.com/document/d/17goe4jacAYjHHtprfVPSrqDvF_J58u2qirz0HQ58sQ4/edit

Ergonomics

This integrates with the Streams APIs, particularly the pipeThrough() method of ReadableStream. TextDecoderStream will be widely used to decode the body stream of a Fetch Response.

Default usage of the API will not cause problems for Chrome's performance.

Activation

Developers can immediately use the feature. A polyfill is available at https://github.com/GoogleChromeLabs/text-encode-transform-polyfill.

Debuggability

As a normal JS API, no special debugging support is needed.

Is this feature fully tested by web-platform-tests?

Yes. Tests are at https://github.com/web-platform-tests/wpt/tree/master/encoding/streams.

Link to "Intent to Implement" blink-dev discussion

https://groups.google.com/a/chromium.org/forum/#!topic/blink-dev/Va5xWNoBOeE

[Yoav Weiss]

LGTM1

On Tue, Sep 4, 2018 at 9:59 AM Adam Rice <ri...@chromium.org> wrote:

Can you link to public support from Firefox and Edge? Have you tried to reach out to Safari/WebKit folks?

Both from the PR to the encoding standard: https://github.com/whatwg/encoding/pull/149#issuecomment-412876950 and https://github.com/whatwg/encoding/pull/149#issuecomment-415103236. Strictly speaking it's support for the standard change rather than any kind of promise to implement.

Thanks! No timelines, but it does seem like they are supportive of the feature.

 

I filed a WebKit issue at https://bugs.webkit.org/show_bug.cgi?id=189066. No response so far.

Looking at the "intent" template, I'm missing some sections here:

I copied it from the I2I, which I think I originally got from chromestatus.com. Sorry I missed some sections.

Seems like this is a common issue.

[Chris Harrelson]

LGTM2

To view this discussion on the web visit https://groups.google.com/a/chromium.org/d/msgid/blink-dev/CACj%3DBEhXgBwziqGdfM%3Dd%2BjH4mjoO6A%3Daaii3dWTeX%2B9rqc6nfg%40mail.gmail.com.

[Philip Jägenstedt]

LGTM3

To view this discussion on the web visit https://groups.google.com/a/chromium.org/d/msgid/blink-dev/CAOMQ%2Bw931PmC6hdCFuJq9VRVSC86BzNQHtniPKSSzsv_SBNhcw%40mail.gmail.com.