Get specs updated to new dictionary defaulting setup

[bzbarsky]

Followup to #750 that probably needs to wait for plinss/widlparser#39 and speced/bikeshed#1491 to be fixed.

To-be-triaged list of things that might need updating, based on Gecko's IDL that needed to be changed:

• CSS -- [web-animations][css-animations][cssom-view][css-font-loading][resize-observer] Update spec to new IDL syntax for optional dictionaries w3c/csswg-drafts#4234
  • https://drafts.csswg.org/web-animations/
    • Animatable
    • AnimationEffect
    • AnimationPlaybackEvent
    • DocumentTimeline
    • KeyframeEffect
  • AnimationEvent -- https://drafts.csswg.org/css-animations-1/
  • https://drafts.csswg.org/cssom-view/
    • Element
    • GeometryUtils
    • MediaQueryListEvent
  • https://drafts.csswg.org/css-font-loading/
    • FontFaceSetLoadEvent
    • FontFace
  • ResizeObserver -- https://drafts.csswg.org/resize-observer/
• https://webaudio.github.io/web-audio-api/ -- Please update to Web IDL changes to optional dictionary defaulting WebAudio/web-audio-api#1989
  • AnalyserNode
  • AudioBufferSourceNode
  • AudioContext
  • AudioWorkletNode
  • AudioWorkletProcessor
  • BaseAudioContext
  • BiquadFilterNode
  • ChannelSplitterNode
  • ChannelMergerNode
  • ConstantSourceNode
  • ConvolverNode
  • DelayNode
  • DynamicsCompressorNode
  • GainNode
  • MediaStreamAudioDestinationNode
  • OscillatorNode
  • PannerNode
  • PeriodicWave
  • StereoPannerNode
  • WaveShaperNode
• https://w3c.github.io/ServiceWorker/ -- Set default value of optional dictionary to {} w3c/ServiceWorker#1448
  • CacheStorage
  • Cache
  • Clients
  • Client
  • ExtendableEvent
  • ExtendableMessageEvent
  • ServiceWorkerContainer
  • ServiceWorker
• BlobEvent -- https://w3c.github.io/mediacapture-record/
• https://w3c.github.io/FileAPI/ -- Update to Web IDL changes to optional dictionary defaulting w3c/FileAPI#134
  • File
  • Blob
• https://html.spec.whatwg.org/ - Align with IDL dictionary changes html#4745
  • CanvasRenderingContext2D
  • CloseEvent
  • CustomElementRegistry
  • DedicatedWorkerGlobalScope
  • DragEvent
  • Element
  • ErrorEvent
  • EventSource
  • HashChangeEvent
  • HTMLSlotElement
  • MessageEvent
  • MessagePort
  • PageTransitionEvent
  • PopStateEvent
  • SharedWorker
  • StorageEvent
  • TrackEvent
  • WindowOrWorkerGlobalScope
  • Window
  • Worker
• ClipboardEvent -- https://w3c.github.io/clipboard-apis/ -- set default for optional dictionary w3c/clipboard-apis#91
• https://w3c.github.io/uievents/ -- set default for optional dictionary w3c/uievents#239
  • CompositionEvent
  • FocusEvent
  • InputEvent
  • KeyboardEvent
  • MouseEvent
  • UIEvent
  • WheelEvent
• CredentialManagement -- Update spec to new IDL syntax for optional dictionaries w3c/webappsec-credential-management#140
• https://dom.spec.whatwg.org/ -- Align with IDL dictionary changes dom#771
  • CustomEvent
  • Document
  • EventTarget
  • Event
  • MutationObserver
  • Node
• https://w3c.github.io/deviceorientation/ -- Align with IDL dictionary changes w3c/deviceorientation#78
  • DeviceMotionEvent
  • DeviceOrientationEvent
• DeviceLightEvent -- Align with IDL dictionary changes w3c/ambient-light#58
• https://drafts.fxtf.org/geometry/ -- [css-geometry] Please update to Web IDL changes to optional dictionary defaulting w3c/fxtf-drafts#356
  • DOMMatrix
  • DOMPoint
  • DOMQuad
  • DOMRect
• FileSystemDirectoryEntry -- https://wicg.github.io/entries-api/ -- Update to Web IDL changes to optional dictionary defaulting WICG/entries-api#31
• GamepadEvent -- Update spec to new IDL syntax for optional dictionaries w3c/gamepad#101
• Geolocation -- https://www.w3.org/TR/geolocation-API/ -- Align with IDL dictionary changes w3c/geolocation-api#27
• https://w3c.github.io/IndexedDB/ -- Update to Web IDL changes to optional dictionary defaulting w3c/IndexedDB#285
  • IDBDatabase
  • IDBObjectStore
  • IDBVersionChangeEvent
