fix(jobsdb): update cache after transaction completes #2567
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
atzoum
changed the title
atzoum
changed the title
Codecov ReportBase: 43.86% // Head: 43.86% // Increases project coverage by
Additional details and impacted files@@ Coverage Diff @@
## release/1.2.x #2567 +/- ##
==============================================
Coverage 43.86% 43.86%
==============================================
Files 187 187
Lines 39090 39107 +17
==============================================
+ Hits 17146 17156 +10
- Misses 20860 20870 +10
+ Partials 1084 1081 -3
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
atzoum
commented
Oct 14, 2022
| @@ -668,7 +701,7 @@ func loadConfig() { | |||
| config.RegisterDurationConfigVariable(5, &addNewDSLoopSleepDuration, true, time.Second, []string{"JobsDB.addNewDSLoopSleepDuration", "JobsDB.addNewDSLoopSleepDurationInS"}...) | |||
| config.RegisterDurationConfigVariable(5, &refreshDSListLoopSleepDuration, true, time.Second, []string{"JobsDB.refreshDSListLoopSleepDuration", "JobsDB.refreshDSListLoopSleepDurationInS"}...) | |||
| config.RegisterDurationConfigVariable(5, &backupCheckSleepDuration, true, time.Second, []string{"JobsDB.backupCheckSleepDuration", "JobsDB.backupCheckSleepDurationIns"}...) | |||
| config.RegisterDurationConfigVariable(60, &cacheExpiration, true, time.Minute, []string{"JobsDB.cacheExpiration"}...) | |||
| config.RegisterDurationConfigVariable(5, &cacheExpiration, true, time.Minute, []string{"JobsDB.cacheExpiration"}...) | |||
There was a problem hiding this comment.
5 minutes by default should be more than enough and could potentially alleviate the consequences of having an incorrectly populated cache for too long.
atzoum
requested review from
saurav-malani,
cisse21,
chandumlg and
Sidddddarth
cisse21
reviewed
Oct 14, 2022
| // Commit commits the transaction and executes all listeners. | ||
| func (tx *Tx) Commit() error { | ||
| err := tx.Tx.Commit() | ||
| if err == nil { |
There was a problem hiding this comment.
Any reason why we are not checking the error early and returning?
There was a problem hiding this comment.
In the future we might want to introduce other listeners as well, such as errorListeners and completionListeners. In such a case returning early wouldn't be relevant.
Now it can be done, but I preferred having one less loc instead :)
if err != nil {
return err
}
for _, successListener := range tx.successListeners {
successListener()
}
return nil
cisse21
approved these changes
Oct 14, 2022
chandumlg
approved these changes
Oct 14, 2022
Merged
atzoum
added a commit
that referenced
this pull request
Oct 14, 2022
atzoum
added a commit
that referenced
this pull request
Oct 14, 2022
Closed
This was referenced Nov 7, 2022
Merged
This was referenced Nov 11, 2022
Closed
This was referenced Dec 1, 2022
Closed
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.
Description
By updating (invalidating) the cache entries before the transaction commits and for the period until the transaction actually commits, we are risking to have other select queries who arrive during this timeframe to populate the cache with incorrect values: until the transaction commits, changes are not visible to other queries, thus they may erroneously put "no result" entries in the cache.
The above can have as a side-effect to:
proc_errortables)This fix introduces a
jobsdb.Txthat wraps asql.Tx, adding support for registering success listeners. Now, all cache entries are updated after the transaction has been successfully committed.Notion Ticket
Link
Security