/
helpers.go
242 lines (185 loc) · 6.62 KB
/
helpers.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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
// 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 manipmongo
import (
"context"
"fmt"
"strconv"
"strings"
"time"
"github.com/globalsign/mgo"
"github.com/globalsign/mgo/bson"
"go.aporeto.io/elemental"
"go.aporeto.io/manipulate"
"go.aporeto.io/manipulate/internal/backoff"
"go.aporeto.io/manipulate/manipmongo/internal/compiler"
)
// CompileFilter compiles the given manipulate filter into a raw mongo filter.
func CompileFilter(f *elemental.Filter) bson.M {
return compiler.CompileFilter(f)
}
// DoesDatabaseExist checks if the database used by the given manipulator exists.
func DoesDatabaseExist(manipulator manipulate.Manipulator) (bool, error) {
m, ok := manipulator.(*mongoManipulator)
if !ok {
panic("you can only pass a mongo manipulator to DoesDatabaseExist")
}
dbs, err := m.rootSession.DatabaseNames()
if err != nil {
return false, err
}
for _, db := range dbs {
if db == m.dbName {
return true, nil
}
}
return false, nil
}
// DropDatabase drops the entire database used by the given manipulator.
func DropDatabase(manipulator manipulate.Manipulator) error {
m, ok := manipulator.(*mongoManipulator)
if !ok {
panic("you can only pass a mongo manipulator to DropDatabase")
}
session := m.rootSession.Copy()
defer session.Close()
return session.DB(m.dbName).DropDatabase()
}
// CreateIndex creates multiple mgo.Index for the collection storing info for the given identity using the given manipulator.
func CreateIndex(manipulator manipulate.Manipulator, identity elemental.Identity, indexes ...mgo.Index) error {
m, ok := manipulator.(*mongoManipulator)
if !ok {
panic("you can only pass a mongo manipulator to CreateIndex")
}
session := m.rootSession.Copy()
defer session.Close()
collection := session.DB(m.dbName).C(identity.Name)
for i, index := range indexes {
if index.Name == "" {
index.Name = "index_" + identity.Name + "_" + strconv.Itoa(i)
}
if err := collection.EnsureIndex(index); err != nil {
return fmt.Errorf("unable to ensure index '%s': %s", index.Name, err)
}
}
return nil
}
// EnsureIndex works like create index, but it will delete existing index
// if they changed before creating a new one.
func EnsureIndex(manipulator manipulate.Manipulator, identity elemental.Identity, indexes ...mgo.Index) error {
m, ok := manipulator.(*mongoManipulator)
if !ok {
panic("you can only pass a mongo manipulator to CreateIndex")
}
session := m.rootSession.Copy()
defer session.Close()
collection := session.DB(m.dbName).C(identity.Name)
for i, index := range indexes {
if index.Name == "" {
index.Name = "index_" + identity.Name + "_" + strconv.Itoa(i)
}
if err := collection.EnsureIndex(index); err != nil {
if strings.HasSuffix(err.Error(), "already exists with different options") {
if err := collection.DropIndexName(index.Name); err != nil {
return fmt.Errorf("cannot delete previous index: %s", err)
}
if err := collection.EnsureIndex(index); err != nil {
return fmt.Errorf("unable to ensure index after dropping old one '%s': %s", index.Name, err)
}
continue
}
return fmt.Errorf("unable to ensure index '%s': %s", index.Name, err)
}
}
return nil
}
// DeleteIndex deletes multiple mgo.Index for the collection.
func DeleteIndex(manipulator manipulate.Manipulator, identity elemental.Identity, indexes ...string) error {
m, ok := manipulator.(*mongoManipulator)
if !ok {
panic("you can only pass a mongo manipulator to DeleteIndex")
}
session := m.rootSession.Copy()
defer session.Close()
collection := session.DB(m.dbName).C(identity.Name)
for _, index := range indexes {
if err := collection.DropIndexName(index); err != nil {
return err
}
}
return nil
}
// CreateCollection creates a collection using the given mgo.CollectionInfo.
func CreateCollection(manipulator manipulate.Manipulator, identity elemental.Identity, info *mgo.CollectionInfo) error {
m, ok := manipulator.(*mongoManipulator)
if !ok {
panic("you can only pass a mongo manipulator to CreateCollection")
}
session := m.rootSession.Copy()
defer session.Close()
collection := session.DB(m.dbName).C(identity.Name)
return collection.Create(info)
}
// GetDatabase returns a ready to use mgo.Database. Use at your own risks.
// You are responsible for closing the session by calling the returner close function
func GetDatabase(manipulator manipulate.Manipulator) (*mgo.Database, func(), error) {
m, ok := manipulator.(*mongoManipulator)
if !ok {
panic("you can only pass a mongo manipulator to GetDatabase")
}
session := m.rootSession.Copy()
return session.DB(m.dbName), func() { session.Close() }, nil
}
// SetConsistencyMode sets the mongo consistency mode of the mongo session.
func SetConsistencyMode(manipulator manipulate.Manipulator, mode mgo.Mode, refresh bool) {
m, ok := manipulator.(*mongoManipulator)
if !ok {
panic("you can only pass a mongo manipulator to SetConsistencyMode")
}
if m.rootSession == nil {
panic("cannot apply SetConsistencyMode. The root mongo session is not ready")
}
m.rootSession.SetMode(mode, refresh)
}
// RunQuery runs a function that must run a mongodb operation.
// It will retry in case of failure. This is an advanced helper can
// be used when you get a session from using GetDatabase().
func RunQuery(mctx manipulate.Context, operationFunc func() (interface{}, error), baseRetryInfo RetryInfo) (interface{}, error) {
var try int
for {
out, err := operationFunc()
if err == nil {
return out, nil
}
err = handleQueryError(err)
if !manipulate.IsCannotCommunicateError(err) {
return out, err
}
baseRetryInfo.try = try
baseRetryInfo.err = err
baseRetryInfo.mctx = mctx
if rf := mctx.RetryFunc(); rf != nil {
if rerr := rf(baseRetryInfo); rerr != nil {
return nil, rerr
}
} else if baseRetryInfo.defaultRetryFunc != nil {
if rerr := baseRetryInfo.defaultRetryFunc(baseRetryInfo); rerr != nil {
return nil, rerr
}
}
deadline, ok := mctx.Context().Deadline()
if ok && deadline.Before(time.Now()) {
return nil, manipulate.NewErrCannotExecuteQuery(context.DeadlineExceeded.Error())
}
<-time.After(backoff.Next(try, deadline))
try++
}
}