Make BackedUpItems thread safe #8366
Conversation
sseago
force-pushed
the
synchronise-backedupitems
branch
from
a9342af to
ec5d953
Compare
sseago
force-pushed
the
synchronise-backedupitems
branch
from
ec5d953 to
f7f2402
Compare
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #8366 +/- ##
==========================================
+ Coverage 58.98% 59.04% +0.06%
==========================================
Files 368 369 +1
Lines 39000 39046 +46
==========================================
+ Hits 23004 23056 +52
+ Misses 14532 14527 -5
+ Partials 1464 1463 -1 ☔ View full report in Codecov by Sentry. |
pkg/backup/backed_up_items_map.go
Outdated
| return len(m.BackedUpItems) | ||
| } | ||
|
|
||
| func (m *backedUpItemsMap) ItemInBackup(key itemKey) bool { |
There was a problem hiding this comment.
I am fine with the current names. But just thought of ItemInBackup <-> IsItemBackedup and AddItem <-> MarkItemBackedup
sseago
force-pushed
the
synchronise-backedupitems
branch
from
f7f2402 to
d2da99d
Compare
|
Minor updates, but I didn't use |
There was a problem hiding this comment.
https://pkg.go.dev/k8s.io/apimachinery/pkg/util/sets#Set has some of the functions being defined here. If the functions for backedUpItemsMap might grow, it might be wise to use the package there. Otherwise this lgtm.
pkg/backup/backed_up_items_map.go
Outdated
| func (m *backedUpItemsMap) CopyItemList() map[itemKey]struct{} { | ||
| m.RLock() | ||
| defer m.RUnlock() | ||
| returnMap := map[itemKey]struct{}{} |
There was a problem hiding this comment.
| returnMap := map[itemKey]struct{}{} | |
| returnMap := make(map[itemKey]struct{}, len(m.BackedUpItems)) |
pkg/backup/backed_up_items_map.go
Outdated
| // backedUpItemsMap keeps track of the items already backed up for the current Velero Backup | ||
| type backedUpItemsMap struct { | ||
| *sync.RWMutex | ||
| BackedUpItems map[itemKey]struct{} |
There was a problem hiding this comment.
Is there a need to expose "BackedUpItems"? i.e. BackedUpItems -> backedUpItems
There was a problem hiding this comment.
This isn't referenced from outside, so you're right -- no need to expose.
pkg/backup/backed_up_items_map.go
Outdated
| } | ||
| } | ||
|
|
||
| func (m *backedUpItemsMap) CopyItemList() map[itemKey]struct{} { |
There was a problem hiding this comment.
Why not call it "CopyItemMap"? In the func the variable it returns is even called "returnMap"
pkg/backup/backed_up_items_map.go
Outdated
| return returnMap | ||
| } | ||
|
|
||
| func (m *backedUpItemsMap) ResourceList() map[string][]string { |
There was a problem hiding this comment.
- If the func returns a map, it would be better to call lit "ResourceMap()"
- It would be better to add some comments to explain what the key and value look like in the returned map.
pkg/backup/backed_up_items_map.go
Outdated
| return len(m.BackedUpItems) | ||
| } | ||
|
|
||
| func (m *backedUpItemsMap) ItemInBackup(key itemKey) bool { |
There was a problem hiding this comment.
I would call it "Has(key)" but it's trivial...
Signed-off-by: Scott Seago <[email protected]>
sseago
dismissed stale reviews from shubham-pampattiwar and kaovilai
via
015b1e6
sseago
force-pushed
the
synchronise-backedupitems
branch
from
d18cf3c to
015b1e6
Compare
Thank you for contributing to Velero!
Please add a summary of your change
This PR synchronizes access to backupRequest.BackedUpItems with an RWMutex so that multiple ItemBlock processing goroutines will be able to access it.
Does your change fix a particular issue?
Fixes #7148
Please indicate you've done the following:
make new-changelog) or comment/kind changelog-not-requiredon this PR.site/content/docs/main.