Make highlight visibility state work in a multi-guest world #3830
There are no files selected for viewing
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -86,7 +86,6 @@ describe('Guest', () => { | |
| createChannel: sinon.stub(), | ||
| destroy: sinon.stub(), | ||
| on: sinon.stub(), | ||
| }; | ||
| FakeBridge = sinon.stub().returns(fakeBridge); | ||
|
|
||
|
|
@@ -406,18 +405,18 @@ describe('Guest', () => { | |
| }); | ||
| }); | ||
|
|
||
| describe('on "setHighlightsVisible" event', () => { | ||
| it('sets visibility of highlights in document', () => { | ||
| const guest = createGuest(); | ||
|
|
||
| emitSidebarEvent('setHighlightsVisible', true); | ||
| assert.calledWith( | ||
| highlighter.setHighlightsVisible, | ||
| guest.element, | ||
| true | ||
| ); | ||
|
|
||
| emitSidebarEvent('setHighlightsVisible', false); | ||
| assert.calledWith( | ||
| highlighter.setHighlightsVisible, | ||
| guest.element, | ||
|
|
@@ -436,7 +435,7 @@ describe('Guest', () => { | |
| beforeEach(() => { | ||
| fakeSidebarFrame = null; | ||
| guest = createGuest(); | ||
| guest.setHighlightsVisible(true); | ||
| rootElement = guest.element; | ||
|
|
||
| // Create a fake highlight as a target for hover and click events. | ||
|
|
@@ -519,7 +518,7 @@ describe('Guest', () => { | |
| }); | ||
|
|
||
| it('does not focus or select annotations in the sidebar if highlights are hidden', () => { | ||
| guest.setHighlightsVisible(false); | ||
|
|
||
| fakeHighlight.dispatchEvent(new Event('mouseover', { bubbles: true })); | ||
| fakeHighlight.dispatchEvent(new Event('mouseup', { bubbles: true })); | ||
|
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -89,7 +89,7 @@ describe('Sidebar', () => { | |
| this.contentContainer = sinon.stub().returns(document.body); | ||
| this.createAnnotation = sinon.stub(); | ||
| this.fitSideBySide = sinon.stub(); | ||
| this.setHighlightsVisible = sinon.stub(); | ||
| } | ||
| } | ||
| fakeGuest = new FakeGuest(); | ||
|
|
@@ -244,14 +244,14 @@ describe('Sidebar', () => { | |
|
|
||
| it('shows or hides highlights when toolbar button is clicked', () => { | ||
| const sidebar = createSidebar(); | ||
| sinon.stub(sidebar, 'setHighlightsVisible'); | ||
|
|
||
| FakeToolbarController.args[0][1].setHighlightsVisible(true); | ||
| assert.calledWith(sidebar.setHighlightsVisible, true); | ||
| sidebar.setHighlightsVisible.resetHistory(); | ||
|
|
||
| FakeToolbarController.args[0][1].setHighlightsVisible(false); | ||
| assert.calledWith(sidebar.setHighlightsVisible, false); | ||
| }); | ||
|
|
||
| it('creates an annotation when toolbar button is clicked', () => { | ||
|
|
@@ -294,6 +294,15 @@ describe('Sidebar', () => { | |
| return result; | ||
| }; | ||
|
|
||
| describe('on "showHighlights" event', () => { | ||
| it('makes all highlights visible', () => { | ||
| createSidebar(); | ||
| assert.isFalse(fakeToolbar.highlightsVisible); | ||
| emitEvent('showHighlights'); | ||
| assert.isTrue(fakeToolbar.highlightsVisible); | ||
| }); | ||
| }); | ||
|
|
||
| describe('on "open" event', () => | ||
| it('opens the frame', () => { | ||
| const target = sandbox.stub(Sidebar.prototype, 'open'); | ||
|
|
@@ -562,13 +571,13 @@ describe('Sidebar', () => { | |
| it('shows highlights if "showHighlights" is set to "whenSidebarOpen"', () => { | ||
| const sidebar = createSidebar({ showHighlights: 'whenSidebarOpen' }); | ||
| sidebar.open(); | ||
| assert.calledWith(fakeBridge.call, 'setHighlightsVisible', true); | ||
| }); | ||
|
|
||
| it('does not show highlights otherwise', () => { | ||
| const sidebar = createSidebar({ showHighlights: 'never' }); | ||
| sidebar.open(); | ||
| assert.neverCalledWith(fakeBridge.call, 'setHighlightsVisible'); | ||
| }); | ||
|
|
||
| it('updates the `sidebarOpen` property of the toolbar', () => { | ||
|
|
@@ -585,7 +594,7 @@ describe('Sidebar', () => { | |
| sidebar.open(); | ||
| sidebar.close(); | ||
|
|
||
| assert.calledWith(fakeBridge.call, 'setHighlightsVisible', false); | ||
| }); | ||
|
|
||
| it('updates the `sidebarOpen` property of the toolbar', () => { | ||
|
|
@@ -598,12 +607,25 @@ describe('Sidebar', () => { | |
| }); | ||
| }); | ||
|
|
||
| describe('#setHighlightsVisible', () => { | ||
| it('requests sidebar to set highlight visibility in guest frames', () => { | ||
| const sidebar = createSidebar(); | ||
| sidebar.setHighlightsVisible(true); | ||
| assert.calledWith(fakeBridge.call, 'setHighlightsVisible', true); | ||
|
|
||
| sidebar.setHighlightsVisible(false); | ||
| assert.calledWith(fakeBridge.call, 'setHighlightsVisible', false); | ||
| }); | ||
|
|
||
| it('toggles "Show highlights" control in toolbar', () => { | ||
| const sidebar = createSidebar(); | ||
| sidebar.setHighlightsVisible(true); | ||
| assert.isTrue(fakeToolbar.highlightsVisible); | ||
|
|
||
| sidebar.setHighlightsVisible(false); | ||
| assert.isFalse(fakeToolbar.highlightsVisible); | ||
| }); | ||
| }); | ||
|
|
||
| it('hides toolbar controls when using the "clean" theme', () => { | ||
| createSidebar({ theme: 'clean' }); | ||
|
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -78,6 +78,9 @@ export class FrameSyncService { | |
| // Set of tags of annotations that are currently loaded into the frame | ||
| const inFrame = new Set(); | ||
|
|
||
| /** Whether highlights are visible in guest frames. */ | ||
| this._highlightsVisible = false; | ||
|
Contributor
There was a problem hiding this comment. A single state for all the guest frames. |
||
|
|
||
| /** | ||
| * Watch for changes to the set of annotations displayed in the sidebar and | ||
| * notify connected guests about new/updated/deleted annotations. | ||
|
|
@@ -164,6 +167,11 @@ export class FrameSyncService { | |
| this._hostRPC.call('openSidebar'); | ||
| } | ||
|
|
||
| // Ensure that the highlight for the newly-created annotation is visible. | ||
| // Currently we only support a single, shared visibility state for all highlights | ||
| // in all frames, so this will make all existing highlights visible too. | ||
| this._hostRPC.call('showHighlights'); | ||
|
Contributor
Author
There was a problem hiding this comment. To recap the sequence of events here when creating a new highlight while the "Show highlights" control is disabled:
This might seem rather roundabout, but steps 3-5 are the same as when toggling the "Show highlights" control manually, so we avoid having multiple code paths to handle keeping the state in sync across all frames. In future if we have a direct guest <-> host channel for each guest, we might be able to eliminate the relaying of the
Contributor
There was a problem hiding this comment. I have been thinking about I would support the creation of |
||
|
|
||
| // Create the new annotation in the sidebar. | ||
| annotationsService.create(annot); | ||
| }); | ||
|
|
@@ -226,6 +234,9 @@ export class FrameSyncService { | |
| * @param {PortRPC} channel | ||
| */ | ||
| const addFrame = channel => { | ||
| // Synchronize highlight visibility in this guest with the sidebar's controls. | ||
| channel.call('setHighlightsVisible', this._highlightsVisible); | ||
|
|
||
| channel.call('getDocumentInfo', (err, info) => { | ||
| if (err) { | ||
| channel.destroy(); | ||
|
|
@@ -279,8 +290,9 @@ export class FrameSyncService { | |
|
|
||
| // When user toggles the highlight visibility control in the sidebar container, | ||
| // update the visibility in all the guest frames. | ||
| this._hostRPC.on('setHighlightsVisible', visible => { | ||
| this._highlightsVisible = visible; | ||
| this._guestRPC.call('setHighlightsVisible', visible); | ||
| }); | ||
|
|
||
| // Create channel for sidebar <-> host communication and send port to host. | ||
|
|
||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
showHighlightsis a new event type that is sent from thesidebarto thehostframe.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes. These lines reported errors as expected after a rebase and I've updated the types.