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

Сортировка возвращаемых результатов callHierarchy, убраны мусорные переменные из outgoingCalls #3427

Merged
merged 1 commit into from
Feb 21, 2025

Conversation

nixel2007
Copy link
Member

@nixel2007 nixel2007 commented Feb 21, 2025

Описание

Fix #3426

Связанные задачи

Closes

Чеклист

Общие

  • Ветка PR обновлена из develop
  • Отладочные, закомментированные и прочие, не имеющие смысла участки кода удалены
  • Изменения покрыты тестами
  • Обязательные действия перед коммитом выполнены (запускал команду gradlew precommit)

Для диагностик

  • Описание диагностики заполнено для обоих языков (присутствуют файлы для обоих языков, для русского заполнено все подробно, перевод на английский можно опустить)

Дополнительно

Copy link
Contributor

coderabbitai bot commented Feb 21, 2025

Walkthrough

В данном изменении обновлён класс CallHierarchyProvider: добавлены новые импорты, поле-сравниватель для элементов и метод для проверки поддержки символа. Логика методов incomingCalls и outgoingCalls переработана для сортировки вызовов с фильтрацией в последнем. Также изменена позиция во входном тесте, и внесены правки в BSL-ресурс с добавлением объявления переменной и присвоением значения.

Changes

Файл Изменения
src/main/java/.../CallHierarchyProvider.java Добавлены импорты Symbol и Ranges; введено поле callHierarchyItemComparator для сортировки; изменена логика методов incomingCalls и outgoingCalls с фильтрацией через isSymbolSupported.
src/test/java/.../CallHierarchyProviderTest.java Изменена инициализация переменной secondFunctionDeclarationPosition с new Position(14, 15) на new Position(16, 15).
src/test/resources/.../callHierarchy.bsl Добавлены две строки в функции ПерваяФункция(): объявление переменной А (Перем А;) и присвоение Б = 1;.

Sequence Diagram(s)

sequenceDiagram
    participant Client as Клиент
    participant CHP as CallHierarchyProvider
    participant Filter as isSymbolSupported
    participant Sort as callHierarchyItemComparator

    Client ->> CHP: Вызывает outgoingCalls()
    CHP ->> CHP: Собирает исходящие вызовы
    CHP ->> Filter: Проверка каждого символа
    Filter -->> CHP: Результат проверки
    CHP ->> Sort: Сортировка вызовов
    Sort -->> CHP: Отсортированный список
    CHP -->> Client: Отправка списка вызовов
Loading

Poem

Я зайчик-кодер в строках играю,
Изменения ловко внедряю, не таю.
Сортирую вызовы, фильтрую,
В тестах позиции обновляю.
Морковку в коде ищу весело –
Пусть новый порядок радует дело! 🐰🌟

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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
Contributor

@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)
src/test/resources/providers/callHierarchy.bsl (1)

8-9: Неиспользуемые переменные в функции.

Объявленная переменная А и присвоенное значение переменной Б не используются в теле функции ПерваяФункция(). Рекомендуется либо использовать эти переменные, либо удалить их, если они не нужны для тестирования.

-    Перем А;
-    Б = 1;
src/main/java/com/github/_1c_syntax/bsl/languageserver/providers/CallHierarchyProvider.java (1)

143-145: Четкое определение поддерживаемых символов.

Метод isSymbolSupported явно определяет, какие типы символов поддерживаются в иерархии вызовов. Рекомендуется добавить документацию к методу.

+  /**
+   * Проверяет, поддерживается ли символ в иерархии вызовов.
+   *
+   * @param symbol Проверяемый символ
+   * @return true, если символ является методом
+   */
   private static boolean isSymbolSupported(Symbol symbol) {
     return symbol.getSymbolKind() == SymbolKind.Method;
   }
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between ee4f141 and f51eae5.

📒 Files selected for processing (3)
  • src/main/java/com/github/_1c_syntax/bsl/languageserver/providers/CallHierarchyProvider.java (7 hunks)
  • src/test/java/com/github/_1c_syntax/bsl/languageserver/providers/CallHierarchyProviderTest.java (1 hunks)
  • src/test/resources/providers/callHierarchy.bsl (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (19)
  • GitHub Check: build (23, windows-latest)
  • GitHub Check: build (23, ubuntu-latest)
  • GitHub Check: build (21, macOS-latest)
  • GitHub Check: build (21, windows-latest)
  • GitHub Check: build (21, ubuntu-latest)
  • GitHub Check: build (17, macOS-latest)
  • GitHub Check: build (17, windows-latest)
  • GitHub Check: build (17, ubuntu-latest)
  • GitHub Check: Analyse
  • GitHub Check: Benchmark
  • GitHub Check: build (23, macOS-latest)
  • GitHub Check: build (23, windows-latest)
  • GitHub Check: build (23, ubuntu-latest)
  • GitHub Check: build (21, macOS-latest)
  • GitHub Check: build (21, windows-latest)
  • GitHub Check: build (21, ubuntu-latest)
  • GitHub Check: build (17, macOS-latest)
  • GitHub Check: build (17, windows-latest)
  • GitHub Check: build (17, ubuntu-latest)
🔇 Additional comments (5)
src/main/java/com/github/_1c_syntax/bsl/languageserver/providers/CallHierarchyProvider.java (4)

61-63: Хорошее решение для сортировки элементов.

Добавление компаратора callHierarchyItemComparator обеспечивает стабильную сортировку результатов по двум критериям: detail и selectionRange. Использование Ranges.compare для сравнения диапазонов является правильным подходом.


99-100: Улучшение читаемости результатов с помощью сортировки.

Сортировка входящих вызовов с использованием компаратора улучшает читаемость и предсказуемость результатов. Использование toList() вместо collect(Collectors.toList()) делает код более лаконичным.


116-116: Правильная фильтрация символов по типу.

Добавление фильтрации isSymbolSupported позволяет исключить нерелевантные символы, оставляя только методы в иерархии вызовов.


124-125: Согласованная сортировка исходящих вызовов.

Применение того же компаратора к исходящим вызовам обеспечивает единообразие в представлении результатов.

src/test/java/com/github/_1c_syntax/bsl/languageserver/providers/CallHierarchyProviderTest.java (1)

55-55: Корректное обновление позиции в тестах.

Позиция secondFunctionDeclarationPosition обновлена в соответствии с изменениями в тестовом файле. Все тесты проходят успешно с новой позицией.

@nixel2007 nixel2007 merged commit 4b97278 into develop Feb 21, 2025
37 checks passed
@nixel2007 nixel2007 deleted the feature/polish-callHierarchy branch February 21, 2025 22:59
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.

Сортировка иерархии вызовов
1 participant