(161623) Do not show "deleted" projects in application #1478
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
lozette
force-pushed
the
feature/161623-do-not-show-deleted-projects-in-application
branch
5 times, most recently
from
9b42e7c
to
64670bb
Compare
lozette
changed the title
Adding default_scope to models can be problematic as default scopes can conceal issues. However, now that we have a concept of "soft deleted" projects, we do not want to return these projects ANYWHERE in the application - not in the UI, exports or statistics. They should not be seen to exist. To avoid explicitly asking for `active` and/or `completed` projects in all our pages, use `default_scope` to exclude deleted projects. If we want to view deleted projects in future, we will have to explicitly look for them (e.g. using `Project.unscoped.where(state: :deleted)` as opposed to the Project.deleted scope).
…edited We don't want users viewing deleted projects by going to their `show` URL - so ensure this doesn't happen using Policies. This will return a 403 not a 404, which semantically isn't quite correct - the project isn't deleted, so it's "found" but it's not viewable. But the user shouldn't know it's not "deleted". However we think it will be rare for a user to have a project URL and go to it directly. The editing restricton is more of a theoretical need than a practical one, but mark "soft deleted" projects as un-editable, just in case anyone manages to access one and tries to edit it.
We were using ProjectPolicy.show? here but this is actually a project _listing_ page, not a show page for an individual project. The naming on this controller is a little obscure - it is _showing_ an individual month of projects not an individual project. So `index?` is the appropriate Policy to call here.
Add some tests to prove our exports are not including any "soft deleted" projects.
lozette
force-pushed
the
feature/161623-do-not-show-deleted-projects-in-application
branch
from
64670bb
to
965ce31
Compare
|
mec
approved these changes
Apr 11, 2024
There was a problem hiding this comment.
Ugh! default_scope again and me reviewing it again (we have a default scope on Note)! 😱
I suspect that, like you, I cannot come up with a good reason not to use it here, 'deleted' projects are a pretty odd concept, it's hard to understand what they are actually for.
For that reason, I am going to go against everything I have read and been told by better developers than me about never using default_scope and approve this!
|
Yeah I have so many misgivings. I can see myself in the future frantically debugging something that's been caused by default_scope. But I also don't want to accidentally leave |
lozette
deleted the
feature/161623-do-not-show-deleted-projects-in-application
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes
Now that we have the concept of "soft deleted" projects (projects which exist in the database but are in a deleted state) we need to ensure they never appear to users.
To ensure this, we have decided to use a
default_scopefor projects. Default scopes can be problematic as they can conceal issues and cause confusion - but the alternative is to addactiveandcompletedscopes to ALL calls to Project in the application.This does mean that we lose access to the
Project.deletedscope, but if we need to call on deleted projects specifically we can unscope the default scope and callProject.unscoped.where(state: :deleted)We then go on to add some Policy changes and extra specs, to make sure deleted projects do not appear in listing pages, and cannot be shown/edited.
Checklist
CHANGELOG.mdif needed.