|
| 1 | +# react-native-postmessage-cat |
| 2 | + |
| 3 | +> Based on [linonetwo/electron-ipc-cat](https://github.com/linonetwo/electron-ipc-cat), and used in [TidGi-Mobile](https://github.com/tiddly-gittly/TidGi-Mobile]). |
| 4 | +
|
| 5 | +<p align="center" style="color: #343a40"> |
| 6 | + <img src="docs/image/title-image.png" alt="electron-ipc-cat logo"> |
| 7 | + <h1 align="center">react-native-postmessage-cat</h1> |
| 8 | +</p> |
| 9 | +<p align="center" style="font-size: 1.2rem;">Passing object and type between React Native main process and WebView process simply via proxy.</p> |
| 10 | + |
| 11 | +## Overview |
| 12 | + |
| 13 | +In latest react-native-webview, the `injectedJavaScriptBeforeContentLoaded` accepts stringified code, and you are required to passing data using postMessage. It requires tons of boilerplate code to build up this message bridge, just like the vanilla Redux. |
| 14 | + |
| 15 | +Luckily we have frankwallis/electron-ipc-proxy which provide a good example about how to automatically build IPC channel for a class in the main process. But it doesn't work in react native, so here we have `react-native-postmessage-cat`! |
| 16 | + |
| 17 | +We wrap our react native side class, and can use them from the `window.xxx` in the webview. All types are preserved, so you can get typescript intellisense just like using a local function. |
| 18 | + |
| 19 | +## Install |
| 20 | + |
| 21 | +```sh |
| 22 | +pnpm i react-native-postmessage-cat |
| 23 | +``` |
| 24 | + |
| 25 | +## Example |
| 26 | + |
| 27 | +Real use case in [TidGi-Mobile's sync-adaptor](https://github.com/tiddly-gittly/TidGi-Mobile) |
| 28 | + |
| 29 | +### 1. The class |
| 30 | + |
| 31 | +```ts |
| 32 | +/** workspaces.ts */ |
| 33 | +export class Workspace implements IWorkspaceService { |
| 34 | + /** |
| 35 | + * Record from workspace id to workspace settings |
| 36 | + */ |
| 37 | + private workspaces: Record<string, IWorkspace> = {}; |
| 38 | + public workspaces$: BehaviorSubject<Record<string, IWorkspace>>; |
| 39 | + |
| 40 | + public async getWorkspacesAsList(): Promise<IWorkspace[]> { |
| 41 | + return Object.values(this.workspaces).sort((a, b) => a.order - b.order); |
| 42 | + } |
| 43 | + |
| 44 | + public async get(id: string): Promise<IWorkspace | undefined> { |
| 45 | + return this.workspaces[id]; |
| 46 | + } |
| 47 | + |
| 48 | + public get$(id: string): Observable<IWorkspace | undefined> { |
| 49 | + return this.workspaces$.pipe(map((workspaces) => workspaces[id])); |
| 50 | + } |
| 51 | +} |
| 52 | + |
| 53 | +export interface IWorkspaceService { |
| 54 | + workspaces$: BehaviorSubject<Record<string, IWorkspace>>; |
| 55 | + getWorkspacesAsList(): Promise<IWorkspace[]>; |
| 56 | + get(id: string): Promise<IWorkspace | undefined>; |
| 57 | + get$(id: string): Observable<IWorkspace | undefined>; |
| 58 | +} |
| 59 | + |
| 60 | +export const WorkspaceServiceIPCDescriptor = { |
| 61 | + channel: WorkspaceChannel.name, |
| 62 | + properties: { |
| 63 | + workspaces$: ProxyPropertyType.Value$, |
| 64 | + getWorkspacesAsList: ProxyPropertyType.Function, |
| 65 | + get: ProxyPropertyType.Function, |
| 66 | + get$: ProxyPropertyType.Function$, |
| 67 | + }, |
| 68 | +}; |
| 69 | +``` |
| 70 | + |
| 71 | +### 2. bindServiceAndProxy in React Native side & bridge proxy in preload script |
| 72 | + |
| 73 | +```tsx |
| 74 | +/** |
| 75 | + * Provide API from main services to WebView |
| 76 | + * This file should be required by BrowserView's preload script to work |
| 77 | + */ |
| 78 | +import { useMemo } from 'react'; |
| 79 | +import webviewPreloadedJS from 'react-native-postmessage-cat/webview-string'; |
| 80 | +import { useRegisterProxy } from 'react-native-postmessage-cat/react-native'; |
| 81 | + |
| 82 | +import { WorkspaceServiceIPCDescriptor } from '@services/workspaces/interface'; |
| 83 | + |
| 84 | +const workspaceService = new WorkspaceService(); |
| 85 | + |
| 86 | +export const WikiViewer = () => { |
| 87 | + const [webViewReference] = useRegisterProxy(workspaceService, WorkspaceServiceIPCDescriptor) |
| 88 | + const preloadScript = useMemo(() =>` |
| 89 | + ${webviewPreloadedJS} |
| 90 | + true; // note: this is required, or you'll sometimes get silent failures |
| 91 | + `, []); |
| 92 | + return ( |
| 93 | + <WebViewContainer> |
| 94 | + <WebView |
| 95 | + source={{ html: wikiHTMLString }} |
| 96 | + onMessage={onMessage} |
| 97 | + ref={webViewReference} |
| 98 | + injectedJavaScriptBeforeContentLoaded={runFirst} |
| 99 | + /> |
| 100 | + </WebViewContainer> |
| 101 | + ); |
| 102 | +}; |
| 103 | +``` |
| 104 | + |
| 105 | +### 4. receive in JS that runs inside WebView |
| 106 | + |
| 107 | +```ts |
| 108 | +/** renderer.tsx */ |
| 109 | +import 'react-native-postmessage-cat/fixContextIsolation'; |
| 110 | + |
| 111 | + |
| 112 | +import { IWorkspace } from '@services/workspaces'; |
| 113 | +import { WorkspaceServiceIPCDescriptor } from '@services/workspaces/interface'; |
| 114 | + |
| 115 | +// `window.PostMessageCat`'s type is same as `createProxy` in `'react-native-postmessage-cat/webview'` |
| 116 | +const workspaceService = window.PostMessageCat<IWorkspace>(WorkspaceServiceIPCDescriptor) |
| 117 | + |
| 118 | +export function useWorkspacesListObservable(): IWorkspace[] | undefined { |
| 119 | + const [workspaces, workspacesSetter] = useState<IWorkspace[] | undefined>(); |
| 120 | + // beware not pipe directly in the react hock, as it will re-pipe every time React reRenders, and every time regarded as new Observable, so it will re-subscribe |
| 121 | + // useMemo will solve this |
| 122 | + const workspacesList$ = useMemo( |
| 123 | + () => workspaceService.workspaces$.pipe(map<Record<string, IWorkspace>, IWorkspace[]>((workspaces) => Object.values(workspaces))), |
| 124 | + [], |
| 125 | + ); |
| 126 | + useObservable<IWorkspace[] | undefined>(workspacesList$, workspacesSetter); |
| 127 | + return workspaces; |
| 128 | +} |
| 129 | + |
| 130 | +export function useWorkspaceObservable(id: string): IWorkspace | undefined { |
| 131 | + const [workspace, workspaceSetter] = useState<IWorkspace | undefined>(); |
| 132 | + const workspace$ = useMemo(() => workspaceService.get$(id), [id]); |
| 133 | + useObservable<IWorkspace | undefined>(workspace$, workspaceSetter); |
| 134 | + return workspace; |
| 135 | +} |
| 136 | +``` |
| 137 | + |
| 138 | +## Notes |
| 139 | + |
| 140 | +All `Values` and `Functions` will return promises on the renderer side, no matter how they have been defined on the source object. This is because communication happens asynchronously. For this reason it is recommended that you make them promises on the source object as well, so the interface is the same on both sides. |
| 141 | + |
| 142 | +Use `Value$` and `Function$` when you want to expose or return an Observable stream across IPC. |
| 143 | + |
| 144 | +Only plain objects can be passed between the 2 sides of the proxy, as the data is serialized to JSON, so no functions or prototypes will make it across to the other side. |
| 145 | + |
| 146 | +Notice the second parameter of `createProxy` - `Observable` this is done so that the library itself does not need to take on a dependency to rxjs. You need to pass in the Observable constructor yourself if you want to consume Observable streams. |
| 147 | + |
| 148 | +The channel specified must be unique and match on both sides of the proxy. |
| 149 | + |
| 150 | +The packages exposes 2 entry points in the "main" and "browser" fields of package.json. "main" is for the main thread and "browser" is for the renderer thread. |
| 151 | + |
| 152 | +## See it working |
| 153 | + |
| 154 | +[Example in TiddlyGit](https://github.com/tiddly-gittly/TiddlyGit-Desktop/blob/0c6b26c0c1113e0c66d6f49f022c5733d4fa85e8/src/preload/common/services.ts#L27-L42) |
| 155 | + |
| 156 | +## FAQ |
| 157 | + |
| 158 | +### reject string |
| 159 | + |
| 160 | +You should reject an Error, other wise `serialize-error` can't handle it well. |
| 161 | + |
| 162 | +```diff |
| 163 | +- reject(errorMessage); |
| 164 | ++ reject(new Error(errorMessage)); |
| 165 | +``` |
| 166 | + |
| 167 | +## Change Log |
0 commit comments