Ensuring article's cache updates on org image update #17052
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
There are three major things occurring in this pull request: 1. Renaming `Article#update_cached_user` to `Article#set_cached_entities`. 2. Reducing an organization's direct knowledge of which of the org's attributes an article caches. 3. Removing duplicate calls to update the article associated with the organization. For renaming to `Article#set_cached_entities`, the prior method implied we were updating the persistence layer. However, we were not making any save nor update calls. This rename should clarify intention. For reducing knowledge, the comments for `Article::ATTRIBUTES_CACHED_FOR_RELATED_ENTITY` should explain the details. And last, removing the duplicate calls; we had three methods that were attempting to build and update the `Article#cached_organization`'s value. Closes #17041
jeremyf
added a commit
to forem/forem-docs
that referenced
this pull request
Mar 30, 2022
Informed by forem/forem#17052 and forem/forem#17041
djuber
approved these changes
Mar 30, 2022
| return unless saved_change_to_attribute?(:name) | ||
|
|
||
| articles.update(cached_organization: Articles::CachedEntity.from_object(self)) | ||
| articles.each(&:save) |
There was a problem hiding this comment.
this makes sense given the hook is now "before save". Saving will trigger the expected action.
also, the TODO comment earlier suggested a lot of the existing complication was related to pushing search documents into ES (and we don't do that any more).
pr-triage
bot
added
PR: partially-approved
|
Confession time, I spent hours 10pm to 11pm fighting with the carrier wave issue. And then from hours 11pm to 7am, as I slept my brain noodled on this. At 8am I said "Alright, let's try a new instance of the object to see if that works." And lo' it did. |
pr-triage
bot
added
PR: reviewed-approved
pr-triage
bot
added
PR: merged
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.
What type of PR is this? (check all applicable)
Description
There are three major things occurring in this pull request:
Article#update_cached_usertoArticle#set_cached_entities.attributes an article caches.
organization.
For renaming to
Article#set_cached_entities, the prior method impliedwe were updating the persistence layer. However, we were not making any
save nor update calls. This rename should clarify intention.
For reducing knowledge, the comments for
Article::ATTRIBUTES_CACHED_FOR_RELATED_ENTITYshould explain the details.And last, removing the duplicate calls; we had three methods that were
attempting to build and update the
Article#cached_organization'svalue.
Related Tickets & Documents
Closes #17041
QA Instructions, Screenshots, Recordings
My hope is that the tests cover this. To test via the UI, I leave the
following gherkin as guide:
Go to
/and make sure that there's an article with an organization.Now, after the change, look on the dashboard for that article's organization
image. It should have changed.
UI accessibility concerns?
None.
Added/updated tests?
[Forem core team only] How will this change be communicated?