✨ Move filtering to backend (part 1)

[matusdrobuliak66]

What do these changes do?

These changes introduce 3 new query parameters in the list projects api (NOTE: Only the search query parameter is currently added to the OAS and implemented in the backend!)

• search
• order_by
• filters

search

Search is implemented by this PR, it is a full-text search on more columns, currently: project name, description, uuid, and user name.

order_by

• inspired by Google AIP https://google.aip.dev/132#ordering
• this will be used when we will want to add ordering on fields
• after discussion with @odeimaiz this is currently not necessary

filtering

• inspired by Docker API https://docs.docker.com/engine/api/v1.43/#tag/Container/operation/ContainerList
• encoded as JSON. Each available filter can have its own logic (should be well documented)
• This will be used for the filtering of "folder_id" in Project Folders in User Workspace (Nov.) osparc-issues#716 and potentially additional filtering on tags, classifiers, ...
• as discussed with @odeimaiz in the beginning we will not include filtering by project type as the filtering is already implemented separately.

Related issue/s

• Project Folders in User Workspace (Nov.) osparc-issues#716

How to test

Webserver

cd services/web/server/
make install-dev
pytest tests/unit/with_dbs/02/test_projects_handlers__list_search.py

DevOps Checklist

[codecov]

Codecov Report

Merging #4283 (45e5157) into master (e3c6b29) will decrease coverage by 6.6%.
The diff coverage is 66.6%.

@@            Coverage Diff            @@
##           master   #4283      +/-   ##
=========================================
- Coverage    85.8%   79.2%    -6.6%     
=========================================
  Files         976     399     -577     
  Lines       41989   20754   -21235     
  Branches      965     173     -792     
=========================================
- Hits        36034   16456   -19578     
+ Misses       5734    4249    -1485     
+ Partials      221      49     -172     

Flag	Coverage Δ
integrationtests	62.1% <57.8%> (-6.6%)	⬇️
unittests	84.3% <66.6%> (+1.6%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
...rc/simcore_service_webserver/projects/_db_utils.py	97.0% <ø> (ø)
...er/src/simcore_service_webserver/projects/utils.py	86.8% <33.3%> (-0.9%)	⬇️
...mcore_service_webserver/projects/_handlers_crud.py	81.9% <50.0%> (-5.6%)	⬇️
...ore_service_webserver/projects/_crud_read_utils.py	97.5% <100.0%> (+1.2%)	⬆️
...erver/src/simcore_service_webserver/projects/db.py	96.6% <100.0%> (+<0.1%)	⬆️

... and 675 files with indirect coverage changes

[pcrespov]

Great!

• Note that there is a trick to reuse the pydantic models defined in handlers_crud as query/parameters in api/specs/webserver/scripts
• Can you please add the references you used (and describes above) in the code as well?

[sanderegg]

Please check the comments.
Very nice and looking forward to this backend search

[sanderegg]

Please check the comments.
Very nice and looking forward to this backend search

[codeclimate]

Code Climate has analyzed commit 45e5157 and detected 0 issues on this pull request.

View more on Code Climate.

[sonarcloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication

[GitHK]

nice!