Skip to content
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

fixed focus scrolling in ace editor #7269

Merged
merged 1 commit into from
Dec 2, 2024
Merged

fixed focus scrolling in ace editor #7269

merged 1 commit into from
Dec 2, 2024

Conversation

JulianWielga
Copy link
Member

@JulianWielga JulianWielga commented Dec 2, 2024

Summary by CodeRabbit

  • New Features

    • Improved cursor positioning and scrolling behavior in the editor component for a smoother user experience.
  • Bug Fixes

    • Simplified event handling by focusing on cursor change events, enhancing reliability.

@github-actions github-actions bot added client client main fe ui labels Dec 2, 2024
Copy link

coderabbitai bot commented Dec 2, 2024

📝 Walkthrough

Walkthrough

The changes made to the AceWithSettings component in AceWithSettings.tsx involve significant alterations to the cursor position and scrolling logic. The previous implementation utilized a prepare function designed to update the editor's rendering prior to setting the cursor position. This function has been eliminated, and its responsibilities have been integrated into the scrollToView function. The updated scrollToView function now begins by invoking editor?.renderer.updateFull(true), which ensures accurate position calculations before scrolling the active element into view.

Additionally, the event listener for cursor changes remains in place, while the listeners for mousedown and mouseup events have been removed. This simplification focuses the event handling on cursor changes, which are deemed sufficient for managing the scrolling behavior. Overall, these modifications enhance the clarity and efficiency of the component's control flow related to cursor positioning and scrolling without altering any exported or public entity declarations.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Editor
    participant Renderer

    User->>Editor: Make cursor change
    Editor->>Renderer: updateFull(true)
    Renderer-->>Editor: Position updated
    Editor->>Editor: scrollToView active element
Loading

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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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 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 for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)
designer/client/src/components/graph/node-modal/editors/expression/AceWithSettings.tsx (2)

46-49: Add null checks and error handling for robustness.

The scrolling logic looks good overall, but could benefit from some defensive programming:

Consider this safer implementation:

- editor?.renderer.updateFull(true);
- const activeElement = editor.container.querySelector(".ace_cursor") || document.activeElement;
- activeElement.scrollIntoView({ block: "nearest", inline: "nearest" });
+ if (editor?.renderer && editor.container) {
+   editor.renderer.updateFull(true);
+   const activeElement = editor.container.querySelector(".ace_cursor") || document.activeElement;
+   activeElement?.scrollIntoView?.({ block: "nearest", inline: "nearest" });
+ }

This ensures that:

  1. The editor and its renderer exist before updating
  2. The container exists before querying
  3. The scroll operation is safe even if no element is found

42-54: Consider monitoring scroll performance.

The throttle delay of 150ms with leading: false is a reasonable starting point, but you might want to monitor if this provides the optimal balance between performance and responsiveness.

Consider:

  1. Adding telemetry to measure the frequency of scroll events
  2. Monitoring for any lag in cursor movement feedback
  3. Testing with different delay values (100-200ms range) based on usage patterns
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 13e570b and 9425ad7.

📒 Files selected for processing (1)
  • designer/client/src/components/graph/node-modal/editors/expression/AceWithSettings.tsx (1 hunks)

Copy link
Member

@gskrobisz gskrobisz left a comment

Choose a reason for hiding this comment

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

It fixes problem with jumping selection in sql-source. Tested FF and Chrome

@JulianWielga JulianWielga merged commit d2b0b33 into staging Dec 2, 2024
13 checks passed
@JulianWielga JulianWielga deleted the ace-focus-fix branch December 2, 2024 16:18
lciolecki pushed a commit that referenced this pull request Dec 2, 2024
arkadius pushed a commit that referenced this pull request Dec 2, 2024
@coderabbitai coderabbitai bot mentioned this pull request Dec 2, 2024
9 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
client client main fe ui
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants