controller-server/src/main/java/com/yahoo/vespa/hosted/controller/persistence/ArchiveBucketsSerializer.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
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

// Copyright Yahoo. 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.config.provision.CloudAccount;
import com.yahoo.config.provision.TenantName;
import com.yahoo.slime.Cursor;
import com.yahoo.slime.Inspector;
import com.yahoo.slime.Slime;
import com.yahoo.slime.SlimeUtils;
import com.yahoo.vespa.hosted.controller.api.integration.archive.ArchiveBuckets;
import com.yahoo.vespa.hosted.controller.api.integration.archive.TenantManagedArchiveBucket;
import com.yahoo.vespa.hosted.controller.api.integration.archive.VespaManagedArchiveBucket;

import java.util.Set;
import java.util.stream.Collectors;

/**
 * (de)serializes tenant/bucket mappings for a zone
 *
 * @author andreer
 */
public class ArchiveBucketsSerializer {

    // 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 vespaManagedBucketsFieldName = "buckets";
    private final static String tenantManagedBucketsFieldName = "tenantManagedBuckets";
    private final static String bucketNameFieldName = "bucketName";
    private final static String keyArnFieldName = "keyArn";
    private final static String tenantsFieldName = "tenantIds";
    private final static String accountFieldName = "account";
    private final static String updatedAtFieldName = "updatedAt";

    public static Slime toSlime(ArchiveBuckets archiveBuckets) {
        Slime slime = new Slime();
        Cursor rootObject = slime.setObject();

        Cursor vespaBucketsArray = rootObject.setArray(vespaManagedBucketsFieldName);
        archiveBuckets.vespaManaged().forEach(bucket -> {
            Cursor cursor = vespaBucketsArray.addObject();
            cursor.setString(bucketNameFieldName, bucket.bucketName());
            cursor.setString(keyArnFieldName, bucket.keyArn());
            Cursor tenants = cursor.setArray(tenantsFieldName);
            bucket.tenants().forEach(tenantName -> tenants.addString(tenantName.value()));
        });

        Cursor tenantBucketsArray = rootObject.setArray(tenantManagedBucketsFieldName);
        archiveBuckets.tenantManaged().forEach(bucket -> {
            Cursor cursor = tenantBucketsArray.addObject();
            cursor.setString(bucketNameFieldName, bucket.bucketName());
            cursor.setString(accountFieldName, bucket.cloudAccount().value());
            cursor.setLong(updatedAtFieldName, bucket.updatedAt().toEpochMilli());
        });

        return slime;
    }

    public static ArchiveBuckets fromSlime(Slime slime) {
        Inspector inspector = slime.get();
        return new ArchiveBuckets(
                SlimeUtils.entriesStream(inspector.field(vespaManagedBucketsFieldName))
                        .map(ArchiveBucketsSerializer::vespaManagedArchiveBucketFromInspector)
                        .collect(Collectors.toUnmodifiableSet()),
                SlimeUtils.entriesStream(inspector.field(tenantManagedBucketsFieldName))
                        .map(ArchiveBucketsSerializer::tenantManagedArchiveBucketFromInspector)
                        .collect(Collectors.toUnmodifiableSet()));
    }

    private static VespaManagedArchiveBucket vespaManagedArchiveBucketFromInspector(Inspector inspector) {
        Set<TenantName> tenants = SlimeUtils.entriesStream(inspector.field(tenantsFieldName))
                .map(i -> TenantName.from(i.asString()))
                .collect(Collectors.toUnmodifiableSet());

        return new VespaManagedArchiveBucket(
                inspector.field(bucketNameFieldName).asString(),
                inspector.field(keyArnFieldName).asString())
                .withTenants(tenants);
    }

    private static TenantManagedArchiveBucket tenantManagedArchiveBucketFromInspector(Inspector inspector) {
        return new TenantManagedArchiveBucket(
                inspector.field(bucketNameFieldName).asString(),
                CloudAccount.from(inspector.field(accountFieldName).asString()),
                SlimeUtils.instant(inspector.field(updatedAtFieldName)));
    }
}