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

Добавление структуры упорядочивания полей #184

Merged
merged 2 commits into from
Jan 13, 2025

Conversation

thvvmas
Copy link
Contributor

@thvvmas thvvmas commented Jan 10, 2025

Closes #182

Summary by CodeRabbit

  • Новые возможности

    • Добавлен параметр упорядочивания при получении данных из внешнего источника
  • Обновления

    • Увеличен номер версии конфигурации с 1.0.5.19 до 1.0.5.20
    • Обновлена версия библиотеки с 1.0.5.19 до 1.0.5.20

@thvvmas thvvmas added the enhancement Улучшение существующей функциональности label Jan 10, 2025
@thvvmas thvvmas requested a review from ivanmolodec January 10, 2025 16:14
@thvvmas thvvmas self-assigned this Jan 10, 2025
Copy link

coderabbitai bot commented Jan 10, 2025

Walkthrough

Изменения включают добавление нового необязательного параметра СтруктураУпорядочивания в функцию ПолучитьТаблицуДанныхИзВнешнегоИсточникаПоУсловиям в модуле интеграций. Также обновлена версия конфигурации с 1.0.5.19 до 1.0.5.20 в нескольких файлах. Эти изменения направлены на расширение функциональности получения данных с возможностью упорядочивания.

Changes

Файл Изменения
src/cf/CommonModules/пбп_ИнтеграцииСервер/Ext/Module.bsl Добавлен новый параметр СтруктураУпорядочивания в сигнатуру функции и обновлена логика обработки данных
src/cf/CommonModules/пбп_ОбновлениеИнформационнойБазыПБП/Ext/Module.bsl Обновлена версия с 1.0.5.19 до 1.0.5.20
src/cf/Configuration.xml Обновлена версия конфигурации с 1.0.5.19 до 1.0.5.20

Assessment against linked issues

Objective Addressed Explanation
Добавить структуру упорядочивания в получение таблицы данных из ВИД по условиям [#182]

Possibly related PRs

Suggested reviewers

  • ivanmolodec

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between be25a55 and 1a5f379.

📒 Files selected for processing (1)
  • src/cf/CommonModules/пбп_ИнтеграцииСервер/Ext/Module.bsl (4 hunks)
🔇 Additional comments (3)
src/cf/CommonModules/пбп_ИнтеграцииСервер/Ext/Module.bsl (3)

175-182: Документация параметра оформлена корректно!

Описание нового параметра СтруктураУпорядочивания соответствует стилю документации модуля.


189-190: Сигнатура функции обновлена корректно!

Добавление необязательного параметра СтруктураУпорядочивания со значением по умолчанию Неопределено обеспечивает обратную совместимость.


264-293: Реализация сортировки соответствует рекомендациям!

Текущая реализация включает все предложенные улучшения:

  1. Валидация значений направления сортировки (ВОЗР/УБЫВ)
  2. Защита от SQL-инъекций при использовании имен полей через параметризацию
  3. Оптимизированное построение строки запроса через массив

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.

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: 1

🧹 Nitpick comments (1)
src/cf/CommonModules/пбп_ИнтеграцииСервер/Ext/Module.bsl (1)

175-182: Добавьте пример структуры упорядочивания

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

Предлагаю добавить пример в документацию:

 //  СтруктураУпорядочивания	 - Структура - ключом является поле, по которому необходимо упорядочить, 
-//  значением является вид сортировки
+//  значением является вид сортировки
+//    Пример:
+//      СтруктураУпорядочивания = Новый Структура;
+//      СтруктураУпорядочивания.Вставить("Поле1", "УБЫВ");
+//      СтруктураУпорядочивания.Вставить("Поле2", "ВОЗР");
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 920fe08 and be25a55.

📒 Files selected for processing (3)
  • src/cf/CommonModules/пбп_ИнтеграцииСервер/Ext/Module.bsl (4 hunks)
  • src/cf/CommonModules/пбп_ОбновлениеИнформационнойБазыПБП/Ext/Module.bsl (1 hunks)
  • src/cf/Configuration.xml (1 hunks)
✅ Files skipped from review due to trivial changes (2)
  • src/cf/Configuration.xml
  • src/cf/CommonModules/пбп_ОбновлениеИнформационнойБазыПБП/Ext/Module.bsl
🔇 Additional comments (1)
src/cf/CommonModules/пбп_ИнтеграцииСервер/Ext/Module.bsl (1)

189-190: Корректное изменение сигнатуры функции

Добавление необязательного параметра СтруктураУпорядочивания выполнено правильно, с корректным значением по умолчанию.

Comment on lines 264 to 276
Если СтруктураУпорядочивания <> Неопределено Тогда
ПорядокЗапроса = "";
Для Каждого КлючЗначениеПорядка Из СтруктураУпорядочивания Цикл
НуженПеренос = ?(ПустаяСтрока(ПорядокЗапроса), "", ",
| ");
ПорядокЗапроса = ПорядокЗапроса + СтрШаблон("%1Таблица.%2 %3",
НуженПеренос, КлючЗначениеПорядка.Ключ, КлючЗначениеПорядка.Значение);
КонецЦикла;

ТекстЗапроса = ТекстЗапроса + "
|УПОРЯДОЧИТЬ ПО
| " + ПорядокЗапроса;
КонецЕсли;
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Необходимо добавить проверки и оптимизировать построение запроса

Текущая реализация требует следующих улучшений:

  1. Отсутствует валидация значений направления сортировки (ВОЗР/УБЫВ)
  2. Нет защиты от SQL-инъекций при использовании имен полей
  3. Можно оптимизировать построение строки запроса

Предлагаю следующие изменения:

 Если СтруктураУпорядочивания <> Неопределено Тогда
+    // Проверка корректности значений
+    ДопустимыеНаправления = Новый Массив;
+    ДопустимыеНаправления.Добавить("ВОЗР");
+    ДопустимыеНаправления.Добавить("УБЫВ");
+    
     ПорядокЗапроса = "";
+    МассивПорядка = Новый Массив;
     
     Для Каждого КлючЗначениеПорядка Из СтруктураУпорядочивания Цикл
-        НуженПеренос = ?(ПустаяСтрока(ПорядокЗапроса), "", ",
-        |    ");
-        ПорядокЗапроса = ПорядокЗапроса + СтрШаблон("%1Таблица.%2 %3",
-            НуженПеренос, КлючЗначениеПорядка.Ключ, КлючЗначениеПорядка.Значение);
+        Если ДопустимыеНаправления.Найти(ВРег(КлючЗначениеПорядка.Значение)) = Неопределено Тогда
+            ВызватьИсключение СтрШаблон(
+                "Недопустимое направление сортировки: %1. Допустимые значения: ВОЗР, УБЫВ",
+                КлючЗначениеПорядка.Значение
+            );
+        КонецЕсли;
+        
+        // Используем параметры запроса для защиты от SQL-инъекций
+        ИмяПараметра = "П_" + КлючЗначениеПорядка.Ключ;
+        Запрос.УстановитьПараметр(ИмяПараметра, КлючЗначениеПорядка.Ключ);
+        МассивПорядка.Добавить(СтрШаблон("Таблица.&%1 %2", 
+            ИмяПараметра, КлючЗначениеПорядка.Значение));
     КонецЦикла;
 
+    ПорядокЗапроса = СтрСоединить(МассивПорядка, ",
+    |    ");
+    
     ТекстЗапроса = ТекстЗапроса + "
         |УПОРЯДОЧИТЬ ПО
         |    " + ПорядокЗапроса;
 КонецЕсли;

Committable suggestion skipped: line range outside the PR's diff.

This comment has been minimized.

Copy link

Passed

Analysis Details

0 Issues

  • Bug 0 Bugs
  • Vulnerability 0 Vulnerabilities
  • Code Smell 0 Code Smells

Coverage and Duplications

  • Coverage No coverage information (12.90% Estimated after merge)
  • Duplications No duplication information (0.40% Estimated after merge)

Project ID: PSSL

View in SonarQube

@ivanmolodec ivanmolodec merged commit ad92b52 into develop Jan 13, 2025
4 checks passed
@ivanmolodec ivanmolodec deleted the add-sort-in-get-data-from-external-db branch January 13, 2025 15:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Улучшение существующей функциональности
Projects
None yet
2 participants