Skip to content

Оптимизировано (и местами исправлено) формирование ссылки на объекты MD #3456

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Оптимизировано (и местами исправлено) формирование ссылки на объекты MD #3456

wants to merge 1 commit into from

Conversation

theshadowco
Copy link
Member

Описание

Скорректировано формирование и использование ссылок mdoref.

PS. временно версия mdclasses указана снапшотная

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

Closes

Чеклист

Общие

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

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

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

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

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 26, 2025 •
edited
Loading

Walkthrough

В этом пулл-реквесте произведены изменения в управлении зависимостями и в упрощении логики получения MDO-ссылок. Версия зависимости mdclasses обновлена с фиксированной версии на develop-SNAPSHOT. Во многих классах удалены лишние импорты и вызовы методов из утилиты MdoRefBuilder в пользу прямого вызова метода getMdoRef() у соответствующих объектов, что значительно упрощает код и улучшает его читаемость. Также внесены коррективы в тесты и форматирование кода.

Changes

Файл(ы) Изменения
build.gradle.kts Обновление версии зависимости mdclasses: "0.15.0" → "develop-SNAPSHOT".
AnalyzeCommand.java, ServerContext.java, ModuleSymbolComputer.java, MissingEventSubscriptionHandlerDiagnostic.java,
PrivilegedModuleMethodCallDiagnostic.java, ScheduledJobHandlerDiagnostic.java,
WrongHttpServiceHandlerDiagnostic.java, DescriptionFormatter.java,
CallHierarchyProvider.java, ReferenceIndex.java, ReferenceIndexFiller.java		 Замена вызовов MdoRefBuilder.getMdoRef(...) на прямой вызов documentContext.getMdoRef() или owner.getMdoRef(), что упрощает получение MDO-ссылок.
DocumentContext.java Добавлен публичный метод getMdoRef(), возвращающий строку ссылки, используя MdoRefBuilder.getMdoRef(this).
AbstractMetadataDiagnostic.java, DenyIncompleteValuesDiagnostic.java,
ForbiddenMetadataNameDiagnostic.java, MetadataObjectNameLengthDiagnostic.java,
ProtectedModuleDiagnostic.java, SameMetadataObjectAndChildNamesDiagnostic.java		 Добавлены/обновлены методы для получения локальной MDO-ссылки (например, getMdoRefLocal(mdo)), изменение сигнатуры методов (например, в checkName) и удаление устаревших методов для упрощения логики диагностики.
MissingCommonModuleMethodDiagnostic.java Повышено читаемость за счёт переноса закрывающих скобок в условных операторах, без изменения логики.
FileInfo.java Упрощена инициализация переменной mdoRef с использованием метода map на Optional с MD::getMdoRef и orElse(""), а также добавлен новый импорт для MD.
MdoRefBuilder.java Реструктуризация класса: удалены некоторые методы, добавлены новые версии для обработки CallStatementContext и ComplexIdentifierContext, а также обновлена логика работы метода с модификаторами.
ModuleSymbolComputerTest.java В тесте testModuleName вместо мокирования используется прямой вызов фабричного метода MdoReference.create, что улучшает настройку тестового окружения.

Sequence Diagram(s)

sequenceDiagram
    participant Caller as Клиентский код
    participant Context as DocumentContext
    participant Builder as MdoRefBuilder (старый)
    Note over Caller,Context: Старый поток получения MDO-ссылки
    Caller->>Context: getMdObject()
    Context->>Builder: getMdoRef(mdObject)
    Builder-->>Context: mdoRef
    Context-->>Caller: mdoRef
Loading 
sequenceDiagram
    participant Caller as Клиентский код
    participant Context as DocumentContext
    Note over Caller,Context: Новый поток получения MDO-ссылки
    Caller->>Context: getMdoRef()
    Context-->>Caller: mdoRef
Loading

Possibly related PRs

  • фикс для обновления mdclasses #3322: Изменения, связанные с обновлением версии зависимости mdclasses, где аналогичные изменения отражают переход от одной версии к другой.

Suggested reviewers

  • nixel2007

Poem

Я заяц-весельчак, сквозь код я бегу,
В поисках ссылок MDO — наш путь прост и ярок.
Лишних вызовов нет, всё ясно как день,
Рефакторинг совершён, исчез избыточный тень.
Пусть код сияет, как морковь в лучах, 🥕
С прыжками вперёд — счастье в новых строках!
Спасибо, разработчики, за чистый и верный код!

📜 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 d9dfbf3 and b11b1d6.

