fix(bridge): warn if not in Draft Mode or Visual Editor #175
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR reintroduces a guard in storyblokRegisterEvent to warn when not in Draft Mode or the Visual Editor (based on URL search), and updates tests accordingly.
- Add a check in
loadBridgetoconsole.warnand exit early if_storyblokis missing fromwindow.location.search. - Update tests to mock
window.location.searchinstead ofwindow.parentand add a new case for the warning. - Replace old iframe-based setup with URL‐search‐based logic in two existing tests.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| packages/js/src/bridge.ts | Insert guard in storyblokRegisterEvent to warn & return when the URL lacks ?_storyblok. |
| packages/js/src/index.test.ts | Switch mocks from window.parent to window.location.search, plus add a test for the warning. |
Comments suppressed due to low confidence (1)
packages/js/src/index.test.ts:417
- Add a test for the scenario where the bridge is already loaded (
loaded === true) to verify that callbacks registered after load are invoked immediately.
it('should execute callbacks in order of registration', async () => {
| // Mock being in an iframe | ||
| Object.defineProperty(window, 'parent', { | ||
| value: { location: { href: 'http://different-origin.com' } }, | ||
| Object.defineProperty(window, 'location', { |
There was a problem hiding this comment.
Consider restoring the original window.location (e.g. in an afterEach) after mocking it, to prevent state leaks between tests.
|
|
||
| // Way to make sure all event handlers are called after loading | ||
| window.storyblokRegisterEvent = (cb: () => void) => { | ||
| if (!window.location.search.includes('_storyblok')) { |
There was a problem hiding this comment.
[nitpick] Consider using URLSearchParams (e.g., new URL(window.location.href).searchParams.has('_storyblok')) for clearer intent and robust parsing.
Suggested change
| if (!window.location.search.includes('_storyblok')) { | |
| if (!new URL(window.location.href).searchParams.has('_storyblok')) { |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The previous PR removed the
window.parentcheck, and in hindsight it should've kept it to preserve the function interface. This change reimplements it whilst defending against CSP errors.