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.

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

refactor[react-devtools-shared]: minor parsing improvements and modifications #27661

Merged
merged 1 commit into from
Nov 7, 2023
+106 −65
Merged

refactor[react-devtools-shared]: minor parsing improvements and modifications #27661

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 0 additions & 1 deletion packages/react-devtools-shared/src/backend/renderer.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -439,7 +439,6 @@ export function getInternalReactConstants(version: string): {
return 'Cache';
case ClassComponent:
case IncompleteClassComponent:
return getDisplayName(resolvedType);
case FunctionComponent:
case IndeterminateComponent:
return getDisplayName(resolvedType);
Expand Down
119 changes: 80 additions & 39 deletions packages/react-devtools-shared/src/devtools/store.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ import {
setSavedComponentFilters,
separateDisplayNameAndHOCs,
shallowDiffers,
utfDecodeString,
utfDecodeStringWithRanges,
} from '../utils';
import {localStorageGetItem, localStorageSetItem} from '../storage';
import {__DEBUG__} from '../constants';
Expand Down Expand Up @@ -450,7 +450,7 @@ export default class Store extends EventEmitter<{
}

// This build of DevTools supports the legacy profiler.
// This is a static flag, controled by the Store config.
// This is a static flag, controlled by the Store config.
get supportsProfiling(): boolean {
return this._supportsProfiling;
}
Expand All @@ -467,7 +467,7 @@ export default class Store extends EventEmitter<{
}

// This build of DevTools supports the Timeline profiler.
// This is a static flag, controled by the Store config.
// This is a static flag, controlled by the Store config.
get supportsTimeline(): boolean {
return this._supportsTimeline;
}
Expand Down Expand Up @@ -502,30 +502,58 @@ export default class Store extends EventEmitter<{
}

// Find which root this element is in...
let rootID;
let root;
let rootWeight = 0;
for (let i = 0; i < this._roots.length; i++) {
rootID = this._roots[i];
root = ((this._idToElement.get(rootID): any): Element);
const rootID = this._roots[i];
root = this._idToElement.get(rootID);

if (root === undefined) {
this._throwAndEmitError(
Error(
`Couldn't find root with id "${rootID}": no matching node was found in the Store.`,
),
);

return null;
}

if (root.children.length === 0) {
continue;
} else if (rootWeight + root.weight > index) {
}

if (rootWeight + root.weight > index) {
break;
} else {
rootWeight += root.weight;
}
}

if (root === undefined) {
return null;
}

// Find the element in the tree using the weight of each node...
// Skip over the root itself, because roots aren't visible in the Elements tree.
let currentElement = ((root: any): Element);
let currentElement: Element = root;
let currentWeight = rootWeight - 1;

while (index !== currentWeight) {
const numChildren = currentElement.children.length;
for (let i = 0; i < numChildren; i++) {
const childID = currentElement.children[i];
const child = ((this._idToElement.get(childID): any): Element);
const child = this._idToElement.get(childID);

if (child === undefined) {
this._throwAndEmitError(
Error(
`Couldn't child element with id "${childID}": no matching node was found in the Store.`,
),
);

return null;
}

const childWeight = child.isCollapsed ? 1 : child.weight;

if (index <= currentWeight + childWeight) {
Expand All @@ -538,7 +566,7 @@ export default class Store extends EventEmitter<{
}
}

return ((currentElement: any): Element) || null;
return currentElement || null;
}

getElementIDAtIndex(index: number): number | null {
Expand All @@ -560,32 +588,31 @@ export default class Store extends EventEmitter<{
getElementsWithErrorsAndWarnings(): Array<{id: number, index: number}> {
if (this._cachedErrorAndWarningTuples !== null) {
return this._cachedErrorAndWarningTuples;
} else {
const errorAndWarningTuples: ErrorAndWarningTuples = [];

this._errorsAndWarnings.forEach((_, id) => {
const index = this.getIndexOfElementID(id);
if (index !== null) {
let low = 0;
let high = errorAndWarningTuples.length;
while (low < high) {
const mid = (low + high) >> 1;
if (errorAndWarningTuples[mid].index > index) {
high = mid;
} else {
low = mid + 1;
}
}
}

errorAndWarningTuples.splice(low, 0, {id, index});
const errorAndWarningTuples: ErrorAndWarningTuples = [];

this._errorsAndWarnings.forEach((_, id) => {
const index = this.getIndexOfElementID(id);
if (index !== null) {
let low = 0;
let high = errorAndWarningTuples.length;
while (low < high) {
const mid = (low + high) >> 1;
if (errorAndWarningTuples[mid].index > index) {
high = mid;
} else {
low = mid + 1;
}
}
});

// Cache for later (at least until the tree changes again).
this._cachedErrorAndWarningTuples = errorAndWarningTuples;
errorAndWarningTuples.splice(low, 0, {id, index});
}
});

return errorAndWarningTuples;
}
// Cache for later (at least until the tree changes again).
this._cachedErrorAndWarningTuples = errorAndWarningTuples;
return errorAndWarningTuples;
}

getErrorAndWarningCountForElementID(id: number): {
Expand Down Expand Up @@ -923,7 +950,11 @@ export default class Store extends EventEmitter<{
const nextLength = operations[i];
i++;

const nextString = utfDecodeString(operations.slice(i, i + nextLength));
const nextString = utfDecodeStringWithRanges(
operations,
i,
i + nextLength - 1,
);
stringTable.push(nextString);
i += nextLength;
}
Expand Down Expand Up @@ -1035,7 +1066,7 @@ export default class Store extends EventEmitter<{
),
);

continue;
break;
}

parentElement.children.push(id);
Expand Down Expand Up @@ -1088,7 +1119,7 @@ export default class Store extends EventEmitter<{
),
);

continue;
break;
}

i += 1;
Expand Down Expand Up @@ -1126,7 +1157,7 @@ export default class Store extends EventEmitter<{
),
);

