garage/src/model/object_table.rs

use async_trait::async_trait;
use serde::{Deserialize, Serialize};
use std::sync::Arc;

use garage_util::background::BackgroundRunner;
use garage_util::data::*;
use garage_util::error::Error;

use garage_table::table_sharded::*;
use garage_table::*;

use crate::version_table::*;

use model010::object_table as prev;

#[derive(PartialEq, Clone, Debug, Serialize, Deserialize)]
pub struct Object {
	// Primary key
	pub bucket: String,

	// Sort key
	pub key: String,

	// Data
	versions: Vec<ObjectVersion>,
}

impl Object {
	pub fn new(bucket: String, key: String, versions: Vec<ObjectVersion>) -> Self {
		let mut ret = Self {
			bucket,
			key,
			versions: vec![],
		};
		for v in versions {
			ret.add_version(v)
				.expect("Twice the same ObjectVersion in Object constructor");
		}
		ret
	}
	/// Adds a version if it wasn't already present
	pub fn add_version(&mut self, new: ObjectVersion) -> Result<(), ()> {
		match self
			.versions
			.binary_search_by(|v| v.cmp_key().cmp(&new.cmp_key()))
		{
			Err(i) => {
				self.versions.insert(i, new);
				Ok(())
			}
			Ok(_) => Err(()),
		}
	}
	pub fn versions(&self) -> &[ObjectVersion] {
		&self.versions[..]
	}
}

#[derive(PartialEq, Clone, Debug, Serialize, Deserialize)]
pub struct ObjectVersion {
	pub uuid: UUID,
	pub timestamp: u64,

	pub state: ObjectVersionState,
}

#[derive(PartialEq, Clone, Debug, Serialize, Deserialize)]
pub enum ObjectVersionState {
	Uploading,
	Complete(ObjectVersionData),
	Aborted,
}

impl ObjectVersionState {
	fn merge(&mut self, other: &Self) {
		use ObjectVersionState::*;
        match other {
            Aborted => {
                *self = Aborted;
            }
            Complete(b) => {
                match self {
                    Aborted => {},
                    Complete(a) => {
                        a.merge(b);
                    }
                    Uploading => {
                        *self = Complete(b.clone());
                    }
                }
            }
            Uploading => {}
        }
	}
}

#[derive(PartialEq, Clone, Debug, Serialize, Deserialize)]
pub enum ObjectVersionData {
	DeleteMarker,
	Inline(ObjectVersionMeta, #[serde(with = "serde_bytes")] Vec<u8>),
	FirstBlock(ObjectVersionMeta, Hash),
}

#[derive(PartialEq, Clone, Debug, Serialize, Deserialize)]
pub struct ObjectVersionMeta {
	pub mime_type: String,
	pub size: u64,
    pub etag: String,
}

impl ObjectVersionData {
    fn merge(&mut self, b: &Self) {
        if *self != *b {
            warn!("Inconsistent object version data: {:?} (local) vs {:?} (remote)", self, b);
        }
    }
}

impl ObjectVersion {
	fn cmp_key(&self) -> (u64, UUID) {
		(self.timestamp, self.uuid)
	}
	pub fn is_complete(&self) -> bool {
        match self.state {
            ObjectVersionState::Complete(_) => true,
            _ => false,
        }
	}
	pub fn is_data(&self) -> bool {
        match self.state {
            ObjectVersionState::Complete(ObjectVersionData::DeleteMarker) => false,
            ObjectVersionState::Complete(_) => true,
            _ => false,
        }
	}
}

impl Entry<String, String> for Object {
	fn partition_key(&self) -> &String {
		&self.bucket
	}
	fn sort_key(&self) -> &String {
		&self.key
	}

	fn merge(&mut self, other: &Self) {
		for other_v in other.versions.iter() {
			match self
				.versions
				.binary_search_by(|v| v.cmp_key().cmp(&other_v.cmp_key()))
			{
				Ok(i) => {
                    self.versions[i].state.merge(&other_v.state);
				}
				Err(i) => {
					self.versions.insert(i, other_v.clone());
				}
			}
		}
		let last_complete = self
			.versions
			.iter()
			.enumerate()
			.rev()
			.filter(|(_, v)| v.is_complete())
			.next()
			.map(|(vi, _)| vi);

		if let Some(last_vi) = last_complete {
			self.versions = self.versions.drain(last_vi..).collect::<Vec<_>>();
		}
	}
}

pub struct ObjectTable {
	pub background: Arc<BackgroundRunner>,
	pub version_table: Arc<Table<VersionTable, TableShardedReplication>>,
}

#[async_trait]
impl TableSchema for ObjectTable {
	type P = String;
	type S = String;
	type E = Object;
	type Filter = ();

	async fn updated(&self, old: Option<Self::E>, new: Option<Self::E>) -> Result<(), Error> {
		let version_table = self.version_table.clone();
		if let (Some(old_v), Some(new_v)) = (old, new) {
			// Propagate deletion of old versions
			for v in old_v.versions.iter() {
				let newly_deleted = match new_v
					.versions
					.binary_search_by(|nv| nv.cmp_key().cmp(&v.cmp_key()))
				{
					Err(_) => true,
					Ok(i) => {
						new_v.versions[i].state == ObjectVersionState::Aborted
							&& v.state != ObjectVersionState::Aborted
					}
				};
				if newly_deleted {
					let deleted_version = Version::new(
						v.uuid,
						old_v.bucket.clone(),
						old_v.key.clone(),
						true,
						vec![],
					);
					version_table.insert(&deleted_version).await?;
				}
			}
		}
		Ok(())
	}

	fn matches_filter(entry: &Self::E, _filter: &Self::Filter) -> bool {
		entry.versions.iter().any(|v| v.is_data())
	}

    fn try_migrate(bytes: &[u8]) -> Option<Self::E> {
        let old = match rmp_serde::decode::from_read_ref::<_, prev::Object>(bytes) {
            Ok(x) => x,
            Err(_) => return None,
        };
        let new_v = old.versions().iter()
            .map(migrate_version)
            .collect::<Vec<_>>();
        let new = Object::new(old.bucket.clone(), old.key.clone(), new_v);
        Some(new)
    }
}

fn migrate_version(old: &prev::ObjectVersion) -> ObjectVersion {
    let meta = ObjectVersionMeta{
        size: old.size,
        mime_type: old.mime_type.clone(),
        etag: "".to_string(),
    };
    let state = match old.state {
        prev::ObjectVersionState::Uploading => ObjectVersionState::Uploading,
        prev::ObjectVersionState::Aborted => ObjectVersionState::Aborted,
        prev::ObjectVersionState::Complete => {
            match &old.data {
                prev::ObjectVersionData::Uploading => ObjectVersionState::Uploading,
                prev::ObjectVersionData::DeleteMarker => ObjectVersionState::Complete(ObjectVersionData::DeleteMarker),
                prev::ObjectVersionData::Inline(x) => ObjectVersionState::Complete(ObjectVersionData::Inline(meta, x.clone())),
                prev::ObjectVersionData::FirstBlock(h) => {
                    let mut hash = [0u8; 32];
                    hash.copy_from_slice(h.as_ref());
                    ObjectVersionState::Complete(ObjectVersionData::FirstBlock(meta, Hash::from(hash)))
                }
            }
        }
    };
    let mut uuid = [0u8; 32];
    uuid.copy_from_slice(old.uuid.as_ref());
    ObjectVersion{
        uuid: UUID::from(uuid),
        timestamp: old.timestamp,
        state,
    }
}