-
Notifications
You must be signed in to change notification settings - Fork 11
/
migrate.go
197 lines (165 loc) · 4.3 KB
/
migrate.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
// Package scmigrate implements a migration for SeenCommit data
// between 0.34 and 0.35
//
// The Migrate implementation is idempotent and finds all seen commit
// records and deletes all *except* the record corresponding to the
// highest height.
package scmigrate
import (
"bytes"
"context"
"errors"
"fmt"
"sort"
"github.com/gogo/protobuf/proto"
"github.com/google/orderedcode"
dbm "github.com/tendermint/tm-db"
tmproto "github.com/dashpay/tenderdash/proto/tendermint/types"
"github.com/dashpay/tenderdash/types"
)
type toMigrate struct {
key []byte
commit *types.Commit
}
const prefixSeenCommit = int64(3)
func makeKeyFromPrefix(ids ...int64) []byte {
vals := make([]interface{}, len(ids))
for idx := range ids {
vals[idx] = ids[idx]
}
key, err := orderedcode.Append(nil, vals...)
if err != nil {
panic(err)
}
return key
}
func makeToMigrate(val []byte) (*types.Commit, error) {
if len(val) == 0 {
return nil, errors.New("empty value")
}
var pbc = new(tmproto.Commit)
if err := proto.Unmarshal(val, pbc); err != nil {
return nil, fmt.Errorf("error reading block seen commit: %w", err)
}
commit, err := types.CommitFromProto(pbc)
if commit == nil {
// theoretically we should error for all errors, but
// there's no reason to keep junk data in the
// database, and it makes testing easier.
if err != nil {
return nil, fmt.Errorf("error from proto commit: %w", err)
}
return nil, fmt.Errorf("missing commit")
}
return commit, nil
}
func sortMigrations(scData []toMigrate) {
// put this in it's own function just to make it testable
sort.SliceStable(scData, func(i, j int) bool {
return scData[i].commit.Height > scData[j].commit.Height
})
}
func getAllSeenCommits(ctx context.Context, db dbm.DB) ([]toMigrate, error) {
scKeyPrefix := makeKeyFromPrefix(prefixSeenCommit)
iter, err := db.Iterator(
scKeyPrefix,
makeKeyFromPrefix(prefixSeenCommit+1),
)
if err != nil {
return nil, err
}
scData := []toMigrate{}
for ; iter.Valid(); iter.Next() {
if err := ctx.Err(); err != nil {
return nil, err
}
k := iter.Key()
nk := make([]byte, len(k))
copy(nk, k)
if !bytes.HasPrefix(nk, scKeyPrefix) {
break
}
commit, err := makeToMigrate(iter.Value())
if err != nil {
return nil, err
}
scData = append(scData, toMigrate{
key: nk,
commit: commit,
})
}
if err := iter.Error(); err != nil {
return nil, err
}
if err := iter.Close(); err != nil {
return nil, err
}
return scData, nil
}
func renameRecord(db dbm.DB, keep toMigrate) error {
wantKey := makeKeyFromPrefix(prefixSeenCommit)
if bytes.Equal(keep.key, wantKey) {
return nil // we already did this conversion
}
// This record's key has already been converted to the "new" format, we just
// now need to trim off the tail.
val, err := db.Get(keep.key)
if err != nil {
return err
}
batch := db.NewBatch()
if err := batch.Delete(keep.key); err != nil {
return err
}
if err := batch.Set(wantKey, val); err != nil {
return err
}
werr := batch.Write()
cerr := batch.Close()
if werr != nil {
return werr
}
return cerr
}
func deleteRecords(db dbm.DB, scData []toMigrate) error {
// delete all the remaining stale values in a single batch
batch := db.NewBatch()
for _, mg := range scData {
if err := batch.Delete(mg.key); err != nil {
return err
}
}
if err := batch.WriteSync(); err != nil {
return err
}
if err := batch.Close(); err != nil {
return err
}
return nil
}
func Migrate(ctx context.Context, db dbm.DB) error {
scData, err := getAllSeenCommits(ctx, db)
if err != nil {
return fmt.Errorf("sourcing tasks to migrate: %w", err)
} else if len(scData) == 0 {
return nil // nothing to do
}
// Sort commits in decreasing order of height.
sortMigrations(scData)
// Keep and rename the newest seen commit, delete the rest.
// In TM < v0.35 we kept a last-seen commit for each height; in v0.35 we
// retain only the latest.
keep, remove := scData[0], scData[1:]
if err := renameRecord(db, keep); err != nil {
return fmt.Errorf("renaming seen commit record: %w", err)
}
if len(remove) == 0 {
return nil
}
// Remove any older seen commits. Prior to v0.35, we kept these records for
// all heights, but v0.35 keeps only the latest.
if err := deleteRecords(db, remove); err != nil {
return fmt.Errorf("writing data: %w", err)
}
return nil
}