/
iter.go
133 lines (114 loc) · 3.52 KB
/
iter.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
// Copyright 2019 Aporeto Inc.
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package manipulate
import (
"context"
"fmt"
"go.aporeto.io/elemental"
)
const iterDefaultBlockSize = 10000
// IterFunc calls RetrieveMany on the given Manipulator, and will retrieve the data by block
// of the given blockSize.
//
// IterFunc will naturally ends and return when there is no more data to pull.
//
// For each retrieved block, the given func will be called with the
// current data block. If the function returns an error, the error is returned to the caller
// of IterFunc and the iteration stops.
//
// The given context will be used if the underlying manipulator honors it.
//
// The given manipulate.Context will be used to retry any failed batch recovery.
//
// The identifiablesTemplate parameter is must be an empty elemental.Identifiables that will be used to
// hold the data block. It is reset at every iteration. Do not rely on it to be filled
// once IterFunc is complete.
//
// Finally, if the given blockSize is <= 0, then it will use the default that is 10000.
func IterFunc(
ctx context.Context,
manipulator Manipulator,
identifiablesTemplate elemental.Identifiables,
mctx Context,
iteratorFunc func(block elemental.Identifiables) error,
blockSize int,
) error {
if manipulator == nil {
panic("manipulator must not be nil")
}
if iteratorFunc == nil {
panic("iteratorFunc must not be nil")
}
if identifiablesTemplate == nil {
panic("identifiablesTemplate must not be nil")
}
if mctx == nil {
mctx = NewContext(ctx)
}
if blockSize <= 0 {
blockSize = iterDefaultBlockSize
}
var page int
for {
page++
objects := identifiablesTemplate.Copy()
if err := Retry(
ctx,
func() error {
return manipulator.RetrieveMany(mctx.Derive(ContextOptionPage(page, blockSize)), objects)
},
nil,
); err != nil {
return fmt.Errorf("unable to retrieve objects for page %d: %s", page, err.Error())
}
if len(objects.List()) == 0 {
return nil
}
if err := iteratorFunc(objects); err != nil {
return fmt.Errorf("iter function returned an error on page %d: %s", page, err)
}
}
}
// Iter is a helper function for IterFunc.
//
// It will simply iterates on the object with identity of the given elemental.Identifiables.
// Not that this function cannot populate the data in the identifiable parameter. Instead
// It will return the destination.
//
// Always pass an empty elemental.Identifiables to this function
//
// For more information, please check IterFunc documentation.
//
// Example:
// dest, err := Iter(context.Background(), m, mctx, model.ThingsList{}, 100)
//
func Iter(
ctx context.Context,
m Manipulator,
mctx Context,
identifiablesTemplate elemental.Identifiables,
blockSize int,
) (elemental.Identifiables, error) {
if err := IterFunc(
ctx,
m,
identifiablesTemplate,
mctx,
func(block elemental.Identifiables) error {
identifiablesTemplate = identifiablesTemplate.Append(block.List()...)
return nil
},
blockSize,
); err != nil {
return nil, err
}
return identifiablesTemplate, nil
}