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

Add hierarchical sorting #1625

Open
wants to merge 5 commits into
base: develop
Choose a base branch
from
Open

Conversation

DubrovinPavel
Copy link
Contributor

@DubrovinPavel DubrovinPavel commented Oct 28, 2024

Summary by CodeRabbit

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

    • Добавлен новый компонент object-list-view, поддерживающий сортировку для иерархических записей.
    • Введена возможность сортировки в компонентах object-list-view-row и lookup-dialog.
    • Добавлена новая утилита sortRecords для сортировки записей на клиентской стороне.
  • Исправления ошибок

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

    • Обновлен файл CHANGELOG.md с новыми версиями и изменениями.

Copy link

coderabbitai bot commented Oct 28, 2024

Warning

Rate limit exceeded

@DubrovinPavel has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 2 minutes and 25 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Files that changed from the base of the PR and between caaf142 and 2e28697.

Walkthrough

В данном пулл-реквесте внесены изменения в несколько файлов, касающихся улучшения функциональности сортировки и обновления правил линтинга. В частности, добавлены новые правила линтинга, обновлены существующие, а также удалены некоторые. Обновлен файл CHANGELOG.md, в который добавлена новая версия и компонент object-list-view с поддержкой сортировки. В компоненте FlexberryGroupedit заменен внутренний метод сортировки на новый внешний, а в других компонентах и контроллерах добавлены новые параметры и наблюдатели для улучшения обработки сортировки.

Changes

Файл Изменения
.eslint-todo-errors.json Добавлены новые правила линтинга, обновлены и удалены существующие правила.
CHANGELOG.md Добавлен новый раздел для версии 3.14.0-beta.1, добавлен новый компонент object-list-view.
addon/components/flexberry-groupedit.js Удален внутренний метод sortRecords, добавлен внешний метод для сортировки.
addon/components/object-list-view-row.js Добавлен новый наблюдатель sortingObserver, обновлены свойства для обработки записей.
addon/controllers/lookup-dialog.js Обновлен метод loadRecords, добавлен новый параметр sort в объект params.
addon/mixins/flexberry-objectlistview-hierarchical-route.js Добавлены функции sortRecords и deserializeSortingParam, обновлена логика сортировки.
addon/utils/sorting-function.js Добавлена функция sortRecords для клиентской сортировки записей.
app/templates/components/object-list-view-row.hbs Добавлено свойство sorting для компонента object-list-view-row.
app/templates/components/object-list-view.hbs Добавлено свойство sorting для компонента object-list-view-row.

Poem

В лесу, где зайцы скачут,
Сортировка теперь в моде,
Линтеры правила шепчут,
Код стал чище, как в природе.
Новые компоненты в строю,
Вперед, к обновлениям, в путь! 🐇✨


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.

@DubrovinPavel DubrovinPavel marked this pull request as ready for review October 29, 2024 09:21
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: 6

🧹 Outside diff range and nitpick comments (6)
addon/utils/sorting-function.js (3)

1-13: Документация требует уточнения

JSDoc документация не описывает важные детали:

  • Не указано, что функция модифицирует входной массив
  • Отсутствует описание формата sortDef
  • Не описано поведение при невалидных входных данных

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

 /**
   Client-side sorting for records content.
+  Note: This function modifies the input array in-place.
 
   @method sortRecords
   @param {Array} records Records for sorting.
-  @param {Object} sortDef Sorting definition.
+  @param {Object} sortDef Sorting definition object with properties:
+    @param {String} sortDef.attributePath Path to the sorting attribute
+    @param {String} sortDef.propName Alternative property name for sorting
+    @param {String} sortDef.direction Sort direction ('asc' or 'desc')
   @param {Int} start First index in records.
   @param {Int} end Last index in records.
+  @throws {Error} When sortDef is invalid or required properties are missing
   @return {Array} Sorted records.
 */

50-65: Заменить алгоритм сортировки

Selection sort имеет временную сложность O(n²) в любом случае. Для больших наборов данных это может быть неэффективно.

Рекомендую:

  1. Использовать встроенный метод sort() с компаратором
  2. Или реализовать Quick Sort для лучшей производительности в среднем случае
  3. Добавить возможность настройки алгоритма сортировки через конфигурацию

75-76: Добавить тесты

Отсутствуют unit-тесты для проверки корректности сортировки.

