summaryrefslogtreecommitdiffstats
path: root/controller-server/src/main/java/com/yahoo/vespa/hosted/controller/persistence/VersionStatusSerializer.java
blob: 366e2c9af4b83ee13fa0948a4c8878439a8c96cc (plain) (blame)
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
// Copyright 2019 Oath Inc. 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.config.provision.ApplicationId;
import com.yahoo.slime.ArrayTraverser;
import com.yahoo.slime.Cursor;
import com.yahoo.slime.Inspector;
import com.yahoo.slime.Slime;
import com.yahoo.vespa.hosted.controller.versions.DeploymentStatistics;
import com.yahoo.vespa.hosted.controller.versions.NodeVersions;
import com.yahoo.vespa.hosted.controller.versions.VersionStatus;
import com.yahoo.vespa.hosted.controller.versions.VespaVersion;

import java.time.Instant;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;

/**
 * Serializer for {@link VersionStatus}.
 *
 * @author mpolden
 */
public class VersionStatusSerializer {

    // 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.

    // VersionStatus fields
    private static final String versionsField = "versions";

    // VespaVersion fields
    private static final String releaseCommitField = "releaseCommit";
    private static final String committedAtField = "releasedAt";
    private static final String isControllerVersionField = "isCurrentControllerVersion";
    private static final String isSystemVersionField = "isCurrentSystemVersion";
    private static final String isReleasedField = "isReleased";
    private static final String deploymentStatisticsField = "deploymentStatistics";
    private static final String confidenceField = "confidence";
    private static final String configServersField = "configServerHostnames";

    // NodeVersions fields
    private static final String nodeVersionsField = "nodeVersions";

    // DeploymentStatistics fields
    private static final String versionField = "version";
    private static final String failingField = "failing";
    private static final String productionField = "production";
    private static final String deployingField = "deploying";

    private final NodeVersionSerializer nodeVersionSerializer;

    public VersionStatusSerializer(NodeVersionSerializer nodeVersionSerializer) {
        this.nodeVersionSerializer = Objects.requireNonNull(nodeVersionSerializer, "nodeVersionSerializer must be non-null");
    }

    public Slime toSlime(VersionStatus status) {
        Slime slime = new Slime();
        Cursor root = slime.setObject();
        versionsToSlime(status.versions(), root.setArray(versionsField));
        return slime;
    }

    public VersionStatus fromSlime(Slime slime) {
        Inspector root = slime.get();
        return new VersionStatus(vespaVersionsFromSlime(root.field(versionsField)));
    }

    private void versionsToSlime(List<VespaVersion> versions, Cursor array) {
        versions.forEach(version -> vespaVersionToSlime(version, array.addObject()));
    }

    private void vespaVersionToSlime(VespaVersion version, Cursor object) {
        object.setString(releaseCommitField, version.releaseCommit());
        object.setLong(committedAtField, version.committedAt().toEpochMilli());
        object.setBool(isControllerVersionField, version.isControllerVersion());
        object.setBool(isSystemVersionField, version.isSystemVersion());
        object.setBool(isReleasedField, version.isReleased());
        deploymentStatisticsToSlime(version.statistics(), object.setObject(deploymentStatisticsField));
        object.setString(confidenceField, version.confidence().name());
        nodeVersionsToSlime(version.nodeVersions(), object.setArray(nodeVersionsField));
    }

    private void nodeVersionsToSlime(NodeVersions nodeVersions, Cursor array) {
        nodeVersionSerializer.nodeVersionsToSlime(nodeVersions, array);
    }

    private void deploymentStatisticsToSlime(DeploymentStatistics statistics, Cursor object) {
        object.setString(versionField, statistics.version().toString());
        applicationsToSlime(statistics.failing(), object.setArray(failingField));
        applicationsToSlime(statistics.production(), object.setArray(productionField));
        applicationsToSlime(statistics.deploying(), object.setArray(deployingField));
    }

    private void applicationsToSlime(Collection<ApplicationId> applications, Cursor array) {
        applications.forEach(application -> array.addString(application.serializedForm()));
    }

    private List<VespaVersion> vespaVersionsFromSlime(Inspector array) {
        List<VespaVersion> versions = new ArrayList<>();
        array.traverse((ArrayTraverser) (i, object) -> versions.add(vespaVersionFromSlime(object)));
        return Collections.unmodifiableList(versions);
    }

    private VespaVersion vespaVersionFromSlime(Inspector object) {
        var deploymentStatistics = deploymentStatisticsFromSlime(object.field(deploymentStatisticsField));
        return new VespaVersion(deploymentStatistics,
                                object.field(releaseCommitField).asString(),
                                Instant.ofEpochMilli(object.field(committedAtField).asLong()),
                                object.field(isControllerVersionField).asBool(),
                                object.field(isSystemVersionField).asBool(),
                                object.field(isReleasedField).asBool(),
                                nodeVersionSerializer.nodeVersionsFromSlime(object.field(nodeVersionsField), deploymentStatistics.version()),
                                VespaVersion.Confidence.valueOf(object.field(confidenceField).asString())
        );
    }

    private DeploymentStatistics deploymentStatisticsFromSlime(Inspector object) {
        return new DeploymentStatistics(Version.fromString(object.field(versionField).asString()),
                                        applicationsFromSlime(object.field(failingField)),
                                        applicationsFromSlime(object.field(productionField)),
                                        applicationsFromSlime(object.field(deployingField)));
    }

    private List<ApplicationId> applicationsFromSlime(Inspector array) {
        List<ApplicationId> applications = new ArrayList<>();
        array.traverse((ArrayTraverser) (i, entry) -> applications.add(
                ApplicationId.fromSerializedForm(entry.asString()))
        );
        return Collections.unmodifiableList(applications);
    }

}