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

474 / Исправлена ошибка инициализации логирования при указании недоступного файла вывода #475

Merged
merged 3 commits into from
Dec 24, 2024

Conversation

alkoleft
Copy link
Member

@alkoleft alkoleft commented Dec 24, 2024

Описание изменений


  • Добавлены тесты
  • Изменения отражены в документации (при необходимости)

Close #474

Summary by CodeRabbit

  • Улучшения

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

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

Copy link

coderabbitai bot commented Dec 24, 2024

Walkthrough

В данном pull request представлены изменения в двух модулях: ДТОткрытиеФорм и ЮТЛогированиеСлужебный. В первом модуле выполнена очистка кода от закомментированных процедур и функций, связанных с регистрацией тестов и фильтрацией метаданных. Во втором модуле введены две новые процедуры для определения уровня логирования и доступности логирования в файл, что повышает модульность и читаемость кода.

Changes

Файл Изменения
exts/smoke/src/CommonModules/ДТОткрытиеФорм/Module.bsl Удалены закомментированные процедуры и функции:
- ЗарегистрироватьТестыФормы
- ИсключитьТипТеста
- ТестПодходитПодИсключения
- ОтборМетаданных
Улучшена обработка ошибок в процедуре ЗарегистрироватьТест
exts/yaxunit/src/CommonModules/ЮТЛогированиеСлужебный/Module.bsl Добавлены новые процедуры:
- ОпределитьУровеньЛоги
- ОпределитьДоступностьЛогированияВФайл
Удалена логика определения уровня логирования из процедуры Инициализация

Assessment against linked issues

Objective Addressed Explanation
Обработка ошибок при недоступном файле лога [#474]

Possibly related PRs

Poem

🐰 В мире кода, где строки танцуют,
Комментарии тают, как утренний сон.
Логи чисты, ошибки не бунтуют,
Rabbit's code - совершенства закон!
Чистота и порядок - вот наш талисман! 🔍


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

@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 (4)
exts/smoke/src/CommonModules/ДТОткрытиеФорм/Module.bsl (3)

201-201: Добавление пояснения об ошибке при открытии
Текст ошибки ясно указывает на проблему, однако рекомендуется добавить дополнительные сведения (например, имя формы) в сам текст сообщения, чтобы помочь операторам быстрее диагностировать причину сбоя.


215-215: Единообразие логирования ошибок
Ошибка при обновлении данных формы логируется аналогично другим исключениям. Убедитесь, что структура сообщения согласована со стандартами проекта (при необходимости — используйте общий формат).


222-225: Обработка ошибки закрытия формы
Аналогично другим блокам Попытка/Исключение, включена повторная генерация исключения. Рекомендуется единый подход к формированию сообщений об ошибках, чтобы оператор быстрее понимал источник проблемы.

exts/yaxunit/src/CommonModules/ЮТЛогированиеСлужебный/Module.bsl (1)

409-432: Проверка доступности файла лога

  1. Используется попытка записать тестовое сообщение в файл — корректный способ проверки доступности.
  2. При ошибке логирования выводится понятное сообщение пользователю и логирование в файл отключается.
  3. Дополнительно проверяется, доступен ли файл лога на сервере.
    Такой подход выглядит надёжным, однако убедитесь, что при возникновении временной проблемы (например, сбойный диск) есть механизм повторной попытки или уведомления.
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between ab80185 and b924b2f.

📒 Files selected for processing (2)
  • exts/smoke/src/CommonModules/ДТОткрытиеФорм/Module.bsl (1 hunks)
  • exts/yaxunit/src/CommonModules/ЮТЛогированиеСлужебный/Module.bsl (2 hunks)
🔇 Additional comments (8)
exts/smoke/src/CommonModules/ДТОткрытиеФорм/Module.bsl (6)

185-188: Уточните обработку исключения при получении формы
Проверка ошибок выглядит корректной, но при возникновении исключения оно повторно пробрасывается. Убедитесь, что это поведение желаемо, и что данная точка перехвата не должна решать проблему локально.


192-193: Явная проверка формы
Вызов ЮТест.ОжидаетЧто(Форма).НеРавно(Неопределено) улучшает читаемость и даёт точную диагностику в случае отсутствия формы. Выглядит корректно.


205-208: Явная проверка успешности открытия
Проверка через ЮТест.ОжидаетЧто(Форма.Открыта()) — удачный выбор. Если форма не открылась, сразу понятно, где искать возможные причины.


217-217: Повторное пробрасывание исключения
При возникновении ошибки она повторно генерируется. Проверьте, требуется ли дополнительная обработка или логирование на этой точке, чтобы уточнить детали.


219-220: Сброс модифицированности формы
Перед закрытием форма принудительно помечается как «не модифицированная». Это логично, если не требуется сохранять изменения или тест не должен влиять на данные.


227-228: Контроль, что форма закрыта
Вызов ОжидаетЧто(Форма.Открыта()).ЭтоЛожь() даёт чёткий фидбек о состоянии формы после закрытия. Отличный ход для надёжности автоматического теста.

exts/yaxunit/src/CommonModules/ЮТЛогированиеСлужебный/Module.bsl (2)

99-100: Вызов новых процедур определения уровня лога и доступности файла
Логика определения уровня и проверка файла вынесены в отдельные процедуры. Это повышает читаемость и улучшает модульность.


392-408: Определение уровня лога по строковым значениям
Сопоставление строковых констант уровней логирования с числовыми приоритетами выполнено понятно. Убедитесь, что заданные числа 99 для ошибок, 10 и 20 для остальных уровней, а также 0 по умолчанию, согласованы с остальными модулями.

@alkoleft alkoleft merged commit ed43933 into develop Dec 24, 2024
5 of 7 checks passed
@alkoleft alkoleft deleted the feature/474 branch December 24, 2024 14:35
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.

[Bug]: Ошибка запуска тестов если указан недоступный файл лога
1 participant