Skip to content
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.

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

feature[REMOVED][devtools]: turn off / hide location based component filters #28417

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 6 additions & 1 deletion packages/react-devtools-shared/src/backend/renderer.js
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ import {
renamePathInObject,
setInObject,
utfEncodeString,
filterOutLocationComponentFilters,
} from 'react-devtools-shared/src/utils';
import {sessionStorageGetItem} from 'react-devtools-shared/src/storage';
import {
Expand Down Expand Up @@ -918,7 +919,11 @@ export function attach(
// because they are stored in localStorage within the context of the extension.
// Instead it relies on the extension to pass filters through.
if (window.__REACT_DEVTOOLS_COMPONENT_FILTERS__ != null) {
applyComponentFilters(window.__REACT_DEVTOOLS_COMPONENT_FILTERS__);
const componentFiltersWithoutLocationBasedOnes =
filterOutLocationComponentFilters(
window.__REACT_DEVTOOLS_COMPONENT_FILTERS__,
);
applyComponentFilters(componentFiltersWithoutLocationBasedOnes);
} else {
// Unfortunately this feature is not expected to work for React Native for now.
// It would be annoying for us to spam YellowBox warnings with unactionable stuff,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -374,7 +374,9 @@ export default function ComponentsSettings(_: {}): React.Node {
): any): ComponentFilterType),
)
}>
<option value={ComponentFilterLocation}>location</option>
{/* TODO: currently disabled, need find a new way of doing this
<option value={ComponentFilterLocation}>location</option>
*/}
<option value={ComponentFilterDisplayName}>name</option>
<option value={ComponentFilterElementType}>type</option>
<option value={ComponentFilterHOC}>hoc</option>
Expand Down
23 changes: 21 additions & 2 deletions packages/react-devtools-shared/src/utils.js
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ import {
} from './constants';
import {
ComponentFilterElementType,
ComponentFilterLocation,
ElementTypeHostComponent,
} from './frontend/types';
import {
Expand Down Expand Up @@ -339,7 +340,8 @@ export function getSavedComponentFilters(): Array<ComponentFilter> {
LOCAL_STORAGE_COMPONENT_FILTER_PREFERENCES_KEY,
);
if (raw != null) {
return JSON.parse(raw);
const parsedFilters: Array<ComponentFilter> = JSON.parse(raw);
return filterOutLocationComponentFilters(parsedFilters);
}
} catch (error) {}
return getDefaultComponentFilters();
Expand All @@ -350,10 +352,27 @@ export function setSavedComponentFilters(
): void {
localStorageSetItem(
LOCAL_STORAGE_COMPONENT_FILTER_PREFERENCES_KEY,
JSON.stringify(componentFilters),
JSON.stringify(filterOutLocationComponentFilters(componentFilters)),
);
}

// Following __debugSource removal from Fiber, the new approach for finding the source location
// of a component, represented by the Fiber, is based on lazily generating and parsing component stack frames
// To find the original location, React DevTools will perform symbolication, source maps are required for that.
// In order to start filtering Fibers, we need to find location for all of them, which can't be done lazily.
// Eager symbolication can become quite expensive for large applications.
export function filterOutLocationComponentFilters(
componentFilters: Array<ComponentFilter>,
): Array<ComponentFilter> {
// This is just an additional check to preserve the previous state
// Filters can be stored on the backend side or in user land (in a window object)
if (!Array.isArray(componentFilters)) {
return componentFilters;
}

return componentFilters.filter(f => f.type !== ComponentFilterLocation);
}

function parseBool(s: ?string): ?boolean {
if (s === 'true') {
return true;
Expand Down