Locus No Pilotus
Project of four first grade MIPT DAFE/RSE students (for engineering practical work in the second semester) in Qt C++
Loading...
Searching...
No Matches
TODO - Known Issues & Improvements


Critical

1. lib::TrappyLine::SetJsonInfo() - пустое тело (десериализация сломана)

  • Файл: lib/trappy_line.h
  • Метод SetJsonInfo() не делает ничего (реализован как override {}). Это означает, что TrappyLine не может быть десериализован из JSON через стандартный интерфейс JSONable.
  • Сейчас обходной путь существует в GuiJsonFile::Open(), который вручную создаёт TrappyLine после загрузки Target, но стандартный контракт должен работать.
  • Нужно: реализовать тело метода или пересмотреть наследование TrappyLine от JSONable.

2. lib::TrappyLine::CheckErrorValues_() всегда бросает исключение

  • Файл: lib/trappy_line.h
  • Метод безусловно кидает std::runtime_error. Это делает любой вызов валидации на TrappyLine фатальным.
  • Нужно: либо реализовать реальную проверку, либо оставить пустым (no-op), либо вынести TrappyLine из иерархии JSONable.

3. Приватное наследование Drawable у Segment и Trajectory

  • Файлы: gui/segment.h, gui/trajectory.h
  • class Segment : private Drawable и class Trajectory : private Drawable скрывают метод Draw() от полиморфного доступа через интерфейс Drawable. Это противоречит самой идее абстрактного базового класса.
  • Нужно: заменить private на public.

4. Raw-указатели с риском висячих ссылок

  • Файлы: gui/trappy_line.h (std::pair<gui::Target*, gui::Target*>), gui/flying_robot.h (gui::Trajectory*), data_tools/plot_area/plot_area.h (DataManager*), data_tools/tables_connection/tables_connection.h (DataManager*, PlotArea*)
  • Хранение сырых указателей на объекты, чьё время жизни не гарантировано. Удаление Target из DataManager делает указатели в TrappyLine висячими. Очистка Trajectory при работающем таймере FlyingRobot - use-after-free.
  • Нужно: рассмотреть std::shared_ptr, QPointer, или документировать контракты времени жизни. Как минимум - сбрасывать указатели при удалении.

Medium

5. Off-by-one в Hill::IsChanged() - пропускается последняя вершина

  • Файл: lib/hill.cpp
  • Цикл for (size_t i = 0; i < vertices_.size() - 1; i++) не проверяет последнюю вершину. Изменение последней вершины полигона не будет обнаружено как «несохранённое изменение».
  • Нужно: исправить границу на vertices_.size().

6. Нет интеграционных тестов

  • Тестируются только отдельные функции (lib/ и math/) в изоляции. Нет тестов, которые:
    • Загружают JSON-файл из .extra/json/
    • Вычисляют траекторию
    • Сравнивают результат с ожидаемым набором сегментов
  • Нужно: добавить end-to-end тесты для полного пайплайна.

7. Нет автоматизированных GUI-тестов

  • Файл: tests/gui/segment_test.txt
  • Единственный «тест» для GUI - ручной скрипт, который нужно вставлять в mainwindow.cpp. Никаких автоматических проверок Qt-виджетов, сигналов/слотов, UI-взаимодействий.
  • Нужно: добавить тесты с Qt Test или аналогичным фреймворком.

8. Неединообразная точность сравнения (epsilon)

  • lib/point.h определяет precision = 1.0E-6
  • lib/trappy_circle.cpp использует хардкод 10.E-7
  • lib/segment.cpp использует precision из point.h
  • Нужно: единый источник истины для epsilon (например, вынести в lib/infinity.h) и ссылаться на него везде.

