Release notes 9-0-0: Difference between revisions
Mitrofanov (talk | contribs) |
m (some minor fixes) |
||
| Line 24: | Line 24: | ||
=== Изменения в правой панели с информацией о маркере раздела '''Разметка''' === | === Изменения в правой панели с информацией о маркере раздела '''Разметка''' === | ||
1. На вкладке '''Комментарии''' добавлена кнопка [[File:Icon_zoom_comment.png|x25px]] открытия диалогового окна для создания | 1. На вкладке '''Комментарии''' добавлена кнопка [[File:Icon_zoom_comment.png|x25px]] открытия диалогового окна для создания/просмотра/редактирования комментария. | ||
[[File:Zoom_comment_marker.png|thumb|none|upright=5|Диалогове окно для создания | [[File:Zoom_comment_marker.png|thumb|none|upright=5|Диалогове окно для создания/редактирования комментария]] | ||
2. На вкладке '''Подробности''' реализованы следующие изменения: | 2. На вкладке '''Подробности''' реализованы следующие изменения: | ||
:* доработан дизайн. Параметры детектора и маркера теперь отображены в раздельных блоках; | :* доработан дизайн. Параметры детектора и маркера теперь отображены в раздельных блоках; | ||
:* в параметры детектора добавлена информация по Серьезности, Надежности, а также информация о связанных CWE. Коды CWE реализованы как ссылки на описание дефектов безопасности на сайте https://cwe.mitre.org/; | :* в параметры детектора добавлена информация по Серьезности, Надежности, а также информация о связанных CWE. Коды CWE реализованы как ссылки на описание дефектов безопасности на сайте https://cwe.mitre.org/; | ||
:* в параметрах маркера кнопка для показа | :* в параметрах маркера кнопка для показа истории маркера вынесена в отдельный параметр; | ||
:* реализована функция добавления текстовых меток к маркеру. | :* реализована функция добавления текстовых меток к маркеру. | ||
[[File:Marker_details.png|thumb|none|upright=5|Вкладка '''Подробноcти''' в панели с информацией о маркере]] | [[File:Marker_details.png|thumb|none|upright=5|Вкладка '''Подробноcти''' в панели с информацией о маркере]] | ||
| Line 45: | Line 45: | ||
:* добавлена кнопка '''Oткрыть в IDE''' для более продвинутой навигации по исходному коду с "подсветкой" маркеров во встроенном Web-IDE; | :* добавлена кнопка '''Oткрыть в IDE''' для более продвинутой навигации по исходному коду с "подсветкой" маркеров во встроенном Web-IDE; | ||
:[[File:snapshot_info_1.png|thumb|none|upright=5|Кнопка открытия Web-IDE]] | :[[File:snapshot_info_1.png|thumb|none|upright=5|Кнопка открытия Web-IDE]] | ||
:* к аккаунту пользователя, который создает(импортирует) снимок в БД Svacer, добавлена дата создания снимка в БД Svacer; | :* к аккаунту пользователя, который создает (импортирует) снимок в БД Svacer, добавлена дата создания снимка в БД Svacer; | ||
:* параметр '''Приложенные файлы''', теперь отображается только тогда, когда к снимку есть приложенные пользователем при импорте файлы; | :* параметр '''Приложенные файлы''', теперь отображается только тогда, когда к снимку есть приложенные пользователем при импорте файлы; | ||
:* добавлено отображение параметра '''Пользовательские поля''', указываемые пользователем при импорте. Если пользовательский полей нет, то параметр не отображается. | :* добавлено отображение параметра '''Пользовательские поля''', указываемые пользователем при импорте. Если пользовательский полей нет, то параметр не отображается. | ||
| Line 60: | Line 60: | ||
:b) Реализована функция добавления комментариев к строке кода: | :b) Реализована функция добавления комментариев к строке кода: | ||
::* добавление комментариев осуществляется про клику на [[File:Icon_add_comment.png|x25px]] слева от выделенной строки с кодом или при выборе команды в контекстном меню, открываемом по правой кнопке мыши; | ::* добавление комментариев осуществляется про клику на [[File:Icon_add_comment.png|x25px]] слева от выделенной строки с кодом или при выборе команды в контекстном меню, открываемом по правой кнопке мыши; | ||
::* наличие комментариев к строке кода показывает иконка [[File:Icon_show_comment.png|x25px]] слева от строки, нажатие на которую открывает | ::* наличие комментариев к строке кода показывает иконка [[File:Icon_show_comment.png|x25px]] слева от строки, нажатие на которую открывает/скрывает виджеты с комментариями; | ||
::* в виджете с комментарием доступны кнопки добавления дополнительного комментария к данной строке кода, а также редактирования и удаления комментария; | ::* в виджете с комментарием доступны кнопки добавления дополнительного комментария к данной строке кода, а также редактирования и удаления комментария; | ||
::* реализованы функции управления отображением добавленных в код комментариев: | ::* реализованы функции управления отображением добавленных в код комментариев: | ||
::: | :::[[File:Icon_show_comment.png|x25px]] — просмотр и открытие комментариев из списка всех комментариев в коде; | ||
::: | :::[[File:Icon_show_all_comments.png|x25px]] — открытие всех комментариев в коде; | ||
::: | :::[[File:Icon_hide_all_comments.png|x25px]] — скрытие всех комментариев в коде. | ||
:[[File:Code_comments.png|thumb|none|upright=5|Элементы управления комментариями в коде]] | :[[File:Code_comments.png|thumb|none|upright=5|Элементы управления комментариями в коде]] | ||
| Line 71: | Line 71: | ||
:[[File:Code_markers.png|thumb|none|upright=5|Элементы управления просмотром маркеров в коде]] | :[[File:Code_markers.png|thumb|none|upright=5|Элементы управления просмотром маркеров в коде]] | ||
:d) Добавлена возможность открытия | :d) Добавлена возможность открытия/скрытия виджетов всех элементов трассы маркера по одному клику. Открытие всей трассы активируется в настройках интерфейса пользователя параметром '''Показать всю трассу маркера'''. | ||
:[[File:Code_trace_1.png|thumb|none|upright=5|Параметр '''Показать всю трассу маркера''']] | :[[File:Code_trace_1.png|thumb|none|upright=5|Параметр '''Показать всю трассу маркера''']] | ||
:[[File:Code_trace_2.png|thumb|none|upright=5|Виджет маркера в коде со скрытыми элементами трассы]] | :[[File:Code_trace_2.png|thumb|none|upright=5|Виджет маркера в коде со скрытыми элементами трассы]] | ||
| Line 78: | Line 78: | ||
=== Изменения в пользовательских фильтрах === | === Изменения в пользовательских фильтрах === | ||
В пользовательские фильтры в разделе '''Разметка''' добавлены следующие поля: | В пользовательские фильтры в разделе '''Разметка''' добавлены следующие поля: | ||
* CWE | * CWE — множественный выбор связанных с детектором кодов CWE; | ||
* Языки | * Языки — множественный выбор языков детектора; | ||
* Метки | * Метки — текстовое поле для ввода меток маркера, разделение меток осуществляется вводом с новой строки; | ||
* Функции | * Функции — текстовое поле для ввода функций маркера, поддерживается ввод с помощью регулярных выражений. | ||
:[[File:custom_filter.png|thumb|none|upright=5|Настройки пользовательских фильтров]] | :[[File:custom_filter.png|thumb|none|upright=5|Настройки пользовательских фильтров]] | ||
| Line 109: | Line 109: | ||
=== Изменения в разделе '''Детекторы''' === | === Изменения в разделе '''Детекторы''' === | ||
1. Раздел из '''Настройки | 1. Раздел из '''Настройки > Детекторы''' перенесен в главное меню. | ||
:[[File:main_menu.png|thumb|none|upright=5|Раздел '''Детекторы''' в главном меню]] | :[[File:main_menu.png|thumb|none|upright=5|Раздел '''Детекторы''' в главном меню]] | ||
2. В разделе '''Детекторы''' изменен дизайн и выполнены следующие доработки: | 2. В разделе '''Детекторы''' изменен дизайн и выполнены следующие доработки: | ||
| Line 119: | Line 119: | ||
:[[File:checker_list.png|thumb|none|upright=5|Изменения в списке детекторов]] | :[[File:checker_list.png|thumb|none|upright=5|Изменения в списке детекторов]] | ||
:[[File:checker_filter.png|thumb|none|upright=5|Параметры фильтра в списке детекторов]] | :[[File:checker_filter.png|thumb|none|upright=5|Параметры фильтра в списке детекторов]] | ||
:* при наличии дополнительной информации о детекторе | :* при наличии дополнительной информации о детекторе рядом с его названием отображается иконка [[File:Icon_question.png|x25px]]. При клике на нее открывается диалог с описанием детектора и примерами. | ||
:[[File:checker_details.png|thumb|none|upright=5|Пример дополнительной информации о детекторе]] | :[[File:checker_details.png|thumb|none|upright=5|Пример дополнительной информации о детекторе]] | ||
| Line 157: | Line 157: | ||
:[[File:user_main_settings.png|thumb|none|upright=5|Общие настройки интерфейса]] | :[[File:user_main_settings.png|thumb|none|upright=5|Общие настройки интерфейса]] | ||
:Добавились параметры: | :Добавились параметры: | ||
::* применение пользовательского фильтра при повторном входе в систему | ::* применение пользовательского фильтра при повторном входе в систему — позволяет указать сохраненный пользовательский фильтр, который будет применяться при повторном входе в систему. По умолчанию применяется последний используемый фильтр. | ||
::* при открытии сохраненного контекста заменить снимок на последний загруженный | ::* при открытии сохраненного контекста заменить снимок на последний загруженный — по умолчанию (параметр выключен) при выборе проекта и ветки открывается, как и было ранее, последний импортированный снимок. | ||
2. Навигационная панель | 2. Навигационная панель | ||
| Line 166: | Line 166: | ||
:[[File:user_code_settings.png|thumb|none|upright=5|Настройки при просмотре кода]] | :[[File:user_code_settings.png|thumb|none|upright=5|Настройки при просмотре кода]] | ||
:Добавились параметры: | :Добавились параметры: | ||
::* '''Показывать всю трассу маркера''' | ::* '''Показывать всю трассу маркера''' — если параметр включен, то при клике в виджете маркера на кнопку '''Показать трассу''' будут открываться сразу все виджеты элементов трассы маркера. Если параметр выключен, то будет показываться только первый элемент трассы маркера. | ||
::* '''Позиция виджета маркера''' | ::* '''Позиция виджета маркера''' — параметр вынесен в настройки интерфейса из правой панели кнопок окна просмотра кода. | ||
4. На форме с информацией о программе добавлены: | 4. На форме с информацией о программе добавлены: | ||
Revision as of 13:24, 14 May 2024
Svacer 9.0.0 UI release notes
Изменения в панели навигации раздела Разметка
1. Добавлена возможность скрытия панели навигации.
Функция скрытия панели навигации
2. На вкладке Детекторы панели навигации добавлены:
- строка поиска по детекторам и файлам;
- кнопка выгрузки в csv-файл списка отображаемых в панели детекторов и маркеров.
Вкладка Детекторы панели навигации
3. На вкладке Файлы панели навигации реализованы следующие доработки:
- добавлена кнопка выгрузки в csv-файл списка отображаемых в панели файлов (независимо от отображения в списке, выгружается полные пути к файлам);
- нажатие на файл приводит к его открытию в окне просмотра кода без фильтрации по нему в таблице маркеров. Для открытия файлов и фильтрации по ним в таблице маркеров требуется нажить на
. Для исключения файла из фильтра требуется нажать на 
;
Вкладка Файлы панели навигации
- нажатие на кнопку
открывает настройки панели навигации в меню пользователя. При изменении настроек они сразу применяются.
- нажатие на кнопку
Пользовательские настройки панели навигации
Изменения в таблице маркеров раздела Разметка
- Реализована сортировка в колонках таблицы маркеров по одному клику. Исключена сортировка по колонке Описание.
- Реализована функция массового добавления комментариев маркерам без привязки к разметке.
Изменения в таблице маркеров
Изменения в правой панели с информацией о маркере раздела Разметка
1. На вкладке Комментарии добавлена кнопка 
открытия диалогового окна для создания/просмотра/редактирования комментария.
2. На вкладке Подробности реализованы следующие изменения:
- доработан дизайн. Параметры детектора и маркера теперь отображены в раздельных блоках;
- в параметры детектора добавлена информация по Серьезности, Надежности, а также информация о связанных CWE. Коды CWE реализованы как ссылки на описание дефектов безопасности на сайте https://cwe.mitre.org/;
- в параметрах маркера кнопка для показа истории маркера вынесена в отдельный параметр;
- реализована функция добавления текстовых меток к маркеру.
3. Доработан дизайн диалога История маркера:
- убрана колонка ID снимка;
- добавлены колонки Дата создания и Дата импорта снимка;
- реализована возможностью сортировки.
Изменения в панели просмотра кода раздела Разметка
1. Изменен дизайн вкладки Информация о снимке и реализованы следующие доработки:
- в названии вкладки теперь отображается только иконка
, название перенесено в тултип; - добавлена кнопка Oткрыть в IDE для более продвинутой навигации по исходному коду с "подсветкой" маркеров во встроенном Web-IDE;
- в названии вкладки теперь отображается только иконка
Кнопка открытия Web-IDE - к аккаунту пользователя, который создает (импортирует) снимок в БД Svacer, добавлена дата создания снимка в БД Svacer;
- параметр Приложенные файлы, теперь отображается только тогда, когда к снимку есть приложенные пользователем при импорте файлы;
- добавлено отображение параметра Пользовательские поля, указываемые пользователем при импорте. Если пользовательский полей нет, то параметр не отображается.
Параметры на вкладке Информация о снимке
2. Изменен дизайн формы Экспорт кода с разметкой, открываемой по кнопке 
.
На форме добавлены параметры, реализующие функцию очистки старых комментариев в экспортируемом коде в соответствии с выбранным шаблоном разметки и возможностью задать регулярные выражения для очистки дополнительных строк.
Форма Экспорт кода с разметкой
3. На вкладке просмотра файла с кодом реализованы следующие изменения:
- a) Добавлено отображение строки и позиции установленного в коде курсора.
Позиция установленного в коде курсора
- b) Реализована функция добавления комментариев к строке кода:
- добавление комментариев осуществляется про клику на
слева от выделенной строки с кодом или при выборе команды в контекстном меню, открываемом по правой кнопке мыши; - наличие комментариев к строке кода показывает иконка
слева от строки, нажатие на которую открывает/скрывает виджеты с комментариями; - в виджете с комментарием доступны кнопки добавления дополнительного комментария к данной строке кода, а также редактирования и удаления комментария;
- реализованы функции управления отображением добавленных в код комментариев:
- — просмотр и открытие комментариев из списка всех комментариев в коде;
— открытие всех комментариев в коде;
— скрытие всех комментариев в коде.
- добавление комментариев осуществляется про клику на
Элементы управления комментариями в коде
- с) Модернизированы кнопки просмотра маркеров в файле. При просмотре списка маркеров теперь отображается список всех маркеров в файле, а не только тех для которых были открыты виджеты.
Элементы управления просмотром маркеров в коде
- d) Добавлена возможность открытия/скрытия виджетов всех элементов трассы маркера по одному клику. Открытие всей трассы активируется в настройках интерфейса пользователя параметром Показать всю трассу маркера.
Параметр Показать всю трассу маркера 
Виджет маркера в коде со скрытыми элементами трассы 
Виджет маркера в коде с раскрытыми элементами трассы
Изменения в пользовательских фильтрах
В пользовательские фильтры в разделе Разметка добавлены следующие поля:
- CWE — множественный выбор связанных с детектором кодов CWE;
- Языки — множественный выбор языков детектора;
- Метки — текстовое поле для ввода меток маркера, разделение меток осуществляется вводом с новой строки;
- Функции — текстовое поле для ввода функций маркера, поддерживается ввод с помощью регулярных выражений.
Настройки пользовательских фильтров
Функциональность сопоставления маркеров
Если при импорте очередного снимка в ветку проекта не все маркеры были автоматически сопоставлены (сформированы инварианты), то пользователь имеет возможность сопоставить такие маркеры вручную в CLI или в UI. При сопоставлении маркеров с разметкой, инварианту присваивается разметка маркера из последнего импортированного снимка. Также реализована функциональность отмены (отката) операций ручного сопоставления. Функциональность доступна пользователям с проектным доступом Разметка маркеров и серверным доступом Администрирование сервера.
1. Сценарий выполнения операции сопоставления маркеров:
- a. Открытие диалога сопоставления маркеров
Открытие диалога для сопоставления маркеров
- b. Выбор снимка в ветке проекта, сопоставление пар маркеров и переход на шаг подтверждения
Выбор и сопоставление пар маркеров
- c. Подтверждение операции сопоставления маркеров
Подтверждение операции сопоставления маркеров
2. Сценарий выполнения отмены (отката) операций ручного сопоставления маркеров
- a. В диалоге сопоставления маркеров на вкладке Отмена операций сопоставления осуществляется выбор операций сопоставления маркеров и переход на шаг подтверждения отмены данных операций
Выбор операций сопоставления маркеров для отмены
- b. На шаге подтверждения отображается список операций, которые будут отменены. Список включает все выбранные на первом шаге операции и связанные с ними операции, которые тоже будут отменены.
Подтверждение отмены операций сопоставления маркеров
3. После выполнения операции сопоставления маркеров или отмены операций сопоставления маркеров всем пользователям, у которых открыт данный контекст (проект/ветка), будет отображена нотификация об изменении конфигурации инвариантов.
Нотификация об изменении конфигурации инвариантов
Изменения в разделе Детекторы
1. Раздел из Настройки > Детекторы перенесен в главное меню.
Раздел Детекторы в главном меню
2. В разделе Детекторы изменен дизайн и выполнены следующие доработки:
- в таблицу со списком детекторов добавлена дополнительная колонка CWE. При клике на ссылку с кодом CWE в отдельном окне браузера открывается описание дефекта безопасности на сайте https://cwe.mitre.org/;
- в строке поиска добавлена возможность поиска детекторов по CWE;
- добавлена возможность выбора отображаемых столбцов в таблице детекторов;
- реализована сортировка в колонках таблицы по одному клику;
- добавлена возможность фильтрации списка детекторов по атрибутам;
Изменения в списке детекторов 
Параметры фильтра в списке детекторов - при наличии дополнительной информации о детекторе рядом с его названием отображается иконка
. При клике на нее открывается диалог с описанием детектора и примерами.
- при наличии дополнительной информации о детекторе рядом с его названием отображается иконка
Пример дополнительной информации о детекторе
Изменения в разделе Проекты
1. Реализована функция клонирования проекта со всеми его ветками и снимками. Функциональность доступна пользователям с серверным доступом Создание проектов.
Команда для открытия формы клонирования проекта 
Форма клонирования проекта
2. Реализована функция импорта .svace-dir. Функциональность доступна пользователям с проектным доступом Импорт снимков и серверным доступом Public API.
Команда для открытия формы импорта .svace-dir 
Форма импорта .svace-dir
3. Реализована функция импорта разметки из исходного кода снимка в текущую ветку проекта. Функциональность доступна пользователям с проектным доступом Импорт разметки.
Команда для открытия формы импорта разметки 
Форма импорта разметки
Изменения в разделе Код
1. Реализована функция множественного отображения вкладок с файлами. Функция активируется выключением параметра Переиспользование вкладки в настройках интерфейса пользователя.
Пример отображения нескольких вкладок с файлами
2. Добавлена функция отображения строки и позиции установленного в коде курсора.
Пример отображения позиции курсора в коде
3. Реализована функциональность сравнения двух файлов. Вызов диалога сравнения файлов осуществляется кликом правой кнопкой мыши на файле в дереве файлов и выбором соответствующей команды в контекстном меню.
Команда для открытия диалога сравнения файлов 
Выбор файла для сравнения 
Форма сравнения двух файлов
Изменения в настройках меню пользователя
Настройки интерфейса пользователя вынесены в отдельный пункт меню пользователя.
Пользовательское меню
Настройки интерфейса пользователя содержат три вкладки параметров:
1. Общие
Общие настройки интерфейса - Добавились параметры:
- применение пользовательского фильтра при повторном входе в систему — позволяет указать сохраненный пользовательский фильтр, который будет применяться при повторном входе в систему. По умолчанию применяется последний используемый фильтр.
- при открытии сохраненного контекста заменить снимок на последний загруженный — по умолчанию (параметр выключен) при выборе проекта и ветки открывается, как и было ранее, последний импортированный снимок.
2. Навигационная панель
Настройки панели навигации
3. Просмотр кода
Настройки при просмотре кода - Добавились параметры:
- Показывать всю трассу маркера — если параметр включен, то при клике в виджете маркера на кнопку Показать трассу будут открываться сразу все виджеты элементов трассы маркера. Если параметр выключен, то будет показываться только первый элемент трассы маркера.
- Позиция виджета маркера — параметр вынесен в настройки интерфейса из правой панели кнопок окна просмотра кода.
4. На форме с информацией о программе добавлены:
- ссылка на swagger со спецификацией OpenAPI;
- e-mail для отправки обратной связи разработчикам Svacer.
Форма О программе
