Improving location support (backend)

[OMWalmsley]

Superseeds #2001 (This new version is not from a fork and thus can be "stacked")
Resolves #1970

Locations are where things are stored. Currently we are using a single string in the database to store the location and then frontend application logic on top to create a nested hierarchy. Moving forward it would be ideal to move some of this logic to the backend to prevent locations being generated from stale/deprecated data that has been stored in the frontend.

Features

• Introduces GET \locations endpoint.
  • Which returns a flat list of all locations and a nested list of all locations.
• Introduces HasLocation attribute for all items

Example

An example return from the endpoint is here
{"flat_locations":["Hub1 > Hub2 > Place 1","LHud One","Lab 1 > Shelf 1 > Place A","Lab 4 > Shelf 1","lab1"],"nested_locations":{"Hub1":{"Hub2":{"Place 1":{}}},"LHud One":{},"Lab 1":{"Shelf 1":{"Place A":{}}},"Lab 4":{"Shelf 1":{}},"lab1":{}}}

Testing

Currently three tests have been written to test this endpoint functionality (GET \locations).

Further planned functionality

Implement this into the frontend so that it queries this endpoint instead of using frontend storage.

[cypress]

datalab    Run #5327

Run Properties:   Passed #5327  •  2b4cf4eac0 ℹ️: Merge 66f1042b1f4e28379bebcdd3de67f033895956c3 into 7ac227b25023731fb66b87ead849...

Project	datalab
Branch Review	OMWalmsley/location-route-and-location-trait
Run status	Passed #5327
Run duration	25m 30s
Commit	2b4cf4eac0 ℹ️: Merge 66f1042b1f4e28379bebcdd3de67f033895956c3 into 7ac227b25023731fb66b87ead849...
Committer	Oliver Walmsley
View all properties for this run ↗︎

---

Test results
Failures	0
Flaky	0
Pending	0
Skipped	0
Passing	548
View all changes introduced in this branch ↗︎

[OMWalmsley]

Added ability to have server default locations and added a test for this occurrence. To use this CONFIG.EXTRA_LOCATIONS should be populated.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 80.34%. Comparing base (d7c4fc5) to head (66f1042).

Additional details and impacted files

@@                   Coverage Diff                   @@
##           ml-evs/custom-items    #2002      +/-   ##
=======================================================
+ Coverage                80.30%   80.34%   +0.04%     
=======================================================
  Files                       84       84              
  Lines                     7824     7841      +17     
=======================================================
+ Hits                      6283     6300      +17     
  Misses                    1541     1541              

Files with missing lines	Coverage Δ
pydatalab/src/pydatalab/models/equipment.py	100.00% <ø> (ø)
pydatalab/src/pydatalab/models/items.py	96.96% <100.00%> (ø)
...datalab/src/pydatalab/models/starting_materials.py	100.00% <100.00%> (ø)
pydatalab/src/pydatalab/models/traits.py	99.04% <100.00%> (+0.02%)	⬆️
pydatalab/src/pydatalab/routes/v0_1/items.py	84.39% <100.00%> (+0.36%)	⬆️

🚀 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.