Skip to content

fix: Fix "Mark decorations may not be empty" issue #325

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

Merged
merged 5 commits into from
Jun 2, 2025

Conversation

brendan-kellam
Copy link
Contributor

@brendan-kellam brendan-kellam commented Jun 2, 2025

Was hitting a "Mark decorations may not be empty" client side error for certain files. Fix is to do a range check before applying the decoration.

Summary by CodeRabbit

  • Bug Fixes
    • Improved highlighting behavior by ensuring only valid, non-zero-length ranges are decorated in code browsing, symbol hover, and search result highlights. This prevents incorrect or empty highlights from appearing in the interface.

Copy link

coderabbitai bot commented Jun 2, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

The changes introduce stricter validation when creating decorations for code ranges, ensuring that only non-empty ranges (where the start is strictly less than the end) are decorated. This logic is applied across range highlighting, symbol hover targets, and search result highlights to prevent zero-length or invalid decorations from being generated.

Changes

File(s) Change Summary
.../rangeHighlightingExtension.ts Added a check to only create decorations if the range start is strictly less than the end.
.../symbolHoverTargetsExtension.ts Added a condition to decorate only nodes with non-empty ranges (node.from < node.to).
.../searchResultHighlightExtension.ts Added a check to only create decorations for search results with valid, non-zero-length ranges.
CHANGELOG.md Updated "Fixed" section with a new fix for client-side error "mark decorations may not be empty".

Poem

A hop, a skip, a careful check,
No empty ranges on this trek!
Highlights now, with bounds so true,
Only where the code runs through.
No zero-lengths to trip or hide,
Just tidy marks, with bunny pride!
🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f068b5e and 79f06f8.

📒 Files selected for processing (2)
  • CHANGELOG.md (1 hunks)
  • packages/web/src/ee/features/codeNav/components/symbolHoverPopup/symbolHoverTargetsExtension.ts (2 hunks)
✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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

🧹 Nitpick comments (1)
packages/web/src/lib/extensions/searchResultHighlightExtension.ts (1)

36-42: Effective range validation with functional approach.

The implementation correctly prevents invalid decorations by returning undefined for zero-length ranges and filtering them out. The functional programming approach is clean and readable.

Consider consistency: while this map-filter pattern works well, the other files use conditional array pushing. Both approaches are valid, but maintaining consistency across similar validation logic could improve code maintainability.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 82a786a and c1861fc.

📒 Files selected for processing (3)
  • packages/web/src/app/[domain]/browse/[...path]/components/rangeHighlightingExtension.ts (1 hunks)
  • packages/web/src/ee/features/codeNav/components/symbolHoverPopup/symbolHoverTargetsExtension.ts (1 hunks)
  • packages/web/src/lib/extensions/searchResultHighlightExtension.ts (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: build
🔇 Additional comments (2)
packages/web/src/ee/features/codeNav/components/symbolHoverPopup/symbolHoverTargetsExtension.ts (1)

67-69: LGTM! Proper range validation prevents empty decorations.

The addition of node.from < node.to check correctly prevents zero-length ranges from being decorated, which would cause the "Mark decorations may not be empty" error. This is a solid defensive programming approach.

packages/web/src/app/[domain]/browse/[...path]/components/rangeHighlightingExtension.ts (1)

23-28: Good implementation of range validation.

The conditional decoration creation properly handles edge cases where from >= to, preventing the "Mark decorations may not be empty" error. The approach of using an empty array and conditionally adding decorations is clean and maintainable.

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

🧹 Nitpick comments (2)
CHANGELOG.md (2)

11-11: Fix typo and grammar in changelog entry

The verb “display” should be “displayed,” and it reads more naturally as “on the login page” rather than “in.”

- Fixed issue where new oauth providers weren't being display in the login page. [commit](https://github.com/sourcebot-dev/sourcebot/commit/a2e06266dbe5e5ad4c2c3f730c73d64edecedcf7)
+ Fixed issue where new OAuth providers weren't being displayed on the login page. [commit](https://github.com/sourcebot-dev/sourcebot/commit/a2e06266dbe5e5ad4c2c3f730c73d64edecedcf7)
🧰 Tools
🪛 LanguageTool

[uncategorized] ~11-~11: This verb may not be in the correct form. Consider using a different form for this context.
Context: ...where new oauth providers weren't being display in the login page. [commit](https://git...

(AI_EN_LECTOR_REPLACEMENT_VERB_FORM)


[uncategorized] ~11-~11: The preposition “on” seems more likely in this position than the preposition “in”.
Context: ...w oauth providers weren't being display in the login page. [commit](https://github...

(AI_EN_LECTOR_REPLACEMENT_PREPOSITION_IN_ON)


12-12: Standardize formatting for error message entry

Hyphenate “client-side” and use code formatting for the error string to improve readability.

- Fixed client side "mark decorations may not be empty" error when viewing certain files. [#325](https://github.com/sourcebot-dev/sourcebot/pull/325)
+ Fixed client-side error `mark decorations may not be empty` when viewing certain files. [#325](https://github.com/sourcebot-dev/sourcebot/pull/325)
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c1861fc and f068b5e.

📒 Files selected for processing (1)
  • CHANGELOG.md (1 hunks)
🧰 Additional context used
🪛 LanguageTool
CHANGELOG.md

[uncategorized] ~11-~11: This verb may not be in the correct form. Consider using a different form for this context.
Context: ...where new oauth providers weren't being display in the login page. [commit](https://git...

(AI_EN_LECTOR_REPLACEMENT_VERB_FORM)


[uncategorized] ~11-~11: The preposition “on” seems more likely in this position than the preposition “in”.
Context: ...w oauth providers weren't being display in the login page. [commit](https://github...

(AI_EN_LECTOR_REPLACEMENT_PREPOSITION_IN_ON)

⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: build

msukkari
msukkari previously approved these changes Jun 2, 2025
@brendan-kellam brendan-kellam merged commit 8a9cdfd into main Jun 2, 2025
4 of 5 checks passed
@brendan-kellam brendan-kellam deleted the bkellam/fix_empty_mark_decorations branch June 2, 2025 18:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants