Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add document.write() fallback #248

Draft
wants to merge 3 commits into
base: master
Choose a base branch
from
Draft

Add document.write() fallback #248

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3b03cf8
Allow falling back to document.write() for initial frame population
andrewpye Nov 2, 2023
f12e134
Add failing test for document.write fallback
andrewpye Nov 2, 2023
69ec5e8
Add documentation for new prop
andrewpye Nov 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,13 @@ The `mountTarget` props is a css selector (#target/.target) that specifies where
</Frame>
```

###### dangerouslyUseDocWrite
`dangerouslyUseDocWrite: PropTypes.bool`

Defaults to `false`

The frame's initial content, as defined by the `initialContent` prop, is populated via the frame's `srcdoc` attribute by default. However, this can cause issues with some libraries such as Recaptcha and Google Maps that depend on the frame's location/origin. In these cases, setting this flag will cause `Frame` to use `document.write()` to populate the initial content. This is **unperformant and unrecommended**, but allows these libraries to be used inside a `Frame` instance.

###### contentDidMount and contentDidUpdate
`contentDidMount: PropTypes.func`
`contentDidUpdate: PropTypes.func`
Expand Down
15 changes: 14 additions & 1 deletion src/Frame.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ export class Frame extends Component {
head: PropTypes.node,
initialContent: PropTypes.string,
mountTarget: PropTypes.string,
dangerouslyUseDocWrite: PropTypes.bool,
contentDidMount: PropTypes.func,
contentDidUpdate: PropTypes.func,
children: PropTypes.oneOfType([
Expand All @@ -27,6 +28,7 @@ export class Frame extends Component {
head: null,
children: undefined,
mountTarget: undefined,
dangerouslyUseDocWrite: false,
contentDidMount: () => {},
contentDidUpdate: () => {},
initialContent:
Expand Down Expand Up @@ -126,6 +128,12 @@ export class Frame extends Component {
</Content>
);

if (this.props.dangerouslyUseDocWrite && doc.body.children.length < 1) {
doc.open('text/html', 'replace');
doc.write(this.props.initialContent);
doc.close();
}

const mountTarget = this.getMountTarget();

return [
Expand All @@ -137,12 +145,17 @@ export class Frame extends Component {
render() {
const props = {
...this.props,
srcDoc: this.props.initialContent,
children: undefined // The iframe isn't ready so we drop children from props here. #12, #17
};

if (!this.props.dangerouslyUseDocWrite) {
props.srcDoc = this.props.initialContent;
}

delete props.head;
delete props.initialContent;
delete props.mountTarget;
delete props.dangerouslyUseDocWrite;
delete props.contentDidMount;
delete props.contentDidUpdate;
delete props.forwardedRef;
Expand Down
21 changes: 21 additions & 0 deletions test/Frame.spec.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -253,6 +253,27 @@ describe('The Frame Component', () => {
);
});

it.only('should allow setting initialContent via document.write() when required', done => {
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ryanseddon this test fails because contentDidMount isn't being triggered when using document.write(). I had a look through the discussions on #206 and #207 and got quite confused about what needs to be done in this situation 😅 Do you have any pointers to share to resolve this?

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok so got this working by working backwards and comparing v4.x.x to latest and seeing what the diff was, you might be able to tidy this up and it may have redundant checks

The main thing with test is doc.write was synchronous and didn't need the async done function passed in.

diff --git a/src/Frame.jsx b/src/Frame.jsx
index 151fa4e..91442c4 100644
--- a/src/Frame.jsx
+++ b/src/Frame.jsx
@@ -47,11 +47,20 @@ export class Frame extends Component {
 
     const doc = this.getDoc();
 
-    if (doc) {
-      this.nodeRef.current.contentWindow.addEventListener(
-        'DOMContentLoaded',
-        this.handleLoad
-      );
+    if (!this.props.dangerouslyUseDocWrite) {
+      if (doc) {
+        this.nodeRef.current.contentWindow.addEventListener(
+          'DOMContentLoaded',
+          this.handleLoad
+        );
+      }
+    } else {
+      // eslint-disable-next-line no-lonely-if
+      if (doc && doc.readyState === 'complete') {
+        this.forceUpdate();
+      } else {
+        this.nodeRef.addEventListener('load', this.handleLoad);
+      }
     }
   }
 
@@ -62,6 +71,8 @@ export class Frame extends Component {
       'DOMContentLoaded',
       this.handleLoad
     );
+
+    this.nodeRef.removeEventListener('load', this.handleLoad);
   }
 
   getDoc() {
@@ -76,7 +87,7 @@ export class Frame extends Component {
     return doc.body.children[0];
   }
 
-  setRef = node => {
+  setRef = (node) => {
     this.nodeRef.current = node;
 
     const { forwardedRef } = this.props; // eslint-disable-line react/prop-types
@@ -88,10 +99,14 @@ export class Frame extends Component {
   };
 
   handleLoad = () => {
-    clearInterval(this.loadCheck);
-    // Bail update as some browsers will trigger on both DOMContentLoaded & onLoad ala firefox
-    if (!this.state.iframeLoaded) {
-      this.setState({ iframeLoaded: true });
+    if (this.props.dangerouslyUseDocWrite) {
+      this.forceUpdate();
+    } else {
+      clearInterval(this.loadCheck);
+      // Bail update as some browsers will trigger on both DOMContentLoaded & onLoad ala firefox
+      if (!this.state.iframeLoaded) {
+        this.setState({ iframeLoaded: true });
+      }
     }
   };
 
@@ -150,6 +165,7 @@ export class Frame extends Component {
 
     if (!this.props.dangerouslyUseDocWrite) {
       props.srcDoc = this.props.initialContent;
+      props.onLoad = this.handleLoad;
     }
 
     delete props.head;
@@ -161,8 +177,10 @@ export class Frame extends Component {
     delete props.forwardedRef;
 
     return (
-      <iframe {...props} ref={this.setRef} onLoad={this.handleLoad}>
-        {this.state.iframeLoaded && this.renderFrameContents()}
+      <iframe {...props} ref={this.setRef}>
+        {this.props.dangerouslyUseDocWrite
+          ? this.renderFrameContents()
+          : this.state.iframeLoaded && this.renderFrameContents()}
       </iframe>
     );
   }
diff --git a/test/Frame.spec.jsx b/test/Frame.spec.jsx
index 6e8b784..cb34daa 100644
--- a/test/Frame.spec.jsx
+++ b/test/Frame.spec.jsx
@@ -253,7 +253,7 @@ describe('The Frame Component', () => {
     );
   });
 
-  it.only('should allow setting initialContent via document.write() when required', done => {
+  it.only('should allow setting initialContent via document.write() when required', () => {
     div = document.body.appendChild(document.createElement('div'));
 
     const initialContent =
@@ -261,17 +261,12 @@ describe('The Frame Component', () => {
     const renderedContent =
       '<html><head><script>console.log("foo");</script></head><body><div><div class="frame-content"></div></div></body></html>';
     const frame = ReactDOM.render(
-      <Frame
-        dangerouslyUseDocWrite
-        initialContent={initialContent}
-        contentDidMount={() => {
-          const doc = ReactDOM.findDOMNode(frame).contentDocument;
-          expect(doc.documentElement.outerHTML).to.equal(renderedContent);
-          done();
-        }}
-      />,
+      <Frame dangerouslyUseDocWrite initialContent={initialContent} />,
       div
     );
+    const doc = ReactDOM.findDOMNode(frame).contentDocument;
+    expect(doc.documentElement.outerHTML).to.equal(renderedContent);
+  
   });
 
   it('should allow setting mountTarget', done => {

div = document.body.appendChild(document.createElement('div'));

const initialContent =
'<!DOCTYPE html><html><head><script>console.log("foo");</script></head><body><div></div></body></html>';
const renderedContent =
'<html><head><script>console.log("foo");</script></head><body><div><div class="frame-content"></div></div></body></html>';
const frame = ReactDOM.render(
<Frame
dangerouslyUseDocWrite
initialContent={initialContent}
contentDidMount={() => {
const doc = ReactDOM.findDOMNode(frame).contentDocument;
expect(doc.documentElement.outerHTML).to.equal(renderedContent);
done();
}}
/>,
div
);
});

it('should allow setting mountTarget', done => {
div = document.body.appendChild(document.createElement('div'));

Expand Down
Loading