feat: support more element types (#617)

Andarist · web-flow · commit bf7f4cf8d314 · 2021-09-28T16:50:28.000+02:00
* Add a failing test for printing `forwardRef` element

* Unwind `getReactElementDisplayName` to a cascade of if statements

* Refactor `getReactElementDisplayName` to switch statement

* Support stringifying more element types

* fix: flow types

* chore: adjust fallback case in the `getReactElementDisplayName`
diff --git a/package.json b/package.json
@@ -24,10 +24,7 @@
     "smoke": "node tests/smoke/run"
   },
   "lint-staged": {
-    "*.js": [
-      "prettier --write \"**/*.{js,json}\"",
-      "git add"
-    ]
+    "*.js": ["prettier --write \"**/*.{js,json}\"", "git add"]
   },
   "author": {
     "name": "Algolia, Inc.",
@@ -72,7 +69,6 @@
     "react-test-renderer": "16.14.0",
     "rollup": "1.32.1",
     "rollup-plugin-babel": "4.4.0",
-    "rollup-plugin-commonjs": "10.1.0",
     "rollup-plugin-node-builtins": "2.1.2",
     "rollup-plugin-node-globals": "1.4.0",
     "rollup-plugin-node-resolve": "5.2.0",
@@ -84,11 +80,10 @@
   },
   "dependencies": {
     "@base2/pretty-print-object": "1.0.0",
-    "is-plain-object": "3.0.1"
+    "is-plain-object": "3.0.1",
+    "react-is": "^17.0.2"
   },
   "jest": {
-    "setupFilesAfterEnv": [
-      "<rootDir>tests/setupTests.js"
-    ]
+    "setupFilesAfterEnv": ["<rootDir>tests/setupTests.js"]
   }
 }
diff --git a/rollup.config.js b/rollup.config.js
@@ -1,12 +1,13 @@
 import babel from 'rollup-plugin-babel';
-import commonjs from 'rollup-plugin-commonjs';
 import resolve from 'rollup-plugin-node-resolve';
 import builtins from 'rollup-plugin-node-builtins';
 import globals from 'rollup-plugin-node-globals';
 import pkg from './package.json';
 
-const extractPackagePeerDependencies = () =>
-  Object.keys(pkg.peerDependencies) || [];
+const extractExternals = () => [
+  ...Object.keys(pkg.dependencies || {}),
+  ...Object.keys(pkg.peerDependencies || {}),
+];
 
 export default {
   input: 'src/index.js',
@@ -22,7 +23,7 @@ export default {
       sourcemap: true,
     },
   ],
-  external: extractPackagePeerDependencies(),
+  external: extractExternals(),
   plugins: [
     babel({
       babelrc: false,
@@ -36,12 +37,6 @@ export default {
     resolve({
       mainFields: ['module', 'main', 'jsnext', 'browser'],
     }),
-    commonjs({
-      sourceMap: true,
-      namedExports: {
-        react: ['isValidElement'],
-      },
-    }),
     globals(),
     builtins(),
   ],
diff --git a/src/index.spec.js b/src/index.spec.js
@@ -1160,4 +1160,174 @@ describe('reactElementToJSXString(ReactElement)', () => {
     }
     mount(<App />);
   });
+
+  it('should use inferred function name as display name for `forwardRef` element', () => {
+    const Tag = React.forwardRef(function Tag({ text }, ref) {
+      return <span ref={ref}>{text}</span>;
+    });
+    expect(reactElementToJSXString(<Tag text="some label" />)).toEqual(
+      `<Tag text="some label" />`
+    );
+  });
+
+  it('should use `displayName` instead of inferred function name as display name for `forwardRef` element', () => {
+    const Tag = React.forwardRef(function Tag({ text }, ref) {
+      return <span ref={ref}>{text}</span>;
+    });
+    Tag.displayName = 'MyTag';
+    expect(reactElementToJSXString(<Tag text="some label" />)).toEqual(
+      `<MyTag text="some label" />`
+    );
+  });
+
+  it('should use inferred function name as display name for `memo` element', () => {
+    const Tag = React.memo(function Tag({ text }) {
+      return <span>{text}</span>;
+    });
+    expect(reactElementToJSXString(<Tag text="some label" />)).toEqual(
+      `<Tag text="some label" />`
+    );
+  });
+
+  it('should use `displayName` instead of inferred function name as display name for `memo` element', () => {
+    const Tag = React.memo(function Tag({ text }) {
+      return <span>{text}</span>;
+    });
+    Tag.displayName = 'MyTag';
+    expect(reactElementToJSXString(<Tag text="some label" />)).toEqual(
+      `<MyTag text="some label" />`
+    );
+  });
+
+  it('should use inferred function name as display name for a `forwardRef` wrapped in `memo`', () => {
+    const Tag = React.memo(
+      React.forwardRef(function Tag({ text }, ref) {
+        return <span ref={ref}>{text}</span>;
+      })
+    );
+    expect(reactElementToJSXString(<Tag text="some label" />)).toEqual(
+      `<Tag text="some label" />`
+    );
+  });
+
+  it('should use inferred function name as display name for a component wrapped in `memo` multiple times', () => {
+    const Tag = React.memo(
+      React.memo(
+        React.memo(function Tag({ text }) {
+          return <span>{text}</span>;
+        })
+      )
+    );
+    expect(reactElementToJSXString(<Tag text="some label" />)).toEqual(
+      `<Tag text="some label" />`
+    );
+  });
+
+  it('should stringify `StrictMode` correctly', () => {
+    const App = () => null;
+
+    expect(
+      reactElementToJSXString(
+        <React.StrictMode>
+          <App />
+        </React.StrictMode>
+      )
+    ).toEqual(`<StrictMode>
+  <App />
+</StrictMode>`);
+  });
+
+  it('should stringify `Suspense` correctly', () => {
+    const Spinner = () => null;
+    const ProfilePage = () => null;
+
+    expect(
+      reactElementToJSXString(
+        <React.Suspense fallback={<Spinner />}>
+          <ProfilePage />
+        </React.Suspense>
+      )
+    ).toEqual(`<Suspense fallback={<Spinner />}>
+  <ProfilePage />
+</Suspense>`);
+  });
+
+  it('should stringify `Profiler` correctly', () => {
+    const Navigation = () => null;
+
+    expect(
+      reactElementToJSXString(
+        <React.Profiler id="Navigation" onRender={() => {}}>
+          <Navigation />
+        </React.Profiler>
+      )
+    ).toEqual(`<Profiler
+  id="Navigation"
+  onRender={function noRefCheck() {}}
+>
+  <Navigation />
+</Profiler>`);
+  });
+
+  it('should stringify `Contex.Provider` correctly', () => {
+    const Ctx = React.createContext();
+    const App = () => {};
+
+    expect(
+      reactElementToJSXString(
+        <Ctx.Provider value={null}>
+          <App />
+        </Ctx.Provider>
+      )
+    ).toEqual(`<Context.Provider value={null}>
+  <App />
+</Context.Provider>`);
+  });
+
+  it('should stringify `Contex.Provider` with `displayName` correctly', () => {
+    const Ctx = React.createContext();
+    Ctx.displayName = 'MyCtx';
+
+    const App = () => {};
+
+    expect(
+      reactElementToJSXString(
+        <Ctx.Provider value={null}>
+          <App />
+        </Ctx.Provider>
+      )
+    ).toEqual(`<MyCtx.Provider value={null}>
+  <App />
+</MyCtx.Provider>`);
+  });
+
+  it('should stringify `Contex.Consumer` correctly', () => {
+    const Ctx = React.createContext();
+    const Button = () => null;
+
+    expect(
+      reactElementToJSXString(
+        <Ctx.Consumer>{theme => <Button theme={theme} />}</Ctx.Consumer>
+      )
+    ).toEqual(`<Context.Consumer />`);
+  });
+
+  it('should stringify `Contex.Consumer` with `displayName` correctly', () => {
+    const Ctx = React.createContext();
+    Ctx.displayName = 'MyCtx';
+
+    const Button = () => null;
+
+    expect(
+      reactElementToJSXString(
+        <Ctx.Consumer>{theme => <Button theme={theme} />}</Ctx.Consumer>
+      )
+    ).toEqual(`<MyCtx.Consumer />`);
+  });
+
+  it('should stringify `lazy` component correctly', () => {
+    const Lazy = React.lazy(() => Promise.resolve(() => {}));
+
+    expect(reactElementToJSXString(<Lazy />)).toEqual(`<Lazy />`);
+  });
 });