continue;
break;
}

const index = parentElement.children.indexOf(id);
Expand Down Expand Up @@ -1172,7 +1203,17 @@ export default class Store extends EventEmitter<{
}
};

const root = ((this._idToElement.get(id): any): Element);
const root = this._idToElement.get(id);
if (root === undefined) {
this._throwAndEmitError(
Error(
`Cannot remove root "${id}": no matching node was found in the Store.`,
),
);

break;
}

recursivelyDeleteElements(id);

this._rootIDToCapabilities.delete(id);
Expand All @@ -1194,7 +1235,7 @@ export default class Store extends EventEmitter<{
),
);

continue;
break;
}

const children = element.children;
Expand Down Expand Up @@ -1279,7 +1320,7 @@ export default class Store extends EventEmitter<{

this._revision++;

// Any time the tree changes (e.g. elements added, removed, or reordered) cached inidices may be invalid.
// Any time the tree changes (e.g. elements added, removed, or reordered) cached indices may be invalid.
this._cachedErrorAndWarningTuples = null;

if (haveErrorsOrWarningsChanged) {
Expand Down
9 changes: 4 additions & 5 deletions packages/react-devtools-shared/src/devtools/views/Components/Element.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ export default function Element({data, index, style}: Props): React.Node {
isStrictModeNonCompliant,
key,
type,
} = ((element: any): ElementType);
} = element;

// Only show strict mode non-compliance badges for top level elements.
// Showing an inline badge for every element in the tree would be noisy.
Expand Down Expand Up @@ -173,17 +173,16 @@ export default function Element({data, index, style}: Props): React.Node {
"
</Fragment>
)}

{hocDisplayNames !== null && hocDisplayNames.length > 0 ? (
<Badge
className={styles.Badge}
hocDisplayNames={hocDisplayNames}
type={type}>
<DisplayName
displayName={hocDisplayNames[0]}
id={((id: any): number)}
/>
<DisplayName displayName={hocDisplayNames[0]} id={id} />
</Badge>
) : null}

{showInlineWarningsAndErrors && errorCount > 0 && (
<Icon
type="error"
Expand Down
11 changes: 5 additions & 6 deletions packages/react-devtools-shared/src/devtools/views/Components/HocBadges.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,11 @@ export default function HocBadges({element}: Props): React.Node {

return (
<div className={styles.HocBadges}>
{hocDisplayNames !== null &&
hocDisplayNames.map(hocDisplayName => (
<div key={hocDisplayName} className={styles.Badge}>
{hocDisplayName}
</div>
))}
{hocDisplayNames.map(hocDisplayName => (
<div key={hocDisplayName} className={styles.Badge}>
{hocDisplayName}
</div>
))}
</div>
);
}
8 changes: 5 additions & 3 deletions packages/react-devtools-shared/src/devtools/views/Profiler/CommitTreeBuilder.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ import {
TREE_OPERATION_UPDATE_TREE_BASE_DURATION,
TREE_OPERATION_UPDATE_ERRORS_OR_WARNINGS,
} from 'react-devtools-shared/src/constants';
import {utfDecodeString} from 'react-devtools-shared/src/utils';
import {utfDecodeStringWithRanges} from 'react-devtools-shared/src/utils';
import {ElementTypeRoot} from 'react-devtools-shared/src/frontend/types';
import ProfilerStore from 'react-devtools-shared/src/devtools/ProfilerStore';

Expand Down Expand Up @@ -170,8 +170,10 @@ function updateTree(
const stringTableEnd = i + stringTableSize;
while (i < stringTableEnd) {
const nextLength = operations[i++];
const nextString = utfDecodeString(
(operations.slice(i, i + nextLength): any),
const nextString = utfDecodeStringWithRanges(
operations,
i,
i + nextLength - 1,
);
stringTable.push(nextString);
i += nextLength;
Expand Down
23 changes: 12 additions & 11 deletions packages/react-devtools-shared/src/utils.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ export function getWrappedDisplayName(
wrapperName: string,
fallbackName?: string,
): string {
const displayName = (outerType: any).displayName;
const displayName = (outerType: any)?.displayName;
return (
displayName || `${wrapperName}(${getDisplayName(innerType, fallbackName)})`
);
Expand Down Expand Up @@ -152,15 +152,14 @@ export function getUID(): number {
return ++uidCounter;
}

export function utfDecodeString(array: Array<number>): string {
// Avoid spreading the array (e.g. String.fromCodePoint(...array))
// Functions arguments are first placed on the stack before the function is called
// which throws a RangeError for large arrays.
// See github.com/facebook/react/issues/22293
export function utfDecodeStringWithRanges(
array: Array<number>,
left: number,
right: number,
): string {
let string = '';
for (let i = 0; i < array.length; i++) {
const char = array[i];
string += String.fromCodePoint(char);
for (let i = left; i <= right; i++) {
string += String.fromCodePoint(array[i]);
}
return string;
}
Expand Down Expand Up @@ -216,8 +215,10 @@ export function printOperationsArray(operations: Array<number>) {
const stringTableEnd = i + stringTableSize;
while (i < stringTableEnd) {
const nextLength = operations[i++];
const nextString = utfDecodeString(
(operations.slice(i, i + nextLength): any),
const nextString = utfDecodeStringWithRanges(
operations,
i,
i + nextLength - 1,
);
stringTable.push(nextString);
i += nextLength;
Expand Down