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

415 / Доработка получения типов из расширения #435

Merged
merged 2 commits into from
Nov 21, 2024

Conversation

alkoleft
Copy link
Member

@alkoleft alkoleft commented Nov 15, 2024

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

  • Исправлена ошибка работы в версиях до 8.3.13
  • Оптимизация для версия <8.3.11 и >8.3.20

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

Close #415

Summary by CodeRabbit

  • Новые функции

    • Добавлены функции для работы с расширениями сессий и ссылочными типами.
    • Введены функции для сравнения версий платформы.
    • Добавлена функция для обработки XML-описаний типов.
  • Устранение ошибок

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

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

    • Улучшено описание в тестах для повышения ясности результатов.

Copy link

coderabbitai bot commented Nov 15, 2024

Walkthrough

В данном пулл-реквесте внесены изменения в несколько модулей, включая добавление новых функций для работы с расширениями и метаданными. В модуле Module.bsl добавлены функции для получения активных расширений сессии, создания массивов ссылочных типов и описания типов метаданных. Также были удалены устаревшие функции, упрощая структуру модулей. В модуле ЮТОкружение добавлены функции для сравнения версий платформы. Внесены изменения в тесты для улучшения вывода сообщений.

Changes

File Change Summary
exts/yaxunit/src/CommonModules/ЮТМетаданныеСлужебныйВызовСервера/Module.bsl Добавлены функции: РасширенияСеанса(), СсылочныеТипыРасширений(), ОписаниеТиповЛюбаяСсылкаПоМетаданным(), СсылочныеКоллекции(). Удалены функции: СсылочныеТипыДобавляемыеРасширениями(), ДополнитьТипы(), ТипыОбъектовМетаданныхСсылочногоТипа().
exts/yaxunit/src/CommonModules/ЮТОкружение/Module.bsl Добавлены функции: ВерсияПлатформыБольшеИлиРавна(), ВерсияПлатформыМеньше().
exts/yaxunit/src/CommonModules/ЮТТипыДанныхСлужебный/Module.bsl Изменена функция ОписаниеТиповЛюбаяСсылка, добавлена новая функция AnyRef().
tests/src/CommonModules/ОМ_ЮТТипыДанныхСлужебный/Module.bsl Обновлено сообщение в тесте для улучшения читаемости: добавлен дополнительный параметр к утверждению.

Assessment against linked issues

Objective Addressed Explanation
Исправление ошибки удаления тестовых данных (415) Изменения не касаются удаления тестовых данных.

Possibly related PRs

  • Не удаляются тестовые данные расширений #416: Изменения в этом PR вводят новую функцию СсылочныеТипыДобавляемыеРасширениями, которая тесно связана с новыми функциями в основном PR, касающимися обработки метаданных и расширений.

🐰 В мире метаданных, мы вновь заиграли,
Расширения сессий, как звезды, сияли.
Устаревшие функции, прощайте, уходим,
Новый код, как весна, к нам приходит!
С тестами теперь всё станет ясней,
Давайте работать, дружно, скорей! 🌟


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

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

SonarQube Quality Gate failed! failed

bug 0 Bugs
vulnerability 0 Vulnerabilities
code_smell 1 Code Smells

No data Coverage
duplication_lt_3 0.00% Duplication

// До 8.3.11 не было возможности добавлять свои ссылочные объекты
// С версии 8.3.20.1549 AnyRef включает в себя типы из расширений
Результат = AnyRef();
// ИначеЕсли ЮТОкружение.ВерсияПлатформыБольшеИлиРавна("8.3.13") Тогда
Copy link
Contributor

Choose a reason for hiding this comment

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

🔗Программные модули не должны иметь закомментированных фрагментов кода

CODE_SMELL Codesmell  MINOR Minor

standard badpractice parameters  Why is this an issue?

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

🧹 Outside diff range and nitpick comments (7)
exts/yaxunit/src/CommonModules/ЮТОкружение/Module.bsl (2)

42-53: Функция корректно реализована, но требуется валидация параметра

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

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

 Функция ВерсияПлатформыБольшеИлиРавна(ВерсияДляПроверки) Экспорт
+    Если Не ЗначениеЗаполнено(ВерсияДляПроверки) Тогда
+        ВызватьИсключение НСтр("ru='Параметр ВерсияДляПроверки должен быть заполнен'");
+    КонецЕсли;
     
     Возврат ЮТСтроки.СравнитьВерсии(ЮТСлужебныйПовторногоИспользования.ВерсияПлатформы(), ВерсияДляПроверки) >= 0;
     
 КонецФункции

55-66: Функция корректно реализована, но требуется валидация параметра

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

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

 Функция ВерсияПлатформыМеньше(ВерсияДляПроверки) Экспорт
+    Если Не ЗначениеЗаполнено(ВерсияДляПроверки) Тогда
+        ВызватьИсключение НСтр("ru='Параметр ВерсияДляПроверки должен быть заполнен'");
+    КонецЕсли;
     
     Возврат ЮТСтроки.СравнитьВерсии(ЮТСлужебныйПовторногоИспользования.ВерсияПлатформы(), ВерсияДляПроверки) < 0;
     
 КонецФункции
exts/yaxunit/src/CommonModules/ЮТТипыДанныхСлужебный/Module.bsl (2)

155-163: Оптимизация получения типов выполнена корректно!

Логика обработки разных версий платформы реализована правильно. Комментарии с метриками производительности очень полезны для понимания причин изменений.

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

 	Если ЮТОкружение.ВерсияПлатформыМеньше("8.3.11") Или ЮТОкружение.ВерсияПлатформыБольшеИлиРавна("8.3.20.1549") Тогда
-		// До 8.3.11 не было возможности добавлять свои ссылочные объекты
-		// С версии 8.3.20.1549 AnyRef включает в себя типы из расширений
+		// До 8.3.11 не было возможности добавлять свои ссылочные объекты
+		// С версии 8.3.20.1549 AnyRef включает в себя типы из расширений
+		// 
+		// Производительность:
+		// - Текущая реализация: ~0.040 сек
+		// - Реализация через метаданные: ~4.485 сек
+		// (тесты на 100 итераций)
 		Результат = AnyRef();

299-308: Добавьте документацию к функции AnyRef

Функция реализована корректно, но требуется добавить документацию с описанием:

  • Назначения функции
  • Возвращаемого значения
  • Примера использования
+// Функция возвращает описание типов для любых ссылочных значений в системе
+//
+// Возвращаемое значение:
+//  ОписаниеТипов - Описание типов, включающее все ссылочные типы
+//
+// Пример:
+//  ОписаниеВсехСсылок = ЮТТипыДанныхСлужебный.AnyRef();
+//
 Функция AnyRef() Экспорт
exts/yaxunit/src/CommonModules/ЮТМетаданныеСлужебныйВызовСервера/Module.bsl (3)

57-94: Рекомендуется добавить обработку ошибок

Функция содержит сложную логику работы с метаданными расширений. Рекомендуется:

  1. Добавить обработку возможных ошибок при вычислении метаданных расширения
  2. Добавить проверку на пустой массив типов перед созданием описания типов
 Функция СсылочныеТипыРасширений() Экспорт
 	
 	МассивТипов = Новый Массив;
 	
 	СсылочныеКоллекции = СсылочныеКоллекции();
 	СобственныйОбъект = Метаданные.СвойстваОбъектов.ПринадлежностьОбъекта.Собственный;
 	
 	Для Каждого Расширение Из РасширенияСеанса() Цикл
 		
 		Если НЕ Расширение.ИзменяетСтруктуруДанных() Тогда
 			Продолжить;
 		КонецЕсли;
 		
 		УстановитьБезопасныйРежим(Истина);
+		Попытка
 			МетаданныеРасширения = Вычислить("Новый ОбъектМетаданныхКонфигурация(Расширение.ПолучитьДанные())");
