TP2000-1130 Move current workbasket from Session to custom User model

[mattjamc]

TP2000-1130 Move current workbasket from Session to custom User model

Why

TMs have reported losing their current workbasket and having it switch to an entirely different one after a short period of inactivity, which has led on occasion to tariff changes being applied to the wrong workbasket. Saving the users' current workbasket in the database rather than in the session would prevent this from happening following session expiration.

What

• Updates User model referencing to use get_user_model()

• Substitutes Django's default User model for a custom user model (see #Note)

• Adds current_workbasket field to User model to store the user's current workbasket in the DB

• Add User model to admin

• Updates require_current_workbasket view decorator to redirect users without an active current workbasket to select a new workbasket

• Removes now unused ValidateSessionWorkBasketMiddleware

• Adds a new view, template and route, NoActiveWorkBasket, to be used as a redirect endpoint for users without an active current workbasket

• Updates WorkBasket model methods and test fixtures to account for the workbasket now being stored in the user model rather than session data

  New model methods:

  • assign_to_user sets the workbasket to be the user's current workbasket
  • remove_users_current_workbasket removes user's current workbasket

  Removed model methods:

  • save_to_session previously saved workbasket to the session of request
  • load_from_session previously queried session workbasket from database
  • remove_current_from_session previously deleted the workbasket from the session data

  New fixtures:

  • client_with_current_workbasket returns a valid user client with a workbasket associated to the user
  • api_client_with_current_workbasket returns a valid user api client with a workbasket associated to the user
  • session_request_with_workbasket returns a request object with a valid user with a current workbasket and session
  • user_workbasket returns a workbasket which has been assigned to a valid logged-in user
  • user_empty_workbasket - returns an empty workbasket which bas been assigned to a valid logged-in user
  • client_with_current_workbasket_no_permissions - returns a client with a logged in user who has a current workbasket but no permissions

  Removed fixtures:

  • session_workbasket previously returned a workbasket in the session
  • session_empty_workbasket previously returned an empty workbasket in the session

• Adds new unit tests for the new changes

Note

This PR followed the guide set out in https://code.djangoproject.com/ticket/25313#comment:24 to change to a custom user model mid project.

It's possible to place the custom User model in its own app, say users, however that requires either truncating the django_migrations table or manually inserting the initial migration for the user model (using raw SQL) into the table making it as if it had already been applied. This would need doing only once for production but need doing every time a new DB snapshot was imported for local dev environments if the snapshot preceded the manual intervention to the migrations table on prod.

Screenshot

Checklist

• Requires migrations? Yes

[codecov-commenter]

Codecov Report

Attention: 109 lines in your changes are missing coverage. Please review.

Comparison is base (e1e87cd) 93.33% compared to head (a296289) 93.17%.
Report is 4 commits behind head on master.

Files	Patch %	Lines
measures/tests/test_migrations.py	10.66%	67 Missing ⚠️
settings/common.py	23.07%	8 Missing and 2 partials ⚠️
workbaskets/models.py	65.21%	8 Missing ⚠️
reports/views.py	78.12%	6 Missing and 1 partial ⚠️
workbaskets/views/ui.py	50.00%	5 Missing ⚠️
commodities/tests/test_migrations.py	0.00%	4 Missing ⚠️
common/middleware.py	72.72%	2 Missing and 1 partial ⚠️
common/tests/test_migrations.py	0.00%	1 Missing ⚠️
publishing/tests/test_migrations.py	0.00%	1 Missing ⚠️
urls.py	50.00%	0 Missing and 1 partial ⚠️
... and 2 more

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1123      +/-   ##
==========================================
- Coverage   93.33%   93.17%   -0.16%     
==========================================
  Files         571      572       +1     
  Lines       42631    42888     +257     
  Branches     3069     3077       +8     
==========================================
+ Hits        39788    39961     +173     
- Misses       2249     2327      +78     
- Partials      594      600       +6     

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