feat(filter): resolve labels and projects to ids before filtering

2024-03-08 14:35:47 +01:00
parent 0c947790e8
commit 55b806d311
4 changed files with 218 additions and 61 deletions
--- a/frontend/src/helpers/filters.test.ts
+++ b/frontend/src/helpers/filters.test.ts
@ -0,0 +1,85 @@
+import {describe, expect, it} from 'vitest'
+import {transformFilterStringForApi} from '@/helpers/filters'
+
+const nullResolver = (title: string) => null
+describe('Filter Transformation', () => {
+
+	const cases = {
+		'done': 'done',
+		'priority': 'priority',
+		'percentDone': 'percent_done',
+		'dueDate': 'due_date',
+		'startDate': 'start_date',
+		'endDate': 'end_date',
+		'doneAt': 'done_at',
+		'reminders': 'reminders',
+		'assignees': 'assignees',
+		'labels': 'labels',
+	}
+
+	for (const c in cases) {
+		it('should transform all filter params for ' + c + ' to snake_case', () => {
+			const transformed = transformFilterStringForApi(c + ' = ipsum', nullResolver, nullResolver)
+
+			expect(transformed).toBe(cases[c] + ' = ipsum')
+		})
+	}
+	
+	it('should correctly resolve labels', () => {
+		const transformed = transformFilterStringForApi(
+			'labels = lorem',
+			(title: string) => 1,
+			nullResolver,
+		)
+		
+		expect(transformed).toBe('labels = 1')
+	})
+
+	it('should correctly resolve multiple labels', () => {
+		const transformed = transformFilterStringForApi(
+			'labels = lorem && dueDate = now && labels = ipsum',
+			(title: string) => {
+				switch (title) {
+					case 'lorem':
+						return 1
+					case 'ipsum':
+						return 2
+					default:
+						return null
+				}
+			},
+			nullResolver,
+		)
+
+		expect(transformed).toBe('labels = 1&& due_date = now && labels = 2')
+	})
+
+	it('should correctly resolve projects', () => {
+		const transformed = transformFilterStringForApi(
+			'project = lorem',
+			nullResolver,
+			(title: string) => 1,
+		)
+
+		expect(transformed).toBe('project = 1')
+	})
+	
+	it('should correctly resolve multiple projects', () => {
+		const transformed = transformFilterStringForApi(
+			'project = lorem && dueDate = now || project = ipsum',
+			nullResolver,
+			(title: string) => {
+				switch (title) {
+					case 'lorem':
+						return 1
+					case 'ipsum':
+						return 2
+					default:
+						return null
+				}
+			},
+		)
+
+		expect(transformed).toBe('project = 1&& due_date = now || project = 2')
+	})
+})
--- a/frontend/src/helpers/filters.ts
+++ b/frontend/src/helpers/filters.ts
@ -0,0 +1,101 @@
+import {snakeCase} from 'snake-case'
+
+export const DATE_FIELDS = [
+	'dueDate',
+	'startDate',
+	'endDate',
+	'doneAt',
+	'reminders',
+]
+
+export const ASSIGNEE_FIELDS = [
+	'assignees',
+]
+
+export const LABEL_FIELDS = [
+	'labels',
+]
+
+export const PROJECT_FIELDS = [
+	'project',
+]
+
+export const AUTOCOMPLETE_FIELDS = [
+	...LABEL_FIELDS,
+	...ASSIGNEE_FIELDS,
+	...PROJECT_FIELDS,
+]
+
+export const AVAILABLE_FILTER_FIELDS = [
+	'done',
+	'priority',
+	'percentDone',
+	...DATE_FIELDS,
+	...ASSIGNEE_FIELDS,
+	...LABEL_FIELDS,
+]
+
+export const FILTER_OPERATORS = [
+	'!=',
+	'=',
+	'>',
+	'>=',
+	'<',
+	'<=',
+	'like',
+	'in',
+	'?=',
+]
+
+export const FILTER_JOIN_OPERATOR = [
+	'&&',
+	'||',
+	'(',
+	')',
+]
+
+export const FILTER_OPERATORS_REGEX = '(&lt;|&gt;|&lt;=|&gt;=|=|!=)'
+
+export function transformFilterStringForApi(
+	filter: string,
+	labelResolver: (title: string) => number | null,
+	projectResolver: (title: string) => number | null,
+): string {
+	// Transform labels to ids
+	LABEL_FIELDS.forEach(field => {
+		const pattern = new RegExp('(' + field + '\\s*' + FILTER_OPERATORS_REGEX + '\\s*)([\'"]?)([^\'"&\|\(\)]+\\1?)?', 'ig')
+
+		let match: RegExpExecArray | null
+		while ((match = pattern.exec(filter)) !== null) {
+			const [matched, prefix, operator, space, keyword] = match
+			if (keyword) {
+				const labelId = labelResolver(keyword.trim())
+				if (labelId !== null) {
+					filter = filter.replace(keyword, String(labelId))
+				}
+			}
+		}
+	})
+	// Transform projects to ids
+	PROJECT_FIELDS.forEach(field => {
+		const pattern = new RegExp('(' + field + '\\s*' + FILTER_OPERATORS_REGEX + '\\s*)([\'"]?)([^\'"&\|\(\)]+\\1?)?', 'ig')
+
+		let match: RegExpExecArray | null
+		while ((match = pattern.exec(filter)) !== null) {
+			const [matched, prefix, operator, space, keyword] = match
+			if (keyword) {
+				const projectId = projectResolver(keyword.trim())
+				if (projectId !== null) {
+					filter = filter.replace(keyword, String(projectId))
+				}
+			}
+		}
+	})
+
+	// Transform all attributes to snake case
+	AVAILABLE_FILTER_FIELDS.forEach(f => {
+		filter = filter.replace(f, snakeCase(f))
+	})
+
+	return filter
+}