Skip to content

Make some objects read-only in event-related APIs #49045

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
rubennorte wants to merge 2 commits into from
Closed

Make some objects read-only in event-related APIs #49045

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
be15449
[skip ci] Refactor NetworkOverlay to use a symbol instead of a public…
rubennorte Jan 29, 2025
2b38416
Make some objects read-only in event-related APIs
rubennorte Jan 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 20 additions & 7 deletions packages/react-native/Libraries/Inspector/NetworkOverlay.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@

'use strict';

import type XMLHttpRequest from '../Network/XMLHttpRequest';
import type {RenderItemProps} from '@react-native/virtualized-lists';

import ScrollView from '../Components/ScrollView/ScrollView';
Expand Down Expand Up @@ -87,6 +88,18 @@ function keyExtractor(request: NetworkRequestInfo): string {
return String(request.id);
}

const XHR_ID_KEY = Symbol('XHR_ID');

function getXHRId(xhr: XMLHttpRequest): number {
// $FlowExpectedError[prop-missing]
return xhr[XHR_ID_KEY];
}

function setXHRId(xhr: XMLHttpRequest, id: number) {
// $FlowExpectedError[prop-missing]
xhr[XHR_ID_KEY] = id;
}

/**
* Show all the intercepted network requests over the InspectorPanel.
*/
Expand All @@ -110,7 +123,7 @@ class NetworkOverlay extends React.Component<Props, State> {

// Map of `socketId` -> `index in `this.state.requests`.
_socketIdMap: {[number]: number} = {};
// Map of `xhr._index` -> `index in `this.state.requests`.
// Map of `xhr[XHR_ID_KEY]` -> `index in `this.state.requests`.
_xhrIdMap: {[key: number]: number, ...} = {};

state: State = {
Expand All @@ -127,9 +140,9 @@ class NetworkOverlay extends React.Component<Props, State> {
// Generate a global id for each intercepted xhr object, add this id
// to the xhr object as a private `_index` property to identify it,
// so that we can distinguish different xhr objects in callbacks.
xhr._index = nextXHRId++;
setXHRId(xhr, nextXHRId++);
const xhrIndex = this.state.requests.length;
this._xhrIdMap[xhr._index] = xhrIndex;
this._xhrIdMap[getXHRId(xhr)] = xhrIndex;

const _xhr: NetworkRequestInfo = {
id: xhrIndex,
Expand All @@ -147,7 +160,7 @@ class NetworkOverlay extends React.Component<Props, State> {

XHRInterceptor.setRequestHeaderCallback((header, value, xhr) => {
// $FlowFixMe[prop-missing]
const xhrIndex = this._getRequestIndexByXHRID(xhr._index);
const xhrIndex = this._getRequestIndexByXHRID(getXHRId(xhr));
if (xhrIndex === -1) {
return;
}
Expand All @@ -164,7 +177,7 @@ class NetworkOverlay extends React.Component<Props, State> {

XHRInterceptor.setSendCallback((data, xhr) => {
// $FlowFixMe[prop-missing]
const xhrIndex = this._getRequestIndexByXHRID(xhr._index);
const xhrIndex = this._getRequestIndexByXHRID(getXHRId(xhr));
if (xhrIndex === -1) {
return;
}
Expand All @@ -179,7 +192,7 @@ class NetworkOverlay extends React.Component<Props, State> {
XHRInterceptor.setHeaderReceivedCallback(
(type, size, responseHeaders, xhr) => {
// $FlowFixMe[prop-missing]
const xhrIndex = this._getRequestIndexByXHRID(xhr._index);
const xhrIndex = this._getRequestIndexByXHRID(getXHRId(xhr));
if (xhrIndex === -1) {
return;
}
Expand All @@ -197,7 +210,7 @@ class NetworkOverlay extends React.Component<Props, State> {
XHRInterceptor.setResponseCallback(
(status, timeout, response, responseURL, responseType, xhr) => {
// $FlowFixMe[prop-missing]
const xhrIndex = this._getRequestIndexByXHRID(xhr._index);
const xhrIndex = this._getRequestIndexByXHRID(getXHRId(xhr));
if (xhrIndex === -1) {
return;
}
Expand Down
4 changes: 2 additions & 2 deletions packages/react-native/src/private/webapis/dom/events/CustomEvent.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@ import type {EventInit} from './Event';

import Event from './Event';

export type CustomEventInit = {
export type CustomEventInit = $ReadOnly<{
...EventInit,
detail?: mixed,
};
}>;

export default class CustomEvent extends Event {
_detail: mixed;
Expand Down
4 changes: 2 additions & 2 deletions packages/react-native/src/private/webapis/dom/events/Event.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,11 @@ import {
setStopPropagationFlag,
} from './internals/EventInternals';

export type EventInit = {
export type EventInit = $ReadOnly<{
bubbles?: boolean,
cancelable?: boolean,
composed?: boolean,
};
}>;

export default class Event {
static +NONE: 0;
Expand Down
8 changes: 4 additions & 4 deletions packages/react-native/src/private/webapis/dom/events/EventTarget.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,16 +39,16 @@ export type EventHandler = interface {
};
export type EventListener = EventCallback | EventHandler;

export type EventListenerOptions = {
export type EventListenerOptions = $ReadOnly<{
capture?: boolean,
};
}>;

export type AddEventListenerOptions = {
export type AddEventListenerOptions = $ReadOnly<{
...EventListenerOptions,
passive?: boolean,
once?: boolean,
signal?: AbortSignal,
};
}>;

type EventListenerRegistration = {
+callback: EventListener,
Expand Down