+		Исключение
+			ЗаписьЖурналаРегистрации("ЮТМетаданные.СсылочныеТипыРасширений",
+				УровеньЖурналаРегистрации.Ошибка,,, 
+				ПодробноеПредставлениеОшибки(ИнформацияОбОшибке()));
+			Продолжить;
+		КонецПопытки;
 		
 		Для Каждого ИмяКоллекции Из СсылочныеКоллекции Цикл
 			
 			Коллекция = МетаданныеРасширения[ИмяКоллекции];
 			ИмяЭлемента = ЮТМетаданныеСлужебныйПовтИсп.ТипыМетаданных()[ИмяКоллекции].Имя;
 			
 			Для Каждого ОбъектМетаданных Из Коллекция Цикл
 				
 				Если ОбъектМетаданных.ПринадлежностьОбъекта = СобственныйОбъект Тогда
 					МассивТипов.Добавить(СтрШаблон("%1Ссылка.%2", ИмяЭлемента, ОбъектМетаданных.Имя));
 				КонецЕсли;
 				
 			КонецЦикла;
 			
 		КонецЦикла;
 		
 	КонецЦикла;
 	
+	Если МассивТипов.Количество() = 0 Тогда
+		Возврат Новый Массив;
+	КонецЕсли;
+	
 	ОписаниеТипов = Новый ОписаниеТипов(МассивТипов);
 	Возврат ОписаниеТипов.Типы();
 	
 КонецФункции

312-333: Оптимизация производительности при работе с большими массивами

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

 Функция ОписаниеТиповЛюбаяСсылкаПоМетаданным() Экспорт
 	
 	МассивТипов = Новый Массив;
 	
 	СсылочныеКоллекции = СсылочныеКоллекции();
 	
 	Для Каждого ИмяКоллекции Из СсылочныеКоллекции Цикл
 		
 		Коллекция = Метаданные[ИмяКоллекции];
 		ИмяЭлемента = ЮТМетаданныеСлужебныйПовтИсп.ТипыМетаданных()[ИмяКоллекции].Имя;
 		
 		Для Каждого ОбъектМетаданных Из Коллекция Цикл
 			
 			МассивТипов.Добавить(СтрШаблон("%1Ссылка.%2", ИмяЭлемента, ОбъектМетаданных.Имя));
 			
 		КонецЦикла;
 		
 	КонецЦикла;
 	
-	Возврат Новый ОписаниеТипов(СтрСоединить(МассивТипов, ","));
+	СтрокаТипов = Новый СписокЗначений;
+	Для Каждого Тип Из МассивТипов Цикл
+		СтрокаТипов.Добавить(Тип);
+	КонецЦикла;
+	Возврат Новый ОписаниеТипов(СтрокаТипов.ВыгрузитьЗначения());
 	
 КонецФункции

498-509: Рекомендуется кэширование результата

Функция возвращает статический список коллекций. Рекомендуется перенести её в модуль повторного использования (ЮТМетаданныеСлужебныйПовтИсп) для оптимизации производительности.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 1189797 and 91f0718.

📒 Files selected for processing (5)
  • exts/yaxunit/src/CommonModules/ЮТМетаданныеСлужебныйВызовСервера/Module.bsl (4 hunks)
  • exts/yaxunit/src/CommonModules/ЮТМетодыСлужебныйВызовСервера/Module.bsl (0 hunks)
  • exts/yaxunit/src/CommonModules/ЮТОкружение/Module.bsl (1 hunks)
  • exts/yaxunit/src/CommonModules/ЮТТипыДанныхСлужебный/Module.bsl (2 hunks)
  • tests/src/CommonModules/ОМ_ЮТТипыДанныхСлужебный/Module.bsl (1 hunks)
💤 Files with no reviewable changes (1)
  • exts/yaxunit/src/CommonModules/ЮТМетодыСлужебныйВызовСервера/Module.bsl
✅ Files skipped from review due to trivial changes (1)
  • tests/src/CommonModules/ОМ_ЮТТипыДанныхСлужебный/Module.bsl
🔇 Additional comments (2)
exts/yaxunit/src/CommonModules/ЮТОкружение/Module.bsl (1)

42-66: Проверить использование новых функций в тестах

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

exts/yaxunit/src/CommonModules/ЮТМетаданныеСлужебныйВызовСервера/Module.bsl (1)

49-55: LGTM: Корректная реализация получения расширений сеанса

Функция правильно использует привилегированный режим и корректно получает активные расширения сеанса.

@alkoleft alkoleft merged commit bd1cf5c into develop Nov 21, 2024
19 of 21 checks passed
@alkoleft alkoleft deleted the feature/415 branch November 21, 2024 12:38
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