📒 Files selected for processing (24)
  • build.gradle.kts (1 hunks)
  • src/main/java/com/github/_1c_syntax/bsl/languageserver/cli/AnalyzeCommand.java (1 hunks)
  • src/main/java/com/github/_1c_syntax/bsl/languageserver/context/DocumentContext.java (2 hunks)
  • src/main/java/com/github/_1c_syntax/bsl/languageserver/context/ServerContext.java (1 hunks)
  • src/main/java/com/github/_1c_syntax/bsl/languageserver/context/computer/ModuleSymbolComputer.java (1 hunks)
  • src/main/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/AbstractMetadataDiagnostic.java (1 hunks)
  • src/main/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/DenyIncompleteValuesDiagnostic.java (1 hunks)
  • src/main/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/ForbiddenMetadataNameDiagnostic.java (1 hunks)
  • src/main/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/MetadataObjectNameLengthDiagnostic.java (1 hunks)
  • src/main/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/MissingCommonModuleMethodDiagnostic.java (4 hunks)
  • src/main/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/MissingEventSubscriptionHandlerDiagnostic.java (1 hunks)
  • src/main/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/PrivilegedModuleMethodCallDiagnostic.java (1 hunks)
  • src/main/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/ProtectedModuleDiagnostic.java (1 hunks)
  • src/main/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/SameMetadataObjectAndChildNamesDiagnostic.java (1 hunks)
  • src/main/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/ScheduledJobHandlerDiagnostic.java (1 hunks)
  • src/main/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/WrongDataPathForFormElementsDiagnostic.java (1 hunks)
  • src/main/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/WrongHttpServiceHandlerDiagnostic.java (1 hunks)
  • src/main/java/com/github/_1c_syntax/bsl/languageserver/hover/DescriptionFormatter.java (2 hunks)
  • src/main/java/com/github/_1c_syntax/bsl/languageserver/providers/CallHierarchyProvider.java (1 hunks)
  • src/main/java/com/github/_1c_syntax/bsl/languageserver/references/ReferenceIndex.java (3 hunks)
  • src/main/java/com/github/_1c_syntax/bsl/languageserver/references/ReferenceIndexFiller.java (6 hunks)
  • src/main/java/com/github/_1c_syntax/bsl/languageserver/reporters/data/FileInfo.java (2 hunks)
  • src/main/java/com/github/_1c_syntax/bsl/languageserver/utils/MdoRefBuilder.java (1 hunks)
  • src/test/java/com/github/_1c_syntax/bsl/languageserver/context/computer/ModuleSymbolComputerTest.java (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (22)
  • src/main/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/MissingCommonModuleMethodDiagnostic.java
  • src/main/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/WrongHttpServiceHandlerDiagnostic.java
  • src/main/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/WrongDataPathForFormElementsDiagnostic.java
  • src/main/java/com/github/_1c_syntax/bsl/languageserver/context/DocumentContext.java
  • build.gradle.kts
  • src/main/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/PrivilegedModuleMethodCallDiagnostic.java
  • src/main/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/MissingEventSubscriptionHandlerDiagnostic.java
  • src/main/java/com/github/_1c_syntax/bsl/languageserver/hover/DescriptionFormatter.java
  • src/main/java/com/github/_1c_syntax/bsl/languageserver/cli/AnalyzeCommand.java
  • src/main/java/com/github/_1c_syntax/bsl/languageserver/providers/CallHierarchyProvider.java
  • src/main/java/com/github/_1c_syntax/bsl/languageserver/references/ReferenceIndexFiller.java
  • src/main/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/ProtectedModuleDiagnostic.java
  • src/main/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/MetadataObjectNameLengthDiagnostic.java
  • src/main/java/com/github/_1c_syntax/bsl/languageserver/references/ReferenceIndex.java
  • src/main/java/com/github/_1c_syntax/bsl/languageserver/context/computer/ModuleSymbolComputer.java
  • src/main/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/SameMetadataObjectAndChildNamesDiagnostic.java
  • src/main/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/DenyIncompleteValuesDiagnostic.java
  • src/main/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/ScheduledJobHandlerDiagnostic.java
  • src/main/java/com/github/_1c_syntax/bsl/languageserver/context/ServerContext.java
  • src/main/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/AbstractMetadataDiagnostic.java
  • src/main/java/com/github/_1c_syntax/bsl/languageserver/reporters/data/FileInfo.java
  • src/test/java/com/github/_1c_syntax/bsl/languageserver/context/computer/ModuleSymbolComputerTest.java
⏰ Context from checks skipped due to timeout of 90000ms (20)
  • GitHub Check: build (17, ubuntu-latest)
  • GitHub Check: build (23, macOS-latest)
  • GitHub Check: build (23, ubuntu-latest)
  • GitHub Check: build (21, windows-latest)
  • GitHub Check: build (21, macOS-latest)
  • GitHub Check: build (21, ubuntu-latest)
  • GitHub Check: build
  • GitHub Check: Analyse
  • GitHub Check: build (23, windows-latest)
  • GitHub Check: build (23, macOS-latest)
  • GitHub Check: build (21, windows-latest)
  • GitHub Check: build (23, ubuntu-latest)
  • GitHub Check: build (17, ubuntu-latest)
  • GitHub Check: build (17, macOS-latest)
  • GitHub Check: build (21, macOS-latest)
  • GitHub Check: build (17, windows-latest)
  • GitHub Check: build (21, ubuntu-latest)
  • GitHub Check: build
  • GitHub Check: Benchmark
  • GitHub Check: Sentry
🔇 Additional comments (16)
src/main/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/ForbiddenMetadataNameDiagnostic.java (4)

134-134: Улучшено использование параметров метода.

Переход от передачи MdoReference к прямой передаче объекта MD упрощает код и делает его более понятным. Это соответствует цели оптимизации формирования ссылок на объекты MD.

139-140: Аналогичное улучшение для проверки дочерних элементов.

Используется тот же подход с передачей объекта MD напрямую, что обеспечивает единообразие и согласованность кода.

143-143: Оптимизирована сигнатура метода checkName.

Изменение сигнатуры метода с (String name, MdoReference mdoReference) на (String name, MD md) позволяет работать напрямую с объектом MD, избегая лишних преобразований и упрощая использование метода в различных контекстах.

145-145: Консолидирована логика получения ссылки на метаданные.

Использование метода getMdoRefLocal(md) вместо предыдущей, предположительно более сложной условной структуры, упрощает код и делает его более поддерживаемым. Это соответствует цели оптимизации, указанной в PR.

Убедитесь, что метод getMdoRefLocal(md) корректно определен в родительском классе или утилитарном классе и правильно обрабатывает объект MD.

src/main/java/com/github/_1c_syntax/bsl/languageserver/utils/MdoRefBuilder.java (12)

34-34: Корректное добавление аннотации @nullable.

Добавление импорта аннотации @Nullable из пакета javax.annotation улучшает качество кода, так как позволяет явно указать, что параметр может быть null.

37-39: Улучшенная документация класса.

Обновленная документация класса теперь точнее описывает его назначение как хелпера для MD ссылок, что повышает понятность кода.

43-46: Добавлено пояснение для StringInterner.

Улучшена документация приватного поля stringInterner, что помогает понять его роль в оптимизации хранения одинаковых строк.

48-55: Расширена документация метода getMdoRef.

Улучшенная документация метода getMdoRef теперь подробно объясняет логику работы с документами, имеющими или не имеющими связь с MDClasses.

57-60: Оптимизирован метод getMdoRef.

Изменен вызов для получения MDO ссылки напрямую через MD::getMdoRef вместо MdoReference::getMdoRef, что упрощает код и предотвращает потенциальную циклическую зависимость.

71-78: Добавлен специализированный метод для обработки вызовов методов.

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

Обратите внимание на TODO-комментарий, указывающий на ограничение в текущей реализации по работе с глобальными методами.

87-89: Добавлен специализированный метод для обработки сложных идентификаторов.

Метод выделяет идентификатор и модификаторы из сложного идентификатора и делегирует их обработку базовому методу.

99-104: Улучшена сигнатура метода getMdoRef.

Добавлена аннотация @Nullable для параметра identifier, что делает API более прозрачным и безопасным.

106-108: Добавлена проверка на null.

Корректная обработка случая, когда identifier равен null, что предотвращает потенциальные NullPointerException.

110-114: Реализована логика поиска для общих модулей.

Добавлен код для поиска и обработки общих модулей, что расширяет возможности класса.

116-125: Реализована логика обработки типов метаданных.

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

Обратите внимание на TODO-комментарий о текущем ограничении: подход не позволяет использовать ссылки на методы платформенных объектов.

131-131: Изменен метод поиска с findAny на findFirst.

Замена findAny() на findFirst() делает поведение более предсказуемым, так как findFirst() гарантированно возвращает первый элемент, а не произвольный.

✨ Finishing Touches
  • 📝 Generate Docstrings
🪧 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.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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.

@theshadowco theshadowco force-pushed the feature/optMdoRefBuilder branch from d9dfbf3 to b11b1d6 Compare March 27, 2025 08:21
@sonarqubecloud SonarQubeCloud
Copy link

Quality Gate Passed Quality Gate passed

Issues
8 New issues
0 Accepted issues

Measures
0 Security Hotspots
96.6% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@theshadowco