controller-server/src/main/java/com/yahoo/vespa/hosted/controller/persistence/ConfidenceOverrideSerializer.java


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

// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.vespa.hosted.controller.persistence;

import com.yahoo.component.Version;
import com.yahoo.slime.Cursor;
import com.yahoo.slime.ObjectTraverser;
import com.yahoo.slime.Slime;
import com.yahoo.vespa.hosted.controller.versions.VespaVersion.Confidence;

import java.util.Collections;
import java.util.LinkedHashMap;
import java.util.Map;

/**
 * Serializer for {@link Confidence} overrides.
 *
 * @author mpolden
 */
public class ConfidenceOverrideSerializer {

    // WARNING: Since there are multiple servers in a ZooKeeper cluster and they upgrade one by one
    //          (and rewrite all nodes on startup), changes to the serialized format must be made
    //          such that what is serialized on version N+1 can be read by version N:
    //          - ADDING FIELDS: Always ok
    //          - REMOVING FIELDS: Stop reading the field first. Stop writing it on a later version.
    //          - CHANGING THE FORMAT OF A FIELD: Don't do it bro.

    private final static String overridesField = "overrides";

    public Slime toSlime(Map<Version, Confidence> overrides) {
        Slime slime = new Slime();
        Cursor root = slime.setObject();
        Cursor object = root.setObject(overridesField);
        overrides.forEach((version, confidence) -> object.setString(version.toString(), confidence.name()));
        return slime;
    }

    public Map<Version, Confidence> fromSlime(Slime slime) {
        Cursor root = slime.get();
        Cursor overridesObject = root.field(overridesField);
        Map<Version, Confidence> overrides = new LinkedHashMap<>();
        overridesObject.traverse((ObjectTraverser) (name, value) -> {
            overrides.put(Version.fromString(name), Confidence.valueOf(value.asString()));
        });
        return Collections.unmodifiableMap(overrides);
    }

}