From 7e0ee61c03114151abe76a8e321aa012b246259b Mon Sep 17 00:00:00 2001
From: Trish Ta <trish.ta@shopify.com>
Date: Fri, 6 Sep 2024 23:05:13 -0400
Subject: [PATCH] demo of iframe with contentWindow.postMessage

---
 examples/kitchen-sink/app/host.tsx            | 10 +++++-
 examples/kitchen-sink/app/host/components.tsx | 31 ++++++++++++++++++-
 examples/kitchen-sink/app/remote/elements.ts  | 24 +++++++++++++-
 .../app/remote/examples/vanilla.ts            | 17 ++++++++++
 examples/kitchen-sink/app/style.css           |  1 -
 packages/core/source/connection.ts            | 18 +++++++++++
 .../core/source/elements/RemoteElement.ts     |  6 ++++
 .../source/elements/RemoteReceiverElement.ts  |  1 +
 packages/core/source/elements/internals.ts    | 15 +++++++++
 packages/core/source/polyfill.ts              |  5 +++
 .../source/receivers/DOMRemoteReceiver.ts     |  4 +++
 .../core/source/receivers/RemoteReceiver.ts   |  6 ++++
 packages/core/source/types.ts                 |  6 ++++
 packages/preact/source/host/component.tsx     | 17 ++++++++--
 .../signals/source/SignalRemoteReceiver.ts    |  7 +++++
 15 files changed, 162 insertions(+), 6 deletions(-)