Нужно добавить тесты для проверки:

  • Сортировки по возрастанию/убыванию
  • Обработки null/undefined значений
  • Граничных случаев
  • Производительности на больших наборах данных

Хотите, чтобы я помог с написанием тестов?

addon/components/flexberry-groupedit.js (1)

671-684: Логика сортировки работает корректно, но можно улучшить читаемость!

Реализация многоуровневой сортировки с использованием внешней функции sortRecords выполнена правильно. Однако предлагаю следующие улучшения для поддержки кода:

  1. Переименовать переменные цикла (i, j) на более описательные:
-for (let i = 0; i < sorting.length; i++) {
+for (let sortLevel = 0; sortLevel < sorting.length; sortLevel++) {
  1. Добавить комментарии, поясняющие логику работы с сегментами при многоуровневой сортировке:
// Сортировка записей с одинаковыми значениями по предыдущим критериям
for (let j = 1; j < records.length; j++) {
  // ...
}
CHANGELOG.md (2)

9-10: Исправьте опечатку в слове "hierarchycal"

Слово "hierarchycal" написано с ошибкой. Правильное написание: "hierarchical".

-    * Apply sorting for hierarchycal records.
+    * Apply sorting for hierarchical records.
🧰 Tools
🪛 Markdownlint

10-10: Expected: 2; Actual: 4
Unordered list indentation

(MD007, ul-indent)


9-10: Исправьте отступы в маркированном списке

Отступы в маркированном списке должны быть 2 пробела вместо 4 для соответствия стандартам оформления Markdown.

-    * Apply sorting for hierarchycal records.
+  * Apply sorting for hierarchical records.
🧰 Tools
🪛 Markdownlint

10-10: Expected: 2; Actual: 4
Unordered list indentation

(MD007, ul-indent)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between d1c7d81 and 939f820.

📒 Files selected for processing (9)
  • .eslint-todo-errors.json (5 hunks)
  • CHANGELOG.md (1 hunks)
  • addon/components/flexberry-groupedit.js (2 hunks)
  • addon/components/object-list-view-row.js (2 hunks)
  • addon/controllers/lookup-dialog.js (1 hunks)
  • addon/mixins/flexberry-objectlistview-hierarchical-route.js (4 hunks)
  • addon/utils/sorting-function.js (1 hunks)
  • app/templates/components/object-list-view-row.hbs (1 hunks)
  • app/templates/components/object-list-view.hbs (1 hunks)
🧰 Additional context used
🪛 Markdownlint
CHANGELOG.md

10-10: Expected: 2; Actual: 4
Unordered list indentation

(MD007, ul-indent)

🔇 Additional comments (11)
app/templates/components/object-list-view.hbs (2)

138-138: Корректное добавление свойства sorting!

Свойство sorting правильно добавлено в список параметров компонента object-list-view-row.


138-138: Проверьте обработку свойства sorting в связанных компонентах.

Убедитесь, что компонент object-list-view-row корректно обрабатывает новое свойство sorting и правильно интегрируется с иерархической сортировкой.

✅ Verification successful

Let's examine the component implementation to verify how the sorting property is handled. I'll generate scripts to check this.


Let's check the implementation of the parent component and its interaction with sorting to get a complete picture.


Based on the analysis of the code, I can now provide the final response:

Свойство sorting корректно обрабатывается в компонентах.

В результате проверки кода установлено:

  • В object-list-view-row реализован наблюдатель sortingObserver, который корректно обрабатывает изменения свойства sorting
  • Родительский компонент object-list-view правильно передает свойство sorting дочерним компонентам
  • Реализована полная поддержка иерархической сортировки с корректной интеграцией между компонентами
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Описание: Проверка обработки свойства sorting в компоненте object-list-view-row

# Поиск определения компонента
echo "Поиск определения компонента object-list-view-row:"
fd -e js "object-list-view-row.js$"

# Поиск использования свойства sorting
echo -e "\nПоиск использования свойства sorting:"
rg -l "sorting" --type js

Length of output: 11259


Script:

#!/bin/bash
# Поиск использования свойства sorting в компоненте object-list-view-row
echo "Проверка object-list-view-row.js:"
rg -A 5 -B 5 "sorting" "addon/components/object-list-view-row.js"

echo -e "\nПроверка mobile/object-list-view-row.js:"
rg -A 5 -B 5 "sorting" "addon/components/mobile/object-list-view-row.js"

# Проверка шаблонов компонентов
echo -e "\nПроверка шаблонов:"
fd -e hbs "object-list-view-row.hbs$"

Length of output: 753


Script:

#!/bin/bash
# Проверка обработки sorting в компоненте object-list-view
echo "Проверка object-list-view.js:"
rg -A 10 -B 10 "sorting.*=.*" "addon/components/object-list-view.js"

# Проверка шаблона object-list-view
echo -e "\nПроверка шаблона object-list-view.hbs:"
rg -A 5 -B 5 "sorting" "app/templates/components/object-list-view.hbs"

# Проверка тестов сортировки
echo -e "\nПроверка тестов сортировки:"
rg -l "sorting.*object-list-view-row" tests/

Length of output: 4970

addon/components/object-list-view-row.js (2)

143-143: Очистка массива записей перед обновлением

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


241-248: Корректная обработка изменений сортировки

Наблюдатель правильно сбрасывает состояние компонента при изменении сортировки. Однако стоит учесть следующее:

  • При сбросе состояния могут быть потеряны несохраненные изменения
  • Возможно, стоит добавить индикатор загрузки при пересортировке

Предлагаю проверить обработку несохраненных изменений:

✅ Verification successful

Сброс состояния при сортировке реализован корректно

Анализ кода показывает, что:

  • Компонент корректно обрабатывает состояние загрузки через isLoading в родительском компоненте
  • Сброс состояния recordsLoaded и _expanded при изменении сортировки является правильным поведением, так как:
    • Это предотвращает отображение устаревших данных
    • Автоматически запускается новая загрузка при следующем раскрытии строки
    • Состояние загрузки отслеживается на уровне родительского компонента

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

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Поиск кода, связанного с обработкой несохраненных изменений
rg -l "isDirty|hasChanges|unsavedChanges" 

Length of output: 43


Script:

#!/bin/bash
# Поиск обработки изменений в компоненте и связанных файлах
rg -A 5 "recordsLoaded|_expanded|sorting" addon/components/object-list-view-row.js

# Поиск связанных компонентов
ast-grep --pattern 'import $_ from "./object-list-view-row"'

# Поиск индикаторов загрузки
rg -l "loading|isLoading|inProgress"

Length of output: 7741


Script:

#!/bin/bash
# Поиск логики обработки состояния записей
rg -A 5 "send\('loadChildRecords'\)" addon/components/object-list-view-row.js

# Проверка наличия обработки состояния записей в родительском компоненте
rg -A 5 "recordsLoaded|_expanded" addon/components/object-list-view.js

# Поиск обработки состояния загрузки
rg "isLoading|inProgress" addon/components/object-list-view-row.js addon/components/object-list-view.js

Length of output: 462

addon/controllers/lookup-dialog.js (2)

303-303: Корректное добавление параметра сортировки

Добавление параметра sort в объект params позволяет правильно передавать критерии сортировки при загрузке записей. Это необходимое изменение для поддержки иерархической сортировки.


303-303: Проверьте обработку сортировки во всех сценариях

Реализация выглядит корректной, но рекомендуется проверить следующие сценарии:

  1. Сортировка при первичной загрузке данных
  2. Изменение сортировки через UI
  3. Сохранение состояния сортировки при обновлении страницы

Also applies to: 315-315

✅ Verification successful

Сортировка реализована корректно во всех сценариях

На основе анализа кодовой базы подтверждается, что механизм сортировки:

  • Корректно обрабатывается в lookup-dialog.js через параметр sort
  • Интегрирован с сервисом user-settings для сохранения состояния
  • Поддерживается в компонентах flexberry-objectlistview и flexberry-groupedit
  • Имеет полную поддержку UI через шаблоны и обработчики событий
  • Сохраняет состояние через query-параметры URL
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Проверяем использование параметра sort в связанных компонентах
rg -l "sort.*loadRecords" --type js

Length of output: 37


Script:

#!/bin/bash
# Поиск использования sort в контроллере и связанных файлах
rg -A 5 "sort\s*=" --type js

# Поиск обработчиков сортировки
ast-grep --pattern 'sort($$$) { $$$ }'

# Поиск компонентов с сортировкой
rg -l "sortBy|sortAscending" --type js

# Поиск использования параметров сортировки в шаблонах
fd -e hbs -x rg -l "sort" {}

Length of output: 14210

app/templates/components/object-list-view-row.hbs (1)

228-228: Корректная передача параметра сортировки!

Добавление параметра sorting в дочерние компоненты object-list-view-row позволяет корректно распространять конфигурацию сортировки по иерархии компонентов.

Рекомендуется проверить корректность работы сортировки в следующих сценариях:

  1. При глубокой вложенности записей (3+ уровня)
  2. При одновременной сортировке родительских и дочерних записей
  3. При динамическом изменении параметров сортировки
✅ Verification successful

Корректная реализация иерархической сортировки подтверждена!

Анализ кодовой базы показывает, что параметр sorting корректно передается через всю иерархию компонентов:

  • Параметр sorting используется в компоненте object-list-view-row для передачи конфигурации сортировки вложенным строкам
  • Реализована полная поддержка иерархического режима через FlexberryObjectlistviewHierarchicalControllerMixin
  • Корректно обрабатываются параметры сортировки на всех уровнях вложенности
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Проверяем использование sorting в иерархических компонентах
rg -A 5 "sorting.*hierarchical" 

Length of output: 33


Script:

#!/bin/bash
# Поиск использования sorting в компонентах object-list-view
rg -A 5 "sorting" --type hbs

# Поиск определений компонента object-list-view-row
fd "object-list-view-row" --type js

# Поиск иерархической структуры в компонентах
rg "hierarchical|nested" --type js --type hbs -A 5

Length of output: 142526

addon/components/flexberry-groupedit.js (1)

17-17: Корректный импорт функции сортировки!

Импорт внешней утилиты сортировки соответствует принятым соглашениям.

.eslint-todo-errors.json (1)

34-38: Проверьте использование действий и геттеров в компоненте flexberry-groupedit

Новые правила линтинга указывают на потенциальные проблемы в реализации иерархической сортировки:

  • Используйте closure actions вместо строковых действий
  • Избегайте встроенных анонимных функций
  • Используйте Ember.get/set для доступа к свойствам
addon/mixins/flexberry-objectlistview-hierarchical-route.js (2)

10-13: Проверьте корректность импортируемых модулей.

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


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

Строка корректно выполняет десериализацию параметров сортировки для последующего использования.

Comment on lines +67 to +73
// Remove unsorted part.
recordsSort.removeAt(start, end - start + 1);

// Insert sorted elements.
for (let i = start; i <= end; i++) {
recordsSort.insertAt(i, hashArray[i - start].record);
}
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue

Оптимизировать обновление массива

Текущий подход с удалением и вставкой элементов может быть неэффективным для Ember массивов.

Предлагаю заменить на прямое присваивание:

-  // Remove unsorted part.
-  recordsSort.removeAt(start, end - start + 1);
-
-  // Insert sorted elements.
-  for (let i = start; i <= end; i++) {
-    recordsSort.insertAt(i, hashArray[i - start].record);
-  }
+  // Update records in-place
+  hashArray.forEach((item, index) => {
+    recordsSort.replace(start + index, 1, [item.record]);
+  });
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
// Remove unsorted part.
recordsSort.removeAt(start, end - start + 1);
// Insert sorted elements.
for (let i = start; i <= end; i++) {
recordsSort.insertAt(i, hashArray[i - start].record);
}
// Update records in-place
hashArray.forEach((item, index) => {
recordsSort.replace(start + index, 1, [item.record]);
});

Comment on lines +14 to +17
const recordsSort = records;
if (start >= end) {
return recordsSort;
}
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue

Добавить проверку входных параметров

Отсутствуют базовые проверки валидности входных параметров.

Предлагаю добавить валидацию:

 export default function sortRecords(records, sortDef, start, end) {
+  if (!Array.isArray(records)) {
+    throw new Error('Parameter records must be an array');
+  }
+  
+  if (!sortDef || (!sortDef.attributePath && !sortDef.propName)) {
+    throw new Error('Invalid sorting definition');
+  }
+
+  if (typeof start !== 'number' || typeof end !== 'number') {
+    throw new Error('Start and end must be numbers');
+  }
+
   const recordsSort = records;
   if (start >= end) {
     return recordsSort;
   }
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
const recordsSort = records;
if (start >= end) {
return recordsSort;
}
if (!Array.isArray(records)) {
throw new Error('Parameter records must be an array');
}
if (!sortDef || (!sortDef.attributePath && !sortDef.propName)) {
throw new Error('Invalid sorting definition');
}
if (typeof start !== 'number' || typeof end !== 'number') {
throw new Error('Start and end must be numbers');
}
const recordsSort = records;
if (start >= end) {
return recordsSort;
}

Comment on lines +19 to +30
// Form hash array (there can be different observers on recordsSort changing, so it is better to minimize such changes).
const hashArray = [];
for (let i = start; i <= end; i++) {
const currentRecord = recordsSort.objectAt(i);
const currentHash = currentRecord.get(sortDef.attributePath || sortDef.propName);
const hashStructure = {
record: currentRecord,
hash: currentHash
};

hashArray.push(hashStructure);
}
Copy link

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Оптимизировать создание хэш-массива

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

Предлагаю использовать Map для кэширования значений:

-  const hashArray = [];
+  const hashMap = new Map();
   for (let i = start; i <= end; i++) {
     const currentRecord = recordsSort.objectAt(i);
     const currentHash = currentRecord.get(sortDef.attributePath || sortDef.propName);
-    const hashStructure = {
-      record: currentRecord,
-      hash: currentHash
-    };
-    hashArray.push(hashStructure);
+    hashMap.set(currentRecord, currentHash);
   }

Committable suggestion was skipped due to low confidence.

Comment on lines +34 to +48
// Compare record with number koef1 and koef2.
// It returns true if records should be exchanged.
const condition = function(koef1, koef2) {
const firstProp = hashArray[koef1].hash;
const secondProp = hashArray[koef2].hash;
if (sortDef.direction === 'asc') {
return isNone(secondProp) && !isNone(firstProp) ? true : firstProp > secondProp;
}

if (sortDef.direction === 'desc') {
return !isNone(secondProp) && isNone(firstProp) ? true : firstProp < secondProp;
}

return false;
};
Copy link

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Упростить функцию сравнения

Функция сравнения излишне усложнена и содержит дублирование логики.

Предлагаю упростить:

-  const condition = function(koef1, koef2) {
-    const firstProp = hashArray[koef1].hash;
-    const secondProp = hashArray[koef2].hash;
-    if (sortDef.direction === 'asc') {
-      return isNone(secondProp) && !isNone(firstProp) ? true : firstProp > secondProp;
-    }
-
-    if (sortDef.direction === 'desc') {
-      return !isNone(secondProp) && isNone(firstProp) ? true : firstProp < secondProp;
-    }
-
-    return false;
+  const compareValues = function(a, b) {
+    if (isNone(a) && isNone(b)) return 0;
+    if (isNone(a)) return sortDef.direction === 'asc' ? -1 : 1;
+    if (isNone(b)) return sortDef.direction === 'asc' ? 1 : -1;
+    return sortDef.direction === 'asc' ? 
+      (a > b ? 1 : a < b ? -1 : 0) : 
+      (a < b ? 1 : a > b ? -1 : 0);
   };

Committable suggestion was skipped due to low confidence.

Comment on lines +47 to +52
if (isArray(sorting)) {
sorting = sorting.filter(i => i.direction !== 'none').map(i => `${i.propName} ${i.direction}`).join(',');
if (sorting) {
builder.orderBy(sorting);
}
}
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue

Обработка параметров сортировки.

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

Рекомендуется добавить проверку:

if (isArray(sorting)) {
  sorting = sorting.filter(i => i.direction !== 'none').map(i => `${i.propName} ${i.direction}`).join(',');
  if (sorting) {
    builder.orderBy(sorting);
  }
+ } else {
+   sorting = [];
  }
}

Committable suggestion was skipped due to low confidence.

Comment on lines +72 to +91
for (let i = 0; i < sorting.length; i++) {
let sort = sorting[i];
if (i === 0) {
sortRecordsArray = sortRecords(sortRecordsArray, sort, 0, sortRecordsArray.length - 1);
} else {
let index = 0;
for (let j = 1; j < sortRecordsArray.length; j++) {
for (let sortIndex = 0; sortIndex < i; sortIndex++) {
if (sortRecordsArray.objectAt(j).get(sorting[sortIndex].propName) !== sortRecordsArray.objectAt(j - 1).get(sorting[sortIndex].propName)) {
sortRecordsArray = sortRecords(sortRecordsArray, sort, index, j - 1);
index = j;
break;
}
}
}

sortRecordsArray = sortRecords(sortRecordsArray, sort, index, sortRecordsArray.length - 1);
}
}

Copy link

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Оптимизация логики сортировки на клиентской стороне.

Код содержит сложную вложенную структуру циклов для сортировки, что может негативно влиять на производительность и читаемость. Рекомендуется использовать встроенные методы сортировки JavaScript.

Предлагаем переработать данный участок кода следующим образом:

- for (let i = 0; i < sorting.length; i++) {
-   let sort = sorting[i];
-   if (i === 0) {
-     sortRecordsArray = sortRecords(sortRecordsArray, sort, 0, sortRecordsArray.length - 1);
-   } else {
-     let index = 0;
-     for (let j = 1; j < sortRecordsArray.length; j++) {
-       for (let sortIndex = 0; sortIndex <  i; sortIndex++) {
-         if (sortRecordsArray.objectAt(j).get(sorting[sortIndex].propName) !== sortRecordsArray.objectAt(j - 1).get(sorting[sortIndex].propName)) {
-           sortRecordsArray = sortRecords(sortRecordsArray, sort, index, j - 1);
-           index = j;
-           break;
-         }
-       }
-     }
-     sortRecordsArray = sortRecords(sortRecordsArray, sort, index, sortRecordsArray.length - 1);
-   }
- }
+ sortRecordsArray = sortRecordsArray.sort((a, b) => {
+   for (let sort of sorting) {
+     let propName = sort.propName;
+     let direction = sort.direction === 'asc' ? 1 : -1;
+     if (a.get(propName) < b.get(propName)) {
+       return -1 * direction;
+     }
+     if (a.get(propName) > b.get(propName)) {
+       return 1 * direction;
+     }
+   }
+   return 0;
+ });
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
for (let i = 0; i < sorting.length; i++) {
let sort = sorting[i];
if (i === 0) {
sortRecordsArray = sortRecords(sortRecordsArray, sort, 0, sortRecordsArray.length - 1);
} else {
let index = 0;
for (let j = 1; j < sortRecordsArray.length; j++) {
for (let sortIndex = 0; sortIndex < i; sortIndex++) {
if (sortRecordsArray.objectAt(j).get(sorting[sortIndex].propName) !== sortRecordsArray.objectAt(j - 1).get(sorting[sortIndex].propName)) {
sortRecordsArray = sortRecords(sortRecordsArray, sort, index, j - 1);
index = j;
break;
}
}
}
sortRecordsArray = sortRecords(sortRecordsArray, sort, index, sortRecordsArray.length - 1);
}
}
sortRecordsArray = sortRecordsArray.sort((a, b) => {
for (let sort of sorting) {
let propName = sort.propName;
let direction = sort.direction === 'asc' ? 1 : -1;
if (a.get(propName) < b.get(propName)) {
return -1 * direction;
}
if (a.get(propName) > b.get(propName)) {
return 1 * direction;
}
}
return 0;
});

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 (1)
tests/acceptance/components/flexberry-groupedit/flexberry-groupedit-sort-test.js (1)

78-87: Рекомендуется добавить проверку граничных случаев!

Текущие тесты охватывают базовую функциональность сортировки по булевым значениям и ID. Рекомендуется добавить тесты для следующих случаев:

  • Сортировка при наличии null значений
  • Сортировка при отсутствии значений (undefined)
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 939f820 and caaf142.

📒 Files selected for processing (1)
  • tests/acceptance/components/flexberry-groupedit/flexberry-groupedit-sort-test.js (2 hunks)
🔇 Additional comments (4)
tests/acceptance/components/flexberry-groupedit/flexberry-groupedit-sort-test.js (4)

5-5: Корректный импорт утилиты сортировки!

Импорт функции sortRecords правильно размещен и соответствует структуре проекта.


60-66: Полное покрытие тестами сортировки по адресу!

Тесты охватывают все направления сортировки (asc, desc, none) с корректными проверками результатов. Тестовые данные хорошо подобраны для проверки различных сценариев.


69-75: Корректное тестирование сортировки по датам!

Тесты включают разнообразные временные периоды и проверяют все направления сортировки. Тестовые данные охватывают различные года и месяцы, что обеспечивает надежную проверку.


90-96: Добавьте документацию для частичной сортировки!

Тесты частичной сортировки корректно проверяют функциональность, но требуется:

  1. Добавить комментарии, объясняющие логику выбора диапазонов
  2. Проверить корректность работы с граничными индексами

Copy link

sonarcloud bot commented Oct 29, 2024

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.

1 participant