Add createBridge and createStore exports to react-devtools-inline (fo…

…r Replay integration) (facebook#21032)
koto · Jun 15, 2021 · b6e1b08 · b6e1b08
1 parent 29e1fbc
commit b6e1b08
Show file tree

Hide file tree

Showing 9 changed files with 91 additions and 25 deletions.
diff --git a/packages/react-devtools-core/package.json b/packages/react-devtools-core/package.json
@@ -1,6 +1,6 @@
 {
   "name": "react-devtools-core",
-  "version": "4.11.0",
+  "version": "4.12.0",
   "description": "Use react-devtools outside of the browser",
   "license": "MIT",
   "main": "./dist/backend.js",

diff --git a/packages/react-devtools-extensions/chrome/manifest.json b/packages/react-devtools-extensions/chrome/manifest.json
@@ -2,8 +2,8 @@
   "manifest_version": 2,
   "name": "React Developer Tools",
   "description": "Adds React debugging tools to the Chrome Developer Tools.",
-  "version": "4.11.0",
-  "version_name": "4.11.0",
+  "version": "4.12.0",
+  "version_name": "4.12.0",
 
   "minimum_chrome_version": "60",
 

diff --git a/packages/react-devtools-extensions/edge/manifest.json b/packages/react-devtools-extensions/edge/manifest.json
@@ -2,8 +2,8 @@
   "manifest_version": 2,
   "name": "React Developer Tools",
   "description": "Adds React debugging tools to the Microsoft Edge Developer Tools.",
-  "version": "4.11.0",
-  "version_name": "4.11.0",
+  "version": "4.12.0",
+  "version_name": "4.12.0",
 
   "minimum_chrome_version": "60",
 

diff --git a/packages/react-devtools-extensions/firefox/manifest.json b/packages/react-devtools-extensions/firefox/manifest.json
@@ -2,7 +2,7 @@
   "manifest_version": 2,
   "name": "React Developer Tools",
   "description": "Adds React debugging tools to the Firefox Developer Tools.",
-  "version": "4.11.0",
+  "version": "4.12.0",
 
   "applications": {
     "gecko": {

diff --git a/packages/react-devtools-inline/README.md b/packages/react-devtools-inline/README.md
@@ -153,6 +153,40 @@ iframe.onload = () => {
 };
 ```
 
+### Advanced integration with custom "wall"
+
+Below is an example of an advanced integration with a website like [Replay.io](https://replay.io/).
+
+```js
+import {
+  createBridge,
+  createStore,
+  initialize as createDevTools,
+} from "react-devtools-inline/frontend";
+
+// Custom Wall implementation enables serializing data
+// using an API other than window.postMessage()
+// For example...
+const wall = {
+  emit() {},
+  listen(listener) {
+    wall._listener = listener;
+  },
+  async send(event, payload) {
+    const response = await fetch(...).json();
+    wall._listener(response);
+  },
+};
+
+// Create a Bridge and Store that use the custom Wall.
+const bridge = createBridge(target, wall);
+const store = createStore(bridge);
+const DevTools = createDevTools(target, { bridge, store });
+
+// Render DevTools with it.
+<DevTools {...otherProps} />;
+```
+
 ## Local development
 You can also build and test this package from source.
 

diff --git a/packages/react-devtools-inline/package.json b/packages/react-devtools-inline/package.json
@@ -1,6 +1,6 @@
 {
   "name": "react-devtools-inline",
-  "version": "4.11.1",
+  "version": "4.12.0",
   "description": "Embed react-devtools within a website",
   "license": "MIT",
   "main": "./dist/backend.js",

diff --git a/packages/react-devtools-inline/src/frontend.js b/packages/react-devtools-inline/src/frontend.js
@@ -16,11 +16,47 @@ import {
   MESSAGE_TYPE_SAVED_PREFERENCES,
 } from './constants';
 
+import type {Wall} from 'react-devtools-shared/src/types';
 import type {FrontendBridge} from 'react-devtools-shared/src/bridge';
 import type {Props} from 'react-devtools-shared/src/devtools/views/DevTools';
 
+export function createStore(bridge: FrontendBridge): Store {
+  return new Store(bridge, {supportsTraceUpdates: true});
+}
+
+export function createBridge(
+  contentWindow: window,
+  wall?: Wall,
+): FrontendBridge {
+  if (wall == null) {
+    wall = {
+      listen(fn) {
+        const onMessage = ({data}) => {
+          fn(data);
+        };
+        window.addEventListener('message', onMessage);
+        return () => {
+          window.removeEventListener('message', onMessage);
+        };
+      },
+      send(event: string, payload: any, transferable?: Array<any>) {
+        contentWindow.postMessage({event, payload}, '*', transferable);
+      },
+    };
+  }
+
+  return (new Bridge(wall): FrontendBridge);
+}
+
 export function initialize(
   contentWindow: window,
+  {
+    bridge,
+    store,
+  }: {|
+    bridge?: FrontendBridge,
+    store?: Store,
+  |} = {},
 ): React.AbstractComponent<Props, mixed> {
   const onGetSavedPreferencesMessage = ({data, source}) => {
     if (source === 'react-devtools-content-script') {
@@ -54,22 +90,13 @@ export function initialize(
 
   window.addEventListener('message', onGetSavedPreferencesMessage);
 
-  const bridge: FrontendBridge = new Bridge({
-    listen(fn) {
-      const onMessage = ({data}) => {
-        fn(data);
-      };
-      window.addEventListener('message', onMessage);
-      return () => {
-        window.removeEventListener('message', onMessage);
-      };
-    },
-    send(event: string, payload: any, transferable?: Array<any>) {
-      contentWindow.postMessage({event, payload}, '*', transferable);
-    },
-  });
+  if (bridge == null) {
+    bridge = createBridge();
+  }
 
-  const store: Store = new Store(bridge, {supportsTraceUpdates: true});
+  if (store == null) {
+    store = createStore(bridge);
+  }
 
   const ForwardRef = forwardRef<Props, mixed>((props, ref) => (
     <DevTools ref={ref} bridge={bridge} store={store} {...props} />

diff --git a/packages/react-devtools/CHANGELOG.md b/packages/react-devtools/CHANGELOG.md
@@ -9,9 +9,14 @@
   <!-- Upcoming changes go here -->
 </details>
 
+## 4.12.0 (April 12, 2021)
+Although this release is being made for all NPM packages, only the `react-devtools-inline` package contains changes.
+#### Feature
+* Added `createBridge` and `createStore` exports to the `react-devtools-inline/frontend` entrypoint to support advanced use cases ([bvaughn](https://github.com/bvaughn) in [#21032](https://github.com/facebook/react/pull/21032))
+
 ## 4.11.1 (April 11, 2021)
 #### Bugfix
-* Fixed broken import in `react-devtools-inline` for feature flags file ([bvaughn](https://github.com/bvaughn) in [#21235](https://github.com/facebook/react/issues/21235))
+* Fixed broken import in `react-devtools-inline` for feature flags file ([bvaughn](https://github.com/bvaughn) in [#21237](https://github.com/facebook/react/pull/21237))
 
 ## 4.11.0 (April 9, 2021)
 #### Bugfix

diff --git a/packages/react-devtools/package.json b/packages/react-devtools/package.json
@@ -1,6 +1,6 @@
 {
   "name": "react-devtools",
-  "version": "4.11.0",
+  "version": "4.12.0",
   "description": "Use react-devtools outside of the browser",
   "license": "MIT",
   "repository": {
@@ -27,7 +27,7 @@
     "electron": "^11.1.0",
     "ip": "^1.1.4",
     "minimist": "^1.2.3",
-    "react-devtools-core": "4.11.0",
+    "react-devtools-core": "4.12.0",
     "update-notifier": "^2.1.0"
   }
 }