⚡ [#621] add key value search to data

[TimdeBeer1]

Fixes #621

Changes

New query:
SELECT "core_object"."id", "core_object"."uuid", "core_object"."object_type_id", "core_object"."created_on", "core_object"."modified_on", (("core_objectrecord"."data" ->> boomspiegel))::varchar AS "key_text" FROM "core_object" INNER JOIN "core_objectrecord" ON ("core_object"."id" = "core_objectrecord"."object_id") WHERE ("core_objectrecord"."data" ? boomspiegel AND UPPER((("core_objectrecord"."data" ->> boomspiegel))::varchar::text) LIKE UPPER(%ipsu%))

[github-actions]

Bencher Report

Branch	feature/621-search-capabilities
Testbed	ubuntu-latest

Click to view all benchmark results

Benchmark	Latency	Benchmark Result milliseconds (ms) (Result Δ%)	Upper Boundary milliseconds (ms) (Limit %)
performance_test/tests/test_objects_list.py::test_objects_api_list_filter_by_object_type	📈 view plot 🚷 view threshold	100.92 ms (-14.95%) Baseline: 118.66 ms	124.59 ms (81.00%)
performance_test/tests/test_objects_list.py::test_objects_api_list_filter_one_result	📈 view plot 🚷 view threshold	19.16 ms (-2.31%) Baseline: 19.61 ms	20.59 ms (93.04%)
performance_test/tests/test_objects_list.py::test_objects_api_list_large_page_size_page_1	📈 view plot 🚷 view threshold	235.79 ms (-6.17%) Baseline: 251.29 ms	263.85 ms (89.37%)
performance_test/tests/test_objects_list.py::test_objects_api_list_large_page_size_page_5	📈 view plot 🚷 view threshold	233.32 ms (-6.89%) Baseline: 250.58 ms	263.11 ms (88.68%)
performance_test/tests/test_objects_list.py::test_objects_api_list_small_page_size_page_20	📈 view plot 🚷 view threshold	117.07 ms (-3.36%) Baseline: 121.14 ms	127.19 ms (92.04%)

🐰 View full continuous benchmarking report in Bencher

[codecov-commenter]

Codecov Report

❌ Patch coverage is 86.66667% with 6 lines in your changes missing coverage. Please review.
✅ Project coverage is 84.12%. Comparing base (71fab09) to head (fc1b627).
⚠️ Report is 10 commits behind head on master.

Files with missing lines	Patch %	Lines
src/objects/core/admin.py	87.87%	2 Missing and 2 partials ⚠️
src/objects/api/v2/filters.py	83.33%	1 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #699      +/-   ##
==========================================
+ Coverage   83.95%   84.12%   +0.17%     
==========================================
  Files         131      134       +3     
  Lines        2480     2576      +96     
  Branches      199      208       +9     
==========================================
+ Hits         2082     2167      +85     
- Misses        354      362       +8     
- Partials       44       47       +3     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[danielmursa-dev]

In my comment #621 (comment) I meant to use the same pattern as in the API filters, for example with underscores, in this way also the URL format is consistent: /admin/core/object/?q=key__value. You can also improve this search by adding options like exact, contains, etc.

Using a : in the search bar I'm not sure if the nested search works properly.

• last thing could you also add some tests?

[stevenbal]

Looks good overall 👍

[danielmursa-dev]

Good 👍

[danielmursa-dev]

@stevenbal should we also add the same Search Instructions to the docs in the admin interface section?

[stevenbal]

@danielmursa-dev

should we also add the same Search Instructions to the docs in the admin interface section?

hmm yeah let's do that. @TimdeBeer1 could you add this explanation to the admin docs as well?