forked from jfrog/jfrog-client-go
-
Notifications
You must be signed in to change notification settings - Fork 0
/
contentreader.go
481 lines (441 loc) · 14.2 KB
/
contentreader.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
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
package content
import (
"bufio"
"encoding/json"
"errors"
"io"
"os"
"reflect"
"sort"
"sync"
"github.com/tenstad/jfrog-client-go/utils"
"github.com/tenstad/jfrog-client-go/utils/errorutils"
"github.com/tenstad/jfrog-client-go/utils/log"
)
// Open and read JSON files, find the array key inside it and load its value into the memory in small chunks.
// Currently, 'ContentReader' only support extracting a single value for a given key (arrayKey), other keys are ignored.
// The value must be of type array.
// Each array value can be fetched using 'NextRecord' (thread-safe).
// This technique solves the limit of memory size which may be too small to fit large JSON.
type ContentReader struct {
// filesPaths - source data file paths.
filesPaths []string
// arrayKey - Read the value of the specific object in JSON.
arrayKey string
// The objects from the source data file are being pushed into the data channel.
dataChannel chan map[string]interface{}
errorsQueue *utils.ErrorsQueue
once *sync.Once
// Number of elements in the array (cache)
length int
empty bool
}
func NewContentReader(filePath string, arrayKey string) *ContentReader {
self := NewMultiSourceContentReader([]string{filePath}, arrayKey)
self.empty = filePath == ""
return self
}
func NewMultiSourceContentReader(filePaths []string, arrayKey string) *ContentReader {
self := ContentReader{}
self.filesPaths = filePaths
self.arrayKey = arrayKey
self.dataChannel = make(chan map[string]interface{}, utils.MaxBufferSize)
self.errorsQueue = utils.NewErrorsQueue(utils.MaxBufferSize)
self.once = new(sync.Once)
self.empty = len(filePaths) == 0
return &self
}
func NewEmptyContentReader(arrayKey string) *ContentReader {
self := NewContentReader("", arrayKey)
return self
}
func (cr *ContentReader) IsEmpty() bool {
return cr.empty
}
// Each call to 'NextRecord()' will return a single element from the channel.
// Only the first call invokes a goroutine to read data from the file and push it into the channel.
// 'io.EOF' will be returned if no data is left.
func (cr *ContentReader) NextRecord(recordOutput interface{}) error {
if cr.empty {
return errorutils.CheckErrorf("Empty")
}
cr.once.Do(func() {
go func() {
defer close(cr.dataChannel)
cr.length = 0
cr.run()
}()
})
record, ok := <-cr.dataChannel
if !ok {
return io.EOF
}
// Transform the data into a Go type
err := ConvertToStruct(record, &recordOutput)
if err != nil {
cr.errorsQueue.AddError(err)
return err
}
cr.length++
return err
}
// Prepare the reader to read the file all over again (not thread-safe).
func (cr *ContentReader) Reset() {
cr.dataChannel = make(chan map[string]interface{}, utils.MaxBufferSize)
cr.once = new(sync.Once)
}
// Cleanup the reader data.
func (cr *ContentReader) Close() error {
for _, filePath := range cr.filesPaths {
if filePath == "" {
continue
}
if err := errorutils.CheckError(os.Remove(filePath)); err != nil {
return errors.New("Failed to close reader: " + err.Error())
}
}
cr.filesPaths = nil
return nil
}
func (cr *ContentReader) GetFilesPaths() []string {
return cr.filesPaths
}
// Number of element in the array.
func (cr *ContentReader) Length() (int, error) {
if cr.empty {
return 0, nil
}
if cr.length == 0 {
for item := new(interface{}); cr.NextRecord(item) == nil; item = new(interface{}) {
}
cr.Reset()
if err := cr.GetError(); err != nil {
return 0, err
}
}
return cr.length, nil
}
// Open and read the files one by one. Push each array element into the channel.
// The channel may block the thread, therefore should run async.
func (cr *ContentReader) run() {
for _, filePath := range cr.filesPaths {
cr.readSingleFile(filePath)
}
}
func (cr *ContentReader) readSingleFile(filePath string) {
fd, err := os.Open(filePath)
if err != nil {
log.Error(err.Error())
cr.errorsQueue.AddError(errorutils.CheckError(err))
return
}
defer func() {
err = fd.Close()
if err != nil {
log.Error(err.Error())
cr.errorsQueue.AddError(errorutils.CheckError(err))
}
}()
br := bufio.NewReaderSize(fd, 65536)
dec := json.NewDecoder(br)
err = findDecoderTargetPosition(dec, cr.arrayKey, true)
if err != nil {
if err == io.EOF {
cr.errorsQueue.AddError(errorutils.CheckErrorf(cr.arrayKey + " not found"))
return
}
cr.errorsQueue.AddError(err)
log.Error(err.Error())
return
}
for dec.More() {
var ResultItem map[string]interface{}
err := dec.Decode(&ResultItem)
if err != nil {
log.Error(err)
cr.errorsQueue.AddError(errorutils.CheckError(err))
return
}
cr.dataChannel <- ResultItem
}
}
func (cr *ContentReader) GetError() error {
return cr.errorsQueue.GetError()
}
// Search and set the decoder's position at the desired key in the JSON file.
// If the desired key is not found, return io.EOF
func findDecoderTargetPosition(dec *json.Decoder, target string, isArray bool) error {
for dec.More() {
// Token returns the next JSON token in the input stream.
t, err := dec.Token()
if err != nil {
return errorutils.CheckError(err)
}
if t == target {
if isArray {
// Skip '['
_, err = dec.Token()
}
return errorutils.CheckError(err)
}
}
return nil
}
func MergeReaders(arr []*ContentReader, arrayKey string) (contentReader *ContentReader, err error) {
cw, err := NewContentWriter(arrayKey, true, false)
if err != nil {
return nil, err
}
defer func() {
e := cw.Close()
if err == nil {
err = e
}
}()
for _, cr := range arr {
for item := new(interface{}); cr.NextRecord(item) == nil; item = new(interface{}) {
cw.Write(*item)
}
if err := cr.GetError(); err != nil {
return nil, err
}
}
contentReader = NewContentReader(cw.GetFilePath(), arrayKey)
return contentReader, nil
}
// Sort a content-reader in the required order (ascending or descending).
// Performs a merge-sort on the reader, splitting the reader to multiple readers of size 'utils.MaxBufferSize'.
// Sort each of the split readers, and merge them into a single sorted reader.
// In case of multiple items with the same key - all the items will appear in the sorted reader, but their order is not guaranteed to be preserved.
func SortContentReader(readerRecord SortableContentItem, reader *ContentReader, ascendingOrder bool) (*ContentReader, error) {
getSortKeyFunc := func(record interface{}) (string, error) {
// Get the expected record type from the reader.
recordType := reflect.ValueOf(readerRecord).Type()
recordItem := (reflect.New(recordType)).Interface()
err := ConvertToStruct(record, &recordItem)
if err != nil {
return "", err
}
contentItem, ok := recordItem.(SortableContentItem)
if !ok {
return "", errorutils.CheckErrorf("attempting to sort a content-reader with unsortable items")
}
return contentItem.GetSortKey(), nil
}
return SortContentReaderByCalculatedKey(reader, getSortKeyFunc, ascendingOrder)
}
type keyCalculationFunc func(interface{}) (string, error)
type SortRecord struct {
Key string `json:"key,omitempty"`
Record interface{} `json:"record,omitempty"`
}
func (sr SortRecord) GetSortKey() string {
return sr.Key
}
// Sort a ContentReader, according to a key generated by getKeyFunc.
// getKeyFunc gets an item from the reader and returns the key of the item.
// Attention! In case of multiple items with the same key - only the first item in the original reader will appear in the sorted one! The other items will be removed.
// Also pay attention that the order of the fields inside the objects might change.
func SortContentReaderByCalculatedKey(reader *ContentReader, getKeyFunc keyCalculationFunc, ascendingOrder bool) (contentReader *ContentReader, err error) {
var sortedReaders []*ContentReader
defer func() {
for _, r := range sortedReaders {
e := r.Close()
if err == nil {
err = e
}
}
}()
// Split reader to multiple sorted readers of size 'utils.MaxBufferSize'.
sortedReaders, err = splitReaderToSortedBufferSizeReadersByCalculatedKey(reader, getKeyFunc, ascendingOrder)
if err != nil {
return nil, err
}
// Merge the sorted readers.
return mergeSortedReadersByCalculatedKey(sortedReaders, ascendingOrder)
}
// Split the reader to multiple readers of size 'utils.MaxBufferSize' to prevent memory overflow.
// Sort each split-reader content according to the provided 'ascendingOrder'.
func splitReaderToSortedBufferSizeReadersByCalculatedKey(reader *ContentReader, getKeyFunc keyCalculationFunc, ascendingOrder bool) ([]*ContentReader, error) {
var splitReaders []*ContentReader
// Split and sort.
keysToContentItems := make(map[string]SortableContentItem)
allKeys := make([]string, 0, utils.MaxBufferSize)
for newRecord := new(interface{}); reader.NextRecord(newRecord) == nil; newRecord = new(interface{}) {
sortKey, err := getKeyFunc(newRecord)
if err != nil {
return nil, err
}
if _, exist := keysToContentItems[sortKey]; !exist {
recordWrapper := &SortRecord{Key: sortKey, Record: newRecord}
keysToContentItems[sortKey] = recordWrapper
allKeys = append(allKeys, sortKey)
if len(allKeys) == utils.MaxBufferSize {
sortedFile, err := SortAndSaveBufferToFile(keysToContentItems, allKeys, ascendingOrder)
if err != nil {
return nil, err
}
splitReaders = append(splitReaders, sortedFile)
keysToContentItems = make(map[string]SortableContentItem)
allKeys = make([]string, 0, utils.MaxBufferSize)
}
}
}
if err := reader.GetError(); err != nil {
return nil, err
}
reader.Reset()
if len(allKeys) > 0 {
sortedFile, err := SortAndSaveBufferToFile(keysToContentItems, allKeys, ascendingOrder)
if err != nil {
return nil, err
}
splitReaders = append(splitReaders, sortedFile)
}
return splitReaders, nil
}
func mergeSortedReadersByCalculatedKey(sortedReaders []*ContentReader, ascendingOrder bool) (contentReader *ContentReader, err error) {
if len(sortedReaders) == 0 {
contentReader = NewEmptyContentReader(DefaultKey)
return contentReader, nil
}
resultWriter, err := NewContentWriter(DefaultKey, true, false)
if err != nil {
return nil, err
}
defer func() {
e := resultWriter.Close()
if err == nil {
err = e
}
}()
currentContentItem := make([]*SortRecord, len(sortedReaders))
sortedFilesClone := make([]*ContentReader, len(sortedReaders))
copy(sortedFilesClone, sortedReaders)
for {
var candidateToWrite *SortRecord
smallestIndex := 0
for i := 0; i < len(sortedFilesClone); i++ {
if currentContentItem[i] == nil && sortedFilesClone[i] != nil {
record := new(SortRecord)
if err := sortedFilesClone[i].NextRecord(record); nil != err {
sortedFilesClone[i] = nil
continue
}
currentContentItem[i] = record
}
var candidateKey, currentKey string
if candidateToWrite != nil && currentContentItem[i] != nil {
candidateKey = candidateToWrite.Key
currentKey = currentContentItem[i].Key
// If there are two items with the same key - the second one will be removed
if candidateKey == currentKey {
currentContentItem[i] = nil
}
}
if candidateToWrite == nil || (currentContentItem[i] != nil && compareStrings(candidateKey, currentKey, ascendingOrder)) {
candidateToWrite = currentContentItem[i]
smallestIndex = i
}
}
if candidateToWrite == nil {
break
}
resultWriter.Write(candidateToWrite.Record)
currentContentItem[smallestIndex] = nil
}
contentReader = NewContentReader(resultWriter.GetFilePath(), resultWriter.GetArrayKey())
return contentReader, nil
}
// Merge a slice of sorted content-readers into a single sorted content-reader.
func MergeSortedReaders(readerRecord SortableContentItem, sortedReaders []*ContentReader, ascendingOrder bool) (contentReader *ContentReader, err error) {
if len(sortedReaders) == 0 {
return NewEmptyContentReader(DefaultKey), nil
}
resultWriter, err := NewContentWriter(DefaultKey, true, false)
if err != nil {
return nil, err
}
defer func() {
e := resultWriter.Close()
if err == nil {
err = e
}
}()
// Get the expected record type from the reader.
value := reflect.ValueOf(readerRecord)
valueType := value.Type()
currentContentItem := make([]*SortableContentItem, len(sortedReaders))
sortedFilesClone := make([]*ContentReader, len(sortedReaders))
copy(sortedFilesClone, sortedReaders)
for {
var candidateToWrite *SortableContentItem
smallestIndex := 0
for i := 0; i < len(sortedFilesClone); i++ {
if currentContentItem[i] == nil && sortedFilesClone[i] != nil {
temp := (reflect.New(valueType)).Interface()
if err := sortedFilesClone[i].NextRecord(temp); nil != err {
sortedFilesClone[i] = nil
continue
}
// Expect to receive 'SortableContentItem'.
contentItem, ok := (temp).(SortableContentItem)
if !ok {
return nil, errorutils.CheckErrorf("Attempting to sort a content-reader with unsortable items.")
}
currentContentItem[i] = &contentItem
}
if candidateToWrite == nil || (currentContentItem[i] != nil && compareStrings((*candidateToWrite).GetSortKey(),
(*currentContentItem[i]).GetSortKey(), ascendingOrder)) {
candidateToWrite = currentContentItem[i]
smallestIndex = i
}
}
if candidateToWrite == nil {
break
}
resultWriter.Write(*candidateToWrite)
currentContentItem[smallestIndex] = nil
}
contentReader = NewContentReader(resultWriter.GetFilePath(), resultWriter.GetArrayKey())
return contentReader, nil
}
func compareStrings(src, against string, ascendingOrder bool) bool {
if ascendingOrder {
return src > against
}
return src < against
}
func SortAndSaveBufferToFile(keysToContentItems map[string]SortableContentItem, allKeys []string, increasingOrder bool) (contentReader *ContentReader, err error) {
if len(allKeys) == 0 {
return nil, nil
}
writer, err := NewContentWriter(DefaultKey, true, false)
if err != nil {
return nil, err
}
defer func() {
e := writer.Close()
if err == nil {
err = e
}
}()
if increasingOrder {
sort.Strings(allKeys)
} else {
sort.Sort(sort.Reverse(sort.StringSlice(allKeys)))
}
for _, v := range allKeys {
writer.Write(keysToContentItems[v])
}
contentReader = NewContentReader(writer.GetFilePath(), writer.GetArrayKey())
return contentReader, nil
}
func ConvertToStruct(record, recordOutput interface{}) error {
data, err := json.Marshal(record)
if errorutils.CheckError(err) != nil {
return err
}
err = errorutils.CheckError(json.Unmarshal(data, recordOutput))
return err
}