Afilters - Revision history

Akuzmin: /* Данные о разметке */

2026-01-13T12:42:30Z

Данные о разметке

← Older revision		Revision as of 15:42, 13 January 2026
Line 56:		Line 56:
	* <code>mseverity(item) string</code> — статус поля severity текущего маркера (не путать с severity детектора). Пример: <code>filter(markers, mseverity(#) == "Critical")</code>		* <code>mseverity(item) string</code> — статус поля severity текущего маркера (не путать с severity детектора). Пример: <code>filter(markers, mseverity(#) == "Critical")</code>
	* <code>triaged(item) bool</code> — возвращает true, если маркер имеет не дефолтную разметку. Пример: <code>filter(markers, triaged(#))</code>		* <code>triaged(item) bool</code> — возвращает true, если маркер имеет не дефолтную разметку. Пример: <code>filter(markers, triaged(#))</code>
	* <code>get_triaged_by(item) UserInfo</code> — возвращает структуру с информацией о пользователе, ~~кто~~ произвел разметку		* <code>get_triaged_by(item) UserInfo</code> — возвращает структуру с информацией о пользователе, который произвел разметку

	Поля структуры <code>UserInfo</code>:		Поля структуры <code>UserInfo</code>:

Akuzmin: return space to 'т. к.'

2026-01-13T10:00:39Z

return space to 'т. к.'

← Older revision		Revision as of 13:00, 13 January 2026
Line 47:		Line 47:
	filter(markers, severity(#) == "Critical")		filter(markers, severity(#) == "Critical")

	'''Внимание:''' использование в предикатах поля <code>Trace</code> может сказаться на скорости применения фильтра, т.к. загрузка большого числа трасс может занять время.		'''Внимание:''' использование в предикатах поля <code>Trace</code> может сказаться на скорости применения фильтра, т. к. загрузка большого числа трасс может занять время.

	=== Данные о разметке ===		=== Данные о разметке ===

Mitrofanov: /* Поля маркера (предупреждения) */

2026-01-13T05:56:16Z

Поля маркера (предупреждения)

← Older revision		Revision as of 08:56, 13 January 2026
Line 47:		Line 47:
	filter(markers, severity(#) == "Critical")		filter(markers, severity(#) == "Critical")

	'''Внимание:''' использование в предикатах поля <code>Trace</code> может сказаться на скорости применения фильтра, т. к. загрузка большого числа трасс может занять время.		'''Внимание:''' использование в предикатах поля <code>Trace</code> может сказаться на скорости применения фильтра, т.к. загрузка большого числа трасс может занять время.

	=== Данные о разметке ===		=== Данные о разметке ===
Line 122:		Line 122:

	== Описание языка предикатов ==		== Описание языка предикатов ==
	Для написания предикатов используется язык '''Expr'''. Детальное описание всех возможностей можно найти здесь: https://github.com/expr-lang/expr		Для написания предикатов используется язык '''Expr'''. Детальное описание всех возможностей можно найти здесь: https://github.com/expr-lang/expr.

	Далее описываются конструкции, наиболее подходящие для написания правил фильтрации.		Далее описываются конструкции, наиболее подходящие для написания правил фильтрации.

Akuzmin: add time package link

2025-12-03T11:17:45Z

add time package link

← Older revision		Revision as of 14:17, 3 December 2025
Line 223:		Line 223:

	=== Функции времени ===		=== Функции времени ===
	Поддерживаются Go типы для времени и интервалов: <code>time.Time</code>, <code>time.Duration</code>.		Поддерживаются Go типы для времени и интервалов: <code>time.Time</code>, <code>time.Duration</code> из [https://pkg.go.dev/time time package].

	Можно использовать операции сложения и вычитания над объектами с типом <code>time.Time</code>.		Можно использовать операции сложения и вычитания над объектами с типом <code>time.Time</code>.

Akuzmin: review and minor fixes

2025-12-03T11:05:20Z

review and minor fixes

← Older revision		Revision as of 14:05, 3 December 2025
Line 153:		Line 153:
	Logical: not or !, and or &&, or or \|\|		Logical: not or !, and or &&, or or \|\|
	Conditional: ?: (ternary), ?? (nil coalescing), if {} else {} (multiline)		Conditional: ?: (ternary), ?? (nil coalescing), if {} else {} (multiline)
	Membership: [], ., ?., in		Membership: [], ., ?., in
	String: + (concatenation), contains, startsWith, endsWith		String: + (concatenation), contains, startsWith, endsWith
	Regex: matches		Regex: matches
	Range ..		Range: ..
	Slice [:]		Slice: [:]
	Pipe \|		Pipe: \|

	=== Операторы доступа к полю объекта ===		=== Операторы доступа к полю объекта ===
	Можно использовать оператор ~~точка~~ <code>.</code> и оператор <code>[]</code>:		Можно использовать оператор <code>.</code> и оператор <code>[]</code>:
	~~<code>~~user.Name		user.Name
	user["Name"]~~</code>~~		user["Name"]

	=== Оператор in ===		=== Оператор in ===
	Оператор <code>in</code> для проверки наличия объекта в массиве или мэпе:		Оператор <code>in</code> для проверки наличия объекта в массиве или мэпе:
	~~<code>~~"John" in ["John", "Jane"]		"John" in ["John", "Jane"]
	"name" in {"name": "John", "age": 30}~~</code>~~		"name" in {"name": "John", "age": 30}

	=== Optional chaining ===		=== Optional chaining ===
Line 174:		Line 174:

	Пример вида:		Пример вида:
	~~<code>~~author.User?.Name~~</code>~~		author.User?.Name
	значит ~~тоже~~ самое, что:
	~~<code>~~author.User != nil ? author.User.Name : nil~~</code>~~		значит то же самое, что:
			author.User != nil ? author.User.Name : nil

	=== Nil coalescing ===		=== Nil coalescing ===
Line 182:		Line 183:

	Пример вида:		Пример вида:
	~~<code>~~author.User?.Name ?? "Anonymous"~~</code>~~		author.User?.Name ?? "Anonymous"
	значит ~~тоже~~ самое, что:
	~~<code>~~author.User != nil ? author.User.Name : "Anonymous"~~</code>~~		значит то же самое, что:
			author.User != nil ? author.User.Name : "Anonymous"

	=== Оператор конвейера ===		=== Оператор конвейера ===
Line 190:		Line 192:

	Пример вида:		Пример вида:
	~~<code>~~user.Name \| lower() \| split(" ")~~</code>~~		user.Name \| lower() \| split(" ")
	значит ~~тоже~~ самое, что:
	~~<code>~~split(lower(user.Name), " ")~~</code>~~		значит то же самое, что:
			split(lower(user.Name), " ")

	=== Предикаты ===		=== Предикаты ===
	Предикат — это выражение. Предикаты можно использовать в функциях, таких как filter, all, any, one, none и других.		Предикат — это выражение. Предикаты можно использовать в функциях, таких как <code>filter, all, any, one, none</code> и других.
	~~<code>~~filter(0..9, {# % 2 == 0})~~</code~~>		filter(0..9, {# % 2 == 0})
			filter(tweets, {len(.Content) > 240})

	<code>~~filter(tweets,~~ {~~len(.Content) > 240~~})</code>		Скобки <code>{ }</code> можно опускать:
	~~Скобки~~ можно опускать ~~<code>{</code> <code>}</code>~~:		filter(tweets, len(.Content) > 240)
	~~<code>~~filter(tweets, len(.Content) > 240)~~</code>~~

	=== Операции над строками ===		=== Операции над строками ===
	~~<code>~~trim(str[, chars])		trim(str[, chars])
	trimPrefix(str, prefix)		trimPrefix(str, prefix)
	trimSuffix(str, suffix)		trimSuffix(str, suffix)
Line 211:		Line 214:
	lastIndexOf(str, substring)		lastIndexOf(str, substring)
	hasPrefix(str, prefix)		hasPrefix(str, prefix)
	hasSuffix(str, suffix)~~</code>~~		hasSuffix(str, suffix)
	~~Так же~~ есть оператор <code>matches</code> для поиска регулярного выражения в строке:
	~~<code>~~str matches "regular expression"~~</code>~~		Также есть оператор <code>matches</code> для поиска регулярного выражения в строке:
			str matches "regular expression"

	Для сопоставления целой строки с регулярным выражением следует использовать вариант:		Для сопоставления целой строки с регулярным выражением следует использовать вариант:
	~~<code>~~str matches "^regex$"~~</code>~~		str matches "^regex$"

	=== Функции времени ===		=== Функции времени ===
	Поддерживаются Go типы для времени и интервалов (<code>time.Time</code>, <code>time.Duration</code>~~) time package~~.		Поддерживаются Go типы для времени и интервалов: <code>time.Time</code>, <code>time.Duration</code>.

	Можно использовать операции сложения и вычитания над объектами с типом <code>time.Time</code>.		Можно использовать операции сложения и вычитания над объектами с типом <code>time.Time</code>.
	~~<code>createdAt - now()</code>~~

	~~<code>createdAt + duration("1h")</code>~~

	~~<code>createdAt > now() - duration("1h")</code>~~

	~~<code~~>date("2023-08-14")		createdAt - now()
			createdAt + duration("1h")
			createdAt > now() - duration("1h")

			date("2023-08-14")
	date("15:04:05")		date("15:04:05")
	date("2023-08-14T00:00:00Z")		date("2023-08-14T00:00:00Z")
	date("2023-08-14 00:00:00", "2006-01-02 15:04:05", "Europe/Zurich")~~</code>~~		date("2023-08-14 00:00:00", "2006-01-02 15:04:05", "Europe/Zurich")

	=== Функции над массивами ===		=== Функции над массивами ===

Akuzmin: minor fixes after partial review

2025-12-02T15:40:18Z

minor fixes after partial review

Show changes

Ruseer: /* Описание языка предикатов */

2025-11-27T09:36:58Z

Описание языка предикатов

← Older revision		Revision as of 12:36, 27 November 2025
Line 113:		Line 113:

	= Описание языка предикатов =		= Описание языка предикатов =
	Для написания предикатов используется язык '''Expr'''. Детальное описание всех возможностей можно найти здесь: ~~<nowiki>~~https://github.com/expr-lang/expr~~</nowiki>.~~		Для написания предикатов используется язык '''Expr'''. Детальное описание всех возможностей можно найти здесь: https://github.com/expr-lang/expr

	Далее описываются конструкции, наиболее подходящие для написания правил фильтрации.		Далее описываются конструкции, наиболее подходящие для написания правил фильтрации.

Ruseer: Описание advanced filters

2025-11-27T09:36:04Z

Описание advanced filters

New page

== Advanced filters ==
Поле "Расширенный фильтр" в пользовательских фильтрах предназначено для фильтрации маркеров (предупреждений) по сложным предикатам.
[[File:Image-afilters-prop.png|thumb]]
Предикат может использовать:

* поля маркера, его трассы, разметки и комментариев
* информацию из контекста (имя проекта, ветки, снимка и т.п.)
* атрибуты снимка (включая пользовательские атрибуты, заданные при импорте)
* статусы разметки
* текст и атрибуты комментариев

Формат фильтра определяется следующим шаблоном:
<code>filter(markers, <predicate expr> )</code>
Выражение <code><predicate expr></code> определяет предикат. Объект <code>markers</code> содержит массив маркеров из контекста, функция <code>filter</code> фильтрует данный список по предикату. Таким образом, применение фильтра заключается в фильтрации списка маркеров по указанному предикату.

== Список доступных полей ==

=== Поля маркера (предупреждения) ===

* <code>Comments</code> - список комментариев маркера. Объект типа Comment (смотреть ниже)
* <code>Details</code> - информация, специфичная для анализатора. Ближайший аналог - fingerprint в SARIF
* <code>File</code> - имя файла
* <code>Function</code> - имя функции, может быть managled для С++
* <code>ID</code> - UUID маркера
* <code>Invariant</code> - инвариант маркера. Используется для авто-переноса разметки между снимками
* <code>Lang</code> - язык детектора
* <code>Line</code> - номер строки в файле
* <code>LocID</code> - порядковый номер маркера относительно изначального отчета анализатора
* <code>MTid</code> - шаблон сообщения
* <code>Msg</code> - текст сообщения
* <code>OrigFunc</code> - 'человекочитаемое' имя функции. Может быть недоступно
* <code>Tags</code> - список тэгов(меток) маркера
* <code>Tool</code> - модуль анализатора, ответственного за данный детектор
* <code>Traces</code> - список трасс маркера. Объект типа Trace (смотреть ниже)
* <code>WarnClass</code> - название детектора/класса детекторов

Имена полей могут так же использоваться в формате, где первая буква в lower-case.

Помимо использования полей, пользователь может использовать вспомогательные функции для доступа к дополнительной информации:
<code>severity(item) string - серьезность детектора (чекера).
Пример: filter(markers, severity(#) == "Critical")</code>
'''Внимание:''' Использование в предикатах поля <code>Trace</code> может сказаться на скорости применения фильтра, т.к загрузка большого числа трасс может занять время.

=== Данные о разметке ===
Поддерживаются следующие функции для получения информации о разметки:

* <code>status(item) string</code> - статус разметки текущего маркера. Пример: <code>filter(markers, status(#) == "Confirmed")</code>
* <code>action(item) string</code> - статус поля action текущего маркера. Пример: <code>filter(markers, action(#) == "Ignore")</code>
* <code>mseverity(item) string</code> - статус поля severity текущего маркера (не путать с severity детектора). Пример: <code>filter(markers, mseverity(#) == "Critical")</code>
* <code>triaged(item) bool</code> - возвращает true, если маркер имеет не дефолтную разметку. Пример: <code>filter(markers, triaged(#))</code>
* <code>get_triaged_by(item) UserInfo</code> - возвращает структуру, с информацией о пользователе, кто произвел разметку

Поля структуры <code>UserInfo</code>:

* <code>login: string</code> - логин юзера
* <code>create_ts: Time (UTC)</code> - время разметки в <code>UTC</code> формате (RFC3339)

=== Комментарии ===
Объекты типа <code>Comment</code> содержатся в поле <code>Comments</code> маркера. Объект имеет следующие поля:

* <code>ID</code> - UUID комментария
* <code>Text</code> - текст комментария
* <code>CreatedBy</code> - имя пользователя, кто создал комментарий
* <code>CreateTs</code> - время создания комментария (объект типа <code>time.Time</code>)
* <code>UpdateTs</code> - время обновления комментария (объект типа <code>time.Time</code>), может быть пустым
* <code>UpdatedBy</code> - имя пользователя, кто обновил комментарий

=== Трассы ===
Маркер может содержать трассу маркера в поле <code>Traces</code>. Трасса описывается следующими структурами:
<code>type Trace struct {
Role string
Locations []TraceEntry
}
type TraceEntry struct {
File string
Line uint32
Col uint32
Info string
}</code>
Доступ к полям объекта <code>Trace</code> может выполняться используя правила языка <code>go-expr</code>, описанные ниже.

Имена полей могут использоваться в виде как описано выше, либо в формате lower-case: <code>role, locations, file, line, col, info</code>

Пример:
<code>filter(markers, any(.Comments, .Text == "Test") &&
any(.Traces, any(.Locations, .Info == "Boolean expression has constant value"))
)</code>

=== Поля снимка ===
Для доступа к полям снимка пользователь может использовать переменную <code>snapshot</code>. Переменная имеет тип структуры со следующими полями
<code>struct {
ID string
Name string
SerialID uint32
BuildObject string
ResultsObject string
ImportTime time.Time
CreatedBy string
CreatedByID string
Details map[string]any
CreateTime time.Time
SourcesAvailable bool
}</code>
Имена полей могут использоваться в виде, где первая буква в lower case.

Объекты в поле <code>Details</code> можно просмотреть нажав на <code>View JSON</code> кнопку в WebUI в поле <code>Snapshot Information</code>.

Пример:
<code>filter(markers,
snapshot.buildObject == "5b634b75422bd554a8569cc10bfadc3aea77b73e" &&
.warnClass matches "DEREF"
)</code>

= Описание языка предикатов =
Для написания предикатов используется язык '''Expr'''. Детальное описание всех возможностей можно найти здесь: <nowiki>https://github.com/expr-lang/expr</nowiki>.

Далее описываются конструкции, наиболее подходящие для написания правил фильтрации.

== Литералы ==
<code>Comment /* */ or //
Boolean true, false
Integer 42, 0x2A, 0o52, 0b101010
Float 0.5, .5
String "foo", 'bar'
Array [1, 2, 3]
Map {a: 1, b: 2, c: 3}
Nil nil</code>

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

Пример однострочного текста:
<code>"Hello\nWorld"</code>
Пример многострочного текста:
<code>`Hello
World`</code>
В многострочном тексте escape-последовательности не поддерживаются.

== Операторы ==
<code>Arithmetic: +, -, *, /, % (modulus), ^ or ** (exponent)
Comparison: ==, !=, <, >, <=, >=
Logical: not or !, and or &&, or or ||
Conditional: ?: (ternary), ?? (nil coalescing), if {} else {} (multiline)
Membership: [], ., ?., in
String: + (concatenation), contains, startsWith, endsWith
Regex: matches
Range ..
Slice [:]
Pipe |</code>

=== Операторы доступа к полю объекта ===
Пользователь может использовать оператор точка <code>.</code> и оператор <code>[]</code>:
<code>user.Name
user["Name"]</code>

=== Оператор in ===
Оператор <code>in</code> для проверки наличия объекта в массиве или мэпе:
<code>"John" in ["John", "Jane"]
"name" in {"name": "John", "age": 30}</code>

==== Optional chaining ====
Оператор <code>?.</code> может использоваться для доступа к полю структуры или элементу отображения (map) без необходимости проверки, является ли структура или отображение равными <code>nil</code>. Если структура или отображение имеют значение <code>nil</code>, результатом выражения будет <code>nil</code>.

Пример вида:
<code>author.User?.Name</code>
значит тоже самое, что:
<code>author.User != nil ? author.User.Name : nil</code>

==== Nil coalescing ====
Оператор <code>??</code> может использоваться для возврата левого операнда, если он не равен <code>nil</code>, в противном случае возвращается правый операнд.

Пример вида:
<code>author.User?.Name ?? "Anonymous"</code>
значит тоже самое, что:
<code>author.User != nil ? author.User.Name : "Anonymous"</code>

=== Оператор конвейера ===
Оператор конвейера <code>|</code> может использоваться для передачи результата выражения левого операнда в качестве первого аргумента выражения правого операнда.

Пример вида:
<code>user.Name | lower() | split(" ")</code>
значит тоже самое, что:
<code>split(lower(user.Name), " ")</code>

== Предикаты ==
Предикат — это выражение. Предикаты можно использовать в функциях, таких как filter, all, any, one, none и других.
<code>filter(0..9, {# % 2 == 0})</code>

<code>filter(tweets, {len(.Content) > 240})</code>
Скобки можно опускать <code>{</code> <code>}</code>:
<code>filter(tweets, len(.Content) > 240)</code>

== Операции над строками ==
<code>trim(str[, chars])
trimPrefix(str, prefix)
trimSuffix(str, suffix)
upper(str)
lower(str)
indexOf(str, substring)
lastIndexOf(str, substring)
hasPrefix(str, prefix)
hasSuffix(str, suffix)</code>
Так же есть оператор <code>matches</code> для поиска регулярного выражения в строке:
<code>str matches "regular expression"</code>
Для сопоставления целой строки с регулярным выражением следует использовать вариант:
<code>str matches "^regex$"</code>

== Функции времени ==
Поддерживаются Go типы для времени и интервалов (<code>time.Time</code>, <code>time.Duration</code>) time package.

Можно использовать операции сложения и вычитания над объектами с типом <code>time.Time</code>.
<code>createdAt - now()</code>

<code>createdAt + duration("1h")</code>

<code>createdAt > now() - duration("1h")</code>

<code>date("2023-08-14")
date("15:04:05")
date("2023-08-14T00:00:00Z")
date("2023-08-14 00:00:00", "2006-01-02 15:04:05", "Europe/Zurich")</code>

== Функции над массивами ==
<code>- all(array, predicate) - все объекты должны удовлетворять предикату
- any(array, predicate) - должен быть по крайней мере один объект, который удовлетворяет предикату
- one(array, predicate) - должен быть только один объект, который удовлетворяет предикату
- none(array, predicate) - ни один объект не должен удовлетворять предикату
- find(array, predicate) - возвращает первый объект, который удовлетворяет предикату
- findLast(array, predicate) - возвращает последний объект, который удовлетворяет предикату
- count(array[, predicate]) - возвращает число объектов, удовлетворяющих предикату
- first(array) - первый объект из массива
- last(array) - последний объект из массива</code>
Примеры:
<code>all(tweets, {.Size < 280})</code>

<code>any(tweets, {.Size > 280})</code>

<code>none(tweets, {.Size > 280})</code>

<code>find([1, 2, 3, 4], # > 2) == 3</code>

<code>findLast([1, 2, 3, 4], # > 2) == 4</code>

<code>count(users, .Age > 18)</code>

<code>first([1, 2, 3]) == 1</code>

<code>last([1, 2, 3]) == 3</code>