diff --git a/src/parser/parseReactElement.js b/src/parser/parseReactElement.js
@@ -1,6 +1,18 @@
 /* @flow */
 
 import React, { type Element as ReactElement, Fragment } from 'react';
+import {
+  ForwardRef,
+  isContextConsumer,
+  isContextProvider,
+  isForwardRef,
+  isLazy,
+  isMemo,
+  isProfiler,
+  isStrictMode,
+  isSuspense,
+  Memo,
+} from 'react-is';
 import type { Options } from './../options';
 import {
   createStringTreeNode,
@@ -12,12 +24,56 @@ import type { TreeNode } from './../tree';
 
 const supportFragment = Boolean(Fragment);
 
-const getReactElementDisplayName = (element: ReactElement<*>): string =>
-  element.type.displayName ||
-  (element.type.name !== '_default' ? element.type.name : null) || // function name
-  (typeof element.type === 'function' // function without a name, you should provide one
-    ? 'No Display Name'
-    : element.type);
+const getFunctionTypeName = (functionType): string => {
+  if (!functionType.name || functionType.name === '_default') {
+    return 'No Display Name';
+  }
+  return functionType.name;
+};
+
+const getWrappedComponentDisplayName = (Component: *): string => {
+  switch (true) {
+    case Boolean(Component.displayName):
+      return Component.displayName;
+    case Component.$$typeof === Memo:
+      return getWrappedComponentDisplayName(Component.type);
+    case Component.$$typeof === ForwardRef:
+      return getWrappedComponentDisplayName(Component.render);
+    default:
+      return getFunctionTypeName(Component);
+  }
+};
+
+// heavily inspired by:
+// https://github.com/facebook/react/blob/3746eaf985dd92f8aa5f5658941d07b6b855e9d9/packages/react-devtools-shared/src/backend/renderer.js#L399-L496
+const getReactElementDisplayName = (element: ReactElement<*>): string => {
+  switch (true) {
+    case typeof element.type === 'string':
+      return element.type;
+    case typeof element.type === 'function':
+      if (element.type.displayName) {
+        return element.type.displayName;
+      }
+      return getFunctionTypeName(element.type);
+    case isForwardRef(element):
+    case isMemo(element):
+      return getWrappedComponentDisplayName(element.type);
+    case isContextConsumer(element):
+      return `${element.type._context.displayName || 'Context'}.Consumer`;
+    case isContextProvider(element):
+      return `${element.type._context.displayName || 'Context'}.Provider`;
+    case isLazy(element):
+      return 'Lazy';
+    case isProfiler(element):
+      return 'Profiler';
+    case isStrictMode(element):
+      return 'StrictMode';
+    case isSuspense(element):
+      return 'Suspense';
+    default:
+      return 'UnknownElementType';
+  }
+};
 
 const noChildren = (propsValue, propName) => propName !== 'children';
 
diff --git a/yarn.lock b/yarn.lock
