Skip to content

Components: refactor Sandbox to pass exhaustive-deps #44378

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

Merged
chad1008 merged 6 commits into from
Sep 27, 2022
Merged

Components: refactor Sandbox to pass exhaustive-deps #44378

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
a48e6c1
Sandbox: protect against `ref.current` changing before cleanup
chad1008 Sep 22, 2022
bf85c94
Sandbox: wrap `trySandbox` in `useCallback`
chad1008 Sep 22, 2022
9e9543d
Components: update CHANGELOG
chad1008 Sep 22, 2022
eab474c
Sandbox: ignore exhaustive-deps warning in native file
chad1008 Sep 22, 2022
eec8709
Sandbox: applly es-lint ignore to useEffect deps warnings. Update ifr…
chad1008 Sep 26, 2022
359be08
Components: update CHANGELOG
chad1008 Sep 26, 2022
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
Next Next commit
Sandbox: protect against ref.current changing before cleanup
  • Loading branch information
@chad1008
chad1008 committed Sep 26, 2022
commit a48e6c11bb639612d7027d00d35f8c2f752a0b82
8 changes: 3 additions & 5 deletions packages/components/src/sandbox/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,12 +215,10 @@ export default function Sandbox( {
ref.current.addEventListener( 'load', tryNoForceSandbox, false );
defaultView.addEventListener( 'message', checkMessageForResize );

const iframeRef = ref.current;
Copy link
Contributor

@ciampo ciampo Sep 23, 2022

Choose a reason for hiding this comment

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

We should probably declare this variable a few lines up, and use it also instead for the ref.current.addEventListener call?

Copy link
Contributor

@ciampo ciampo Sep 23, 2022

Choose a reason for hiding this comment

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

diff --git a/packages/components/src/sandbox/index.js b/packages/components/src/sandbox/index.js
index 6bf9669613..67929c6e4e 100644
--- a/packages/components/src/sandbox/index.js
+++ b/packages/components/src/sandbox/index.js
@@ -205,22 +205,19 @@ export default function Sandbox( {
 			setHeight( data.height );
 		}
 
-		const { ownerDocument } = ref.current;
+		const iframe = ref.current;
+		const { ownerDocument } = iframe;
 		const { defaultView } = ownerDocument;
 
 		// This used to be registered using <iframe onLoad={} />, but it made the iframe blank
 		// after reordering the containing block. See these two issues for more details:
 		// https://github.com/WordPress/gutenberg/issues/6146
 		// https://github.com/facebook/react/issues/18752
-		ref.current.addEventListener( 'load', tryNoForceSandbox, false );
+		iframe.addEventListener( 'load', tryNoForceSandbox, false );
 		defaultView.addEventListener( 'message', checkMessageForResize );
 
 		return () => {
-			ref.current?.removeEventListener(
-				'load',
-				tryNoForceSandbox,
-				false
-			);
+			iframe?.removeEventListener( 'load', tryNoForceSandbox, false );
 			defaultView.addEventListener( 'message', checkMessageForResize );
 		};
 	}, [] );

Copy link
Contributor Author

@chad1008 chad1008 Sep 26, 2022

Choose a reason for hiding this comment

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

Good point! I'll hold off on this for now, since we're going with ignore-rule comments instead for the time being, but thank you for sharing it with me!

Copy link
Contributor Author

@chad1008 chad1008 Sep 26, 2022

Choose a reason for hiding this comment

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

...actually, scratch that. I've included this change in PR, as it isn't subject to the same complications as the useEffect dependencies.


return () => {
ref.current?.removeEventListener(
'load',
tryNoForceSandbox,
false
);
iframeRef?.removeEventListener( 'load', tryNoForceSandbox, false );
defaultView.addEventListener( 'message', checkMessageForResize );
};
}, [] );
Expand Down