Fix event listener option object types #34999
Open
+4
−4
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Summary: ### Context Currently, we're allowing users to pass in a lot of unnecessary options to `removeEventListener`. Flow supports [all of the `AddEventListenerOptions` flags](https://www.internalfb.com/code/fbsource/[af794e4e4e71]/www/html/xplat-react/flow/dom.js.flow?lines=333-341) for `removeEventListener` which is too permissive. Below is the DOM spec: ``` interface EventTarget { constructor(); undefined addEventListener(DOMString type, EventListener? callback, optional (AddEventListenerOptions or boolean) options = {}); undefined removeEventListener(DOMString type, EventListener? callback, optional (EventListenerOptions or boolean) options = {}); boolean dispatchEvent(Event event); }; dictionary EventListenerOptions { boolean capture = false; }; dictionary AddEventListenerOptions : EventListenerOptions { boolean passive; boolean once = false; AbortSignal signal; }; ``` https://dom.spec.whatwg.org/#interface-eventtarget Only `capture` or `boolean` should ever be allowed for `removeEventListener` as a property key in an object or a straightforward boolean. For reference, here are the related TypeScript types which appear to [implement the above correctly](https://github.com/microsoft/TypeScript/blob/main/src/lib/dom.generated.d.ts#L8-L12). ### Diff This diff corrects the types and brings them more in line with the spec in `html/xplat-react/flow/dom.js.flow`, and then updates any erroring call sites in Flow. Differential Revision: D84544559
|
@thegreatercurve has exported this pull request. If you are a Meta employee, you can view the originating Diff in D84544559. |
|
Comparing: b4455a6...d33ff9f Critical size changesIncludes critical production bundles, as well as any change greater than 2%:
Significant size changesIncludes any change greater than 0.2%: (No significant changes) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary:
Context
Currently, we're allowing users to pass in a lot of unnecessary options to
removeEventListener.Flow supports all of the
AddEventListenerOptionsflags forremoveEventListenerwhich is too permissive. Below is the DOM spec:https://dom.spec.whatwg.org/#interface-eventtarget
Only
captureorbooleanshould ever be allowed forremoveEventListeneras a property key in an object or a straightforward boolean.For reference, here are the related TypeScript types which appear to implement the above correctly.
Diff
This diff corrects the types and brings them more in line with the spec in
html/xplat-react/flow/dom.js.flow, and then updates any erroring call sites in Flow.Differential Revision: D84544559