Skip to content

armgit / papra

Public Imported from GitHub
0

The minimalistic document archiving platform.

refactor(query-builder): mutualized search issue pattern (#944)

Corentin Thomasset3bde35bb0723
diff --git a/apps/papra-server/src/modules/documents/document-search/database-fts5/query-builder/query-builder.models.ts b/apps/papra-server/src/modules/documents/document-search/database-fts5/query-builder/query-builder.models.ts
index 1c3fbe44..727d6cd6 100644
--- a/apps/papra-server/src/modules/documents/document-search/database-fts5/query-builder/query-builder.models.ts
+++ b/apps/papra-server/src/modules/documents/document-search/database-fts5/query-builder/query-builder.models.ts
@@ -1,6 +1,7 @@
import type { Operator } from '@papra/search-parser';
import type { BinaryOperator } from 'drizzle-orm';
-import { eq, gt, gte, lt, lte } from 'drizzle-orm';
+import type { QueryResult } from './query-builder.types';
+import { eq, gt, gte, lt, lte, sql } from 'drizzle-orm';
import { documentsFtsTable } from '../database-fts5.tables';
function joinColumnNames(columns: string[]): string {
@@ -33,13 +34,6 @@ export function formatFts5QueryValue({
return { queryString };
}
-export function createUnsupportedOperatorIssue({ operator, field }: { operator: string; field: string }) {
- return {
- message: `Unsupported operator "${operator}" for ${field} filter`,
- code: 'UNSUPPORTED_FILTER_OPERATOR',
- };
-}
-
const operatorsMap: Record<Operator, BinaryOperator> = {
'=': eq,
'<': lt,
@@ -51,3 +45,27 @@ const operatorsMap: Record<Operator, BinaryOperator> = {
export function getSqlOperator({ operator }: { operator: Operator }): BinaryOperator {
return operatorsMap[operator];
}
+
+export function createInvalidQueryResult({ message, code}: { message: string; code: string }): QueryResult {
+ return {
+ sqlQuery: sql`0`,
+ issues: [{
+ message,
+ code,
+ }],
+ };
+}
+
+export function createInvalidDateFormatQueryResult({ field, value }: { field: string; value: string }): QueryResult {
+ return createInvalidQueryResult({
+ message: `Invalid date format for ${field} filter: "${value}". Expected a valid date string.`,
+ code: 'INVALID_DATE_FORMAT',
+ });
+}
+
+export function createUnsupportedOperatorQueryResult({ operator, field }: { operator: Operator; field: string }): QueryResult {
+ return createInvalidQueryResult({
+ message: `Unsupported operator "${operator}" for ${field} filter`,
+ code: 'UNSUPPORTED_FILTER_OPERATOR',
+ });
+}
diff --git a/apps/papra-server/src/modules/documents/document-search/database-fts5/query-builder/query-builder.test.ts b/apps/papra-server/src/modules/documents/document-search/database-fts5/query-builder/query-builder.test.ts
index a9f8fdf8..53bb27bb 100644
--- a/apps/papra-server/src/modules/documents/document-search/database-fts5/query-builder/query-builder.test.ts
+++ b/apps/papra-server/src/modules/documents/document-search/database-fts5/query-builder/query-builder.test.ts
@@ -194,7 +194,7 @@ describe('query-builder', async () => {
});
expect(issues).to.eql([{
- message: 'Invalid date format "not-a-date" for created filter',
+ message: 'Invalid date format for created filter: "not-a-date". Expected a valid date string.',
code: 'INVALID_DATE_FORMAT',
}]);
diff --git a/apps/papra-server/src/modules/documents/document-search/database-fts5/query-builder/query-builder.ts b/apps/papra-server/src/modules/documents/document-search/database-fts5/query-builder/query-builder.ts
index 2f068fda..2b806e5f 100644
--- a/apps/papra-server/src/modules/documents/document-search/database-fts5/query-builder/query-builder.ts
+++ b/apps/papra-server/src/modules/documents/document-search/database-fts5/query-builder/query-builder.ts
@@ -8,7 +8,13 @@ import { normalizeTagName } from '../../../../tags/tags.repository.models';
import { documentsTagsTable, tagsTable } from '../../../../tags/tags.table';
import { documentsTable } from '../../../documents.table';
import { documentsFtsTable } from '../database-fts5.tables';
-import { createUnsupportedOperatorIssue, formatFts5QueryValue, getSqlOperator } from './query-builder.models';
+import {
+ createInvalidDateFormatQueryResult,
+ createInvalidQueryResult,
+ createUnsupportedOperatorQueryResult,
+ formatFts5QueryValue,
+ getSqlOperator,
+} from './query-builder.models';
export function handleEmptyExpression(): QueryResult {
return {
@@ -21,10 +27,7 @@ export function handleNameFilter({ expression, organizationId, db }: { expressio
const { value, operator, field } = expression;
if (operator !== '=') {
- return {
- sqlQuery: sql`0`,
- issues: [createUnsupportedOperatorIssue({ operator, field })],
- };
+ return createUnsupportedOperatorQueryResult({ operator, field });
}
const { queryString } = formatFts5QueryValue({
@@ -48,10 +51,7 @@ export function handleContentFilter({ expression, organizationId, db }: { expres
const { value, operator, field } = expression;
if (operator !== '=') {
- return {
- sqlQuery: sql`0`,
- issues: [createUnsupportedOperatorIssue({ operator, field })],
- };
+ return createUnsupportedOperatorQueryResult({ operator, field });
}
const { queryString } = formatFts5QueryValue({
@@ -159,10 +159,7 @@ export function handleHasTagsFilter({ expression, organizationId, db }: { expres
const { operator, field } = expression;
if (operator !== '=') {
- return {
- sqlQuery: sql`0`,
- issues: [createUnsupportedOperatorIssue({ operator, field })],
- };
+ return createUnsupportedOperatorQueryResult({ operator, field });
}
return {
@@ -183,15 +180,7 @@ export function handleCreatedFilter({ expression }: { expression: FilterExpressi
const dateValue = new Date(value);
if (!isValidDate(dateValue)) {
- return {
- sqlQuery: sql`0`,
- issues: [
- {
- message: `Invalid date format "${value}" for created filter`,
- code: 'INVALID_DATE_FORMAT',
- },
- ],
- };
+ return createInvalidDateFormatQueryResult({ field: 'created', value });
}
const sqlOperator = getSqlOperator({ operator });
@@ -203,27 +192,17 @@ export function handleCreatedFilter({ expression }: { expression: FilterExpressi
}
export function handleUnsupportedExpression(): QueryResult {
- return {
- sqlQuery: sql`0`,
- issues: [
- {
- message: 'Unsupported expression type',
- code: 'UNSUPPORTED_EXPRESSION_TYPE',
- },
- ],
- };
+ return createInvalidQueryResult({
+ message: 'Unsupported expression type',
+ code: 'UNSUPPORTED_EXPRESSION_TYPE',
+ });
}
export function handleInvalidHasValue({ expression }: { expression: FilterExpression }): QueryResult {
- return {
- sqlQuery: sql`0`,
- issues: [
- {
- message: `Unsupported value "${expression.value}" for has filter`,
- code: 'UNSUPPORTED_HAS_VALUE',
- },
- ],
- };
+ return createInvalidQueryResult({
+ message: `Unsupported value "${expression.value}" for has filter`,
+ code: 'UNSUPPORTED_HAS_VALUE',
+ });
}
export function buildQueryFromExpression({ expression, organizationId, db }: { expression: Expression; organizationId: string; db: Database }): QueryResult {