diff --git a/changelog/unreleased/issue-22092 b/changelog/unreleased/issue-22092 new file mode 100644 index 000000000..bd8358663 --- /dev/null +++ b/changelog/unreleased/issue-22092 @@ -0,0 +1,9 @@ +Bugfix: Read empty directories from older repaired snapshots + +Since restic 0.19.0, snapshots containing empty directories written by older +versions of `repair snapshots` could fail with `error decoding tree: expected +[, got `. Restic now accepts these empty directory trees again, allowing +`prune`, `check` and `restore` to process the affected snapshots. + +https://github.com/restic/restic/issues/22092 +https://github.com/restic/restic/pull/22117 diff --git a/internal/data/tree.go b/internal/data/tree.go index ed9b727ce..0bb8b06b8 100644 --- a/internal/data/tree.go +++ b/internal/data/tree.go @@ -25,8 +25,9 @@ import ( var ErrTreeNotOrdered = errors.New("nodes are not ordered or duplicate") type treeIterator struct { - dec json.Decoder - started bool + dec json.Decoder + started bool + nodesNull bool } type NodeOrError struct { @@ -87,10 +88,15 @@ func (t *treeIterator) init() error { return errors.Errorf("error decoding tree: expected string key, got %v", token) } if key == "nodes" { - // Found "nodes", proceed to read the array - if err := t.assertToken(json.Delim('[')); err != nil { + token, err := t.dec.Token() + if err != nil { return err } + if token != nil && token != json.Delim('[') { + return errors.Errorf("error decoding tree: expected [, got %v", token) + } + // A null node list encodes an empty tree in older repaired snapshots. + t.nodesNull = token == nil return nil } // Unknown key, decode its value into RawMessage and discard it @@ -102,17 +108,19 @@ func (t *treeIterator) init() error { } func (t *treeIterator) next() (*Node, error) { - if t.dec.More() { - var n Node - err := t.dec.Decode(&n) - if err != nil { + if !t.nodesNull { + if t.dec.More() { + var n Node + err := t.dec.Decode(&n) + if err != nil { + return nil, err + } + return &n, nil + } + + if err := t.assertToken(json.Delim(']')); err != nil { return nil, err } - return &n, nil - } - - if err := t.assertToken(json.Delim(']')); err != nil { - return nil, err } // Skip unknown keys after the array until we find the closing brace for { diff --git a/internal/data/tree_test.go b/internal/data/tree_test.go index b4bc6e20d..09656c45b 100644 --- a/internal/data/tree_test.go +++ b/internal/data/tree_test.go @@ -295,6 +295,42 @@ func TestTreeIteratorUnknownKeys(t *testing.T) { } } +func TestTreeIteratorNullNodes(t *testing.T) { + for _, tc := range []struct { + name string + input string + wantErr bool + }{ + {"null", `{"nodes":null}`, false}, + {"unknown key before", `{"extra":{"nested":[1,2]},"nodes":null}`, false}, + {"unknown key after", `{"nodes":null,"extra":{"nested":[1,2]}}`, false}, + {"unknown keys around", `{"before":true,"nodes":null,"after":[1,2]}`, false}, + {"boolean", `{"nodes":false}`, true}, + {"number", `{"nodes":0}`, true}, + {"string", `{"nodes":""}`, true}, + {"object", `{"nodes":{}}`, true}, + {"invalid trailing value", `{"nodes":null,"extra":]}`, true}, + } { + t.Run(tc.name, func(t *testing.T) { + it, err := data.NewTreeNodeIterator(strings.NewReader(tc.input)) + items := 0 + if err == nil { + for item := range it { + items++ + err = item.Error + rtest.Assert(t, item.Node == nil, "unexpected node: %v", item.Node) + } + } + if tc.wantErr { + rtest.Assert(t, err != nil, "expected invalid tree to fail") + } else { + rtest.OK(t, err) + rtest.Equals(t, 0, items) + } + }) + } +} + func BenchmarkLoadTree(t *testing.B) { repository.BenchmarkAllVersions(t, benchmarkLoadTree) }