Skip to content

Conversation

@theshadowco
Copy link
Member

Описание

Пропускает битые файлы (в том числе дочерние) с выводом пути к файлу и описания проблемы (если удалось понять).

Пример

2025-03-25 12:23:45 DEBUG Чтения файла поставки ParentConfigurations.bin, полное чтение = false
2025-03-25 12:23:45 DEBUG Найдено конфигураций: 0
2025-03-25 12:23:45 ERROR Can't read file '/home/valery/reps/configuration/src/Roles/BrokenRole/Rights.rights' - it's broken (skipped): ParseError at [row,col]:[1,7]
Message: A pseudo attribute name is expected.

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

Closes

Чеклист

Общие

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

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

@coderabbitai
Copy link

coderabbitai bot commented Mar 25, 2025

Walkthrough

Изменения в файле ExtendXStream.java касаются обновления логики обработки ошибок в методе fromXML. Внесены изменения в блоки catch для ConversionException, StreamException и CannotResolveClassException. Теперь ошибки логируются с указанием "(skipped)" (в некоторых случаях с добавлением причины ошибки), и исключения не пробрасываются повторно, что позволяет методу продолжать выполнение.

Changes

Файл Изменения
src/main/java/.../ExtendXStream.java Обновлена обработка исключений в методе fromXML:
- ConversionException: Логирование ошибки с сообщением "(skipped)", исключение не выбрасывается.
- StreamException: Новый блок с логированием ошибки и указанием причины.
- CannotResolveClassException: Добавлено "(skipped)" к сообщению.

Sequence Diagram(s)

sequenceDiagram
    participant C as Клиент
    participant X as ExtendXStream
    C->>X: Вызов метода fromXML()
    alt Без ошибок
        X->>C: Возвращает корректный результат
    else Если возникает ConversionException
        X->>X: Логирует "file is broken (skipped)"
    else Если возникает StreamException
        X->>X: Логирует ошибку с указанием причины
    else Если возникает CannotResolveClassException
        X->>X: Логирует "file is broken (skipped)"
    else Если возникает любое другое Exception
        X->>X: Логирует сообщение об ошибке (пропущено)
    end
    X->>C: Завершает выполнение метода
Loading

Poem

Я кролик в коде, ловлю ошибки в тиши,
Лог пишу аккуратно, как в волшебной книжке.
"(skipped)" на экране – знак, что всё под контролем,
Ошибки теперь прощены, все хвосты подолгу трепещут.
Пусть баги бегут, а я с морковкой в руке – в веселье!
🥕🐇


📜 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 132e58c and 7aaa331.

📒 Files selected for processing (1)
  • src/main/java/com/github/_1c_syntax/bsl/reader/common/xstream/ExtendXStream.java (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/main/java/com/github/_1c_syntax/bsl/reader/common/xstream/ExtendXStream.java
⏰ Context from checks skipped due to timeout of 90000ms (18)
  • GitHub Check: build (23, windows-latest)
  • GitHub Check: build (21, macOS-latest)
  • GitHub Check: build (21, ubuntu-latest)
  • GitHub Check: build (23, ubuntu-latest)
  • GitHub Check: build (21, windows-latest)
  • GitHub Check: build (17, windows-latest)
  • GitHub Check: build (17, ubuntu-latest)
  • GitHub Check: build (17, macOS-latest)
  • GitHub Check: QA
  • GitHub Check: build (21, ubuntu-latest)
  • GitHub Check: build (23, windows-latest)
  • GitHub Check: build (23, macOS-latest)
  • GitHub Check: build (23, ubuntu-latest)
  • GitHub Check: build (21, macOS-latest)
  • GitHub Check: build (21, windows-latest)
  • GitHub Check: build (17, windows-latest)
  • GitHub Check: build (17, macOS-latest)
  • GitHub Check: build (17, ubuntu-latest)

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

@github-actions
Copy link
Contributor

github-actions bot commented Mar 25, 2025

Test Results

  531 files  ±0    531 suites  ±0   5m 9s ⏱️ -1s
  221 tests ±0    221 ✅ ±0  0 💤 ±0  0 ❌ ±0 
2 007 runs  ±0  2 007 ✅ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit 7aaa331. ± Comparison against base commit 540e043.

♻️ This comment has been updated with latest results.

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)
src/main/java/com/github/_1c_syntax/bsl/reader/common/xstream/ExtendXStream.java (2)

129-130: Добавлен универсальный обработчик исключений.

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

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


123-131: Обеспечьте единообразие в сообщениях об ошибках.

Форматирование сообщений об ошибках немного отличается в разных блоках catch:

  • В блоках для ConversionException, CannotResolveClassException и общего Exception используется \n в конце
  • В блоке для StreamException символ переноса строки отсутствует

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

-        LOGGER.error("Can't read file '{}' - it's broken (skipped) \n", file, e);
+        LOGGER.error("Can't read file '{}' - it's broken (skipped)", file, e);
-        LOGGER.debug("Can't read file '{}' - unknown class (skipped) \n", file, e);
+        LOGGER.debug("Can't read file '{}' - unknown class (skipped)", file, e);
-        LOGGER.error("Can't read file '{}' - unknown error (skipped) \n", file, e);
+        LOGGER.error("Can't read file '{}' - unknown error (skipped)", file, e);
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 540e043 and 132e58c.

📒 Files selected for processing (1)
  • src/main/java/com/github/_1c_syntax/bsl/reader/common/xstream/ExtendXStream.java (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (10)
  • GitHub Check: build (21, windows-latest)
  • GitHub Check: build (17, windows-latest)
  • GitHub Check: build (21, ubuntu-latest)
  • GitHub Check: build (23, ubuntu-latest)
  • GitHub Check: build (23, windows-latest)
  • GitHub Check: QA
  • GitHub Check: build (23, macOS-latest)
  • GitHub Check: build (17, macOS-latest)
  • GitHub Check: build (17, ubuntu-latest)
  • GitHub Check: build (21, macOS-latest)
🔇 Additional comments (5)
src/main/java/com/github/_1c_syntax/bsl/reader/common/xstream/ExtendXStream.java (5)

71-71: Добавление нового импорта для обработки StreamException.

Импорт com.thoughtworks.xstream.io.StreamException добавлен для обработки ошибок потока при чтении XML.


123-124: Улучшен механизм обработки ConversionException.

Изменение обработки исключения ConversionException позволяет пропускать битые файлы вместо прерывания процесса. Теперь ошибка логируется, а программа продолжает работу с другими файлами.


126-126: Дополнено сообщение для CannotResolveClassException.

Добавлена отметка "(skipped)" в сообщение лога для обозначения того, что файл с неизвестным классом был пропущен.


127-128: Добавлена обработка StreamException.

Добавлена обработка StreamException, которая может возникать при проблемах с XML-потоком. Теперь такие ошибки логируются с указанием причины, а файл пропускается.


123-131: Рассмотрите добавление тестов для нового функционала.

В соответствии с PR objectives отмечено, что изменения ещё не покрыты тестами. Рекомендуется добавить модульные тесты для проверки корректной обработки различных типов ошибок и правильного пропуска битых файлов.

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

@sonarqubecloud
Copy link

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.

3 participants