9. God-класс MainWindow

  • Файл: main/mainwindow.h + 5 файлов mainwindow_connections/*.cpp
  • MainWindow содержит ~35 слот-методов и делает всё: файловый I/O, создание объектов, интерактивные режимы мыши, управление траекторией и роботом, клавиатурные события, контекстные меню. Единый класс без делегирования (кроме data_tools).
  • Нужно: разбить на отдельные контроллеры (AddObjectController, InteractivePlotController, TrajectoryController) или вынести логику из слотов в data_tools.

10. Хардкод относительного пути к изображению робота

  • Файл: gui/flying_robot.cpp
  • Draw() загружает "../images/flying_robot_pixel.png" относительно рабочей директории. При запуске из другого каталога изображение не найдётся.
  • Нужно: использовать QCoreApplication::applicationDirPath() или Qt Resource System (.qrc).

11. Magic-числа в анимации робота

  • Файл: gui/flying_robot.cpp
  • line_const_ (0.01, 0.05, 0.375) и число разбиений дуги (100, 20, 7.5) - хардкод без поясняющих констант.
  • Нужно: вынести в именованные constexpr переменные.

12. Segment и Target - геттеры возвращают mutable-ссылки

  • Файлы: gui/segment.h (Start(), End(), Center() - возвращают lib::Point&)
  • Внешний код может изменить внутреннюю геометрию сегмента в обход уведомлений и перерисовки.
  • Нужно: возвращать const lib::Point&, либо добавить уведомления при изменении.

Minor

13. Смешанный язык комментариев

  • Все комментарии и Doxygen-документация на русском, идентификаторы на английском. Это снижает доступность для не-русскоязычных контрибьюторов.
  • Нужно: постепенный перевод на английский.

14. PlotItemArc вне неймспейса

  • Файл: gui/plot_item_arc.h
  • Все классы gui/ живут в namespace gui, а PlotItemArc - в глобальном. Неединообразно.
  • Нужно: переместить в namespace gui или выделить в отдельный неймспейс.

15. Дублирование в Hill::Draw() и TrappyLine::Draw()

  • Hill::Draw() дублирует замыкающую вершину полигона (N+1 точка данных).
  • TrappyLine::Draw() и Segment::Draw() (случай линии) используют два вызова addData вместо setData({x1,x2}, {y1,y2}).
  • Не критично, но неконсистентно.

16. Airport и Target не имеют .cpp файлов

  • Файлы: gui/airport.h, gui/target.h
  • Реализация Draw() полностью в хедере. Для Target это минимально, но для Airport создаёт транзитивную зависимость компиляции у всех, кто включает airport.h.
  • Нужно: вынести реализацию в .cpp файлы.

17. Segment::CouldBeArc() используется без отдельных тестов

  • Метод вызывается в рандомизированных тестах сегментов как предусловие, но не имеет собственных тест-кейсов с граничными условиями.
  • Нужно: добавить dedicated тесты.

18. Нет бенчмарков производительности

  • Алгоритмы комбинаторные (TSP - NP-полная задача), но нет тестов на время выполнения или регрессию сложности при росте числа целей/препятствий.
  • Нужно: добавить хотя бы простые тайминг-тесты для OptimalWayCalculator и TravellingSalesmansProblem при разном размере входа.

19. CI собирает проект, но не запускает тесты

  • В .github/workflows/ есть build.yml (сборка на Ubuntu + Qt6) и doxygen.yml (документация). Сборка есть, но тесты не запускаются - нет ctest или ./tests/tests в workflow.
  • Нужно: добавить шаг запуска тестов в build.yml.

20. TrappyLine не имеет валидации ID-диапазона

  • Target (10000–19999), TrappyCircle (20000–29999), Hill (40000–49999) - все проверяют диапазон. TrappyLine (должен быть 30000–39999) - нет.
  • Нужно: добавить проверку диапазона при реализации SetJsonInfo().

21. DeleteEdge() в TSP использует линейный поиск

  • Файл: math/littles_algorithm/travelling_salesmans_problem.cpp
  • DeleteEdge() сканирует всю extra row/col для нахождения позиции удаляемого ребра - O(N).
  • Нужно: хранить обратный маппинг (vertex → matrix index) для O(1) поиска.

22. QCustomPlot::selectTest() возвращает -1 в PlotItemArc

  • Файл: gui/plot_item_arc.h - все дуги траектории некликабельны. Нельзя выделить или удалить дугу через контекстное меню мыши.
  • Нужно: реализовать selectTest() для возможности взаимодействия с дугами.

Quick Wins (низкие усилия, быстрый эффект)

# Что Где
Q1 Исправить Hill::IsChanged() - цикл size() вместо size() - 1 lib/hill.cpp
Q2 Вынести единый constexpr double precision в lib/infinity.h lib/infinity.h, lib/trappy_circle.cpp
Q3 using QCoreApplication::applicationDirPath() для пути к иконке робота gui/flying_robot.cpp
Q4 Перенести PlotItemArc в namespace gui gui/plot_item_arc.h
Q5 Создать .cpp для Airport и Target gui/airport.cpp, gui/target.cpp