diff --git a/examples/kitchen-sink/app/host.tsx b/examples/kitchen-sink/app/host.tsx
index 5664b6d7..262da637 100644
--- a/examples/kitchen-sink/app/host.tsx
+++ b/examples/kitchen-sink/app/host.tsx
@@ -7,7 +7,14 @@ import {
 import {ThreadIframe, ThreadWebWorker} from '@quilted/threads';
 
 import type {SandboxAPI} from './types.ts';
-import {Button, Modal, Stack, Text, ControlPanel} from './host/components.tsx';
+import {
+  Button,
+  Modal,
+  Stack,
+  Text,
+  ControlPanel,
+  Iframe,
+} from './host/components.tsx';
 import {createState} from './host/state.ts';
 
 // We will put any remote elements we want to render in this root element.
@@ -42,6 +49,7 @@ const components = new Map([
   ['ui-button', createRemoteComponentRenderer(Button)],
   ['ui-stack', createRemoteComponentRenderer(Stack)],
   ['ui-modal', createRemoteComponentRenderer(Modal)],
+  ['ui-iframe', createRemoteComponentRenderer(Iframe)],
   // The `remote-fragment` element is a special element created by Remote DOM when
   // it needs an unstyled container for a list of elements. This is primarily used
   // to convert elements passed as a prop to React or Preact components into a slotted
diff --git a/examples/kitchen-sink/app/host/components.tsx b/examples/kitchen-sink/app/host/components.tsx
index b22f62f2..496c1e21 100644
--- a/examples/kitchen-sink/app/host/components.tsx
+++ b/examples/kitchen-sink/app/host/components.tsx
@@ -1,6 +1,6 @@
 import {type ComponentChildren} from 'preact';
 import {forwardRef} from 'preact/compat';
-import {useRef, useImperativeHandle} from 'preact/hooks';
+import {useRef, useImperativeHandle, useEffect} from 'preact/hooks';
 import type {Signal} from '@preact/signals';
 
 import type {
@@ -233,3 +233,32 @@ function nanoId(size = 21) {
   }
   return id;
 }
+
+export function Iframe({src, onReady}: {src: string; onReady: any}) {
+  const iframe = useRef<HTMLIFrameElement | null>(null);
+
+  useEffect(() => {
+    const iframeRef = iframe.current;
+    if (!iframeRef || !iframeRef.contentWindow) {
+      return;
+    }
+    iframeRef.addEventListener('message', (event) => {
+      const origin = new URL(src).origin;
+      iframeRef.contentWindow?.postMessage(event.data, origin);
+    });
+  }, []);
+
+  return (
+    <iframe
+      style={{outline: 'none', height: '100%', width: '100%', border: 'none'}}
+      ref={iframe}
+      src={src}
+      onLoad={() => {
+        // onload should be called only after the app bridge handshake happens, this is just an artificial delay
+        setTimeout(() => {
+          onReady?.(new Event('ready'));
+        }, 100);
+      }}
+    />
+  );
+}
diff --git a/examples/kitchen-sink/app/remote/elements.ts b/examples/kitchen-sink/app/remote/elements.ts
index 940dd067..ef12a420 100644
--- a/examples/kitchen-sink/app/remote/elements.ts
+++ b/examples/kitchen-sink/app/remote/elements.ts
@@ -1,8 +1,9 @@
 import {
   createRemoteElement,
+  RemoteEvent,
   RemoteRootElement,
   RemoteFragmentElement,
-  type RemoteEvent,
+  RemoteElement,
 } from '@remote-dom/core/elements';
 
 import type {
@@ -12,6 +13,7 @@ import type {
   ModalMethods,
   StackProperties,
 } from '../types.ts';
+import {dispatchEventToHost} from '../../../../packages/core/source/elements/internals.ts';
 
 // In this file we will define the custom elements that can be rendered in the
 // remote environment. Note that none of these elements have any real implementation —
@@ -19,6 +21,24 @@ import type {
 // The host environment contains the actual implementation of these elements (in this case,
 // they have been implemented using Preact, in the `host/components.tsx` file).
 
+export class Iframe extends RemoteElement {
+  static get remoteAttributes() {
+    return ['src'];
+  }
+
+  static get remoteEvents() {
+    return ['ready'];
+  }
+
+  get contentWindow() {
+    return {
+      postMessage: (data: any) => {
+        dispatchEventToHost(this, 'message', {data});
+      },
+    };
+  }
+}
+
 export const Text = createRemoteElement<TextProperties>({
   properties: {
     emphasis: {type: Boolean},
@@ -56,6 +76,7 @@ customElements.define('ui-text', Text);
 customElements.define('ui-button', Button);
 customElements.define('ui-modal', Modal);
 customElements.define('ui-stack', Stack);
+customElements.define('ui-iframe', Iframe);
 
 declare global {
   interface HTMLElementTagNameMap {
@@ -63,6 +84,7 @@ declare global {
     'ui-button': InstanceType<typeof Button>;
     'ui-stack': InstanceType<typeof Stack>;
     'ui-modal': InstanceType<typeof Modal>;
+    'ui-iframe': InstanceType<typeof Iframe>;
   }
 }
 
diff --git a/examples/kitchen-sink/app/remote/examples/vanilla.ts b/examples/kitchen-sink/app/remote/examples/vanilla.ts
index f3c4ebf4..356e2551 100644
--- a/examples/kitchen-sink/app/remote/examples/vanilla.ts
+++ b/examples/kitchen-sink/app/remote/examples/vanilla.ts
@@ -19,6 +19,9 @@ export function renderUsingVanillaDOM(root: Element, api: RenderAPI) {
   function updateCount(newCount: number) {
     count = newCount;
     countText.textContent = String(count);
+    iframe.contentWindow?.postMessage({
+      count,
+    });
   }
 
   function handlePrimaryAction() {
@@ -38,6 +41,7 @@ export function renderUsingVanillaDOM(root: Element, api: RenderAPI) {
       <ui-button slot="primaryAction">
         Close
       </ui-button>
+      <ui-iframe/>
     </ui-modal>
   `.trim();
 
@@ -45,6 +49,19 @@ export function renderUsingVanillaDOM(root: Element, api: RenderAPI) {
     typeof Modal
   >;
 
+  const iframe = template.querySelector('ui-iframe');
+
+  iframe.addEventListener('ready', () => {
+    iframe.contentWindow?.postMessage({
+      count,
+    });
+  });
+
+  iframe.setAttribute(
+    'src',
+    'https://emacs-since-invention-shannon.trycloudflare.com/app',
+  );
+
   modal.addEventListener('close', handleClose);
 
   modal.querySelector('ui-text')!.append(countText);
diff --git a/examples/kitchen-sink/app/style.css b/examples/kitchen-sink/app/style.css
index 1890e081..11b7f1df 100644
--- a/examples/kitchen-sink/app/style.css
+++ b/examples/kitchen-sink/app/style.css
@@ -186,7 +186,6 @@ li {
   display: grid;
   gap: 1rem;
   padding: 1rem;
-  justify-content: start;
 }
 
 .Modal-Actions {
diff --git a/packages/core/source/connection.ts b/packages/core/source/connection.ts
index 6631c5c6..6ca90ebb 100644
--- a/packages/core/source/connection.ts
+++ b/packages/core/source/connection.ts
@@ -15,6 +15,11 @@ import type {
 export type {RemoteConnection};
 
 export interface RemoteConnectionHandler {
+  /**
+   * Triggers events on the host component.
+   */
+  dispatchEvent: <E extends Event>(id: string, event: E) => void;
+
   /**
    * Handles the `call()` operation on the `RemoteConnection`.
    */
@@ -62,6 +67,7 @@ export interface RemoteConnectionHandler {
  * naming on top of the protocol.
  */
 export function createRemoteConnection({
+  dispatchEvent,
   call,
   insertChild,
   removeChild,
@@ -76,6 +82,9 @@ export function createRemoteConnection({
   };
 
   return {
+    dispatchEvent: (id, type, details) => {
+      dispatchEvent(id, constructEvent(type, details));
+    },
     call,
     mutate(records) {
       for (const [type, ...args] of records) {
@@ -84,3 +93,12 @@ export function createRemoteConnection({
     },
   };
 }
+
+export function constructEvent(type: string, eventDict: Record<string, any>) {
+  switch (type) {
+    case 'message':
+      return new MessageEvent(type, eventDict);
+    default:
+      return new Event(type, eventDict);
+  }
+}
diff --git a/packages/core/source/elements/RemoteElement.ts b/packages/core/source/elements/RemoteElement.ts
index 816ec90a..f822db13 100644
--- a/packages/core/source/elements/RemoteElement.ts
+++ b/packages/core/source/elements/RemoteElement.ts
@@ -636,6 +636,12 @@ export abstract class RemoteElement<
 
     Object.defineProperties(this, propertyDescriptors);
     Object.assign(this, initialPropertiesToSet);
+
+    // this.contentWindow = {
+    //   postMessage: (data: any) => {
+    //     dispatchEventToHost(this, 'message', data);
+    //   },
+    // };
   }
 
   attributeChangedCallback(attribute: string, _oldValue: any, newValue: any) {
diff --git a/packages/core/source/elements/RemoteReceiverElement.ts b/packages/core/source/elements/RemoteReceiverElement.ts
index ac68776f..ddc99ca5 100644
--- a/packages/core/source/elements/RemoteReceiverElement.ts
+++ b/packages/core/source/elements/RemoteReceiverElement.ts
@@ -76,6 +76,7 @@ export class RemoteReceiverElement extends HTMLElement {
 
     const receiver = new DOMRemoteReceiver({
       root: this,
+      dispatchEvent: receiver.dispatchEvent,
       call: (element, method, ...args) =>
         this.call
           ? this.call(element, method, ...args)
diff --git a/packages/core/source/elements/internals.ts b/packages/core/source/elements/internals.ts
index 8a680846..6b0112fa 100644
--- a/packages/core/source/elements/internals.ts
+++ b/packages/core/source/elements/internals.ts
@@ -301,3 +301,18 @@ export function callRemoteElementMethod(
 
   return connection.call(id, method, ...args);
 }
+
+export function dispatchEventToHost(
+  node: Element,
+  type: string,
+  details: Record<string, any>,
+) {
+  const id = REMOTE_IDS.get(node);
+  const connection = REMOTE_CONNECTIONS.get(node);
+
+  if (id == null || connection == null) {
+    throw new Error('node not found or not connected');
+  }
+
+  return connection.dispatchEvent(id, type, details);
+}
diff --git a/packages/core/source/polyfill.ts b/packages/core/source/polyfill.ts
index 6f166d8c..f6e3c254 100644
--- a/packages/core/source/polyfill.ts
+++ b/packages/core/source/polyfill.ts
@@ -73,3 +73,8 @@ hooks.removeAttribute = (element, name) => {
 };
 
 export {hooks, window, type Hooks};
+
+// Object.defineProperty(window, 'HTMLIFrameElement', {
+//   value: HTMLIFrameElement,
+//   configurable: true,
+// });
diff --git a/packages/core/source/receivers/DOMRemoteReceiver.ts b/packages/core/source/receivers/DOMRemoteReceiver.ts
index 0962b9c6..25199ee6 100644
--- a/packages/core/source/receivers/DOMRemoteReceiver.ts
+++ b/packages/core/source/receivers/DOMRemoteReceiver.ts
@@ -95,6 +95,10 @@ export class DOMRemoteReceiver {
     const destroyTimeouts = new Map<string, number>();
 
     this.connection = createRemoteConnection({
+      dispatchEvent: (id, event) => {
+        const implementation = attached.get(id) as Node;
+        implementation.dispatchEvent(event);
+      },
       call: (id, method, ...args) => {
         const element =
           id === ROOT_ID && this.root.nodeType !== 11
diff --git a/packages/core/source/receivers/RemoteReceiver.ts b/packages/core/source/receivers/RemoteReceiver.ts
index de0bd2b1..b88554c7 100644
--- a/packages/core/source/receivers/RemoteReceiver.ts
+++ b/packages/core/source/receivers/RemoteReceiver.ts
@@ -144,6 +144,12 @@ export class RemoteReceiver {
     const {attached, parents, subscribers} = this;
 
     this.connection = createRemoteConnection({
+      dispatchEvent: (id, type, details) => {
+        const element = attached.get(id);
+        if (element) {
+          element.dispatchEvent(new Event(type, {...details}));
+        }
+      },
       call: (id, method, ...args) => {
         const implementation = this.implementations.get(id);
         const implementationMethod = implementation?.[method];
diff --git a/packages/core/source/types.ts b/packages/core/source/types.ts
index ab690e4c..d6173a00 100644
--- a/packages/core/source/types.ts
+++ b/packages/core/source/types.ts
@@ -133,6 +133,12 @@ export interface RemoteConnection {
    * @returns The return value of the method.
    */
   call(id: string, method: string, ...args: readonly unknown[]): unknown;
+
+  dispatchEvent(
+    id: string,
+    type: string,
+    details: Record<string, any>,
+  ): unknown;
 }
 
 /**
diff --git a/packages/preact/source/host/component.tsx b/packages/preact/source/host/component.tsx
index e8e4f338..d12df6cf 100644
--- a/packages/preact/source/host/component.tsx
+++ b/packages/preact/source/host/component.tsx
@@ -1,5 +1,11 @@
 import type {ComponentType} from 'preact';
-import {memo, useRef, useEffect, type MutableRefObject} from 'preact/compat';
+import {
+  memo,
+  useRef,
+  useEffect,
+  type MutableRefObject,
+  findDOMNode,
+} from 'preact/compat';
 import type {RemoteReceiverElement} from '@remote-dom/core/receivers';
 
 import {
@@ -112,7 +118,14 @@ export function createRemoteComponentRenderer<
       };
     }, [id, receiver]);
 
-    return <Component ref={internalsRef.current.instanceRef} {...props} />;
+    return (
+      <Component
+        ref={(node) => {
+          internalsRef.current.instanceRef.current = findDOMNode(node) || node;
+        }}
+        {...props}
+      />
+    );
   });
 
   RemoteComponentRenderer.displayName =
diff --git a/packages/signals/source/SignalRemoteReceiver.ts b/packages/signals/source/SignalRemoteReceiver.ts
index 91dd49c4..8ade3a3b 100644
--- a/packages/signals/source/SignalRemoteReceiver.ts
+++ b/packages/signals/source/SignalRemoteReceiver.ts
@@ -138,6 +138,12 @@ export class SignalRemoteReceiver {
     const {attached, parents} = this;
 
     const baseConnection = createRemoteConnection({
+      dispatchEvent: (id, event) => {
+        const implementation = this.implementations.get(
+          id,
+        ) as unknown as Element;
+        implementation.dispatchEvent(event);
+      },
       call: (id, method, ...args) => {
         const implementation = this.implementations.get(id);
         const implementationMethod = implementation?.[method];
@@ -232,6 +238,7 @@ export class SignalRemoteReceiver {
     });
 
     this.connection = {
+      dispatchEvent: baseConnection.dispatchEvent,
       call: baseConnection.call,
       mutate(records) {
         batch(() => {