diff --git a/client/public/locales/en/common.json b/client/public/locales/en/common.json index 1ad71b366..e6896f0fa 100644 --- a/client/public/locales/en/common.json +++ b/client/public/locales/en/common.json @@ -332,7 +332,7 @@ }, "extra_fields": { "tab": "Extra Fields", - "description": "

Here you can add extra custom fields to your entities.

Once a field is added, you can not change its key or type, and for choice type fields you can not remove choices or change the multi choice state. If you remove a field, the associated data for all entities will be deleted.

The key is what other programs read/write the data as, so if your custom field is supposed to integrate with a third-party program, make sure to set it correctly. Default value is only applied to new items.

Extra fields can not be sorted or filtered in the table views.

", + "description": "

Here you can add extra custom fields to your entities.

Once a field is added, you can not change its key or type, and for choice type fields you can not remove choices or change the multi choice state. If you remove a field, the associated data for all entities will be deleted.

The key is what other programs read/write the data as, so if your custom field is supposed to integrate with a third-party program, make sure to set it correctly. Default value is only applied to new items.

Extra fields can be shown and sorted in the table views. Choice and boolean fields expose filter options there as well, and all extra field types support filtering for empty values.

", "params": { "key": "Key", "name": "Name", diff --git a/client/src/components/column.tsx b/client/src/components/column.tsx index 059b607f0..85f9b79b9 100644 --- a/client/src/components/column.tsx +++ b/client/src/components/column.tsx @@ -1,7 +1,7 @@ import { DateField, TextField } from "@refinedev/antd"; import { UseQueryResult } from "@tanstack/react-query"; -import { Button, Col, Dropdown, Row, Space, Spin } from "antd"; -import { ColumnFilterItem, ColumnType } from "antd/es/table/interface"; +import { Button, Col, DatePicker, Dropdown, Input, InputNumber, Row, Space, Spin } from "antd"; +import { ColumnFilterItem, ColumnType, FilterDropdownProps } from "antd/es/table/interface"; import dayjs from "dayjs"; import utc from "dayjs/plugin/utc"; import { AlignType } from "rc-table/lib/interface"; @@ -27,6 +27,156 @@ const FilterDropdownLoading = () => { ); }; +function TextFilterDropdown({ setSelectedKeys, selectedKeys, confirm, clearFilters }: FilterDropdownProps) { + const hasValue = selectedKeys.length > 0; + return ( + <> +
+ setSelectedKeys(e.target.value ? [e.target.value] : [])} + onPressEnter={() => confirm()} + /> +
+
+ + +
+ + ); +} + +function NumberRangeFilterDropdown({ + setSelectedKeys, + selectedKeys, + confirm, + clearFilters, + precision, +}: FilterDropdownProps & { precision?: number }) { + const current = selectedKeys[0] as string | undefined; + let minVal: number | null = null; + let maxVal: number | null = null; + if (current && current.includes(":")) { + const parts = current.split(":", 2); + minVal = parts[0] ? Number(parts[0]) : null; + maxVal = parts[1] ? Number(parts[1]) : null; + } + + const updateKeys = (min: number | null, max: number | null) => { + if (min === null && max === null) { + setSelectedKeys([]); + } else { + setSelectedKeys([`${min !== null ? min : ""}:${max !== null ? max : ""}`]); + } + }; + + const hasValue = selectedKeys.length > 0; + return ( + <> +
+ updateKeys(value, maxVal)} + /> + updateKeys(minVal, value)} + /> +
+
+ + +
+ + ); +} + +function DateTimeRangeFilterDropdown({ setSelectedKeys, selectedKeys, confirm, clearFilters }: FilterDropdownProps) { + const current = selectedKeys[0] as string | undefined; + let fromVal: dayjs.Dayjs | null = null; + let toVal: dayjs.Dayjs | null = null; + if (current && current.includes("|")) { + const parts = current.split("|", 2); + fromVal = parts[0] ? dayjs(parts[0]) : null; + toVal = parts[1] ? dayjs(parts[1]) : null; + } + + const updateKeys = (from: dayjs.Dayjs | null, to: dayjs.Dayjs | null) => { + if (from === null && to === null) { + setSelectedKeys([]); + } else { + setSelectedKeys([`${from ? from.utc().toISOString() : ""}|${to ? to.utc().toISOString() : ""}`]); + } + }; + + const hasValue = selectedKeys.length > 0; + return ( + <> +
+ updateKeys(date, toVal)} + /> + updateKeys(fromVal, date)} + /> +
+
+ + +
+ + ); +} + interface Entity { id: number; } @@ -40,7 +190,7 @@ export interface Action { interface BaseColumnProps { id: string | string[]; - dataId?: keyof Obj & string; + dataId?: (keyof Obj & string) | string; // Allow string values for custom fields i18ncat?: string; i18nkey?: string; title?: string; @@ -62,6 +212,7 @@ interface FilteredColumnProps { allowMultipleFilters?: boolean; onFilterDropdownOpen?: () => void; loadingFilters?: boolean; + filterDropdown?: (props: FilterDropdownProps) => React.ReactNode; } interface CustomColumnProps { @@ -98,10 +249,8 @@ function Column( // Sorting if (props.sorter) { columnProps.sorter = true; - columnProps.sortOrder = getSortOrderForField( - typeSorters(props.tableState.sorters), - props.dataId ?? (props.id as keyof Obj), - ); + const sortField = props.dataId ?? (Array.isArray(props.id) ? props.id.join(".") : props.id); + columnProps.sortOrder = getSortOrderForField(typeSorters(props.tableState.sorters), sortField); } // Filter @@ -121,6 +270,13 @@ function Column( if (props.dataId) { columnProps.key = props.dataId; } + } else if (props.filterDropdown) { + columnProps.filterDropdown = props.filterDropdown; + columnProps.filteredValue = props.filteredValue; + columnProps.filterMultiple = false; + if (props.dataId) { + columnProps.key = props.dataId; + } } // Render @@ -174,7 +330,7 @@ export function SortedColumn(props: BaseColumnProps) { } export function RichColumn( - props: Omit, "transform"> & { transform?: (value: unknown) => string }, + props: Omit, "transform"> & FilteredColumnProps & { transform?: (value: unknown) => string }, ) { return Column({ ...props, @@ -207,11 +363,12 @@ export function FilteredQueryColumn(props: FilteredQueryColu } filters.push({ text: "", - value: "", + value: "", }); const typedFilters = typeFilters(props.tableState.filters); - const filteredValue = getFiltersForField(typedFilters, props.dataId ?? (props.id as keyof Obj)); + const filterField = props.dataId ?? (Array.isArray(props.id) ? props.id.join(".") : props.id); + const filteredValue = getFiltersForField(typedFilters, filterField); const onFilterDropdownOpen = () => { query.refetch(); @@ -220,7 +377,7 @@ export function FilteredQueryColumn(props: FilteredQueryColu return Column({ ...props, filters, filteredValue, onFilterDropdownOpen, loadingFilters: query.isLoading }); } -interface NumberColumnProps extends BaseColumnProps { +interface NumberColumnProps extends BaseColumnProps, FilteredColumnProps { unit: string; maxDecimals?: number; minDecimals?: number; @@ -250,7 +407,7 @@ export function NumberColumn(props: NumberColumnProps) }); } -export function DateColumn(props: BaseColumnProps) { +export function DateColumn(props: BaseColumnProps & FilteredColumnProps) { return Column({ ...props, render: (rawValue) => { @@ -325,7 +482,8 @@ export function SpoolIconColumn(props: SpoolIconColumnProps< }); const typedFilters = typeFilters(props.tableState.filters); - const filteredValue = getFiltersForField(typedFilters, props.dataId ?? (props.id as keyof Obj)); + const filterField = props.dataId ?? (Array.isArray(props.id) ? props.id.join(".") : props.id); + const filteredValue = getFiltersForField(typedFilters, filterField); const onFilterDropdownOpen = () => { query.refetch(); @@ -389,13 +547,46 @@ export function NumberRangeColumn(props: NumberColumnProps { + filters.push({ + text: choice, + value: `"${choice}"`, + }); + }); + } + + filters.push({ text: "", value: "" }); + + return filters; +} + export function CustomFieldColumn(props: Omit, "id"> & { field: Field }) { const field = props.field; + const fieldId = `extra.${field.key}`; + + const typedFilters = typeFilters(props.tableState.filters); + const filteredValue = getFiltersForField(typedFilters, fieldId); + const commonProps = { ...props, id: ["extra", field.key], title: field.name, - sorter: false, + sorter: true, + dataId: fieldId, transform: (value: unknown) => { if (value === null || value === undefined) { return undefined; @@ -407,12 +598,16 @@ export function CustomFieldColumn(props: Omit , + filteredValue, unit: field.unit ?? "", maxDecimals: 0, }); } else if (field.field_type === FieldType.float) { return NumberColumn({ ...commonProps, + filterDropdown: (p: FilterDropdownProps) => , + filteredValue, unit: field.unit ?? "", minDecimals: 0, maxDecimals: 3, @@ -420,12 +615,16 @@ export function CustomFieldColumn(props: Omit , + filteredValue, unit: field.unit ?? "", maxDecimals: 0, }); } else if (field.field_type === FieldType.float_range) { return NumberRangeColumn({ ...commonProps, + filterDropdown: (p: FilterDropdownProps) => , + filteredValue, unit: field.unit ?? "", minDecimals: 0, maxDecimals: 3, @@ -433,14 +632,20 @@ export function CustomFieldColumn(props: Omit { const value = commonProps.transform ? commonProps.transform(rawValue) : rawValue; let text; @@ -457,6 +662,8 @@ export function CustomFieldColumn(props: Omit { const value = commonProps.transform ? commonProps.transform(rawValue) : rawValue; return ; @@ -465,6 +672,8 @@ export function CustomFieldColumn(props: Omit { const value = commonProps.transform ? commonProps.transform(rawValue) : rawValue; return ; diff --git a/client/src/components/dataProvider.ts b/client/src/components/dataProvider.ts index 95efd97a9..7bfa36978 100644 --- a/client/src/components/dataProvider.ts +++ b/client/src/components/dataProvider.ts @@ -2,6 +2,8 @@ import { DataProvider } from "@refinedev/core"; import { axiosInstance } from "@refinedev/simple-rest"; import { AxiosInstance } from "axios"; import { stringify } from "query-string"; +import { getCustomFieldFilters } from "../utils/filtering"; +import { isCustomField } from "../utils/queryFields"; type MethodTypes = "get" | "delete" | "head" | "options"; type MethodTypesWithBody = "post" | "put" | "patch"; @@ -25,20 +27,30 @@ const dataProvider = ( } if (sorters && sorters.length > 0) { + // Map all sorters, including custom field sorters queryParams["sort"] = sorters .map((sort) => { const field = sort.field; + // Custom field sorters are already in the correct format (extra.field_key) return `${field}:${sort.order}`; }) .join(","); } if (filters && filters.length > 0) { + // Process regular filters filters.forEach((filter) => { if (!("field" in filter)) { throw Error("Filter must be a LogicalFilter."); } + const field = filter.field; + + // Skip custom fields, they'll be handled separately + if (typeof field === "string" && isCustomField(field)) { + return; + } + if (filter.value.length > 0) { const filterValueArray = Array.isArray(filter.value) ? filter.value : [filter.value]; @@ -54,6 +66,14 @@ const dataProvider = ( queryParams[field] = filterValue; } }); + + // Process custom field filters + const customFieldFilters = getCustomFieldFilters(filters); + Object.entries(customFieldFilters).forEach(([key, values]) => { + if (values.length > 0) { + queryParams[`extra.${key}`] = values.map((value) => (value === "" ? "" : value)).join(","); + } + }); } const { data, headers } = await httpClient[requestMethod](`${url}`, { diff --git a/client/src/utils/filtering.ts b/client/src/utils/filtering.ts index da99b43c4..6acf9a8b3 100644 --- a/client/src/utils/filtering.ts +++ b/client/src/utils/filtering.ts @@ -1,7 +1,8 @@ import { CrudFilter, CrudOperators } from "@refinedev/core"; +import { Field, FieldType, getCustomFieldKey, isCustomField } from "./queryFields"; interface TypedCrudFilter { - field: keyof Obj; + field: keyof Obj | string; operator: Exclude; value: string[]; } @@ -16,10 +17,7 @@ export function typeFilters(filters: CrudFilter[]): TypedCrudFilter[] * @param field The field to get the filter values for. * @returns An array of filter values for the given field. */ -export function getFiltersForField( - filters: TypedCrudFilter[], - field: Field, -): string[] { +export function getFiltersForField(filters: TypedCrudFilter[], field: Field | string): string[] { const filterValues: string[] = []; filters.forEach((filter) => { if (filter.field === field) { @@ -29,6 +27,89 @@ export function getFiltersForField( return filterValues; } +/** + * Creates a filter value for a custom field based on its type + * @param field The custom field definition + * @param value The value to filter by + * @returns The formatted filter value + */ +type CustomFieldFilterValue = + | string + | number + | boolean + | Date + | [number | null | undefined, number | null | undefined] + | null + | undefined; + +export function formatCustomFieldFilterValue(field: Field, value: CustomFieldFilterValue): string { + switch (field.field_type) { + case FieldType.text: + case FieldType.choice: + // For text and choice fields, we can use the value directly + // If it's an exact match, surround with quotes + if (typeof value === "string" && !value.startsWith('"') && !value.endsWith('"')) { + // Check if we need an exact match (no wildcards) + if (!value.includes("*") && !value.includes("?")) { + return `"${value}"`; + } + } + return value == null ? "" : String(value); + + case FieldType.integer: + case FieldType.float: + // For numeric fields, we can use the value directly + return value == null ? "" : value.toString(); + + case FieldType.boolean: + // For boolean fields, convert to "true" or "false" + return value ? "true" : "false"; + + case FieldType.datetime: + // For datetime fields, format as ISO string + if (value instanceof Date) { + return value.toISOString(); + } + return value == null ? "" : String(value); + + case FieldType.integer_range: + case FieldType.float_range: + // For range fields, format as min:max + if (Array.isArray(value) && value.length === 2) { + return `${value[0] ?? ""}:${value[1] ?? ""}`; + } + return value == null ? "" : String(value); + + default: + return value == null ? "" : String(value); + } +} + +/** + * Extracts all custom field filters from a list of filters + * @param filters The list of filters + * @returns An object with custom field keys and their filter values + */ +export function getCustomFieldFilters( + filters: CrudFilter[] | TypedCrudFilter[], +): Record { + const customFieldFilters: Record = {}; + + filters.forEach((filter) => { + if (!("field" in filter)) { + return; // Skip non-field filters + } + + const field = filter.field.toString(); + if (isCustomField(field)) { + const key = getCustomFieldKey(field); + customFieldFilters[key] = filter.value as string[]; + } + }); + + return customFieldFilters; +} + /** * Function that returns an array with all undefined values removed. */ diff --git a/client/src/utils/queryFields.ts b/client/src/utils/queryFields.ts index 7cde38c05..f7a048a74 100644 --- a/client/src/utils/queryFields.ts +++ b/client/src/utils/queryFields.ts @@ -110,6 +110,24 @@ export function useSetField(entity_type: EntityType) { }); } +/** + * Checks if a field is a custom field (starts with "extra.") + * @param field The field to check + * @returns True if the field is a custom field + */ +export function isCustomField(field: string): boolean { + return field.startsWith("extra."); +} + +/** + * Extracts the key from a custom field (removes the "extra." prefix) + * @param field The custom field + * @returns The key of the custom field + */ +export function getCustomFieldKey(field: string): string { + return field.substring(6); // Remove "extra." prefix +} + export function useDeleteField(entity_type: EntityType) { const queryClient = useQueryClient(); diff --git a/client/src/utils/sorting.ts b/client/src/utils/sorting.ts index 543d72546..27ee36b3d 100644 --- a/client/src/utils/sorting.ts +++ b/client/src/utils/sorting.ts @@ -1,8 +1,9 @@ import { CrudSort } from "@refinedev/core"; import { SortOrder } from "antd/es/table/interface"; +import { Field, getCustomFieldKey, isCustomField } from "./queryFields"; interface TypedCrudSort { - field: keyof Obj; + field: keyof Obj | string; order: "asc" | "desc"; } @@ -12,10 +13,7 @@ interface TypedCrudSort { * @param field The field to get the sort order for. * @returns The sort order for the given field, or undefined if the field is not being sorted. */ -export function getSortOrderForField( - sorters: TypedCrudSort[], - field: Field, -): SortOrder | undefined { +export function getSortOrderForField(sorters: TypedCrudSort[], field: Field | string): SortOrder | undefined { const sorter = sorters.find((s) => s.field === field); if (sorter) { return sorter.order === "asc" ? "ascend" : "descend"; @@ -26,3 +24,33 @@ export function getSortOrderForField( export function typeSorters(sorters: CrudSort[]): TypedCrudSort[] { return sorters as TypedCrudSort[]; // <-- Unsafe cast } + +/** + * Checks if a sorter is for a custom field + * @param sorter The sorter to check + * @returns True if the sorter is for a custom field + */ +export function isCustomFieldSorter(sorter: TypedCrudSort | CrudSort): boolean { + return typeof sorter.field === "string" && isCustomField(sorter.field); +} + +/** + * Extracts all custom field sorters from a list of sorters + * @param sorters The list of sorters + * @returns An object with custom field keys and their sort orders + */ +export function getCustomFieldSorters( + sorters: TypedCrudSort[] | CrudSort[], +): Record { + const customFieldSorters: Record = {}; + + sorters.forEach((sorter) => { + if (isCustomFieldSorter(sorter)) { + const field = sorter.field.toString(); + const key = getCustomFieldKey(field); + customFieldSorters[key] = sorter.order; + } + }); + + return customFieldSorters; +} diff --git a/spoolman/api/v1/filament.py b/spoolman/api/v1/filament.py index 3e3f859af..0549f5dbc 100644 --- a/spoolman/api/v1/filament.py +++ b/spoolman/api/v1/filament.py @@ -4,7 +4,7 @@ import logging from typing import Annotated -from fastapi import APIRouter, Depends, Query, WebSocket, WebSocketDisconnect +from fastapi import APIRouter, Depends, Query, Request, WebSocket, WebSocketDisconnect from fastapi.encoders import jsonable_encoder from fastapi.responses import JSONResponse from pydantic import BaseModel, Field, field_validator, model_validator @@ -201,6 +201,7 @@ def prevent_none(cls: type["FilamentUpdateParameters"], v: float | None) -> floa ) async def find( *, + request: Request, db: Annotated[AsyncSession, Depends(get_db_session)], vendor_name_old: Annotated[ str | None, @@ -342,19 +343,31 @@ async def find( else: filter_by_ids = None - db_items, total_count = await filament.find( - db=db, - ids=filter_by_ids, - vendor_name=vendor_name if vendor_name is not None else vendor_name_old, - vendor_id=vendor_ids, - name=name, - material=material, - article_number=article_number, - external_id=external_id, - sort_by=sort_by, - limit=limit, - offset=offset, - ) + # Extract custom field filters from query parameters + extra_field_filters = {} + query_params = request.query_params + for key, value in query_params.items(): + if key.startswith("extra."): + field_key = key[6:] # Remove "extra." prefix + extra_field_filters[field_key] = value + + try: + db_items, total_count = await filament.find( + db=db, + ids=filter_by_ids, + vendor_name=vendor_name if vendor_name is not None else vendor_name_old, + vendor_id=vendor_ids, + name=name, + material=material, + article_number=article_number, + external_id=external_id, + extra_field_filters=extra_field_filters if extra_field_filters else None, + sort_by=sort_by, + limit=limit, + offset=offset, + ) + except ValueError as e: + return JSONResponse(status_code=400, content=Message(message=str(e)).dict()) # Set x-total-count header for pagination return JSONResponse( diff --git a/spoolman/api/v1/spool.py b/spoolman/api/v1/spool.py index 8f667e3da..fa86b385b 100644 --- a/spoolman/api/v1/spool.py +++ b/spoolman/api/v1/spool.py @@ -5,7 +5,7 @@ from datetime import datetime from typing import Annotated -from fastapi import APIRouter, Depends, Query, WebSocket, WebSocketDisconnect +from fastapi import APIRouter, Depends, Query, Request, WebSocket, WebSocketDisconnect from fastapi.encoders import jsonable_encoder from fastapi.responses import JSONResponse from pydantic import BaseModel, Field, field_validator @@ -127,6 +127,7 @@ class SpoolMeasureParameters(BaseModel): ) async def find( *, + request: Request, db: Annotated[AsyncSession, Depends(get_db_session)], filament_name_old: Annotated[ str | None, @@ -285,20 +286,32 @@ async def find( else: filament_vendor_ids = None - db_items, total_count = await spool.find( - db=db, - filament_name=filament_name if filament_name is not None else filament_name_old, - filament_id=filament_ids, - filament_material=filament_material if filament_material is not None else filament_material_old, - vendor_name=filament_vendor_name if filament_vendor_name is not None else vendor_name_old, - vendor_id=filament_vendor_ids, - location=location, - lot_nr=lot_nr, - allow_archived=allow_archived, - sort_by=sort_by, - limit=limit, - offset=offset, - ) + # Extract custom field filters from query parameters + extra_field_filters = {} + query_params = request.query_params + for key, value in query_params.items(): + if key.startswith("extra."): + field_key = key[6:] # Remove "extra." prefix + extra_field_filters[field_key] = value + + try: + db_items, total_count = await spool.find( + db=db, + filament_name=filament_name if filament_name is not None else filament_name_old, + filament_id=filament_ids, + filament_material=filament_material if filament_material is not None else filament_material_old, + vendor_name=filament_vendor_name if filament_vendor_name is not None else vendor_name_old, + vendor_id=filament_vendor_ids, + location=location, + lot_nr=lot_nr, + allow_archived=allow_archived, + extra_field_filters=extra_field_filters if extra_field_filters else None, + sort_by=sort_by, + limit=limit, + offset=offset, + ) + except ValueError as e: + return JSONResponse(status_code=400, content=Message(message=str(e)).dict()) # Set x-total-count header for pagination return JSONResponse( diff --git a/spoolman/api/v1/vendor.py b/spoolman/api/v1/vendor.py index 9216fba30..f9395a004 100644 --- a/spoolman/api/v1/vendor.py +++ b/spoolman/api/v1/vendor.py @@ -3,7 +3,7 @@ import asyncio from typing import Annotated -from fastapi import APIRouter, Depends, Query, WebSocket, WebSocketDisconnect +from fastapi import APIRouter, Depends, Query, Request, WebSocket, WebSocketDisconnect from fastapi.encoders import jsonable_encoder from fastapi.responses import JSONResponse from pydantic import BaseModel, Field, field_validator @@ -79,6 +79,7 @@ def prevent_none(cls: type["VendorUpdateParameters"], v: str | None) -> str | No }, ) async def find( + request: Request, db: Annotated[AsyncSession, Depends(get_db_session)], name: Annotated[ str | None, @@ -124,14 +125,27 @@ async def find( field, direction = sort_item.split(":") sort_by[field] = SortOrder[direction.upper()] - db_items, total_count = await vendor.find( - db=db, - name=name, - external_id=external_id, - sort_by=sort_by, - limit=limit, - offset=offset, - ) + # Extract custom field filters from query parameters + extra_field_filters = {} + query_params = request.query_params + for key, value in query_params.items(): + if key.startswith("extra."): + field_key = key[6:] # Remove "extra." prefix + extra_field_filters[field_key] = value + + try: + db_items, total_count = await vendor.find( + db=db, + name=name, + external_id=external_id, + extra_field_filters=extra_field_filters if extra_field_filters else None, + sort_by=sort_by, + limit=limit, + offset=offset, + ) + except ValueError as e: + return JSONResponse(status_code=400, content=Message(message=str(e)).dict()) + # Set x-total-count header for pagination return JSONResponse( content=jsonable_encoder( diff --git a/spoolman/database/extra_field_query.py b/spoolman/database/extra_field_query.py new file mode 100644 index 000000000..75fa2291e --- /dev/null +++ b/spoolman/database/extra_field_query.py @@ -0,0 +1,404 @@ +"""Helpers for filtering and sorting extra fields.""" + +from __future__ import annotations + +import json +from typing import TYPE_CHECKING + +import sqlalchemy +from sqlalchemy import Select +from sqlalchemy.ext.compiler import compiles +from sqlalchemy.sql.expression import FunctionElement + +from spoolman.database import models +from spoolman.database.utils import SortOrder +from spoolman.extra_field_registry import EntityType, ExtraField, ExtraFieldType, get_extra_fields + +if TYPE_CHECKING: + from sqlalchemy.ext.asyncio import AsyncSession + from sqlalchemy.orm.attributes import InstrumentedAttribute + + +class _JsonArrayFirstElement(FunctionElement): + """Cross-database helper: return the first element of a JSON array stored as text.""" + + name = "json_array_first_element" + inherit_cache = True + + +@compiles(_JsonArrayFirstElement, "postgresql") +@compiles(_JsonArrayFirstElement, "cockroachdb") +def _compile_json_array_first_pg(element: _JsonArrayFirstElement, compiler: object, **kw: object) -> str: # type: ignore[misc] + """PostgreSQL/CockroachDB: CAST(value AS JSON)->>0 returns the first element as TEXT.""" + (col_expr,) = element.clauses + col_sql = compiler.process(col_expr, **kw) # type: ignore[union-attr] + return f"(CAST({col_sql} AS JSON)->>0)" + + +@compiles(_JsonArrayFirstElement) +def _compile_json_array_first_default(element: _JsonArrayFirstElement, compiler: object, **kw: object) -> str: # type: ignore[misc] + """SQLite/MariaDB: json_extract(value, '$[0]') returns the first element as a scalar.""" + (col_expr,) = element.clauses + col_sql = compiler.process(col_expr, **kw) # type: ignore[union-attr] + return f"JSON_EXTRACT({col_sql}, '$[0]')" + + +class _JsonScalarText(FunctionElement): + """Cross-database helper: decode a top-level JSON scalar and return it as unquoted TEXT. + + Used to compare against the *decoded* value rather than reconstructing the exact JSON + serialization the client wrote. This decouples filtering from json.dumps/JSON.stringify + encoding quirks (non-ASCII escaping, surrounding quotes, etc.). Only valid for JSON string + scalars (text/choice/datetime) - booleans and numbers are handled with numeric casts instead, + since scalar decoding is not consistent for them across dialects. + """ + + name = "json_scalar_text" + inherit_cache = True + + +@compiles(_JsonScalarText, "postgresql") +@compiles(_JsonScalarText, "cockroachdb") +def _compile_json_scalar_text_pg(element: _JsonScalarText, compiler: object, **kw: object) -> str: # type: ignore[misc] + """PostgreSQL/CockroachDB: CAST(value AS JSON) #>> '{}' extracts the root scalar as TEXT.""" + (col_expr,) = element.clauses + col_sql = compiler.process(col_expr, **kw) # type: ignore[union-attr] + return f"(CAST({col_sql} AS JSON) #>> '{{}}')" + + +@compiles(_JsonScalarText, "mysql") +def _compile_json_scalar_text_mysql(element: _JsonScalarText, compiler: object, **kw: object) -> str: # type: ignore[misc] + """MySQL/MariaDB: JSON_EXTRACT keeps the surrounding quotes, so JSON_UNQUOTE is required.""" + (col_expr,) = element.clauses + col_sql = compiler.process(col_expr, **kw) # type: ignore[union-attr] + return f"JSON_UNQUOTE(JSON_EXTRACT({col_sql}, '$'))" + + +@compiles(_JsonScalarText) +def _compile_json_scalar_text_default(element: _JsonScalarText, compiler: object, **kw: object) -> str: # type: ignore[misc] + """SQLite: json_extract(value, '$') already returns string scalars unquoted.""" + (col_expr,) = element.clauses + col_sql = compiler.process(col_expr, **kw) # type: ignore[union-attr] + return f"JSON_EXTRACT({col_sql}, '$')" + + +class _JsonArraySecondElement(FunctionElement): + """Cross-database helper: return the second element of a JSON array stored as text.""" + + name = "json_array_second_element" + inherit_cache = True + + +@compiles(_JsonArraySecondElement, "postgresql") +@compiles(_JsonArraySecondElement, "cockroachdb") +def _compile_json_array_second_pg(element: _JsonArraySecondElement, compiler: object, **kw: object) -> str: # type: ignore[misc] + """PostgreSQL/CockroachDB: CAST(value AS JSON)->>1 returns the second element as TEXT.""" + (col_expr,) = element.clauses + col_sql = compiler.process(col_expr, **kw) # type: ignore[union-attr] + return f"(CAST({col_sql} AS JSON)->>1)" + + +@compiles(_JsonArraySecondElement) +def _compile_json_array_second_default(element: _JsonArraySecondElement, compiler: object, **kw: object) -> str: # type: ignore[misc] + """SQLite/MariaDB: json_extract(value, '$[1]') returns the second element as a scalar.""" + (col_expr,) = element.clauses + col_sql = compiler.process(col_expr, **kw) # type: ignore[union-attr] + return f"JSON_EXTRACT({col_sql}, '$[1]')" + + +def _get_field_table_for_entity(entity_type: EntityType) -> type[models.Base]: + """Map an entity type to its extra-field table.""" + if entity_type == EntityType.spool: + return models.SpoolField + if entity_type == EntityType.filament: + return models.FilamentField + if entity_type == EntityType.vendor: + return models.VendorField + raise ValueError(f"Unknown entity type: {entity_type}") + + +def _get_entity_id_column(field_table: type[models.Base]) -> InstrumentedAttribute[int]: + """Map an extra-field table to its owning entity id column.""" + if field_table == models.SpoolField: + return models.SpoolField.spool_id + if field_table == models.FilamentField: + return models.FilamentField.filament_id + if field_table == models.VendorField: + return models.VendorField.vendor_id + raise ValueError(f"Unknown field table: {field_table}") + + +# Escape character for LIKE patterns. Deliberately not backslash: a backslash ESCAPE clause is +# ambiguous under MySQL/MariaDB string parsing. '/' renders safely on all four dialects. +_LIKE_ESCAPE = "/" + + +def _escape_like(value: str) -> str: + """Escape LIKE wildcards so user input is matched literally, not as a wildcard pattern.""" + return ( + value.replace(_LIKE_ESCAPE, _LIKE_ESCAPE * 2).replace("%", f"{_LIKE_ESCAPE}%").replace("_", f"{_LIKE_ESCAPE}_") + ) + + +def _parse_boolean_filter(value: str) -> bool: + """Parse a boolean filter using explicit true/false tokens only.""" + normalized = value.strip().lower() + if normalized == "true": + return True + if normalized == "false": + return False + raise ValueError(f"Invalid boolean filter value: {value!r}") + + +async def apply_extra_field_filters_and_sort( + *, + db: AsyncSession, + stmt: Select, + base_obj: type[models.Base], + entity_type: EntityType, + extra_field_filters: dict[str, str] | None, + sort_by: dict[str, SortOrder] | None, +) -> Select: + """Apply extra-field filtering and sorting to a query.""" + if not extra_field_filters and not (sort_by is not None and any(field.startswith("extra.") for field in sort_by)): + return stmt + + extra_fields = await get_extra_fields(db, entity_type) + extra_fields_dict: dict[str, ExtraField] = {field.key: field for field in extra_fields} + + if extra_field_filters: + for field_key, value in extra_field_filters.items(): + field = extra_fields_dict.get(field_key) + if field is None: + continue + stmt = add_where_clause_extra_field( + stmt=stmt, + base_obj=base_obj, + entity_type=entity_type, + field_key=field_key, + field_type=field.field_type, + value=value, + multi_choice=field.multi_choice if field.field_type == ExtraFieldType.choice else None, + ) + + if sort_by is not None: + for field_name, order in sort_by.items(): + if not field_name.startswith("extra."): + continue + + field_key = field_name[6:] + extra_field = extra_fields_dict.get(field_key) + if extra_field is None: + continue + + stmt = add_order_by_extra_field( + stmt=stmt, + base_obj=base_obj, + entity_type=entity_type, + field_key=field_key, + field_type=extra_field.field_type, + order=order, + ) + + return stmt + + +def add_where_clause_extra_field( # noqa: C901, PLR0912, PLR0915 + stmt: Select, + base_obj: type[models.Base], + entity_type: EntityType, + field_key: str, + field_type: ExtraFieldType, + value: str, + *, + multi_choice: bool | None = None, +) -> Select: + """Add a where clause to a select statement for an extra field.""" + field_table = _get_field_table_for_entity(entity_type) + entity_id_column = _get_entity_id_column(field_table) + base_id_column = base_obj.id + + conditions = [] + for value_part in value.split(","): + # Empty-string filters follow the existing string-query API semantics. + if len(value_part) == 0: + empty_conditions = [ + field_table.value.is_(None), + field_table.value == "null", + ] + if field_type == ExtraFieldType.boolean: + empty_conditions.append(field_table.value == json.dumps(bool(0))) + + field_has_empty_value = sqlalchemy.select(entity_id_column).where( + sqlalchemy.and_(field_table.key == field_key, sqlalchemy.or_(*empty_conditions)) + ) + field_missing_entirely = sqlalchemy.select(base_id_column).where( + base_id_column.not_in(sqlalchemy.select(entity_id_column).where(field_table.key == field_key)) + ) + conditions.append(base_id_column.in_(field_has_empty_value)) + conditions.append(base_id_column.in_(field_missing_entirely)) + continue + + exact_match = value_part.startswith('"') and value_part.endswith('"') + parsed_value = value_part[1:-1] if exact_match else value_part + + if field_type == ExtraFieldType.text: + # Compare against the DB-decoded scalar rather than a reconstructed JSON string, so + # matching is independent of how the value was encoded (quote handling, non-ASCII + # escaping). Substring search escapes LIKE wildcards to match user input literally. + decoded = _JsonScalarText(field_table.value) + field_condition = ( + decoded == parsed_value + if exact_match + else decoded.ilike(f"%{_escape_like(parsed_value)}%", escape=_LIKE_ESCAPE) + ) + elif field_type == ExtraFieldType.integer: + if ":" in parsed_value: + min_val_str, max_val_str = parsed_value.split(":", 1) + int_conditions = [] + try: + stored = sqlalchemy.cast(field_table.value, sqlalchemy.Integer) + if min_val_str: + int_conditions.append(stored >= int(min_val_str)) + if max_val_str: + int_conditions.append(stored <= int(max_val_str)) + except (ValueError, TypeError) as exc: + raise ValueError(f"Invalid integer range filter value for '{field_key}': {parsed_value}") from exc + if not int_conditions: + raise ValueError(f"Invalid integer range filter value for '{field_key}': {parsed_value}") + field_condition = sqlalchemy.and_(*int_conditions) + else: + try: + field_condition = field_table.value == json.dumps(int(parsed_value)) + except ValueError as exc: + raise ValueError(f"Invalid integer filter value for '{field_key}': {parsed_value}") from exc + elif field_type == ExtraFieldType.float: + if ":" in parsed_value: + min_val_str, max_val_str = parsed_value.split(":", 1) + float_conditions = [] + try: + stored = sqlalchemy.cast(field_table.value, sqlalchemy.Float) + if min_val_str: + float_conditions.append(stored >= float(min_val_str)) + if max_val_str: + float_conditions.append(stored <= float(max_val_str)) + except (ValueError, TypeError) as exc: + raise ValueError(f"Invalid float range filter value for '{field_key}': {parsed_value}") from exc + if not float_conditions: + raise ValueError(f"Invalid float range filter value for '{field_key}': {parsed_value}") + field_condition = sqlalchemy.and_(*float_conditions) + else: + try: + # Compare numerically rather than by JSON string so that int-typed storage + # (e.g. "2") and non-canonical decimals (e.g. "2.50") match a "2.0" filter. + field_condition = sqlalchemy.cast(field_table.value, sqlalchemy.Float) == float(parsed_value) + except ValueError as exc: + raise ValueError(f"Invalid float filter value for '{field_key}': {parsed_value}") from exc + elif field_type == ExtraFieldType.boolean: + field_condition = field_table.value == json.dumps(_parse_boolean_filter(parsed_value)) + elif field_type == ExtraFieldType.choice: + if multi_choice: + # Multi-choice is stored as a JSON array; match the JSON-encoded token as a + # substring. json.dumps gives the exact quoted, escaped form the array element + # is stored as, and LIKE wildcards in the token are escaped. + token = json.dumps(parsed_value, ensure_ascii=False) + field_condition = field_table.value.like(f"%{_escape_like(token)}%", escape=_LIKE_ESCAPE) + else: + # Compare against the DB-decoded scalar, independent of JSON encoding. + field_condition = _JsonScalarText(field_table.value) == parsed_value + elif field_type == ExtraFieldType.datetime: + # Compare decoded ISO-8601 strings. Both bounds and stored values are the frontend's + # canonical toISOString() output, so lexicographic comparison is chronological. + decoded = _JsonScalarText(field_table.value) + if "|" in parsed_value: + start_str, end_str = parsed_value.split("|", 1) + dt_conditions = [] + if start_str: + dt_conditions.append(decoded >= start_str) + if end_str: + dt_conditions.append(decoded <= end_str) + if not dt_conditions: + raise ValueError( + f"Invalid datetime range filter for '{field_key}': {parsed_value}. Expected '|'." + ) + field_condition = sqlalchemy.and_(*dt_conditions) + else: + field_condition = decoded == parsed_value + elif field_type in (ExtraFieldType.integer_range, ExtraFieldType.float_range): + if ":" not in parsed_value: + raise ValueError( + f"Invalid range filter value for '{field_key}': {parsed_value}. Expected ':'." + ) + min_val_str, max_val_str = parsed_value.split(":", 1) + converter = int if field_type == ExtraFieldType.integer_range else float + range_conditions = [] + try: + cast_type = sqlalchemy.Integer if field_type == ExtraFieldType.integer_range else sqlalchemy.Float + if min_val_str: + # stored_min >= filter_min: the range starts at or after the requested minimum. + stored_min = sqlalchemy.cast(_JsonArrayFirstElement(field_table.value), cast_type) + range_conditions.append(stored_min >= converter(min_val_str)) + if max_val_str: + # stored_max <= filter_max: the range ends at or before the requested maximum. + stored_max = sqlalchemy.cast(_JsonArraySecondElement(field_table.value), cast_type) + range_conditions.append(stored_max <= converter(max_val_str)) + except (ValueError, TypeError) as exc: + range_kind = "integer" if field_type == ExtraFieldType.integer_range else "float" + raise ValueError(f"Invalid {range_kind} range filter value for '{field_key}': {parsed_value}") from exc + if not range_conditions: + raise ValueError( + f"Invalid range filter value for '{field_key}': {parsed_value}. Expected ':'." + ) + field_condition = sqlalchemy.and_(*range_conditions) + else: + raise ValueError(f"Unsupported extra field type for '{field_key}': {field_type}") + + matching_entities = sqlalchemy.select(entity_id_column).where( + sqlalchemy.and_(field_table.key == field_key, field_condition) + ) + conditions.append(base_id_column.in_(matching_entities)) + + if not conditions: + return stmt + + return stmt.where(sqlalchemy.or_(*conditions)) + + +def add_order_by_extra_field( + stmt: Select, + base_obj: type[models.Base], + entity_type: EntityType, + field_key: str, + field_type: ExtraFieldType, + order: SortOrder, +) -> Select: + """Add an order-by clause to a select statement for an extra field.""" + field_table = _get_field_table_for_entity(entity_type) + entity_id_column = _get_entity_id_column(field_table) + + value_subq = ( + sqlalchemy.select(field_table.value) + .where( + sqlalchemy.and_( + field_table.key == field_key, + entity_id_column == base_obj.id, + ) + ) + .scalar_subquery() + .correlate(base_obj) + ) + + if field_type == ExtraFieldType.integer: + sort_expr = sqlalchemy.cast(value_subq, sqlalchemy.Integer) + elif field_type == ExtraFieldType.float: + sort_expr = sqlalchemy.cast(value_subq, sqlalchemy.Float) + elif field_type in (ExtraFieldType.integer_range, ExtraFieldType.float_range): + cast_type = sqlalchemy.Integer if field_type == ExtraFieldType.integer_range else sqlalchemy.Float + # Use dialect-specific JSON first-element extraction, then cast to numeric. + sort_expr = sqlalchemy.cast(_JsonArrayFirstElement(value_subq), cast_type) + else: + sort_expr = value_subq + + if order == SortOrder.ASC: + return stmt.order_by(sort_expr.asc()) + return stmt.order_by(sort_expr.desc()) diff --git a/spoolman/database/filament.py b/spoolman/database/filament.py index ee759e84e..caa42e7ea 100644 --- a/spoolman/database/filament.py +++ b/spoolman/database/filament.py @@ -12,6 +12,7 @@ from spoolman.api.v1.models import EventType, Filament, FilamentEvent, MultiColorDirection from spoolman.database import models, vendor +from spoolman.database.extra_field_query import apply_extra_field_filters_and_sort from spoolman.database.utils import ( SortOrder, add_where_clause_int_in, @@ -21,6 +22,7 @@ parse_nested_field, ) from spoolman.exceptions import ItemDeleteError, ItemNotFoundError +from spoolman.extra_field_registry import EntityType from spoolman.math import delta_e, hex_to_rgb, rgb_to_lab from spoolman.ws import websocket_manager @@ -102,6 +104,7 @@ async def find( material: str | None = None, article_number: str | None = None, external_id: str | None = None, + extra_field_filters: dict[str, str] | None = None, sort_by: dict[str, SortOrder] | None = None, limit: int | None = None, offset: int = 0, @@ -129,20 +132,32 @@ async def find( total_count = None - if limit is not None: - total_count_stmt = stmt.with_only_columns(func.count(), maintain_column_froms=True) - total_count = (await db.execute(total_count_stmt)).scalar() - - stmt = stmt.offset(offset).limit(limit) + stmt = await apply_extra_field_filters_and_sort( + db=db, + stmt=stmt, + base_obj=models.Filament, + entity_type=EntityType.filament, + extra_field_filters=extra_field_filters, + sort_by=sort_by, + ) if sort_by is not None: for fieldstr, order in sort_by.items(): + # Check if this is a custom field sort + if fieldstr.startswith("extra."): + continue + field = parse_nested_field(models.Filament, fieldstr) if order == SortOrder.ASC: stmt = stmt.order_by(field.asc()) elif order == SortOrder.DESC: stmt = stmt.order_by(field.desc()) + if limit is not None: + total_count_stmt = stmt.with_only_columns(func.count(), maintain_column_froms=True).order_by(None) + total_count = (await db.execute(total_count_stmt)).scalar() + stmt = stmt.offset(offset).limit(limit) + rows = await db.execute( stmt, execution_options={"populate_existing": True}, diff --git a/spoolman/database/spool.py b/spoolman/database/spool.py index 53f217343..cb06cfd12 100644 --- a/spoolman/database/spool.py +++ b/spoolman/database/spool.py @@ -13,6 +13,7 @@ from spoolman.api.v1.models import EventType, Spool, SpoolEvent from spoolman.database import filament, models +from spoolman.database.extra_field_query import apply_extra_field_filters_and_sort from spoolman.database.utils import ( SortOrder, add_where_clause_int, @@ -22,6 +23,7 @@ parse_nested_field, ) from spoolman.exceptions import ItemCreateError, ItemNotFoundError, SpoolMeasureError +from spoolman.extra_field_registry import EntityType from spoolman.math import weight_from_length from spoolman.ws import websocket_manager @@ -122,6 +124,7 @@ async def find( # noqa: C901, PLR0912 location: str | None = None, lot_nr: str | None = None, allow_archived: bool = False, + extra_field_filters: dict[str, str] | None = None, sort_by: dict[str, SortOrder] | None = None, limit: int | None = None, offset: int = 0, @@ -159,20 +162,29 @@ async def find( # noqa: C901, PLR0912 total_count = None - if limit is not None: - total_count_stmt = stmt.with_only_columns(func.count(), maintain_column_froms=True) - total_count = (await db.execute(total_count_stmt)).scalar() - - stmt = stmt.offset(offset).limit(limit) + stmt = await apply_extra_field_filters_and_sort( + db=db, + stmt=stmt, + base_obj=models.Spool, + entity_type=EntityType.spool, + extra_field_filters=extra_field_filters, + sort_by=sort_by, + ) if sort_by is not None: for fieldstr, order in sort_by.items(): + # Check if this is a custom field sort + if fieldstr.startswith("extra."): + continue + sorts = [] if fieldstr == "remaining_weight": - sorts.append(coalesce(models.Spool.initial_weight, models.Filament.weight) - models.Spool.used_weight) + sorts.append( + coalesce(models.Spool.initial_weight, models.Filament.weight) - models.Spool.used_weight, + ) elif fieldstr == "remaining_length": - # Simplified weight -> length formula. Absolute value is not correct but the proportionality is still - # kept, which means the sort order is correct. + # Simplified weight -> length formula. Absolute value is not correct but the proportionality + # is still kept, which means the sort order is correct. sorts.append( (coalesce(models.Spool.initial_weight, models.Filament.weight) - models.Spool.used_weight) / models.Filament.density @@ -197,6 +209,11 @@ async def find( # noqa: C901, PLR0912 elif order == SortOrder.DESC: stmt = stmt.order_by(*(f.desc() for f in sorts)) + if limit is not None: + total_count_stmt = stmt.with_only_columns(func.count(), maintain_column_froms=True).order_by(None) + total_count = (await db.execute(total_count_stmt)).scalar() + stmt = stmt.offset(offset).limit(limit) + rows = await db.execute( stmt, execution_options={"populate_existing": True}, diff --git a/spoolman/database/vendor.py b/spoolman/database/vendor.py index c62d6cba5..6a0100b5b 100644 --- a/spoolman/database/vendor.py +++ b/spoolman/database/vendor.py @@ -9,8 +9,10 @@ from spoolman.api.v1.models import EventType, Vendor, VendorEvent from spoolman.database import models +from spoolman.database.extra_field_query import apply_extra_field_filters_and_sort from spoolman.database.utils import SortOrder, add_where_clause_str, add_where_clause_str_opt from spoolman.exceptions import ItemNotFoundError +from spoolman.extra_field_registry import EntityType from spoolman.ws import websocket_manager logger = logging.getLogger(__name__) @@ -53,6 +55,7 @@ async def find( db: AsyncSession, name: str | None = None, external_id: str | None = None, + extra_field_filters: dict[str, str] | None = None, sort_by: dict[str, SortOrder] | None = None, limit: int | None = None, offset: int = 0, @@ -68,20 +71,32 @@ async def find( total_count = None - if limit is not None: - total_count_stmt = stmt.with_only_columns(func.count(), maintain_column_froms=True) - total_count = (await db.execute(total_count_stmt)).scalar() - - stmt = stmt.offset(offset).limit(limit) + stmt = await apply_extra_field_filters_and_sort( + db=db, + stmt=stmt, + base_obj=models.Vendor, + entity_type=EntityType.vendor, + extra_field_filters=extra_field_filters, + sort_by=sort_by, + ) if sort_by is not None: for fieldstr, order in sort_by.items(): + # Check if this is a custom field sort + if fieldstr.startswith("extra."): + continue + field = getattr(models.Vendor, fieldstr) if order == SortOrder.ASC: stmt = stmt.order_by(field.asc()) elif order == SortOrder.DESC: stmt = stmt.order_by(field.desc()) + if limit is not None: + total_count_stmt = stmt.with_only_columns(func.count(), maintain_column_froms=True).order_by(None) + total_count = (await db.execute(total_count_stmt)).scalar() + stmt = stmt.offset(offset).limit(limit) + rows = await db.execute( stmt, execution_options={"populate_existing": True}, diff --git a/spoolman/extra_field_registry.py b/spoolman/extra_field_registry.py new file mode 100644 index 000000000..173b2420a --- /dev/null +++ b/spoolman/extra_field_registry.py @@ -0,0 +1,196 @@ +"""Shared extra-field definitions and settings access.""" + +from __future__ import annotations + +import json +import logging +from enum import Enum +from typing import TYPE_CHECKING + +from fastapi.encoders import jsonable_encoder +from pydantic import BaseModel, Field + +from spoolman.database import setting as db_setting +from spoolman.exceptions import ItemNotFoundError +from spoolman.settings import parse_setting + +if TYPE_CHECKING: + from sqlalchemy.ext.asyncio import AsyncSession + +logger = logging.getLogger(__name__) + + +class EntityType(Enum): + vendor = "vendor" + filament = "filament" + spool = "spool" + + +class ExtraFieldType(Enum): + text = "text" + integer = "integer" + integer_range = "integer_range" + float = "float" + float_range = "float_range" + datetime = "datetime" + boolean = "boolean" + choice = "choice" + + +class ExtraFieldParameters(BaseModel): + name: str = Field(description="Nice name", min_length=1, max_length=128) + order: int = Field(0, description="Order of the field") + unit: str | None = Field(None, description="Unit of the value", min_length=1, max_length=16) + field_type: ExtraFieldType = Field(description="Type of the field") + default_value: str | None = Field(None, description="Default value of the field") + choices: list[str] | None = Field( + None, + description="Choices for the field, only for field type choice", + min_length=1, + ) + multi_choice: bool | None = Field(None, description="Whether multiple choices can be selected") + + +class ExtraField(ExtraFieldParameters): + key: str = Field(description="Unique key", pattern="^[a-z0-9_]+$", min_length=1, max_length=64) + entity_type: EntityType = Field(description="Entity type this field is for") + + +def validate_extra_field_value(field: ExtraFieldParameters, value: str) -> None: # noqa: C901, PLR0912 + """Validate that the value has the correct type.""" + try: + data = json.loads(value) + except json.JSONDecodeError: + raise ValueError("Value is not valid JSON.") from None + + if field.field_type == ExtraFieldType.text: + if not isinstance(data, str): + raise ValueError("Value is not a string.") + elif field.field_type == ExtraFieldType.integer: + if not isinstance(data, int): + raise ValueError("Value is not an integer.") + elif field.field_type == ExtraFieldType.integer_range: + if not isinstance(data, list): + raise ValueError("Value is not a list.") + if len(data) != 2: # noqa: PLR2004 + raise ValueError("Value list must have exactly two values.") + if not all(isinstance(item, int) or item is None for item in data): + raise ValueError("Value list must contain only integers or null.") + elif field.field_type == ExtraFieldType.float: + if not isinstance(data, (float, int)) or isinstance(data, bool): + raise ValueError("Value is not a float.") + elif field.field_type == ExtraFieldType.float_range: + if not isinstance(data, list): + raise ValueError("Value is not a list.") + if len(data) != 2: # noqa: PLR2004 + raise ValueError("Value list must have exactly two values.") + if not all((isinstance(item, (float, int)) or item is None) and not isinstance(item, bool) for item in data): + raise ValueError("Value list must contain only floats or null.") + elif field.field_type == ExtraFieldType.datetime: + if not isinstance(data, str): + raise ValueError("Value is not a string.") + elif field.field_type == ExtraFieldType.boolean: + if not isinstance(data, bool): + raise ValueError("Value is not a boolean.") + elif field.field_type == ExtraFieldType.choice: + if field.multi_choice: + if not isinstance(data, list): + raise ValueError("Value is not a list.") + if not all(isinstance(item, str) for item in data): + raise ValueError("Value list must contain only strings.") + if field.choices is not None and not all(item in field.choices for item in data): + raise ValueError("Value list contains invalid choices.") + else: + if not isinstance(data, str): + raise ValueError("Value is not a string.") + if field.choices is not None and data not in field.choices: + raise ValueError("Value is not a valid choice.") + else: + raise ValueError(f"Unknown field type {field.field_type}.") + + +def validate_extra_field(field: ExtraFieldParameters) -> None: + """Validate an extra field.""" + if field.field_type == ExtraFieldType.choice: + if field.choices is None: + raise ValueError("Choices must be set for field type choice.") + if field.multi_choice is None: + raise ValueError("Multi choice must be set for field type choice.") + else: + if field.choices is not None: + raise ValueError("Choices must not be set for field type other than choice.") + if field.multi_choice is not None: + raise ValueError("Multi choice must not be set for field type other than choice.") + + if field.default_value is not None: + try: + validate_extra_field_value(field, field.default_value) + except ValueError as e: + raise ValueError(f"Default value is not valid: {e}") from None + + +def validate_extra_field_dict(all_fields: list[ExtraField], fields_input: dict[str, str]) -> None: + """Validate a dict of extra fields.""" + all_field_lookup = {field.key: field for field in all_fields} + for key, value in fields_input.items(): + if key not in all_field_lookup: + raise ValueError(f"Unknown extra field {key}.") + field = all_field_lookup[key] + try: + validate_extra_field_value(field, value) + except ValueError as e: + raise ValueError(f"Invalid extra field for key {key}: {e!s}") from None + + +extra_field_cache: dict[EntityType, list[ExtraField]] = {} + + +async def get_extra_fields(db: AsyncSession, entity_type: EntityType) -> list[ExtraField]: + """Get all extra fields for a specific entity type.""" + if entity_type in extra_field_cache: + return extra_field_cache[entity_type] + + setting_def = parse_setting(f"extra_fields_{entity_type.name}") + try: + setting = await db_setting.get(db, setting_def) + setting_value = setting.value + except ItemNotFoundError: + setting_value = setting_def.default + + setting_array = json.loads(setting_value) + if not isinstance(setting_array, list): + logger.warning("Setting %s is not a list, using default.", setting_def.key) + setting_array = [] + + fields = [ExtraField.parse_obj(obj) for obj in setting_array] + extra_field_cache[entity_type] = fields + return fields + + +async def add_or_update_extra_field(db: AsyncSession, entity_type: EntityType, extra_field: ExtraField) -> None: + """Add or update an extra field for a specific entity type.""" + validate_extra_field(extra_field) + + extra_fields = await get_extra_fields(db, entity_type) + existing_field = next((field for field in extra_fields if field.key == extra_field.key), None) + if existing_field is not None: + if existing_field.field_type != extra_field.field_type: + raise ValueError("Field type cannot be changed.") + if extra_field.field_type == ExtraFieldType.choice: + if existing_field.multi_choice != extra_field.multi_choice: + raise ValueError("Multi choice cannot be changed.") + if ( + existing_field.choices is not None + and extra_field.choices is not None + and not all(choice in extra_field.choices for choice in existing_field.choices) + ): + raise ValueError("Cannot remove existing choices.") + + extra_fields = [field for field in extra_fields if field.key != extra_field.key] + extra_fields.append(extra_field) + + setting_def = parse_setting(f"extra_fields_{entity_type.name}") + await db_setting.update(db=db, definition=setting_def, value=json.dumps(jsonable_encoder(extra_fields))) + + extra_field_cache[entity_type] = extra_fields + logger.info("Added/updated extra field %s for entity type %s.", extra_field.key, entity_type.name) diff --git a/spoolman/extra_fields.py b/spoolman/extra_fields.py index 2be157e3d..6b3ad0f6b 100644 --- a/spoolman/extra_fields.py +++ b/spoolman/extra_fields.py @@ -2,10 +2,8 @@ import json import logging -from enum import Enum from fastapi.encoders import jsonable_encoder -from pydantic import BaseModel, Field from sqlalchemy.ext.asyncio import AsyncSession from spoolman.database import filament as db_filament @@ -13,196 +11,36 @@ from spoolman.database import spool as db_spool from spoolman.database import vendor as db_vendor from spoolman.exceptions import ItemNotFoundError +from spoolman.extra_field_registry import ( + EntityType, + ExtraField, + ExtraFieldParameters, + ExtraFieldType, + add_or_update_extra_field, + extra_field_cache, + get_extra_fields, + validate_extra_field, + validate_extra_field_dict, + validate_extra_field_value, +) from spoolman.settings import parse_setting logger = logging.getLogger(__name__) - -class EntityType(Enum): - vendor = "vendor" - filament = "filament" - spool = "spool" - - -class ExtraFieldType(Enum): - text = "text" - integer = "integer" - integer_range = "integer_range" - float = "float" - float_range = "float_range" - datetime = "datetime" - boolean = "boolean" - choice = "choice" - - -class ExtraFieldParameters(BaseModel): - name: str = Field(description="Nice name", min_length=1, max_length=128) - order: int = Field(0, description="Order of the field") - unit: str | None = Field(None, description="Unit of the value", min_length=1, max_length=16) - field_type: ExtraFieldType = Field(description="Type of the field") - default_value: str | None = Field(None, description="Default value of the field") - choices: list[str] | None = Field( - None, - description="Choices for the field, only for field type choice", - min_length=1, - ) - multi_choice: bool | None = Field(None, description="Whether multiple choices can be selected") - - -class ExtraField(ExtraFieldParameters): - key: str = Field(description="Unique key", pattern="^[a-z0-9_]+$", min_length=1, max_length=64) - entity_type: EntityType = Field(description="Entity type this field is for") - - -def validate_extra_field_value(field: ExtraFieldParameters, value: str) -> None: # noqa: C901, PLR0912 - """Validate that the value has the correct type.""" - try: - data = json.loads(value) - except json.JSONDecodeError: - raise ValueError("Value is not valid JSON.") from None - - if field.field_type == ExtraFieldType.text: - if not isinstance(data, str): - raise ValueError("Value is not a string.") - elif field.field_type == ExtraFieldType.integer: - if not isinstance(data, int): - raise ValueError("Value is not an integer.") - elif field.field_type == ExtraFieldType.integer_range: - if not isinstance(data, list): - raise ValueError("Value is not a list.") - if len(data) != 2: # noqa: PLR2004 - raise ValueError("Value list must have exactly two values.") - if not all(isinstance(value, int) or value is None for value in data): - raise ValueError("Value list must contain only integers or null.") - elif field.field_type == ExtraFieldType.float: - if not isinstance(data, (float, int)) or isinstance(data, bool): - raise ValueError("Value is not a float.") - elif field.field_type == ExtraFieldType.float_range: - if not isinstance(data, list): - raise ValueError("Value is not a list.") - if len(data) != 2: # noqa: PLR2004 - raise ValueError("Value list must have exactly two values.") - if not all( - (isinstance(value, (float, int)) or value is None) and not isinstance(value, bool) for value in data - ): - raise ValueError("Value list must contain only floats or null.") - elif field.field_type == ExtraFieldType.datetime: - if not isinstance(data, str): - raise ValueError("Value is not a string.") - elif field.field_type == ExtraFieldType.boolean: - if not isinstance(data, bool): - raise ValueError("Value is not a boolean.") - elif field.field_type == ExtraFieldType.choice: - if field.multi_choice: - if not isinstance(data, list): - raise ValueError("Value is not a list.") - if not all(isinstance(value, str) for value in data): - raise ValueError("Value list must contain only strings.") - if field.choices is not None and not all(value in field.choices for value in data): - raise ValueError("Value list contains invalid choices.") - else: - if not isinstance(data, str): - raise ValueError("Value is not a string.") - if field.choices is not None and data not in field.choices: - raise ValueError("Value is not a valid choice.") - else: - raise ValueError(f"Unknown field type {field.field_type}.") - - -def validate_extra_field(field: ExtraFieldParameters) -> None: - """Validate an extra field.""" - # Validate choices exist if field type is choice - if field.field_type == ExtraFieldType.choice: - if field.choices is None: - raise ValueError("Choices must be set for field type choice.") - if field.multi_choice is None: - raise ValueError("Multi choice must be set for field type choice.") - else: - if field.choices is not None: - raise ValueError("Choices must not be set for field type other than choice.") - if field.multi_choice is not None: - raise ValueError("Multi choice must not be set for field type other than choice.") - - # Validate default value data type - if field.default_value is not None: - try: - validate_extra_field_value(field, field.default_value) - except ValueError as e: - raise ValueError(f"Default value is not valid: {e}") from None - - -def validate_extra_field_dict(all_fields: list[ExtraField], fields_input: dict[str, str]) -> None: - """Validate a dict of extra fields.""" - all_field_lookup = {field.key: field for field in all_fields} - for key, value in fields_input.items(): - if key not in all_field_lookup: - raise ValueError(f"Unknown extra field {key}.") - field = all_field_lookup[key] - try: - validate_extra_field_value(field, value) - except ValueError as e: - raise ValueError(f"Invalid extra field for key {key}: {e!s}") from None - - -extra_field_cache = {} - - -async def get_extra_fields(db: AsyncSession, entity_type: EntityType) -> list[ExtraField]: - """Get all extra fields for a specific entity type.""" - if entity_type in extra_field_cache: - return extra_field_cache[entity_type] - - setting_def = parse_setting(f"extra_fields_{entity_type.name}") - try: - setting = await db_setting.get(db, setting_def) - setting_value = setting.value - except ItemNotFoundError: - setting_value = setting_def.default - - setting_array = json.loads(setting_value) - if not isinstance(setting_array, list): - logger.warning("Setting %s is not a list, using default.", setting_def.key) - setting_array = [] - - fields = [ExtraField.parse_obj(obj) for obj in setting_array] - extra_field_cache[entity_type] = fields - return fields - - -async def add_or_update_extra_field(db: AsyncSession, entity_type: EntityType, extra_field: ExtraField) -> None: - """Add or update an extra field for a specific entity type.""" - validate_extra_field(extra_field) - - extra_fields = await get_extra_fields(db, entity_type) - - # If the field already exists, verify that we don't do anything that would break existing data - existing_field = next((field for field in extra_fields if field.key == extra_field.key), None) - if existing_field is not None: - if existing_field.field_type != extra_field.field_type: - raise ValueError("Field type cannot be changed.") - if extra_field.field_type == ExtraFieldType.choice: - # Can't change multi choice since that would break existing data - if existing_field.multi_choice != extra_field.multi_choice: - raise ValueError("Multi choice cannot be changed.") - - # Verify that we have only added new choices, not removed any - if ( - existing_field.choices is not None - and extra_field.choices is not None - and not all(choice in extra_field.choices for choice in existing_field.choices) - ): - raise ValueError("Cannot remove existing choices.") - - extra_fields = [field for field in extra_fields if field.key != extra_field.key] - extra_fields.append(extra_field) - - setting_def = parse_setting(f"extra_fields_{entity_type.name}") - await db_setting.update(db=db, definition=setting_def, value=json.dumps(jsonable_encoder(extra_fields))) - - # Update cache - extra_field_cache[entity_type] = extra_fields - - logger.info("Added/updated extra field %s for entity type %s.", extra_field.key, entity_type.name) +__all__ = [ + "EntityType", + "ExtraField", + "ExtraFieldParameters", + "ExtraFieldType", + "add_or_update_extra_field", + "delete_extra_field", + "extra_field_cache", + "get_extra_fields", + "populate_with_defaults", + "validate_extra_field", + "validate_extra_field_dict", + "validate_extra_field_value", +] async def delete_extra_field(db: AsyncSession, entity_type: EntityType, key: str) -> None: @@ -221,7 +59,8 @@ async def delete_extra_field(db: AsyncSession, entity_type: EntityType, key: str # Update cache extra_field_cache[entity_type] = extra_fields - # Delete the extra field for all entities + logger.info("Deleted extra field %r for entity type %r.", key, entity_type.name) + if entity_type == EntityType.vendor: await db_vendor.clear_extra_field(db, key) elif entity_type == EntityType.filament: @@ -231,8 +70,6 @@ async def delete_extra_field(db: AsyncSession, entity_type: EntityType, key: str else: raise ValueError(f"Unknown entity type {entity_type.name}.") - logger.info("Deleted extra field %s for entity type %s.", key, entity_type.name) - async def populate_with_defaults(db: AsyncSession, entity_type: EntityType, existing: dict[str, str]) -> None: """Populate the given list of extra fields with defaults.""" diff --git a/tests_integration/tests/fields/test_filter_sort.py b/tests_integration/tests/fields/test_filter_sort.py new file mode 100644 index 000000000..a124cc95f --- /dev/null +++ b/tests_integration/tests/fields/test_filter_sort.py @@ -0,0 +1,1298 @@ +"""Tests for filtering and sorting by custom fields.""" + +import json +import uuid +from typing import Any + +import httpx +import pytest + +from ..conftest import URL, assert_httpx_success + + +def _create_entity(entity_type: str, extra: dict[str, str], random_filament: dict[str, Any]) -> int: + """Create a test entity of the given type with the given extra fields. Returns the entity id.""" + if entity_type == "spool": + result = httpx.post( + f"{URL}/api/v1/spool", + json={"filament_id": random_filament["id"], "extra": extra}, + ) + elif entity_type == "filament": + result = httpx.post( + f"{URL}/api/v1/filament", + json={ + "vendor_id": random_filament["vendor"]["id"], + "name": f"Test-{uuid.uuid4().hex[:8]}", + "density": 1.24, + "diameter": 1.75, + "extra": extra, + }, + ) + elif entity_type == "vendor": + result = httpx.post( + f"{URL}/api/v1/vendor", + json={"name": f"Vendor-{uuid.uuid4().hex[:8]}", "extra": extra}, + ) + else: + raise ValueError(f"Unknown entity type: {entity_type}") + result.raise_for_status() + return result.json()["id"] + + +# --------------------------------------------------------------------------- +# Numeric fields - integer, float, integer_range, float_range (all entity types) +# --------------------------------------------------------------------------- + + +@pytest.mark.asyncio +@pytest.mark.parametrize("entity_type", ["spool", "filament", "vendor"]) +async def test_integer_filter_and_sort(entity_type: str, random_filament: dict[str, Any]) -> None: + """Test filter and sort by a custom integer field for all entity types.""" + field_key = "test_int_field" + httpx.post( + f"{URL}/api/v1/field/{entity_type}/{field_key}", + json={"name": "Integer field", "field_type": "integer"}, + ).raise_for_status() + id1 = _create_entity(entity_type, {field_key: json.dumps(100)}, random_filament) + id2 = _create_entity(entity_type, {field_key: json.dumps(200)}, random_filament) + try: + # Exact match + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={f"extra.{field_key}": "100"}) + assert_httpx_success(result) + ids = {item["id"] for item in result.json()} + assert id1 in ids + assert id2 not in ids + + # Range: min only (>= 150 matches only id2=200) + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={f"extra.{field_key}": "150:"}) + assert_httpx_success(result) + ids = {item["id"] for item in result.json()} + assert id1 not in ids + assert id2 in ids + + # Range: max only (<= 150 matches only id1=100) + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={f"extra.{field_key}": ":150"}) + assert_httpx_success(result) + ids = {item["id"] for item in result.json()} + assert id1 in ids + assert id2 not in ids + + # Range: both bounds (50 <= x <= 150 matches only id1=100) + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={f"extra.{field_key}": "50:150"}) + assert_httpx_success(result) + ids = {item["id"] for item in result.json()} + assert id1 in ids + assert id2 not in ids + + # Sort ascending (100 before 200) + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={"sort": f"extra.{field_key}:asc"}) + assert_httpx_success(result) + ordered = [item for item in result.json() if item["id"] in (id1, id2)] + assert len(ordered) == 2 + assert ordered[0]["id"] == id1 + assert ordered[1]["id"] == id2 + + # Sort descending + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={"sort": f"extra.{field_key}:desc"}) + assert_httpx_success(result) + ordered = [item for item in result.json() if item["id"] in (id1, id2)] + assert len(ordered) == 2 + assert ordered[0]["id"] == id2 + assert ordered[1]["id"] == id1 + finally: + httpx.delete(f"{URL}/api/v1/field/{entity_type}/{field_key}").raise_for_status() + httpx.delete(f"{URL}/api/v1/{entity_type}/{id1}").raise_for_status() + httpx.delete(f"{URL}/api/v1/{entity_type}/{id2}").raise_for_status() + + +@pytest.mark.asyncio +@pytest.mark.parametrize("entity_type", ["spool", "filament", "vendor"]) +async def test_float_filter_and_sort(entity_type: str, random_filament: dict[str, Any]) -> None: + """Test filter and sort by a custom float field for all entity types.""" + field_key = "test_float_field" + httpx.post( + f"{URL}/api/v1/field/{entity_type}/{field_key}", + json={"name": "Float field", "field_type": "float"}, + ).raise_for_status() + id1 = _create_entity(entity_type, {field_key: json.dumps(1.5)}, random_filament) + id2 = _create_entity(entity_type, {field_key: json.dumps(2.5)}, random_filament) + try: + # Exact match + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={f"extra.{field_key}": "1.5"}) + assert_httpx_success(result) + ids = {item["id"] for item in result.json()} + assert id1 in ids + assert id2 not in ids + + # Range: min only (>= 2.0 matches only id2=2.5) + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={f"extra.{field_key}": "2.0:"}) + assert_httpx_success(result) + ids = {item["id"] for item in result.json()} + assert id1 not in ids + assert id2 in ids + + # Range: max only (<= 2.0 matches only id1=1.5) + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={f"extra.{field_key}": ":2.0"}) + assert_httpx_success(result) + ids = {item["id"] for item in result.json()} + assert id1 in ids + assert id2 not in ids + + # Range: both bounds (1.0 <= x <= 2.0 matches only id1=1.5) + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={f"extra.{field_key}": "1.0:2.0"}) + assert_httpx_success(result) + ids = {item["id"] for item in result.json()} + assert id1 in ids + assert id2 not in ids + + # Sort ascending (1.5 before 2.5) + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={"sort": f"extra.{field_key}:asc"}) + assert_httpx_success(result) + ordered = [item for item in result.json() if item["id"] in (id1, id2)] + assert len(ordered) == 2 + assert ordered[0]["id"] == id1 + assert ordered[1]["id"] == id2 + + # Sort descending + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={"sort": f"extra.{field_key}:desc"}) + assert_httpx_success(result) + ordered = [item for item in result.json() if item["id"] in (id1, id2)] + assert len(ordered) == 2 + assert ordered[0]["id"] == id2 + assert ordered[1]["id"] == id1 + finally: + httpx.delete(f"{URL}/api/v1/field/{entity_type}/{field_key}").raise_for_status() + httpx.delete(f"{URL}/api/v1/{entity_type}/{id1}").raise_for_status() + httpx.delete(f"{URL}/api/v1/{entity_type}/{id2}").raise_for_status() + + +@pytest.mark.asyncio +@pytest.mark.parametrize("entity_type", ["spool", "filament", "vendor"]) +async def test_integer_range_filter_and_sort(entity_type: str, random_filament: dict[str, Any]) -> None: + """Test filter and sort by a custom integer_range field for all entity types.""" + field_key = "test_int_range_field" + httpx.post( + f"{URL}/api/v1/field/{entity_type}/{field_key}", + json={"name": "Integer range field", "field_type": "integer_range"}, + ).raise_for_status() + # id1=[100,200], id2=[300,400] + id1 = _create_entity(entity_type, {field_key: json.dumps([100, 200])}, random_filament) + id2 = _create_entity(entity_type, {field_key: json.dumps([300, 400])}, random_filament) + try: + # Both bounds: stored_min>=100 AND stored_max<=200 matches only id1 + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={f"extra.{field_key}": "100:200"}) + assert_httpx_success(result) + ids = {item["id"] for item in result.json()} + assert id1 in ids + assert id2 not in ids + + # Min only: stored_min>=200 matches only id2 (300>=200; 100<200) + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={f"extra.{field_key}": "200:"}) + assert_httpx_success(result) + ids = {item["id"] for item in result.json()} + assert id1 not in ids + assert id2 in ids + + # Max only: stored_max<=300 matches only id1 (200<=300; 400>300) + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={f"extra.{field_key}": ":300"}) + assert_httpx_success(result) + ids = {item["id"] for item in result.json()} + assert id1 in ids + assert id2 not in ids + + # Sort ascending by stored_min (100 before 300) + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={"sort": f"extra.{field_key}:asc"}) + assert_httpx_success(result) + ordered = [item for item in result.json() if item["id"] in (id1, id2)] + assert len(ordered) == 2 + assert ordered[0]["id"] == id1 + assert ordered[1]["id"] == id2 + + # Sort descending + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={"sort": f"extra.{field_key}:desc"}) + assert_httpx_success(result) + ordered = [item for item in result.json() if item["id"] in (id1, id2)] + assert len(ordered) == 2 + assert ordered[0]["id"] == id2 + assert ordered[1]["id"] == id1 + finally: + httpx.delete(f"{URL}/api/v1/field/{entity_type}/{field_key}").raise_for_status() + httpx.delete(f"{URL}/api/v1/{entity_type}/{id1}").raise_for_status() + httpx.delete(f"{URL}/api/v1/{entity_type}/{id2}").raise_for_status() + + +@pytest.mark.asyncio +@pytest.mark.parametrize("entity_type", ["spool", "filament", "vendor"]) +async def test_float_range_filter_and_sort(entity_type: str, random_filament: dict[str, Any]) -> None: + """Test filter and sort by a custom float_range field for all entity types.""" + field_key = "test_float_range_field" + httpx.post( + f"{URL}/api/v1/field/{entity_type}/{field_key}", + json={"name": "Float range field", "field_type": "float_range"}, + ).raise_for_status() + # id1=[1.5,2.5], id2=[3.5,4.5] + id1 = _create_entity(entity_type, {field_key: json.dumps([1.5, 2.5])}, random_filament) + id2 = _create_entity(entity_type, {field_key: json.dumps([3.5, 4.5])}, random_filament) + try: + # Both bounds: stored_min>=1.5 AND stored_max<=2.5 matches only id1 + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={f"extra.{field_key}": "1.5:2.5"}) + assert_httpx_success(result) + ids = {item["id"] for item in result.json()} + assert id1 in ids + assert id2 not in ids + + # Min only: stored_min>=2.5 matches only id2 (3.5>=2.5; 1.5<2.5) + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={f"extra.{field_key}": "2.5:"}) + assert_httpx_success(result) + ids = {item["id"] for item in result.json()} + assert id1 not in ids + assert id2 in ids + + # Max only: stored_max<=3.5 matches only id1 (2.5<=3.5; 4.5>3.5) + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={f"extra.{field_key}": ":3.5"}) + assert_httpx_success(result) + ids = {item["id"] for item in result.json()} + assert id1 in ids + assert id2 not in ids + + # Sort ascending by stored_min (1.5 before 3.5) + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={"sort": f"extra.{field_key}:asc"}) + assert_httpx_success(result) + ordered = [item for item in result.json() if item["id"] in (id1, id2)] + assert len(ordered) == 2 + assert ordered[0]["id"] == id1 + assert ordered[1]["id"] == id2 + + # Sort descending + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={"sort": f"extra.{field_key}:desc"}) + assert_httpx_success(result) + ordered = [item for item in result.json() if item["id"] in (id1, id2)] + assert len(ordered) == 2 + assert ordered[0]["id"] == id2 + assert ordered[1]["id"] == id1 + finally: + httpx.delete(f"{URL}/api/v1/field/{entity_type}/{field_key}").raise_for_status() + httpx.delete(f"{URL}/api/v1/{entity_type}/{id1}").raise_for_status() + httpx.delete(f"{URL}/api/v1/{entity_type}/{id2}").raise_for_status() + + +# --------------------------------------------------------------------------- +# Date fields (all entity types) +# --------------------------------------------------------------------------- + + +@pytest.mark.asyncio +@pytest.mark.parametrize("entity_type", ["spool", "filament", "vendor"]) +async def test_datetime_filter_and_sort(entity_type: str, random_filament: dict[str, Any]) -> None: + """Test filter and sort by a custom datetime field for all entity types.""" + field_key = "test_dt_field" + httpx.post( + f"{URL}/api/v1/field/{entity_type}/{field_key}", + json={"name": "Datetime field", "field_type": "datetime"}, + ).raise_for_status() + dt_early = "2023-01-01T00:00:00" + dt_late = "2024-06-15T12:30:00" + id1 = _create_entity(entity_type, {field_key: json.dumps(dt_early)}, random_filament) + id2 = _create_entity(entity_type, {field_key: json.dumps(dt_late)}, random_filament) + try: + # Exact match: only id1 + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={f"extra.{field_key}": dt_early}) + assert_httpx_success(result) + ids = {item["id"] for item in result.json()} + assert id1 in ids + assert id2 not in ids + + # Range: start only (>= 2023-06-01 matches only id2=2024-06-15) + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={f"extra.{field_key}": "2023-06-01T00:00:00|"}) + assert_httpx_success(result) + ids = {item["id"] for item in result.json()} + assert id1 not in ids + assert id2 in ids + + # Range: end only (<= 2023-06-01 matches only id1=2023-01-01) + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={f"extra.{field_key}": "|2023-06-01T00:00:00"}) + assert_httpx_success(result) + ids = {item["id"] for item in result.json()} + assert id1 in ids + assert id2 not in ids + + # Range: both bounds (2022-01-01 to 2023-06-01 matches only id1) + result = httpx.get( + f"{URL}/api/v1/{entity_type}", + params={f"extra.{field_key}": "2022-01-01T00:00:00|2023-06-01T00:00:00"}, + ) + assert_httpx_success(result) + ids = {item["id"] for item in result.json()} + assert id1 in ids + assert id2 not in ids + + # Sort ascending (early before late) + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={"sort": f"extra.{field_key}:asc"}) + assert_httpx_success(result) + ordered = [item for item in result.json() if item["id"] in (id1, id2)] + assert len(ordered) == 2 + assert ordered[0]["id"] == id1 + assert ordered[1]["id"] == id2 + + # Sort descending + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={"sort": f"extra.{field_key}:desc"}) + assert_httpx_success(result) + ordered = [item for item in result.json() if item["id"] in (id1, id2)] + assert len(ordered) == 2 + assert ordered[0]["id"] == id2 + assert ordered[1]["id"] == id1 + finally: + httpx.delete(f"{URL}/api/v1/field/{entity_type}/{field_key}").raise_for_status() + httpx.delete(f"{URL}/api/v1/{entity_type}/{id1}").raise_for_status() + httpx.delete(f"{URL}/api/v1/{entity_type}/{id2}").raise_for_status() + + +# --------------------------------------------------------------------------- +# Text / boolean / choice / empty (all entity types) +# --------------------------------------------------------------------------- + + +@pytest.mark.asyncio +@pytest.mark.parametrize("entity_type", ["spool", "filament", "vendor"]) +async def test_text_filter_and_sort(entity_type: str, random_filament: dict[str, Any]) -> None: + """Test filter and sort by a custom text field for all entity types.""" + field_key = "test_text_field" + httpx.post( + f"{URL}/api/v1/field/{entity_type}/{field_key}", + json={"name": "Text field", "field_type": "text"}, + ).raise_for_status() + # id1="beta", id2="alpha" so ascending order is id2 before id1 + id1 = _create_entity(entity_type, {field_key: json.dumps("beta")}, random_filament) + id2 = _create_entity(entity_type, {field_key: json.dumps("alpha")}, random_filament) + try: + # Substring filter: "beta" matches only id1 + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={f"extra.{field_key}": "beta"}) + assert_httpx_success(result) + ids = {item["id"] for item in result.json()} + assert id1 in ids + assert id2 not in ids + + # Exact-match filter (double-quoted) + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={f"extra.{field_key}": '"beta"'}) + assert_httpx_success(result) + ids = {item["id"] for item in result.json()} + assert id1 in ids + assert id2 not in ids + + # Multi-value OR: both + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={f"extra.{field_key}": "beta,alpha"}) + assert_httpx_success(result) + ids = {item["id"] for item in result.json()} + assert id1 in ids + assert id2 in ids + + # Sort ascending: alpha before beta + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={"sort": f"extra.{field_key}:asc"}) + assert_httpx_success(result) + ordered = [item for item in result.json() if item["id"] in (id1, id2)] + assert len(ordered) == 2 + assert ordered[0]["id"] == id2 # alpha first + assert ordered[1]["id"] == id1 # beta second + + # Sort descending + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={"sort": f"extra.{field_key}:desc"}) + assert_httpx_success(result) + ordered = [item for item in result.json() if item["id"] in (id1, id2)] + assert len(ordered) == 2 + assert ordered[0]["id"] == id1 # beta first + assert ordered[1]["id"] == id2 # alpha second + finally: + httpx.delete(f"{URL}/api/v1/field/{entity_type}/{field_key}").raise_for_status() + httpx.delete(f"{URL}/api/v1/{entity_type}/{id1}").raise_for_status() + httpx.delete(f"{URL}/api/v1/{entity_type}/{id2}").raise_for_status() + + +@pytest.mark.asyncio +@pytest.mark.parametrize("entity_type", ["spool", "filament", "vendor"]) +async def test_boolean_filter_and_sort(entity_type: str, random_filament: dict[str, Any]) -> None: + """Test filter and sort by a custom boolean field for all entity types.""" + field_key = "test_bool_field" + httpx.post( + f"{URL}/api/v1/field/{entity_type}/{field_key}", + json={"name": "Boolean field", "field_type": "boolean"}, + ).raise_for_status() + id_true = _create_entity(entity_type, {field_key: json.dumps(bool(1))}, random_filament) + id_false = _create_entity(entity_type, {field_key: json.dumps(bool(0))}, random_filament) + try: + # Filter true + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={f"extra.{field_key}": "true"}) + assert_httpx_success(result) + ids = {item["id"] for item in result.json()} + assert id_true in ids + assert id_false not in ids + + # Filter false + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={f"extra.{field_key}": "false"}) + assert_httpx_success(result) + ids = {item["id"] for item in result.json()} + assert id_false in ids + assert id_true not in ids + + # Sort ascending: false before true + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={"sort": f"extra.{field_key}:asc"}) + assert_httpx_success(result) + ordered = [item for item in result.json() if item["id"] in (id_true, id_false)] + assert len(ordered) == 2 + assert ordered[0]["id"] == id_false + assert ordered[1]["id"] == id_true + + # Sort descending: true before false + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={"sort": f"extra.{field_key}:desc"}) + assert_httpx_success(result) + ordered = [item for item in result.json() if item["id"] in (id_true, id_false)] + assert len(ordered) == 2 + assert ordered[0]["id"] == id_true + assert ordered[1]["id"] == id_false + finally: + httpx.delete(f"{URL}/api/v1/field/{entity_type}/{field_key}").raise_for_status() + httpx.delete(f"{URL}/api/v1/{entity_type}/{id_true}").raise_for_status() + httpx.delete(f"{URL}/api/v1/{entity_type}/{id_false}").raise_for_status() + + +@pytest.mark.asyncio +@pytest.mark.parametrize("entity_type", ["spool", "filament", "vendor"]) +async def test_single_choice_filter_and_sort(entity_type: str, random_filament: dict[str, Any]) -> None: + """Test filter and sort by a single-choice custom field for all entity types.""" + field_key = "test_choice_field" + httpx.post( + f"{URL}/api/v1/field/{entity_type}/{field_key}", + json={ + "name": "Choice field", + "field_type": "choice", + "choices": ["OptionA", "OptionB"], + "multi_choice": False, + }, + ).raise_for_status() + id1 = _create_entity(entity_type, {field_key: json.dumps("OptionA")}, random_filament) + id2 = _create_entity(entity_type, {field_key: json.dumps("OptionB")}, random_filament) + try: + # Single value: only id1 + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={f"extra.{field_key}": "OptionA"}) + assert_httpx_success(result) + ids = {item["id"] for item in result.json()} + assert id1 in ids + assert id2 not in ids + + # Multi-value OR: both + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={f"extra.{field_key}": "OptionA,OptionB"}) + assert_httpx_success(result) + ids = {item["id"] for item in result.json()} + assert id1 in ids + assert id2 in ids + + # Sort ascending: OptionA before OptionB + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={"sort": f"extra.{field_key}:asc"}) + assert_httpx_success(result) + ordered = [item for item in result.json() if item["id"] in (id1, id2)] + assert len(ordered) == 2 + assert ordered[0]["id"] == id1 # OptionA first + assert ordered[1]["id"] == id2 # OptionB second + + # Sort descending + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={"sort": f"extra.{field_key}:desc"}) + assert_httpx_success(result) + ordered = [item for item in result.json() if item["id"] in (id1, id2)] + assert len(ordered) == 2 + assert ordered[0]["id"] == id2 # OptionB first + assert ordered[1]["id"] == id1 # OptionA second + finally: + httpx.delete(f"{URL}/api/v1/field/{entity_type}/{field_key}").raise_for_status() + httpx.delete(f"{URL}/api/v1/{entity_type}/{id1}").raise_for_status() + httpx.delete(f"{URL}/api/v1/{entity_type}/{id2}").raise_for_status() + + +@pytest.mark.asyncio +@pytest.mark.parametrize("entity_type", ["spool", "filament", "vendor"]) +async def test_multi_choice_filter(entity_type: str, random_filament: dict[str, Any]) -> None: + """Test filter by a multi-choice custom field for all entity types.""" + field_key = "test_multi_field" + httpx.post( + f"{URL}/api/v1/field/{entity_type}/{field_key}", + json={ + "name": "Multi-choice field", + "field_type": "choice", + "choices": ["A", "B", "C"], + "multi_choice": True, + }, + ).raise_for_status() + # id1 has [A, B], id2 has [C] + id1 = _create_entity(entity_type, {field_key: json.dumps(["A", "B"])}, random_filament) + id2 = _create_entity(entity_type, {field_key: json.dumps(["C"])}, random_filament) + try: + # Filter by A: only id1 + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={f"extra.{field_key}": "A"}) + assert_httpx_success(result) + ids = {item["id"] for item in result.json()} + assert id1 in ids + assert id2 not in ids + + # Filter by C: only id2 + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={f"extra.{field_key}": "C"}) + assert_httpx_success(result) + ids = {item["id"] for item in result.json()} + assert id2 in ids + assert id1 not in ids + + # Multi-value OR (A,C): both + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={f"extra.{field_key}": "A,C"}) + assert_httpx_success(result) + ids = {item["id"] for item in result.json()} + assert id1 in ids + assert id2 in ids + finally: + httpx.delete(f"{URL}/api/v1/field/{entity_type}/{field_key}").raise_for_status() + httpx.delete(f"{URL}/api/v1/{entity_type}/{id1}").raise_for_status() + httpx.delete(f"{URL}/api/v1/{entity_type}/{id2}").raise_for_status() + + +@pytest.mark.asyncio +@pytest.mark.parametrize("entity_type", ["spool", "filament", "vendor"]) +async def test_empty_filter(entity_type: str, random_filament: dict[str, Any]) -> None: + """Test the empty-string filter returns only items with no value set for a custom field.""" + field_key = "test_optional_field" + httpx.post( + f"{URL}/api/v1/field/{entity_type}/{field_key}", + json={"name": "Optional field", "field_type": "text"}, + ).raise_for_status() + id1 = _create_entity(entity_type, {field_key: json.dumps("has_value")}, random_filament) + id2 = _create_entity(entity_type, {}, random_filament) + try: + # Empty filter: only id2 (field not set) + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={f"extra.{field_key}": ""}) + assert_httpx_success(result) + ids = {item["id"] for item in result.json()} + assert id2 in ids + assert id1 not in ids + + # Value filter: only id1 + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={f"extra.{field_key}": "has_value"}) + assert_httpx_success(result) + ids = {item["id"] for item in result.json()} + assert id1 in ids + assert id2 not in ids + finally: + httpx.delete(f"{URL}/api/v1/field/{entity_type}/{field_key}").raise_for_status() + httpx.delete(f"{URL}/api/v1/{entity_type}/{id1}").raise_for_status() + httpx.delete(f"{URL}/api/v1/{entity_type}/{id2}").raise_for_status() + + +# --------------------------------------------------------------------------- +# Invalid filter values → 400 (all entity types) +# --------------------------------------------------------------------------- + + +@pytest.mark.asyncio +@pytest.mark.parametrize("entity_type", ["spool", "filament", "vendor"]) +async def test_invalid_integer_filter_returns_400(entity_type: str) -> None: + """Invalid integer custom-field filters should fail with a 400 error.""" + field_key = "int_field_400" + httpx.post( + f"{URL}/api/v1/field/{entity_type}/{field_key}", + json={"name": "Integer 400", "field_type": "integer"}, + ).raise_for_status() + try: + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={f"extra.{field_key}": "abc"}) + assert result.status_code == 400 + assert "Invalid integer filter value" in result.json()["message"] + finally: + httpx.delete(f"{URL}/api/v1/field/{entity_type}/{field_key}").raise_for_status() + + +@pytest.mark.asyncio +@pytest.mark.parametrize("entity_type", ["spool", "filament", "vendor"]) +async def test_invalid_boolean_filter_returns_400(entity_type: str) -> None: + """Invalid boolean custom-field filters should fail with a 400 error.""" + field_key = "bool_field_400" + httpx.post( + f"{URL}/api/v1/field/{entity_type}/{field_key}", + json={"name": "Boolean 400", "field_type": "boolean"}, + ).raise_for_status() + try: + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={f"extra.{field_key}": "maybe"}) + assert result.status_code == 400 + assert "Invalid boolean filter value" in result.json()["message"] + + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={f"extra.{field_key}": "yes"}) + assert result.status_code == 400 + assert "Invalid boolean filter value" in result.json()["message"] + finally: + httpx.delete(f"{URL}/api/v1/field/{entity_type}/{field_key}").raise_for_status() + + +@pytest.mark.asyncio +@pytest.mark.parametrize("entity_type", ["spool", "filament", "vendor"]) +async def test_invalid_float_filter_returns_400(entity_type: str) -> None: + """Invalid float custom-field filters should fail with a 400 error.""" + field_key = "float_field_400" + httpx.post( + f"{URL}/api/v1/field/{entity_type}/{field_key}", + json={"name": "Float 400", "field_type": "float"}, + ).raise_for_status() + try: + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={f"extra.{field_key}": "notafloat"}) + assert result.status_code == 400 + assert "Invalid float filter value" in result.json()["message"] + finally: + httpx.delete(f"{URL}/api/v1/field/{entity_type}/{field_key}").raise_for_status() + + +@pytest.mark.asyncio +@pytest.mark.parametrize("entity_type", ["spool", "filament", "vendor"]) +async def test_invalid_integer_range_filter_returns_400(entity_type: str) -> None: + """Invalid integer_range custom-field filters should fail with a 400 error.""" + field_key = "int_range_400" + httpx.post( + f"{URL}/api/v1/field/{entity_type}/{field_key}", + json={"name": "Integer range 400", "field_type": "integer_range"}, + ).raise_for_status() + try: + # Missing colon separator + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={f"extra.{field_key}": "100"}) + assert result.status_code == 400 + assert "Invalid range filter value" in result.json()["message"] + + # Non-numeric min value + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={f"extra.{field_key}": "abc:200"}) + assert result.status_code == 400 + assert "range filter value" in result.json()["message"] + finally: + httpx.delete(f"{URL}/api/v1/field/{entity_type}/{field_key}").raise_for_status() + + +@pytest.mark.asyncio +@pytest.mark.parametrize("entity_type", ["spool", "filament", "vendor"]) +async def test_invalid_float_range_filter_returns_400(entity_type: str) -> None: + """Invalid float_range custom-field filters should fail with a 400 error.""" + field_key = "float_range_400" + httpx.post( + f"{URL}/api/v1/field/{entity_type}/{field_key}", + json={"name": "Float range 400", "field_type": "float_range"}, + ).raise_for_status() + try: + # Missing colon separator + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={f"extra.{field_key}": "1.5"}) + assert result.status_code == 400 + assert "Invalid range filter value" in result.json()["message"] + + # Non-numeric min value + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={f"extra.{field_key}": "notanum:2.5"}) + assert result.status_code == 400 + assert "range filter value" in result.json()["message"] + finally: + httpx.delete(f"{URL}/api/v1/field/{entity_type}/{field_key}").raise_for_status() + + +# --------------------------------------------------------------------------- +# Filter composition - multiple extra fields, extra + built-in, filter + sort +# --------------------------------------------------------------------------- + + +@pytest.mark.asyncio +@pytest.mark.parametrize("entity_type", ["spool", "filament", "vendor"]) +async def test_multiple_extra_field_filters_are_anded(entity_type: str, random_filament: dict[str, Any]) -> None: + """Filtering on two custom fields at once should AND the conditions together.""" + text_key = "combo_text_field" + int_key = "combo_int_field" + httpx.post( + f"{URL}/api/v1/field/{entity_type}/{text_key}", + json={"name": "Combo text", "field_type": "text"}, + ).raise_for_status() + httpx.post( + f"{URL}/api/v1/field/{entity_type}/{int_key}", + json={"name": "Combo int", "field_type": "integer"}, + ).raise_for_status() + # id_match satisfies both; the others satisfy only one each. + id_match = _create_entity(entity_type, {text_key: json.dumps("alpha"), int_key: json.dumps(5)}, random_filament) + id_text_only = _create_entity( + entity_type, {text_key: json.dumps("alpha"), int_key: json.dumps(99)}, random_filament + ) + id_int_only = _create_entity(entity_type, {text_key: json.dumps("beta"), int_key: json.dumps(5)}, random_filament) + try: + result = httpx.get( + f"{URL}/api/v1/{entity_type}", + params={f"extra.{text_key}": '"alpha"', f"extra.{int_key}": "5"}, + ) + assert_httpx_success(result) + ids = {item["id"] for item in result.json()} + assert id_match in ids + assert id_text_only not in ids + assert id_int_only not in ids + finally: + httpx.delete(f"{URL}/api/v1/field/{entity_type}/{text_key}").raise_for_status() + httpx.delete(f"{URL}/api/v1/field/{entity_type}/{int_key}").raise_for_status() + for eid in (id_match, id_text_only, id_int_only): + httpx.delete(f"{URL}/api/v1/{entity_type}/{eid}").raise_for_status() + + +@pytest.mark.asyncio +async def test_extra_filter_combined_with_builtin_filter(random_filament: dict[str, Any]) -> None: + """An extra-field filter should compose (AND) with a built-in filter (filament.material).""" + field_key = "builtin_combo_field" + httpx.post( + f"{URL}/api/v1/field/filament/{field_key}", + json={"name": "Builtin combo", "field_type": "text"}, + ).raise_for_status() + vendor_id = random_filament["vendor"]["id"] + + def _make_filament(material: str, extra_value: str) -> int: + result = httpx.post( + f"{URL}/api/v1/filament", + json={ + "vendor_id": vendor_id, + "name": f"Test-{uuid.uuid4().hex[:8]}", + "material": material, + "density": 1.24, + "diameter": 1.75, + "extra": {field_key: json.dumps(extra_value)}, + }, + ) + result.raise_for_status() + return result.json()["id"] + + mat = f"PLA-{uuid.uuid4().hex[:8]}" + id_match = _make_filament(mat, "wanted") + id_wrong_material = _make_filament("PETG", "wanted") + id_wrong_extra = _make_filament(mat, "other") + try: + result = httpx.get( + f"{URL}/api/v1/filament", + params={"material": mat, f"extra.{field_key}": '"wanted"'}, + ) + assert_httpx_success(result) + ids = {item["id"] for item in result.json()} + assert id_match in ids + assert id_wrong_material not in ids + assert id_wrong_extra not in ids + finally: + httpx.delete(f"{URL}/api/v1/field/filament/{field_key}").raise_for_status() + for fid in (id_match, id_wrong_material, id_wrong_extra): + httpx.delete(f"{URL}/api/v1/filament/{fid}").raise_for_status() + + +@pytest.mark.asyncio +@pytest.mark.parametrize("entity_type", ["spool", "filament", "vendor"]) +async def test_filter_on_one_field_sort_on_another(entity_type: str, random_filament: dict[str, Any]) -> None: + """Filter on one custom field while sorting on a different custom field.""" + filter_key = "fs_filter_field" + sort_key = "fs_sort_field" + httpx.post( + f"{URL}/api/v1/field/{entity_type}/{filter_key}", + json={"name": "FS filter", "field_type": "text"}, + ).raise_for_status() + httpx.post( + f"{URL}/api/v1/field/{entity_type}/{sort_key}", + json={"name": "FS sort", "field_type": "integer"}, + ).raise_for_status() + # Both included have group="g"; sort by number should put id_low before id_high. + id_high = _create_entity(entity_type, {filter_key: json.dumps("g"), sort_key: json.dumps(20)}, random_filament) + id_low = _create_entity(entity_type, {filter_key: json.dumps("g"), sort_key: json.dumps(10)}, random_filament) + id_other = _create_entity(entity_type, {filter_key: json.dumps("h"), sort_key: json.dumps(1)}, random_filament) + try: + result = httpx.get( + f"{URL}/api/v1/{entity_type}", + params={f"extra.{filter_key}": '"g"', "sort": f"extra.{sort_key}:asc"}, + ) + assert_httpx_success(result) + ordered = [item["id"] for item in result.json() if item["id"] in (id_high, id_low, id_other)] + assert ordered == [id_low, id_high] + assert id_other not in ordered + finally: + httpx.delete(f"{URL}/api/v1/field/{entity_type}/{filter_key}").raise_for_status() + httpx.delete(f"{URL}/api/v1/field/{entity_type}/{sort_key}").raise_for_status() + for eid in (id_high, id_low, id_other): + httpx.delete(f"{URL}/api/v1/{entity_type}/{eid}").raise_for_status() + + +@pytest.mark.asyncio +@pytest.mark.parametrize("entity_type", ["spool", "filament", "vendor"]) +async def test_pagination_total_count_with_extra_filter(entity_type: str, random_filament: dict[str, Any]) -> None: + """x-total-count reflects the filtered set, and limit/offset page within it.""" + field_key = "paginate_field" + unique = uuid.uuid4().hex[:8] + httpx.post( + f"{URL}/api/v1/field/{entity_type}/{field_key}", + json={"name": "Paginate", "field_type": "text"}, + ).raise_for_status() + # Three entities share a unique value so only these three match the filter. + ids = [_create_entity(entity_type, {field_key: json.dumps(unique)}, random_filament) for _ in range(3)] + try: + result = httpx.get( + f"{URL}/api/v1/{entity_type}", + params={f"extra.{field_key}": f'"{unique}"', "limit": 2, "offset": 0}, + ) + assert_httpx_success(result) + assert result.headers["x-total-count"] == "3" + assert len(result.json()) == 2 + + # Second page returns the remaining item. + result = httpx.get( + f"{URL}/api/v1/{entity_type}", + params={f"extra.{field_key}": f'"{unique}"', "limit": 2, "offset": 2}, + ) + assert_httpx_success(result) + assert result.headers["x-total-count"] == "3" + assert len(result.json()) == 1 + finally: + httpx.delete(f"{URL}/api/v1/field/{entity_type}/{field_key}").raise_for_status() + for eid in ids: + httpx.delete(f"{URL}/api/v1/{entity_type}/{eid}").raise_for_status() + + +@pytest.mark.asyncio +@pytest.mark.parametrize("entity_type", ["spool", "filament", "vendor"]) +async def test_unknown_extra_field_key_is_ignored(entity_type: str, random_filament: dict[str, Any]) -> None: + """Filtering/sorting on an undefined custom field is ignored, not a 400.""" + id1 = _create_entity(entity_type, {}, random_filament) + try: + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={"extra.does_not_exist": "whatever"}) + assert_httpx_success(result) + ids = {item["id"] for item in result.json()} + assert id1 in ids # filter ignored -> entity still returned + + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={"sort": "extra.does_not_exist:asc"}) + assert_httpx_success(result) + finally: + httpx.delete(f"{URL}/api/v1/{entity_type}/{id1}").raise_for_status() + + +# --------------------------------------------------------------------------- +# Text field edge cases - case-insensitivity, substring, non-ASCII +# --------------------------------------------------------------------------- + + +@pytest.mark.asyncio +@pytest.mark.parametrize("entity_type", ["spool", "filament", "vendor"]) +async def test_text_filter_case_insensitive_and_partial(entity_type: str, random_filament: dict[str, Any]) -> None: + """Text substring filtering is case-insensitive and matches partial substrings.""" + field_key = "ci_text_field" + httpx.post( + f"{URL}/api/v1/field/{entity_type}/{field_key}", + json={"name": "CI text", "field_type": "text"}, + ).raise_for_status() + id1 = _create_entity(entity_type, {field_key: json.dumps("HelloWorld")}, random_filament) + try: + # Partial + lowercase substring of a mixed-case value. + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={f"extra.{field_key}": "elloworl"}) + assert_httpx_success(result) + assert id1 in {item["id"] for item in result.json()} + + # Fully uppercased query still matches (ilike). + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={f"extra.{field_key}": "HELLOWORLD"}) + assert_httpx_success(result) + assert id1 in {item["id"] for item in result.json()} + finally: + httpx.delete(f"{URL}/api/v1/field/{entity_type}/{field_key}").raise_for_status() + httpx.delete(f"{URL}/api/v1/{entity_type}/{id1}").raise_for_status() + + +@pytest.mark.asyncio +@pytest.mark.parametrize("entity_type", ["spool", "filament", "vendor"]) +async def test_text_filter_non_ascii(entity_type: str, random_filament: dict[str, Any]) -> None: + """Text filtering works with non-ASCII values (encoding canary).""" + field_key = "unicode_text_field" + httpx.post( + f"{URL}/api/v1/field/{entity_type}/{field_key}", + json={"name": "Unicode text", "field_type": "text"}, + ).raise_for_status() + # Store the value unescaped, the way the JS frontend's JSON.stringify does (not Python's + # default ensure_ascii=True, which would persist literal \uXXXX escapes). + id1 = _create_entity(entity_type, {field_key: json.dumps("Café åäö 日本", ensure_ascii=False)}, random_filament) + id2 = _create_entity(entity_type, {field_key: json.dumps("Grün", ensure_ascii=False)}, random_filament) + try: + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={f"extra.{field_key}": "åäö"}) + assert_httpx_success(result) + ids = {item["id"] for item in result.json()} + assert id1 in ids + assert id2 not in ids + + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={f"extra.{field_key}": "日本"}) + assert_httpx_success(result) + assert id1 in {item["id"] for item in result.json()} + + # Exact match (double-quoted) on a non-ASCII value. + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={f"extra.{field_key}": '"Café åäö 日本"'}) + assert_httpx_success(result) + ids = {item["id"] for item in result.json()} + assert id1 in ids + assert id2 not in ids + finally: + httpx.delete(f"{URL}/api/v1/field/{entity_type}/{field_key}").raise_for_status() + httpx.delete(f"{URL}/api/v1/{entity_type}/{id1}").raise_for_status() + httpx.delete(f"{URL}/api/v1/{entity_type}/{id2}").raise_for_status() + + +@pytest.mark.asyncio +@pytest.mark.parametrize("entity_type", ["spool", "filament", "vendor"]) +async def test_single_choice_filter_non_ascii(entity_type: str, random_filament: dict[str, Any]) -> None: + """Single-choice equality works with non-ASCII choice labels (frontend-stored unescaped).""" + field_key = "unicode_choice_field" + httpx.post( + f"{URL}/api/v1/field/{entity_type}/{field_key}", + json={ + "name": "Unicode choice", + "field_type": "choice", + "choices": ["Röd", "Blå"], + "multi_choice": False, + }, + ).raise_for_status() + id_rod = _create_entity(entity_type, {field_key: json.dumps("Röd", ensure_ascii=False)}, random_filament) + id_bla = _create_entity(entity_type, {field_key: json.dumps("Blå", ensure_ascii=False)}, random_filament) + try: + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={f"extra.{field_key}": "Röd"}) + assert_httpx_success(result) + ids = {item["id"] for item in result.json()} + assert id_rod in ids + assert id_bla not in ids + finally: + httpx.delete(f"{URL}/api/v1/field/{entity_type}/{field_key}").raise_for_status() + httpx.delete(f"{URL}/api/v1/{entity_type}/{id_rod}").raise_for_status() + httpx.delete(f"{URL}/api/v1/{entity_type}/{id_bla}").raise_for_status() + + +# --------------------------------------------------------------------------- +# Numeric / boolean / choice edge cases +# --------------------------------------------------------------------------- + + +@pytest.mark.asyncio +@pytest.mark.parametrize("entity_type", ["spool", "filament", "vendor"]) +async def test_integer_multi_value_or(entity_type: str, random_filament: dict[str, Any]) -> None: + """A comma-separated integer filter matches any of the listed exact values (OR).""" + field_key = "int_or_field" + httpx.post( + f"{URL}/api/v1/field/{entity_type}/{field_key}", + json={"name": "Int OR", "field_type": "integer"}, + ).raise_for_status() + id100 = _create_entity(entity_type, {field_key: json.dumps(100)}, random_filament) + id200 = _create_entity(entity_type, {field_key: json.dumps(200)}, random_filament) + id300 = _create_entity(entity_type, {field_key: json.dumps(300)}, random_filament) + try: + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={f"extra.{field_key}": "100,300"}) + assert_httpx_success(result) + ids = {item["id"] for item in result.json()} + assert id100 in ids + assert id300 in ids + assert id200 not in ids + finally: + httpx.delete(f"{URL}/api/v1/field/{entity_type}/{field_key}").raise_for_status() + for eid in (id100, id200, id300): + httpx.delete(f"{URL}/api/v1/{entity_type}/{eid}").raise_for_status() + + +@pytest.mark.asyncio +@pytest.mark.parametrize("entity_type", ["spool", "filament", "vendor"]) +async def test_float_exact_match_against_int_typed_storage(entity_type: str, random_filament: dict[str, Any]) -> None: + """A float field stored as an integer JSON value still matches an equivalent float filter.""" + field_key = "float_intstore_field" + httpx.post( + f"{URL}/api/v1/field/{entity_type}/{field_key}", + json={"name": "Float intstore", "field_type": "float"}, + ).raise_for_status() + # json.dumps(2) -> "2" (no decimal); json.dumps(3) -> "3". + id2 = _create_entity(entity_type, {field_key: json.dumps(2)}, random_filament) + id3 = _create_entity(entity_type, {field_key: json.dumps(3)}, random_filament) + try: + for query in ("2.0", "2", "2.00"): + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={f"extra.{field_key}": query}) + assert_httpx_success(result) + ids = {item["id"] for item in result.json()} + assert id2 in ids, f"expected match for filter {query!r}" + assert id3 not in ids + finally: + httpx.delete(f"{URL}/api/v1/field/{entity_type}/{field_key}").raise_for_status() + httpx.delete(f"{URL}/api/v1/{entity_type}/{id2}").raise_for_status() + httpx.delete(f"{URL}/api/v1/{entity_type}/{id3}").raise_for_status() + + +@pytest.mark.asyncio +@pytest.mark.parametrize("entity_type", ["spool", "filament", "vendor"]) +async def test_boolean_empty_filter_matches_false_and_unset(entity_type: str, random_filament: dict[str, Any]) -> None: + """The empty filter on a boolean field returns entities that are false or have no value set.""" + field_key = "bool_empty_field" + httpx.post( + f"{URL}/api/v1/field/{entity_type}/{field_key}", + json={"name": "Bool empty", "field_type": "boolean"}, + ).raise_for_status() + id_true = _create_entity(entity_type, {field_key: json.dumps(bool(1))}, random_filament) + id_false = _create_entity(entity_type, {field_key: json.dumps(bool(0))}, random_filament) + id_unset = _create_entity(entity_type, {}, random_filament) + try: + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={f"extra.{field_key}": ""}) + assert_httpx_success(result) + ids = {item["id"] for item in result.json()} + assert id_false in ids + assert id_unset in ids + assert id_true not in ids + finally: + httpx.delete(f"{URL}/api/v1/field/{entity_type}/{field_key}").raise_for_status() + for eid in (id_true, id_false, id_unset): + httpx.delete(f"{URL}/api/v1/{entity_type}/{eid}").raise_for_status() + + +@pytest.mark.asyncio +@pytest.mark.parametrize("entity_type", ["spool", "filament", "vendor"]) +async def test_boolean_rejects_numeric_tokens(entity_type: str) -> None: + """Boolean filters only accept true/false; 1/0 are rejected with 400.""" + field_key = "bool_token_field" + httpx.post( + f"{URL}/api/v1/field/{entity_type}/{field_key}", + json={"name": "Bool token", "field_type": "boolean"}, + ).raise_for_status() + try: + for token in ("1", "0"): + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={f"extra.{field_key}": token}) + assert result.status_code == 400 + assert "Invalid boolean filter value" in result.json()["message"] + finally: + httpx.delete(f"{URL}/api/v1/field/{entity_type}/{field_key}").raise_for_status() + + +@pytest.mark.asyncio +@pytest.mark.parametrize("entity_type", ["spool", "filament", "vendor"]) +async def test_multi_choice_no_substring_collision(entity_type: str, random_filament: dict[str, Any]) -> None: + """Multi-choice filtering matches whole tokens, not substrings of longer choices.""" + field_key = "multi_collision_field" + httpx.post( + f"{URL}/api/v1/field/{entity_type}/{field_key}", + json={ + "name": "Multi collision", + "field_type": "choice", + "choices": ["Red", "Reddish"], + "multi_choice": True, + }, + ).raise_for_status() + id_red = _create_entity(entity_type, {field_key: json.dumps(["Red"])}, random_filament) + id_reddish = _create_entity(entity_type, {field_key: json.dumps(["Reddish"])}, random_filament) + try: + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={f"extra.{field_key}": "Red"}) + assert_httpx_success(result) + ids = {item["id"] for item in result.json()} + assert id_red in ids + assert id_reddish not in ids + finally: + httpx.delete(f"{URL}/api/v1/field/{entity_type}/{field_key}").raise_for_status() + httpx.delete(f"{URL}/api/v1/{entity_type}/{id_red}").raise_for_status() + httpx.delete(f"{URL}/api/v1/{entity_type}/{id_reddish}").raise_for_status() + + +# --------------------------------------------------------------------------- +# Empty / null bounds and additional invalid-value paths +# --------------------------------------------------------------------------- + + +@pytest.mark.asyncio +@pytest.mark.parametrize("entity_type", ["spool", "filament", "vendor"]) +async def test_empty_filter_on_integer_field(entity_type: str, random_filament: dict[str, Any]) -> None: + """The empty filter on a non-text (integer) field returns only entities with no value set.""" + field_key = "int_empty_field" + httpx.post( + f"{URL}/api/v1/field/{entity_type}/{field_key}", + json={"name": "Int empty", "field_type": "integer"}, + ).raise_for_status() + id_set = _create_entity(entity_type, {field_key: json.dumps(42)}, random_filament) + id_unset = _create_entity(entity_type, {}, random_filament) + try: + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={f"extra.{field_key}": ""}) + assert_httpx_success(result) + ids = {item["id"] for item in result.json()} + assert id_unset in ids + assert id_set not in ids + finally: + httpx.delete(f"{URL}/api/v1/field/{entity_type}/{field_key}").raise_for_status() + httpx.delete(f"{URL}/api/v1/{entity_type}/{id_set}").raise_for_status() + httpx.delete(f"{URL}/api/v1/{entity_type}/{id_unset}").raise_for_status() + + +@pytest.mark.asyncio +@pytest.mark.parametrize("entity_type", ["spool", "filament", "vendor"]) +async def test_range_field_with_null_bound(entity_type: str, random_filament: dict[str, Any]) -> None: + """Range fields with a null bound filter on their concrete bound and are excluded on the null side.""" + field_key = "null_range_field" + httpx.post( + f"{URL}/api/v1/field/{entity_type}/{field_key}", + json={"name": "Null range", "field_type": "integer_range"}, + ).raise_for_status() + id_open_low = _create_entity(entity_type, {field_key: json.dumps([None, 200])}, random_filament) + id_bounded = _create_entity(entity_type, {field_key: json.dumps([100, 300])}, random_filament) + try: + # Max-only filter uses the concrete second element: [null,200] passes (<=250), [100,300] fails. + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={f"extra.{field_key}": ":250"}) + assert_httpx_success(result) + ids = {item["id"] for item in result.json()} + assert id_open_low in ids + assert id_bounded not in ids + + # Min-only filter compares the null first element: [null,200] is excluded, [100,300] passes. + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={f"extra.{field_key}": "50:"}) + assert_httpx_success(result) + ids = {item["id"] for item in result.json()} + assert id_bounded in ids + assert id_open_low not in ids + finally: + httpx.delete(f"{URL}/api/v1/field/{entity_type}/{field_key}").raise_for_status() + httpx.delete(f"{URL}/api/v1/{entity_type}/{id_open_low}").raise_for_status() + httpx.delete(f"{URL}/api/v1/{entity_type}/{id_bounded}").raise_for_status() + + +@pytest.mark.asyncio +@pytest.mark.parametrize("entity_type", ["spool", "filament", "vendor"]) +async def test_empty_both_sides_range_returns_400(entity_type: str) -> None: + """A range/datetime filter with both bounds empty is rejected with a 400.""" + int_range_key = "empty_range_400" + dt_key = "empty_dt_400" + int_key = "empty_intrange_400" + httpx.post( + f"{URL}/api/v1/field/{entity_type}/{int_range_key}", + json={"name": "Empty range", "field_type": "integer_range"}, + ).raise_for_status() + httpx.post( + f"{URL}/api/v1/field/{entity_type}/{dt_key}", + json={"name": "Empty dt", "field_type": "datetime"}, + ).raise_for_status() + httpx.post( + f"{URL}/api/v1/field/{entity_type}/{int_key}", + json={"name": "Empty int range", "field_type": "integer"}, + ).raise_for_status() + try: + # integer_range with just a colon -> no bounds -> 400. + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={f"extra.{int_range_key}": ":"}) + assert result.status_code == 400 + assert "range filter value" in result.json()["message"] + + # datetime with just a separator -> no bounds -> 400. + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={f"extra.{dt_key}": "|"}) + assert result.status_code == 400 + assert "datetime range filter" in result.json()["message"] + + # integer field with a bare colon range -> no bounds -> 400. + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={f"extra.{int_key}": ":"}) + assert result.status_code == 400 + assert "range filter value" in result.json()["message"] + finally: + httpx.delete(f"{URL}/api/v1/field/{entity_type}/{int_range_key}").raise_for_status() + httpx.delete(f"{URL}/api/v1/field/{entity_type}/{dt_key}").raise_for_status() + httpx.delete(f"{URL}/api/v1/field/{entity_type}/{int_key}").raise_for_status() + + +# --------------------------------------------------------------------------- +# LIKE-wildcard escaping and JSON-scalar decoding edge cases +# --------------------------------------------------------------------------- + + +@pytest.mark.asyncio +@pytest.mark.parametrize("entity_type", ["spool", "filament", "vendor"]) +async def test_text_filter_escapes_like_wildcards(entity_type: str, random_filament: dict[str, Any]) -> None: + """Substring text filtering treats % and _ as literal characters, not LIKE wildcards.""" + field_key = "wildcard_text_field" + httpx.post( + f"{URL}/api/v1/field/{entity_type}/{field_key}", + json={"name": "Wildcard text", "field_type": "text"}, + ).raise_for_status() + # '%' would match any sequence, '_' any single char, if not escaped. + id_pct = _create_entity(entity_type, {field_key: json.dumps("100% cotton")}, random_filament) + id_notpct = _create_entity(entity_type, {field_key: json.dumps("100X cotton")}, random_filament) + id_us = _create_entity(entity_type, {field_key: json.dumps("a_b")}, random_filament) + id_anychar = _create_entity(entity_type, {field_key: json.dumps("axb")}, random_filament) + try: + # "100%" must match only the literal "100% cotton", not "100X cotton". + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={f"extra.{field_key}": "100%"}) + assert_httpx_success(result) + ids = {item["id"] for item in result.json()} + assert id_pct in ids + assert id_notpct not in ids + + # "a_b" must match only the literal "a_b", not "axb" (where _ would be a wildcard). + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={f"extra.{field_key}": "a_b"}) + assert_httpx_success(result) + ids = {item["id"] for item in result.json()} + assert id_us in ids + assert id_anychar not in ids + finally: + httpx.delete(f"{URL}/api/v1/field/{entity_type}/{field_key}").raise_for_status() + for entity_id in (id_pct, id_notpct, id_us, id_anychar): + httpx.delete(f"{URL}/api/v1/{entity_type}/{entity_id}").raise_for_status() + + +@pytest.mark.asyncio +@pytest.mark.parametrize("entity_type", ["spool", "filament", "vendor"]) +async def test_text_filter_escape_char_is_literal(entity_type: str, random_filament: dict[str, Any]) -> None: + """A literal '/' (the internal LIKE escape char) in the query is matched literally.""" + field_key = "slash_text_field" + httpx.post( + f"{URL}/api/v1/field/{entity_type}/{field_key}", + json={"name": "Slash text", "field_type": "text"}, + ).raise_for_status() + id_slash = _create_entity(entity_type, {field_key: json.dumps("and/or logic")}, random_filament) + id_noslash = _create_entity(entity_type, {field_key: json.dumps("andor logic")}, random_filament) + try: + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={f"extra.{field_key}": "and/or"}) + assert_httpx_success(result) + ids = {item["id"] for item in result.json()} + assert id_slash in ids + assert id_noslash not in ids + finally: + httpx.delete(f"{URL}/api/v1/field/{entity_type}/{field_key}").raise_for_status() + httpx.delete(f"{URL}/api/v1/{entity_type}/{id_slash}").raise_for_status() + httpx.delete(f"{URL}/api/v1/{entity_type}/{id_noslash}").raise_for_status() + + +@pytest.mark.asyncio +@pytest.mark.parametrize("entity_type", ["spool", "filament", "vendor"]) +async def test_multi_choice_filter_escapes_like_wildcards(entity_type: str, random_filament: dict[str, Any]) -> None: + """Multi-choice token matching treats % and _ in the choice as literal characters.""" + field_key = "wildcard_choice_field" + httpx.post( + f"{URL}/api/v1/field/{entity_type}/{field_key}", + json={ + "name": "Wildcard choice", + "field_type": "choice", + "choices": ["50%", "50X"], + "multi_choice": True, + }, + ).raise_for_status() + id_pct = _create_entity(entity_type, {field_key: json.dumps(["50%"])}, random_filament) + id_x = _create_entity(entity_type, {field_key: json.dumps(["50X"])}, random_filament) + try: + # "50%" must match only the "50%" token, not "50X" via a wildcard. + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={f"extra.{field_key}": "50%"}) + assert_httpx_success(result) + ids = {item["id"] for item in result.json()} + assert id_pct in ids + assert id_x not in ids + finally: + httpx.delete(f"{URL}/api/v1/field/{entity_type}/{field_key}").raise_for_status() + httpx.delete(f"{URL}/api/v1/{entity_type}/{id_pct}").raise_for_status() + httpx.delete(f"{URL}/api/v1/{entity_type}/{id_x}").raise_for_status() + + +@pytest.mark.asyncio +@pytest.mark.parametrize("entity_type", ["spool", "filament", "vendor"]) +async def test_single_choice_filter_escapes_like_wildcards(entity_type: str, random_filament: dict[str, Any]) -> None: + """Single-choice equality on a value with % matches exactly, not as a wildcard.""" + field_key = "wildcard_single_choice" + httpx.post( + f"{URL}/api/v1/field/{entity_type}/{field_key}", + json={ + "name": "Wildcard single choice", + "field_type": "choice", + "choices": ["50%", "50X"], + "multi_choice": False, + }, + ).raise_for_status() + id_pct = _create_entity(entity_type, {field_key: json.dumps("50%")}, random_filament) + id_x = _create_entity(entity_type, {field_key: json.dumps("50X")}, random_filament) + try: + result = httpx.get(f"{URL}/api/v1/{entity_type}", params={f"extra.{field_key}": '"50%"'}) + assert_httpx_success(result) + ids = {item["id"] for item in result.json()} + assert id_pct in ids + assert id_x not in ids + finally: + httpx.delete(f"{URL}/api/v1/field/{entity_type}/{field_key}").raise_for_status() + httpx.delete(f"{URL}/api/v1/{entity_type}/{id_pct}").raise_for_status() + httpx.delete(f"{URL}/api/v1/{entity_type}/{id_x}").raise_for_status()