Fix discarded draft attribution in timeline entries #1755
Merged
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
The impetus to add tests for this was learning that there is actually a problem where the edition model used in this interactor is not up to date and thus a timeline entry is created with the wrong status. This adds tests for the whole file however the one on line 20 is a failing test that captures this problem.
This changes this service to take an edition as it's argument rather than a document. This change has been done in part to resolve a problem where operating on a document meant a stale edition was used in the interactor. When trying to address that problem I noticed that it seemed quite strange that this class operated on a document when its name implies an edition. I also added reload methods for associations of a document so that were a similar problem to occur again the document is up to date.
I found these tests quite hard to follow as there are quite a lot of them. I decided that it would be easier to work with them if they were in certain groupings so I've moved them into individual describe blocks. This might well be a sign that this class has too many responsibilities but that seems like a problem for another day. Aside from these I've adapted these tests to be much more edition centric and to no longer rely on any reloading. I've had to tweak a bunch of factory calls and to resolve some inconsistencies with use of brackets or not I've made them all use brackets - hopefully this isn't too controversial.
kevindew
force-pushed
the
fix-discard-draft-attribution
branch
from
a1e2b3a
to
bf4385e
Compare
benthorner
approved these changes
Feb 11, 2020
| end | ||
|
|
||
| it "raises an error when a base path cannot be deleted" do | ||
| edition = create :edition | ||
| describe "Asset Manager communication" do |
There was a problem hiding this comment.
Could we extract this part into a service?
| } | ||
| stub_any_publishing_api_discard_draft | ||
| .to_return(status: 422, body: discard_draft_error.to_json) | ||
| it "does not delete path reservations for published documents" do |
There was a problem hiding this comment.
Could we make a DeletePathReservationService to extract this?
There was a problem hiding this comment.
(Especially noting the detailed edge case of having had multiple base paths.)
|
Thanks @benthorner I'll add something to the card AC about deciding what to tell about this (whether just fix it or add to wall of pain) |
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.
Trello: https://trello.com/c/yqXt0RGc/1417-remove-documents-at-dwps-request
It turns out that we have a bug in the code used to assign the status of a timeline entry. The
DeleteDraftEditionServiceaccepts a document as input and modifies the current_edition of that. As the edition that is used in the interactor is not the same object asdocument.current_editionthe edition in the interactor becomes stale and using that to populate the timeline entry uses an out of date status.Looking on production we have 175 discarded timeline entries and only 32 of those are attributed to the correct status:
The problems seem to kick in between March 20th to 25th this year - which makes this change (by me) the likely culprit. Once this is merged I plan to fix those in the DB manually.
To resolve this I've changed the
DeleteDraftEditionServiceto operate on an edition, which felt more natural anyway given the naming the class.