• ImageCaptureErrorEvent -- Update spec to new IDL syntax for optional dictionaries w3c/mediacapture-image#214
• IntersectionObserver -- set default for optional dictionary w3c/IntersectionObserver#374
• Update spec to new IDL syntax for optional dictionaries w3c/mediacapture-main#613
  • MediaDevices
  • MediaStreamTrack
• MediaEncryptedEvent -- Update spec to new IDL syntax for optional dictionaries w3c/encrypted-media#452
• MediaRecorder -- Update spec to new IDL syntax for optional dictionaries w3c/mediacapture-record#180
• MediaStreamEvent -- no longer specified?
• set default for optional dictionary WebAudio/web-midi-api#203
  • MIDIConnectionEvent
  • MIDIMessageEvent
  • Navigator.requestMIDIAccess
• Navigator.share -- fix: default share(data) to empty dictionary w3c/web-share#111
• https://notifications.spec.whatwg.org/ - Align with IDL dictionary changes notifications#149
  • Notification
  • ServiceWorkerRegistration
• Payment Request -- fix: set default for optional dictionaries w3c/payment-request#874
  • MerchantValidationEvent
  • PaymentMethodChangeEvent
  • PaymentRequestUpdateEvent
  • PaymentRequest
  • PaymentResponse
• Performance -- Giving startOrOptions a default value for IDL conformance. w3c/user-timing#65
• PerformanceObserverEntryList -- remove PerformanceEntryFilterOptions w3c/performance-timeline#61
• PerformanceObserver -- Add default value to observe() parameter w3c/performance-timeline#147
• PointerEvent -- Update spec to new IDL syntax for optional dictionaries w3c/pointerevents#296
• ProximitySensor -- Update spec to new IDL syntax for optional dictionaries w3c/proximity#40
• Push Update to Web IDL changes to optional dictionary defaulting w3c/push-api#308
  • PushEvent
  • PushManager
  • PushSubscription
• Reporting -- Update spec to new IDL syntax for optional dictionaries w3c/reporting#172
• https://fetch.spec.whatwg.org/ - Align with IDL dictionary changes fetch#919
  • Request
  • Response
• Update spec to new IDL syntax for optional dictionaries w3c/webrtc-pc#2277
  • RTCDTMFToneChangeEvent
  • RTCIceCandidate
  • RTCPeerConnectionIceEvent
  • RTCPeerConnection
  • RTCSessionDescription
• SecurityPolicyViolationEvent -- Update spec to new IDL syntax for optional dictionaries w3c/webappsec-csp#408
• Update spec to new IDL syntax for optional dictionaries WICG/speech-api#60
  • SpeechRecognitionErrorEvent
  • SpeechRecognitionEvent
• Update spec to new IDL syntax for optional dictionaries w3c/svgwg#727
  • SVGGeometryElement
  • SVGGraphicsElement
  • SVGTextContentElement
• TextDecoder -- https://encoding.spec.whatwg.org/ - Align with IDL dictionary changes encoding#181
• TouchEvent -- Update spec to new IDL syntax for optional dictionaries w3c/touch-events#104
• TransitionEvent -- [css-transition-1] Add dictionary default value w3c/csswg-drafts#4232
• WebGLContextEvent
• WebGPU -- Update spec to new IDL syntax for optional dictionaries gpuweb/gpuweb#420
• Worklet -- [worklets] Update spec to new IDL syntax for optional dictionaries w3c/css-houdini-drafts#937
• https://xhr.spec.whatwg.org/ - Align with IDL dictionary changes xhr#250
  • ProgressEvent

[bzbarsky]

@annevk @domenic

[marcoscaceres]

I can help with the WebApps WG specs and Payments WG spec and get them republished.

ReSpec will emit warnings for this too. We might also implement an “auto fix” for this in ReSpec, so at least Editors drafts will produce the right IDL.

[bzbarsky]

@marcoscaceres Thanks! I'll keep triaging the list above as I have time, and trying to get issues filed.

[inexorabletash]

Once bikeshed is ready, I can take the IndexedDB and entries-api ones.

In the above checklist, MediaStreamAudioDestinationNode, OscillatorNode, PannerNode, StereoPannerNode, WaveShaperNode, PeriodicWave should be added to the webaudio batch.

Presumably the UDP* and TCP* ones are Firefox OS residue?

Also, IDBFileHandle is non-standard, it's a Gecko thing. Similarly, there is no standard IDBFactory method that takes a dictionary - that's a nonstandard Gecko extension.

Filed w3c/IndexedDB#285 and WICG/entries-api#31

[bzbarsky]

should be added to the webaudio batch

Done, thanks. Hadn't gotten to those yet. ;)

Presumably the UDP* and TCP* ones are Firefox OS residue?

They started out with Firefox OS, but at this point it looks like Firefox devtools use them (e.g. for adb connection). More pertinently, https://www.w3.org/2012/sysapps/tcp-udp-sockets/ is a thing, but doesn't seem to contain any actual IDL, though https://www.w3.org/TR/tcp-udp-sockets/ does. Not sure whether it's worth trying to get that updated; it seems pretty dead at the moment... I'll take all the TCP* and UDP* bits out of the list for now.

