-
Notifications
You must be signed in to change notification settings - Fork 92
fix(superdoc): expose header/footer edits in update callbacks #2368
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.
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
Open
luccas-harbour
wants to merge
5
commits into
main
Choose a base branch
from
luccas/sd-2179-bug-headerfooter-edits-do-not-emit-update-events-until-blur
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+458
−11
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
ac0c701
fix(superdoc): expose header/footer edits in update callbacks
luccas-harbour 7eb0779
fix(super-editor): teardown header/footer editor bridge on session reset
luccas-harbour 0261e4c
refactor(super-editor): simplify header/footer bridge listener cleanup
luccas-harbour e1d8837
refactor(superdoc): share editor event payload builder fields
luccas-harbour fad2014
test(superdoc): cover header/footer editor event payload paths
luccas-harbour File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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 |
|---|---|---|
|
|
@@ -2088,6 +2088,200 @@ describe('PresentationEditor', () => { | |
| boundingSpy.mockRestore(); | ||
| }); | ||
|
|
||
| it('re-emits live header/footer child editor updates and transactions', async () => { | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. the same ~25 lines of setup (create editor, wait for layout, mock viewport, add spies) are copied across all three new tests. a small helper would make these easier to read. |
||
| mockIncrementalLayout.mockResolvedValueOnce(buildLayoutResult()); | ||
|
|
||
| editor = new PresentationEditor({ | ||
| element: container, | ||
| documentId: 'test-doc', | ||
| }); | ||
|
|
||
| await vi.waitFor(() => expect(mockIncrementalLayout).toHaveBeenCalled()); | ||
| await new Promise((resolve) => setTimeout(resolve, 100)); | ||
|
|
||
| const pagesHost = container.querySelector('.presentation-editor__pages') as HTMLElement; | ||
| const mockPage = document.createElement('div'); | ||
| mockPage.setAttribute('data-page-index', '0'); | ||
| pagesHost.appendChild(mockPage); | ||
|
|
||
| const viewport = container.querySelector('.presentation-editor__viewport') as HTMLElement; | ||
| vi.spyOn(viewport, 'getBoundingClientRect').mockReturnValue({ | ||
| left: 0, | ||
| top: 0, | ||
| width: 800, | ||
| height: 1000, | ||
| right: 800, | ||
| bottom: 1000, | ||
| x: 0, | ||
| y: 0, | ||
| toJSON: () => ({}), | ||
| } as DOMRect); | ||
|
|
||
| const updateSpy = vi.fn(); | ||
| const transactionSpy = vi.fn(); | ||
| editor.on('headerFooterUpdate', updateSpy); | ||
| editor.on('headerFooterTransaction', transactionSpy); | ||
|
|
||
| viewport.dispatchEvent(new MouseEvent('dblclick', { bubbles: true, clientX: 120, clientY: 50, button: 0 })); | ||
|
|
||
| await vi.waitFor(() => expect(createdSectionEditors.length).toBeGreaterThan(0)); | ||
| await vi.waitFor(() => expect(editor.getActiveEditor()).toBe(createdSectionEditors.at(-1)?.editor)); | ||
|
|
||
| const sourceEditor = editor.getActiveEditor(); | ||
| expect(sourceEditor).toBeDefined(); | ||
|
|
||
| const transaction = { docChanged: true }; | ||
| sourceEditor?.emit('update', { editor: sourceEditor }); | ||
| sourceEditor?.emit('transaction', { editor: sourceEditor, transaction, duration: 9 }); | ||
|
|
||
| expect(updateSpy).toHaveBeenCalledWith( | ||
| expect.objectContaining({ | ||
| editor: expect.any(Object), | ||
| sourceEditor, | ||
| surface: 'header', | ||
| headerId: 'rId-header-default', | ||
| sectionType: 'default', | ||
| }), | ||
| ); | ||
| expect(transactionSpy).toHaveBeenCalledWith( | ||
| expect.objectContaining({ | ||
| editor: expect.any(Object), | ||
| sourceEditor, | ||
| surface: 'header', | ||
| headerId: 'rId-header-default', | ||
| sectionType: 'default', | ||
| transaction, | ||
| duration: 9, | ||
| }), | ||
| ); | ||
| }); | ||
|
|
||
| it('stops re-emitting header/footer child editor events after exiting edit mode', async () => { | ||
| mockIncrementalLayout.mockResolvedValueOnce(buildLayoutResult()); | ||
|
|
||
| editor = new PresentationEditor({ | ||
| element: container, | ||
| documentId: 'test-doc', | ||
| }); | ||
|
|
||
| await vi.waitFor(() => expect(mockIncrementalLayout).toHaveBeenCalled()); | ||
| await new Promise((resolve) => setTimeout(resolve, 100)); | ||
|
|
||
| const pagesHost = container.querySelector('.presentation-editor__pages') as HTMLElement; | ||
| const mockPage = document.createElement('div'); | ||
| mockPage.setAttribute('data-page-index', '0'); | ||
| pagesHost.appendChild(mockPage); | ||
|
|
||
| const viewport = container.querySelector('.presentation-editor__viewport') as HTMLElement; | ||
| vi.spyOn(viewport, 'getBoundingClientRect').mockReturnValue({ | ||
| left: 0, | ||
| top: 0, | ||
| width: 800, | ||
| height: 1000, | ||
| right: 800, | ||
| bottom: 1000, | ||
| x: 0, | ||
| y: 0, | ||
| toJSON: () => ({}), | ||
| } as DOMRect); | ||
|
|
||
| const updateSpy = vi.fn(); | ||
| const transactionSpy = vi.fn(); | ||
| editor.on('headerFooterUpdate', updateSpy); | ||
| editor.on('headerFooterTransaction', transactionSpy); | ||
|
|
||
| viewport.dispatchEvent(new MouseEvent('dblclick', { bubbles: true, clientX: 120, clientY: 50, button: 0 })); | ||
|
|
||
| await vi.waitFor(() => expect(createdSectionEditors.length).toBeGreaterThan(0)); | ||
| await vi.waitFor(() => expect(editor.getActiveEditor()).toBe(createdSectionEditors.at(-1)?.editor)); | ||
|
|
||
| const sourceEditor = editor.getActiveEditor(); | ||
| const transaction = { docChanged: true }; | ||
|
|
||
| sourceEditor?.emit('update', { editor: sourceEditor }); | ||
| sourceEditor?.emit('transaction', { editor: sourceEditor, transaction, duration: 9 }); | ||
|
|
||
| expect(updateSpy).toHaveBeenCalledTimes(1); | ||
| expect(transactionSpy).toHaveBeenCalledTimes(1); | ||
|
|
||
| container.dispatchEvent(new KeyboardEvent('keydown', { key: 'Escape', bubbles: true })); | ||
| await vi.waitFor(() => expect(editor.getActiveEditor()).not.toBe(sourceEditor)); | ||
|
|
||
| sourceEditor?.emit('update', { editor: sourceEditor }); | ||
| sourceEditor?.emit('transaction', { editor: sourceEditor, transaction, duration: 11 }); | ||
|
|
||
| expect(updateSpy).toHaveBeenCalledTimes(1); | ||
| expect(transactionSpy).toHaveBeenCalledTimes(1); | ||
| }); | ||
|
|
||
| it('re-emits live footer child editor updates and transactions', async () => { | ||
| mockIncrementalLayout.mockResolvedValueOnce(buildLayoutResult()); | ||
|
|
||
| editor = new PresentationEditor({ | ||
| element: container, | ||
| documentId: 'test-doc', | ||
| }); | ||
|
|
||
| await vi.waitFor(() => expect(mockIncrementalLayout).toHaveBeenCalled()); | ||
| await new Promise((resolve) => setTimeout(resolve, 100)); | ||
|
|
||
| const pagesHost = container.querySelector('.presentation-editor__pages') as HTMLElement; | ||
| const mockPage = document.createElement('div'); | ||
| mockPage.setAttribute('data-page-index', '0'); | ||
| pagesHost.appendChild(mockPage); | ||
|
|
||
| const viewport = container.querySelector('.presentation-editor__viewport') as HTMLElement; | ||
| vi.spyOn(viewport, 'getBoundingClientRect').mockReturnValue({ | ||
| left: 0, | ||
| top: 0, | ||
| width: 800, | ||
| height: 1000, | ||
| right: 800, | ||
| bottom: 1000, | ||
| x: 0, | ||
| y: 0, | ||
| toJSON: () => ({}), | ||
| } as DOMRect); | ||
|
|
||
| const updateSpy = vi.fn(); | ||
| const transactionSpy = vi.fn(); | ||
| editor.on('headerFooterUpdate', updateSpy); | ||
| editor.on('headerFooterTransaction', transactionSpy); | ||
|
|
||
| viewport.dispatchEvent(new MouseEvent('dblclick', { bubbles: true, clientX: 120, clientY: 740, button: 0 })); | ||
|
|
||
| await vi.waitFor(() => expect(createdSectionEditors.length).toBeGreaterThan(0)); | ||
| await vi.waitFor(() => expect(editor.getActiveEditor()).toBe(createdSectionEditors.at(-1)?.editor)); | ||
|
|
||
| const sourceEditor = editor.getActiveEditor(); | ||
| expect(sourceEditor).toBeDefined(); | ||
|
|
||
| const transaction = { docChanged: true }; | ||
| sourceEditor?.emit('update', { editor: sourceEditor }); | ||
| sourceEditor?.emit('transaction', { editor: sourceEditor, transaction, duration: 12 }); | ||
|
|
||
| expect(updateSpy).toHaveBeenCalledWith( | ||
| expect.objectContaining({ | ||
| editor: expect.any(Object), | ||
| sourceEditor, | ||
| surface: 'footer', | ||
| headerId: 'rId-footer-default', | ||
| sectionType: 'default', | ||
| }), | ||
| ); | ||
| expect(transactionSpy).toHaveBeenCalledWith( | ||
| expect.objectContaining({ | ||
| editor: expect.any(Object), | ||
| sourceEditor, | ||
| surface: 'footer', | ||
| headerId: 'rId-footer-default', | ||
| sectionType: 'default', | ||
| transaction, | ||
| duration: 12, | ||
| }), | ||
| ); | ||
| }); | ||
|
|
||
| it('clears leftover footer transform when entering footer editing with non-negative minY', async () => { | ||
| mockIncrementalLayout.mockResolvedValueOnce(buildLayoutResult()); | ||
|
|
||
|
|
||
Oops, something went wrong.
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.