ckeditor / ckeditor5

Powerful rich text editor framework with a modular architecture, modern integrations, and features like collaborative editing.
https://ckeditor.com/ckeditor-5
Other
8.28k stars 3.59k forks source link

[Testing] Tracking the composed range so content can be replaced while composing. #16247

Closed niegowski closed 3 weeks ago

niegowski commented 3 weeks ago

Suggested merge commit message (convention)

Fix (typing, engine): Tracking the composed range so content can be replaced while composing. Closes #16106.


Additional information

For example – encountered issues, assumptions you had to make, other affected tickets, etc.

Summary by CodeRabbit

coderabbitai[bot] commented 3 weeks ago

Walkthrough

The updates involve enhancing the CKEditor5's handling of composition and selection events, particularly addressing issues with predictive text in Safari. Changes include importing new event types, refining event listeners in the typing module, and adjusting how events are fired in the observer to better manage text insertion and selection behaviors.

Changes

File Path Changes
.../ckeditor5-engine/src/view/observer/selectionobserver.ts
.../ckeditor5-typing/src/input.ts
.../ckeditor5-typing/src/inserttextobserver.ts
Imported new event types, adjusted event handling for specific types, and modified event firing method to improve text insertion and selection behaviors.

Assessment against linked issues

Objective Addressed Explanation
Address predictive text "double typing" effect in Safari (Issue #16106) The changes seem relevant to improving event handling, which could potentially address the double typing effect. However, without specific details on how these changes directly impact the predictive text behavior in Safari, it's unclear if the issue is fully resolved.

The assessment suggests that while the changes are pertinent to event handling, further details or testing may be required to confirm the resolution of the specific Safari predictive text issue.


Recent Review Details **Configuration used: CodeRabbit UI**
Commits Files that changed from the base of the PR and between 1e6187d1da1616132f9ec89fb46b06ba2d8803f9 and 84e74039c002430bfcb497ada5f8d5b596c96652.
Files selected for processing (4) * packages/ckeditor5-engine/src/view/observer/selectionobserver.ts (5 hunks) * packages/ckeditor5-engine/tests/view/observer/selectionobserver.js (2 hunks) * packages/ckeditor5-typing/tests/input.js (3 hunks) * packages/ckeditor5-typing/tests/inserttextobserver.js (1 hunks)
Files skipped from review as they are similar to previous changes (1) * packages/ckeditor5-engine/src/view/observer/selectionobserver.ts
Additional comments not posted (6)
packages/ckeditor5-typing/tests/inserttextobserver.js (1)
`189-189`: Ensure the `selection` property is correctly set to `undefined` as expected. This change aligns with the new behavior where the `selection` property should not be part of the event data, simplifying the handling process.
packages/ckeditor5-typing/tests/input.js (3)
`11-11`: Ensure the import of `DomEventData` is correctly utilized in the file. The addition of `DomEventData` is crucial for handling DOM events accurately within the tests. --- `131-151`: Verify the logic for using model document selection when the selection property is not passed. This change ensures that the model document selection is used as a fallback, which is a sensible default behavior. --- `195-227`: Check the synchronization of model and DOM selections during composition events. This addition is important for ensuring that the model and DOM selections are synchronized, which is critical during composition events to maintain consistency between the view and the model.
packages/ckeditor5-engine/tests/view/observer/selectionobserver.js (2)
`21-21`: Ensure the import of `priorities` is correctly utilized in the file. The addition of `priorities` is crucial for handling event priorities accurately within the tests. --- `196-236`: Check the new test case for firing `selectionChange` synchronously on composition start. This test is important for ensuring that the `selectionChange` event behaves as expected during composition start, especially considering the priority handling.
--- Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?
Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
niegowski commented 3 weeks ago

This PR was just for test purposes.