mirror of
https://github.com/syncthing/syncthing.git
synced 2024-11-16 10:28:49 -07:00
c71116ee94
This PR does two things, because one lead to the other: - Move the leveldb specific stuff into a small "backend" package that defines a backend interface and the leveldb implementation. This allows, potentially, in the future, switching the db implementation so another KV store should we wish to do so. - Add proper error handling all along the way. The db and backend packages are now errcheck clean. However, I drew the line at modifying the FileSet API in order to keep this manageable and not continue refactoring all of the rest of Syncthing. As such, the FileSet methods still panic on database errors, except for the "database is closed" error which is instead handled by silently returning as quickly as possible, with the assumption that we're anyway "on the way out".
117 lines
3.2 KiB
Go
117 lines
3.2 KiB
Go
// Copyright (C) 2018 The Syncthing Authors.
|
|
//
|
|
// This Source Code Form is subject to the terms of the Mozilla Public
|
|
// License, v. 2.0. If a copy of the MPL was not distributed with this file,
|
|
// You can obtain one at https://mozilla.org/MPL/2.0/.
|
|
|
|
package db
|
|
|
|
import (
|
|
"encoding/json"
|
|
"io"
|
|
"os"
|
|
|
|
"github.com/syncthing/syncthing/lib/db/backend"
|
|
)
|
|
|
|
// writeJSONS serializes the database to a JSON stream that can be checked
|
|
// in to the repo and used for tests.
|
|
func writeJSONS(w io.Writer, db backend.Backend) {
|
|
it, err := db.NewPrefixIterator(nil)
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
defer it.Release()
|
|
enc := json.NewEncoder(w)
|
|
for it.Next() {
|
|
err := enc.Encode(map[string][]byte{
|
|
"k": it.Key(),
|
|
"v": it.Value(),
|
|
})
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
}
|
|
}
|
|
|
|
// we know this function isn't generally used, nonetheless we want it in
|
|
// here and the linter to not complain.
|
|
var _ = writeJSONS
|
|
|
|
// openJSONS reads a JSON stream file into a backend DB
|
|
func openJSONS(file string) (backend.Backend, error) {
|
|
fd, err := os.Open(file)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
dec := json.NewDecoder(fd)
|
|
|
|
db := backend.OpenMemory()
|
|
|
|
for {
|
|
var row map[string][]byte
|
|
|
|
err := dec.Decode(&row)
|
|
if err == io.EOF {
|
|
break
|
|
} else if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
if err := db.Put(row["k"], row["v"]); err != nil {
|
|
return nil, err
|
|
}
|
|
}
|
|
|
|
return db, nil
|
|
}
|
|
|
|
// The following commented tests were used to generate jsons files to stdout for
|
|
// future tests and are kept here for reference (reuse).
|
|
|
|
// TestGenerateIgnoredFilesDB generates a database with files with invalid flags,
|
|
// local and remote, in the format used in 0.14.48.
|
|
// func TestGenerateIgnoredFilesDB(t *testing.T) {
|
|
// db := OpenMemory()
|
|
// fs := NewFileSet("test", fs.NewFilesystem(fs.FilesystemTypeBasic, "."), db)
|
|
// fs.Update(protocol.LocalDeviceID, []protocol.FileInfo{
|
|
// { // invalid (ignored) file
|
|
// Name: "foo",
|
|
// Type: protocol.FileInfoTypeFile,
|
|
// Invalid: true,
|
|
// Version: protocol.Vector{Counters: []protocol.Counter{{ID: 1, Value: 1000}}},
|
|
// },
|
|
// { // regular file
|
|
// Name: "bar",
|
|
// Type: protocol.FileInfoTypeFile,
|
|
// Version: protocol.Vector{Counters: []protocol.Counter{{ID: 1, Value: 1001}}},
|
|
// },
|
|
// })
|
|
// fs.Update(protocol.DeviceID{42}, []protocol.FileInfo{
|
|
// { // invalid file
|
|
// Name: "baz",
|
|
// Type: protocol.FileInfoTypeFile,
|
|
// Invalid: true,
|
|
// Version: protocol.Vector{Counters: []protocol.Counter{{ID: 42, Value: 1000}}},
|
|
// },
|
|
// { // regular file
|
|
// Name: "quux",
|
|
// Type: protocol.FileInfoTypeFile,
|
|
// Version: protocol.Vector{Counters: []protocol.Counter{{ID: 42, Value: 1002}}},
|
|
// },
|
|
// })
|
|
// writeJSONS(os.Stdout, db.DB)
|
|
// }
|
|
|
|
// TestGenerateUpdate0to3DB generates a database with files with invalid flags, prefixed
|
|
// by a slash and other files to test database migration from version 0 to 3, in the
|
|
// format used in 0.14.45.
|
|
// func TestGenerateUpdate0to3DB(t *testing.T) {
|
|
// db := OpenMemory()
|
|
// fs := NewFileSet(update0to3Folder, fs.NewFilesystem(fs.FilesystemTypeBasic, "."), db)
|
|
// for devID, files := range haveUpdate0to3 {
|
|
// fs.Update(devID, files)
|
|
// }
|
|
// writeJSONS(os.Stdout, db.DB)
|
|
// }
|