rename group handler interface (#4531)

renames methods in the group handler interface
to replace the channel-specific vocabulary with the more standard and generic "containers" and
"items" naming conventions.

---

#### Does this PR need a docs update or release note?

- [x]  No

#### Type of change

- [x] 🧹 Tech Debt/Cleanup

#### Test Plan

- [x]  Unit test
- [x] 💚 E2E
This commit is contained in:
Keepers 2023-10-24 11:05:41 -06:00 committed by GitHub
parent 9e40d88265
commit a9cc29d8c6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 26 additions and 26 deletions

View File

@ -58,7 +58,7 @@ func CreateCollections(
ctx = clues.Add(ctx, "can_use_previous_backup", canUsePreviousBackup) ctx = clues.Add(ctx, "can_use_previous_backup", canUsePreviousBackup)
channels, err := bh.getChannels(ctx) channels, err := bh.getContainers(ctx)
if err != nil { if err != nil {
return nil, false, clues.Stack(err) return nil, false, clues.Stack(err)
} }
@ -154,7 +154,7 @@ func populateCollections(
// and will return an error if a delta token is queried. // and will return an error if a delta token is queried.
canMakeDeltaQueries := len(ptr.Val(c.GetEmail())) > 0 canMakeDeltaQueries := len(ptr.Val(c.GetEmail())) > 0
add, _, rem, du, err := bh.getChannelMessageIDs(ctx, cID, prevDelta, canMakeDeltaQueries) add, _, rem, du, err := bh.getContainerItemIDs(ctx, cID, prevDelta, canMakeDeltaQueries)
if err != nil { if err != nil {
el.AddRecoverable(ctx, clues.Stack(err)) el.AddRecoverable(ctx, clues.Stack(err))
continue continue

View File

@ -49,11 +49,11 @@ type mockBackupHandler struct {
doNotInclude bool doNotInclude bool
} }
func (bh mockBackupHandler) getChannels(context.Context) ([]models.Channelable, error) { func (bh mockBackupHandler) getContainers(context.Context) ([]models.Channelable, error) {
return bh.channels, bh.channelsErr return bh.channels, bh.channelsErr
} }
func (bh mockBackupHandler) getChannelMessageIDs( func (bh mockBackupHandler) getContainerItemIDs(
_ context.Context, _ context.Context,
_, _ string, _, _ string,
_ bool, _ bool,
@ -89,7 +89,7 @@ func (bh mockBackupHandler) canonicalPath(
false) false)
} }
func (bh mockBackupHandler) GetChannelMessage( func (bh mockBackupHandler) GetItemByID(
_ context.Context, _ context.Context,
_, _, itemID string, _, _, itemID string,
) (models.ChatMessageable, *details.GroupsInfo, error) { ) (models.ChatMessageable, *details.GroupsInfo, error) {

View File

@ -31,13 +31,13 @@ func NewChannelBackupHandler(
} }
} }
func (bh channelsBackupHandler) getChannels( func (bh channelsBackupHandler) getContainers(
ctx context.Context, ctx context.Context,
) ([]models.Channelable, error) { ) ([]models.Channelable, error) {
return bh.ac.GetChannels(ctx, bh.protectedResource) return bh.ac.GetChannels(ctx, bh.protectedResource)
} }
func (bh channelsBackupHandler) getChannelMessageIDs( func (bh channelsBackupHandler) getContainerItemIDs(
ctx context.Context, ctx context.Context,
channelID, prevDelta string, channelID, prevDelta string,
canMakeDeltaQueries bool, canMakeDeltaQueries bool,
@ -76,9 +76,9 @@ func (bh channelsBackupHandler) PathPrefix(tenantID string) (path.Path, error) {
false) false)
} }
func (bh channelsBackupHandler) GetChannelMessage( func (bh channelsBackupHandler) GetItemByID(
ctx context.Context, ctx context.Context,
teamID, channelID, itemID string, groupID, channelID, itemID string,
) (models.ChatMessageable, *details.GroupsInfo, error) { ) (models.ChatMessageable, *details.GroupsInfo, error) {
return bh.ac.GetChannelMessage(ctx, teamID, channelID, itemID) return bh.ac.GetChannelMessage(ctx, groupID, channelID, itemID)
} }

View File

@ -35,7 +35,7 @@ type Collection struct {
// removed is a list of item IDs that were deleted from, or moved out, of a container // removed is a list of item IDs that were deleted from, or moved out, of a container
removed map[string]struct{} removed map[string]struct{}
getter getChannelMessager getter getItemByIDer
statusUpdater support.StatusUpdater statusUpdater support.StatusUpdater
} }
@ -48,7 +48,7 @@ type Collection struct {
// or notMoved (if they match). // or notMoved (if they match).
func NewCollection( func NewCollection(
baseCol data.BaseCollection, baseCol data.BaseCollection,
getter getChannelMessager, getter getItemByIDer,
protectedResource string, protectedResource string,
added map[string]struct{}, added map[string]struct{},
removed map[string]struct{}, removed map[string]struct{},
@ -144,7 +144,7 @@ func (col *Collection) streamItems(ctx context.Context, errs *fault.Bus) {
flds := col.FullPath().Folders() flds := col.FullPath().Folders()
parentFolderID := flds[len(flds)-1] parentFolderID := flds[len(flds)-1]
item, info, err := col.getter.GetChannelMessage( item, info, err := col.getter.GetItemByID(
ctx, ctx,
col.protectedResource, col.protectedResource,
parentFolderID, parentFolderID,

View File

@ -14,21 +14,21 @@ import (
) )
type backupHandler interface { type backupHandler interface {
getChannelMessager getItemByIDer
// gets all channels for the group // gets all containers for the resource
getChannels( getContainers(
ctx context.Context, ctx context.Context,
) ([]models.Channelable, error) ) ([]models.Channelable, error)
// gets all message IDs (by delta, if possible) in the channel // gets all item IDs (by delta, if possible) in the container
getChannelMessageIDs( getContainerItemIDs(
ctx context.Context, ctx context.Context,
channelID, prevDelta string, containerID, prevDelta string,
canMakeDeltaQueries bool, canMakeDeltaQueries bool,
) (map[string]time.Time, bool, []string, api.DeltaUpdate, error) ) (map[string]time.Time, bool, []string, api.DeltaUpdate, error)
// includeContainer evaluates whether the channel is included // includeContainer evaluates whether the container is included
// in the provided scope. // in the provided scope.
includeContainer( includeContainer(
ctx context.Context, ctx context.Context,
@ -45,9 +45,9 @@ type backupHandler interface {
) (path.Path, error) ) (path.Path, error)
} }
type getChannelMessager interface { type getItemByIDer interface {
GetChannelMessage( GetItemByID(
ctx context.Context, ctx context.Context,
teamID, channelID, itemID string, resourceID, containerID, itemID string,
) (models.ChatMessageable, *details.GroupsInfo, error) ) (models.ChatMessageable, *details.GroupsInfo, error)
} }

View File

@ -13,12 +13,12 @@ type GetChannelMessage struct {
Err error Err error
} }
func (m GetChannelMessage) GetChannelMessage( func (m GetChannelMessage) GetItemByID(
ctx context.Context, ctx context.Context,
teamID, channelID, itemID string, groupID, channelID, messageID string,
) (models.ChatMessageable, *details.GroupsInfo, error) { ) (models.ChatMessageable, *details.GroupsInfo, error) {
msg := models.NewChatMessage() msg := models.NewChatMessage()
msg.SetId(ptr.To(itemID)) msg.SetId(ptr.To(messageID))
return msg, &details.GroupsInfo{}, m.Err return msg, &details.GroupsInfo{}, m.Err
} }