feat[devtools]: display Forget badge for the relevant components (fac…

…ebook#27709) Adds `Forget` badge to all relevant components. Changes: - If component is compiled with Forget and using a built-in `useMemoCache` hook, it will have a `Forget` badge next to its display name in: - components tree - inspected element view - owners list - Such badges are indexable, so Forget components can be searched using search bar. Fixes: - Displaying the badges for owners list inside the inspected component view Implementation: - React DevTools backend is responsible for identifying if component is compiled with Forget, based on `fiber.updateQueue.memoCache`. It will wrap component's display name with `Forget(...)` prefix before passing operations to the frontend. On the frontend side, we will parse the display name and strip Forget prefix, marking the corresponding element by setting `compiledWithForget` field. Almost the same logic is currently used for HOC display names.
EdisonVan · Apr 15, 2024 · 035c9e7 · 035c9e7
1 parent ac026a8
commit 035c9e7
Show file tree

Hide file tree

Showing 29 changed files with 428 additions and 225 deletions.
diff --git a/packages/react-devtools-shared/src/__tests__/inspectedElement-test.js b/packages/react-devtools-shared/src/__tests__/inspectedElement-test.js
@@ -2765,13 +2765,15 @@ describe('InspectedElement', () => {
     expect(inspectedElement.owners).toMatchInlineSnapshot(`
       [
         {
+          "compiledWithForget": false,
           "displayName": "Child",
           "hocDisplayNames": null,
           "id": 3,
           "key": null,
           "type": 5,
         },
         {
+          "compiledWithForget": false,
           "displayName": "App",
           "hocDisplayNames": null,
           "id": 2,

diff --git a/packages/react-devtools-shared/src/__tests__/profilingCache-test.js b/packages/react-devtools-shared/src/__tests__/profilingCache-test.js
@@ -968,6 +968,7 @@ describe('ProfilingCache', () => {
           "timestamp": 0,
           "updaters": [
             {
+              "compiledWithForget": false,
               "displayName": "render()",
               "hocDisplayNames": null,
               "id": 1,
@@ -1010,6 +1011,7 @@ describe('ProfilingCache', () => {
           "timestamp": 0,
           "updaters": [
             {
+              "compiledWithForget": false,
               "displayName": "render()",
               "hocDisplayNames": null,
               "id": 1,

diff --git a/packages/react-devtools-shared/src/backend/renderer.js b/packages/react-devtools-shared/src/backend/renderer.js
@@ -424,7 +424,10 @@ export function getInternalReactConstants(version: string): {
   }
 
   // NOTICE Keep in sync with shouldFilterFiber() and other get*ForFiber methods
-  function getDisplayNameForFiber(fiber: Fiber): string | null {
+  function getDisplayNameForFiber(
+    fiber: Fiber,
+    shouldSkipForgetCheck: boolean = false,
+  ): string | null {
     const {elementType, type, tag} = fiber;
 
     let resolvedType = type;
@@ -433,6 +436,18 @@ export function getInternalReactConstants(version: string): {
     }
 
     let resolvedContext: any = null;
+    // $FlowFixMe[incompatible-type] fiber.updateQueue is mixed
+    if (!shouldSkipForgetCheck && fiber.updateQueue?.memoCache != null) {
+      const displayNameWithoutForgetWrapper = getDisplayNameForFiber(
+        fiber,
+        true,
+      );
+      if (displayNameWithoutForgetWrapper == null) {
+        return null;
+      }
+
+      return `Forget(${displayNameWithoutForgetWrapper})`;
+    }
 
     switch (tag) {
       case CacheComponent:

diff --git a/packages/react-devtools-shared/src/backendAPI.js b/packages/react-devtools-shared/src/backendAPI.js
@@ -8,7 +8,7 @@
  */
 
 import {hydrate, fillInPath} from 'react-devtools-shared/src/hydration';
-import {separateDisplayNameAndHOCs} from 'react-devtools-shared/src/utils';
+import {backendToFrontendSerializedElementMapper} from 'react-devtools-shared/src/utils';
 import Store from 'react-devtools-shared/src/devtools/store';
 import TimeoutError from 'react-devtools-shared/src/errors/TimeoutError';
 import ElementPollingCancellationError from 'react-devtools-shared/src/errors/ElementPollingCancellationError';
@@ -266,17 +266,7 @@ export function convertInspectedElementBackendToFrontend(
     owners:
       owners === null
         ? null
-        : owners.map(owner => {
-            const [displayName, hocDisplayNames] = separateDisplayNameAndHOCs(
-              owner.displayName,
-              owner.type,
-            );
-            return {
-              ...owner,
-              displayName,
-              hocDisplayNames,
-            };
-          }),
+        : owners.map(backendToFrontendSerializedElementMapper),
     context: hydrateHelper(context),
     hooks: hydrateHelper(hooks),
     props: hydrateHelper(props),

diff --git a/packages/react-devtools-shared/src/devtools/constants.js b/packages/react-devtools-shared/src/devtools/constants.js
@@ -77,6 +77,7 @@ export const THEME_STYLES: {[style: Theme | DisplayDensity]: any, ...} = {
     '--color-error-border': 'hsl(0, 100%, 92%)',
     '--color-error-text': '#ff0000',
     '--color-expand-collapse-toggle': '#777d88',
+    '--color-forget-badge': '#2683E2',
     '--color-link': '#0000ff',
     '--color-modal-background': 'rgba(255, 255, 255, 0.75)',
     '--color-bridge-version-npm-background': '#eff0f1',
@@ -221,6 +222,7 @@ export const THEME_STYLES: {[style: Theme | DisplayDensity]: any, ...} = {
     '--color-error-border': '#900',
     '--color-error-text': '#f55',
     '--color-expand-collapse-toggle': '#8f949d',
+    '--color-forget-badge': '#2683E2',
     '--color-link': '#61dafb',
     '--color-modal-background': 'rgba(0, 0, 0, 0.75)',
     '--color-bridge-version-npm-background': 'rgba(0, 0, 0, 0.25)',

diff --git a/packages/react-devtools-shared/src/devtools/store.js b/packages/react-devtools-shared/src/devtools/store.js
@@ -25,9 +25,9 @@ import {ElementTypeRoot} from '../frontend/types';
 import {
   getSavedComponentFilters,
   setSavedComponentFilters,
-  separateDisplayNameAndHOCs,
   shallowDiffers,
   utfDecodeStringWithRanges,
+  parseElementDisplayNameFromBackend,
 } from '../utils';
 import {localStorageGetItem, localStorageSetItem} from '../storage';
 import {__DEBUG__} from '../constants';
@@ -1033,6 +1033,7 @@ export default class Store extends EventEmitter<{
               parentID: 0,
               type,
               weight: 0,
+              compiledWithForget: false,
             });
 
             haveRootsChanged = true;
@@ -1071,8 +1072,11 @@ export default class Store extends EventEmitter<{
 
             parentElement.children.push(id);
 
-            const [displayNameWithoutHOCs, hocDisplayNames] =
-              separateDisplayNameAndHOCs(displayName, type);
+            const {
+              formattedDisplayName: displayNameWithoutHOCs,
+              hocDisplayNames,
+              compiledWithForget,
+            } = parseElementDisplayNameFromBackend(displayName, type);
 
             const element: Element = {
               children: [],
@@ -1087,6 +1091,7 @@ export default class Store extends EventEmitter<{
               parentID,
               type,
               weight: 1,
+              compiledWithForget,
             };
 
             this._idToElement.set(id, element);

diff --git a/packages/react-devtools-shared/src/devtools/views/Components/Badge.css b/packages/react-devtools-shared/src/devtools/views/Components/Badge.css
@@ -9,9 +9,3 @@
   font-family: var(--font-family-monospace);
   font-size: var(--font-size-monospace-small);
 }
-
-.ExtraLabel {
-  font-family: var(--font-family-monospace);
-  font-size: var(--font-size-monospace-small);
-  color: var(--color-component-badge-count);
-}
diff --git a/packages/react-devtools-shared/src/devtools/views/Components/Badge.js b/packages/react-devtools-shared/src/devtools/views/Components/Badge.js
@@ -8,36 +8,14 @@
  */
 
 import * as React from 'react';
-import {Fragment} from 'react';
-import styles from './Badge.css';
 
-import type {ElementType} from 'react-devtools-shared/src/frontend/types';
+import styles from './Badge.css';
 
 type Props = {
   className?: string,
-  hocDisplayNames: Array<string> | null,
-  type: ElementType,
   children: React$Node,
 };
 
-export default function Badge({
-  className,
-  hocDisplayNames,
-  type,
-  children,
-}: Props): React.Node {
-  if (hocDisplayNames === null || hocDisplayNames.length === 0) {
-    return null;
-  }
-
-  const totalBadgeCount = hocDisplayNames.length;
-
-  return (
-    <Fragment>
-      <div className={`${styles.Badge} ${className || ''}`}>{children}</div>
-      {totalBadgeCount > 1 && (
-        <div className={styles.ExtraLabel}>+{totalBadgeCount - 1}</div>
-      )}
-    </Fragment>
-  );
+export default function Badge({className = '', children}: Props): React.Node {
+  return <div className={`${styles.Badge} ${className}`}>{children}</div>;
 }
diff --git a/packages/react-devtools-shared/src/devtools/views/Components/Element.css b/packages/react-devtools-shared/src/devtools/views/Components/Element.css
@@ -65,7 +65,7 @@
   color: var(--color-expand-collapse-toggle);
 }
 
-.Badge {
+.BadgesBlock {
   margin-left: 0.25rem;
 }
 

diff --git a/packages/react-devtools-shared/src/devtools/views/Components/Element.js b/packages/react-devtools-shared/src/devtools/views/Components/Element.js
@@ -10,14 +10,14 @@
 import * as React from 'react';
 import {Fragment, useContext, useMemo, useState} from 'react';
 import Store from 'react-devtools-shared/src/devtools/store';
-import Badge from './Badge';
 import ButtonIcon from '../ButtonIcon';
-import {createRegExp} from '../utils';
 import {TreeDispatcherContext, TreeStateContext} from './TreeContext';
 import {SettingsContext} from '../Settings/SettingsContext';
 import {StoreContext} from '../context';
 import {useSubscription} from '../hooks';
 import {logEvent} from 'react-devtools-shared/src/Logger';
+import IndexableElementBadges from './IndexableElementBadges';
+import IndexableDisplayName from './IndexableDisplayName';
 
 import type {ItemData} from './Tree';
 import type {Element as ElementType} from 'react-devtools-shared/src/frontend/types';
@@ -121,7 +121,7 @@ export default function Element({data, index, style}: Props): React.Node {
     hocDisplayNames,
     isStrictModeNonCompliant,
     key,
-    type,
+    compiledWithForget,
   } = element;
 
   // Only show strict mode non-compliance badges for top level elements.
@@ -155,11 +155,11 @@ export default function Element({data, index, style}: Props): React.Node {
           // We must use padding rather than margin/left because of the selected background color.
           transform: `translateX(calc(${depth} * var(--indentation-size)))`,
         }}>
-        {ownerID === null ? (
+        {ownerID === null && (
           <ExpandCollapseToggle element={element} store={store} />
-        ) : null}
+        )}
 
-        <DisplayName displayName={displayName} id={((id: any): number)} />
+        <IndexableDisplayName displayName={displayName} id={id} />
 
         {key && (
           <Fragment>
@@ -174,14 +174,12 @@ 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} />
-          </Badge>
-        ) : null}
+        <IndexableElementBadges
+          hocDisplayNames={hocDisplayNames}
+          compiledWithForget={compiledWithForget}
+          elementID={id}
+          className={styles.BadgesBlock}
+        />
 
         {showInlineWarningsAndErrors && errorCount > 0 && (
           <Icon
@@ -262,47 +260,3 @@ function ExpandCollapseToggle({element, store}: ExpandCollapseToggleProps) {
     </div>
   );
 }
-
-type DisplayNameProps = {
-  displayName: string | null,
-  id: number,
-};
-
-function DisplayName({displayName, id}: DisplayNameProps) {
-  const {searchIndex, searchResults, searchText} = useContext(TreeStateContext);
-  const isSearchResult = useMemo(() => {
-    return searchResults.includes(id);
-  }, [id, searchResults]);
-  const isCurrentResult =
-    searchIndex !== null && id === searchResults[searchIndex];
-
-  if (!isSearchResult || displayName === null) {
-    return displayName;
-  }
-
-  const match = createRegExp(searchText).exec(displayName);
-
-  if (match === null) {
-    return displayName;
-  }
-
-  const startIndex = match.index;
-  const stopIndex = startIndex + match[0].length;
-
-  const children = [];
-  if (startIndex > 0) {
-    children.push(<span key="begin">{displayName.slice(0, startIndex)}</span>);
-  }
-  children.push(
-    <mark
-      key="middle"
-      className={isCurrentResult ? styles.CurrentHighlight : styles.Highlight}>
-      {displayName.slice(startIndex, stopIndex)}
-    </mark>,
-  );
-  if (stopIndex < displayName.length) {
-    children.push(<span key="end">{displayName.slice(stopIndex)}</span>);
-  }
-
-  return children;
-}
diff --git a/packages/react-devtools-shared/src/devtools/views/Components/ElementBadges.css b/packages/react-devtools-shared/src/devtools/views/Components/ElementBadges.css
@@ -0,0 +1,14 @@
+.Root {
+  display: inline-flex;
+  align-items: center;
+}
+
+.Root *:not(:first-child) {
+  margin-left: 0.25rem;
+}
+
+.ExtraLabel {
+  font-family: var(--font-family-monospace);
+  font-size: var(--font-size-monospace-small);
+  color: var(--color-component-badge-count);
+}
diff --git a/packages/react-devtools-shared/src/devtools/views/Components/ElementBadges.js b/packages/react-devtools-shared/src/devtools/views/Components/ElementBadges.js
@@ -0,0 +1,48 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow
+ */
+
+import * as React from 'react';
+
+import Badge from './Badge';
+import ForgetBadge from './ForgetBadge';
+
+import styles from './ElementBadges.css';
+
+type Props = {
+  hocDisplayNames: Array<string> | null,
+  compiledWithForget: boolean,
+  className?: string,
+};
+
+export default function ElementBadges({
+  compiledWithForget,
+  hocDisplayNames,
+  className = '',
+}: Props): React.Node {
+  if (
+    !compiledWithForget &&
+    (hocDisplayNames == null || hocDisplayNames.length === 0)
+  ) {
+    return null;
+  }
+
+  return (
+    <div className={`${styles.Root} ${className}`}>
+      {compiledWithForget && <ForgetBadge indexable={false} />}
+
+      {hocDisplayNames != null && hocDisplayNames.length > 0 && (
+        <Badge>{hocDisplayNames[0]}</Badge>
+      )}
+
+      {hocDisplayNames != null && hocDisplayNames.length > 1 && (
+        <div className={styles.ExtraLabel}>+{hocDisplayNames.length - 1}</div>
+      )}
+    </div>
+  );
+}
diff --git a/packages/react-devtools-shared/src/devtools/views/Components/ForgetBadge.css b/packages/react-devtools-shared/src/devtools/views/Components/ForgetBadge.css
@@ -0,0 +1,3 @@
+.Root {
+  background-color: var(--color-forget-badge);
+}