puffin/
file_metadata.rs

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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
// Copyright 2023 Greptime Team
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use std::collections::HashMap;

use derive_builder::Builder;
use serde::{Deserialize, Serialize};

use crate::blob_metadata::BlobMetadata;

/// Metadata of a Puffin file
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, Builder)]
pub struct FileMetadata {
    /// Metadata for each blob in the file
    #[builder(default)]
    pub blobs: Vec<BlobMetadata>,

    /// Storage for arbitrary meta-information, like writer identification/version
    #[builder(default)]
    #[serde(default)]
    #[serde(skip_serializing_if = "HashMap::is_empty")]
    pub properties: HashMap<String, String>,
}

impl FileMetadata {
    /// Calculates the memory usage of the file metadata in bytes.
    pub fn memory_usage(&self) -> usize {
        self.blobs
            .iter()
            .map(|blob| blob.memory_usage())
            .sum::<usize>()
            + self
                .properties
                .iter()
                .map(|(k, v)| k.len() + v.len())
                .sum::<usize>()
            + std::mem::size_of::<Self>()
    }
}

#[cfg(test)]
mod tests {
    use std::collections::HashMap;

    use super::*;
    use crate::blob_metadata::BlobMetadataBuilder;

    #[test]
    fn test_file_metadata_builder() {
        let mut properties = HashMap::new();
        properties.insert(String::from("key1"), String::from("value1"));

        let blob_metadata = BlobMetadataBuilder::default()
            .blob_type("type1".to_string())
            .offset(10)
            .length(30)
            .build()
            .unwrap();

        let metadata = FileMetadataBuilder::default()
            .blobs(vec![blob_metadata.clone()])
            .properties(properties.clone())
            .build()
            .unwrap();

        assert_eq!(properties, metadata.properties);
        assert_eq!(vec![blob_metadata], metadata.blobs);
    }

    #[test]
    fn test_file_metadata_serialization() {
        let mut properties = HashMap::new();
        properties.insert(String::from("key1"), String::from("value1"));

        let blob_metadata = BlobMetadataBuilder::default()
            .blob_type("type1".to_string())
            .offset(10)
            .length(30)
            .build()
            .unwrap();

        let metadata = FileMetadataBuilder::default()
            .blobs(vec![blob_metadata.clone()])
            .properties(properties.clone())
            .build()
            .unwrap();

        let serialized = serde_json::to_string(&metadata).unwrap();
        assert_eq!(
            serialized,
            r#"{"blobs":[{"type":"type1","fields":[],"snapshot-id":0,"sequence-number":0,"offset":10,"length":30}],"properties":{"key1":"value1"}}"#
        );
    }

    #[test]
    fn test_file_metadata_deserialization() {
        let data = r#"{"blobs":[{"type":"type1","fields":[],"snapshot-id":0,"sequence-number":0,"offset":10,"length":30}],"properties":{"key1":"value1"}}"#;
        let deserialized: FileMetadata = serde_json::from_str(data).unwrap();

        assert_eq!(deserialized.blobs[0].blob_type, "type1");
        assert_eq!(deserialized.blobs[0].offset, 10);
        assert_eq!(deserialized.blobs[0].length, 30);
        assert_eq!(deserialized.properties.get("key1").unwrap(), "value1");
    }

    #[test]
    fn test_empty_properties_not_serialized() {
        let blob_metadata = BlobMetadataBuilder::default()
            .blob_type("type1".to_string())
            .offset(10)
            .length(30)
            .build()
            .unwrap();

        let metadata = FileMetadataBuilder::default()
            .blobs(vec![blob_metadata.clone()])
            .build()
            .unwrap();

        let serialized = serde_json::to_string(&metadata).unwrap();
        assert_eq!(
            serialized,
            r#"{"blobs":[{"type":"type1","fields":[],"snapshot-id":0,"sequence-number":0,"offset":10,"length":30}]}"#
        );
    }

    #[test]
    fn test_empty_blobs_serialization() {
        let metadata = FileMetadataBuilder::default()
            .blobs(vec![])
            .build()
            .unwrap();

        let serialized = serde_json::to_string(&metadata).unwrap();
        assert_eq!(serialized, r#"{"blobs":[]}"#);
    }

    #[test]
    fn test_missing_blobs_deserialization() {
        let data = r#"{"properties":{"key1":"value1"}}"#;
        let deserialized = serde_json::from_str::<FileMetadata>(data);

        assert!(deserialized
            .unwrap_err()
            .to_string()
            .contains("missing field `blobs`"));
    }
}