Also, IDBFileHandle is non-standard, it's a Gecko thing

Yep, I just dropped all the IDB things in without checking carefully, since the IDB spec needs some updates... I'll remove it from the list.

Similarly, there is no standard IDBFactory method that takes a dictionary - that's a nonstandard Gecko extension.

Removed from list, thanks.

There are likely more Gecko-specific things in the untriaged list; I removed some obvious ones as a first pass, but as you found there's more there...

Thank you for filing the IDB and entries-api issues!

[marcoscaceres]

Sent w3c/payment-request#874 for Payment Request:

You can ✓:

• PaymentMethodChangeEvent
• PaymentRequestUpdateEvent
• PaymentRequest
• PaymentResponse
• MerchantValidationEvent

[marcoscaceres]

Sent w3c/FileAPI#134 for File API, which covers:

• File
• Blob

[CYBAI]

Sent w3c/ServiceWorker#1448 for ServiceWorker, which covers:

• ServiceWorker
• ServiceWorkerContainer
• Client
• Clients
• ExtendableEvent
• ExtendableMessageEvent
• Cache
• CacheStorage

[marcoscaceres]

Sent w3c/push-api#308 for Push, which covers:

• PushEvent
• PushManager
• PushSubscription

[marcoscaceres]

Sent w3c/clipboard-apis#91 for Clipboard APIs, which covers:

• ClipboardEvent

[marcoscaceres]

Cc @anssiko... there are a few above from your WGs. Could use your help 🙏

[marcoscaceres]

Sent w3c/IntersectionObserver#374 for IntersectionObserver, which covers:

• IntersectionObserver

[marcoscaceres]

Sent w3c/uievents#239 for UIEvents, which covers:

• UIEvent
• FocusEvent
• MouseEvent
• WheelEvent
• InputEvent
• KeyboardEvent
• CompositionEvent

[marcoscaceres]

Note above... InputEvent is defined in UIEvents, not in https://w3c.github.io/input-events/, where it's a partial interface.

[marcoscaceres]

Sent WebAudio/web-midi-api#203 for Web Midi, which covers:

• MIDIConnectionEvent
• MIDIMessageEvent

[marcoscaceres]

@yoavweiss a few here from the Perf WG:

• PerformanceEntryEvent
• PerformanceObserverEntryList
• PerformanceObserver

If you let me know the specs, I can send some PRs.

[annevk]

All WHATWG standards have a PR at this point.

[anssiko]

PRs submitted for w3c/deviceorientation#78 and w3c/geolocation-api#27. DeviceProximityEvent, UserProximityEvent, and DeviceLightEvent are deprecated and superseded by ProximitySensor and AmbientLightSensor that were affected and received a similar PR treatment.

In addition, I created PRs for specs that extend Generic Sensor API, also affected.

[Ms2ger]

Everything except WebGL should be filed now; I also removed the Mozilla-internal APIs.

[domenic]

Awesome! How did you feel about this process? In particular, how painful was it, and how does that make us feel about changes like #700, or other more speculative ideas people have thrown around?

[annevk]

My main takeaway is that it'd be great to have all tooling PRs ready as well so we only need to communicate a change to everyone once. So that at the point it's communicated everyone can pick it up straight away.

[Ms2ger]

It wasn't too bad, I think. @bzbarsky's list was very helpful.

[anssiko]

Second that, the list was helpful.

Related to tooling, and hopefully not too much OT, do we have a tool to conveniently diff spec IDLs against major browsers' implementations to make communicating (proposed) spec changes not just toward downstream specs but also toward implementations easier?

There's https://github.com/mdittmer/web-apis and https://github.com/tidoust/reffy so parts of the problem have already been solved. @foolip @tidoust?

[foolip]

@anssiko a part of https://github.com/mdittmer/web-apis was indeed directed towards this problem, and @mdittmer did in fact produce lists of discrepancies in various categories. We used these lists to file a lot of bugs tracked by https://crbug.com/674593. You can see a lot have been resolved, so the approach worked!

However, we didn't keep triaging differences over time or build tooling to prevent differences from occurring in the first place.

The biggest hurdle, which isn't a very big one, is having a Web IDL parser able to parse both all spec IDL (webidl2.js) but also all the IDL from Chromium, Gecko and WebKit. https://github.com/mdittmer/webidl2-js (not the same as webidl2.js) was once able to do that, but such a parser has to be continuously maintained to keep up with changes.

So to summarize, such tooling isn't deployed, but it's been done before, and the technical challenges are pretty modest. It's mostly a matter of time investment vs. payoff, and web-platform-tests took priority for us.

@lukebjerring FYI about this history and potential area of work.

[annevk]

I'm closing this. There's one or two specs still not updated, but by-and-large this has been embraced and tooling will eventually get the laggards updated as well.