2022-11-26 23:57:50 +00:00
|
|
|
// Copyright 2020 The Jujutsu Authors
|
2021-09-12 06:52:38 +00:00
|
|
|
//
|
|
|
|
// 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
|
|
|
|
//
|
|
|
|
// https://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::BTreeMap;
|
|
|
|
use std::fmt::{Debug, Error, Formatter};
|
|
|
|
use std::io::Read;
|
|
|
|
use std::result::Result;
|
|
|
|
use std::vec::Vec;
|
|
|
|
|
|
|
|
use thiserror::Error;
|
|
|
|
|
2022-11-12 19:19:03 +00:00
|
|
|
use crate::content_hash::ContentHash;
|
2021-09-12 06:52:38 +00:00
|
|
|
use crate::repo_path::{RepoPath, RepoPathComponent};
|
|
|
|
|
2023-01-01 03:24:32 +00:00
|
|
|
pub trait ObjectId {
|
|
|
|
fn new(value: Vec<u8>) -> Self;
|
|
|
|
fn object_type(&self) -> String;
|
|
|
|
fn from_bytes(bytes: &[u8]) -> Self;
|
|
|
|
fn as_bytes(&self) -> &[u8];
|
|
|
|
fn to_bytes(&self) -> Vec<u8>;
|
|
|
|
fn from_hex(hex: &str) -> Self;
|
|
|
|
fn hex(&self) -> String;
|
|
|
|
}
|
|
|
|
|
2022-12-21 12:00:07 +00:00
|
|
|
macro_rules! id_type {
|
|
|
|
($vis:vis $name:ident) => {
|
|
|
|
content_hash! {
|
|
|
|
#[derive(PartialEq, Eq, PartialOrd, Ord, Clone, Hash)]
|
|
|
|
$vis struct $name(Vec<u8>);
|
|
|
|
}
|
|
|
|
impl_id_type!($name);
|
|
|
|
};
|
|
|
|
}
|
|
|
|
|
2022-12-21 11:40:36 +00:00
|
|
|
macro_rules! impl_id_type {
|
|
|
|
($name:ident) => {
|
|
|
|
impl Debug for $name {
|
|
|
|
fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error> {
|
|
|
|
f.debug_tuple(stringify!($name)).field(&self.hex()).finish()
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2023-01-01 03:24:32 +00:00
|
|
|
impl crate::backend::ObjectId for $name {
|
|
|
|
fn new(value: Vec<u8>) -> Self {
|
2022-12-21 11:40:36 +00:00
|
|
|
Self(value)
|
|
|
|
}
|
|
|
|
|
2023-01-01 03:24:32 +00:00
|
|
|
fn object_type(&self) -> String {
|
|
|
|
stringify!($name)
|
|
|
|
.strip_suffix("Id")
|
|
|
|
.unwrap()
|
|
|
|
.to_ascii_lowercase()
|
|
|
|
.to_string()
|
|
|
|
}
|
|
|
|
|
|
|
|
fn from_bytes(bytes: &[u8]) -> Self {
|
2022-12-21 11:40:36 +00:00
|
|
|
Self(bytes.to_vec())
|
|
|
|
}
|
|
|
|
|
2023-01-01 03:24:32 +00:00
|
|
|
fn as_bytes(&self) -> &[u8] {
|
2022-12-21 11:40:36 +00:00
|
|
|
&self.0
|
|
|
|
}
|
|
|
|
|
2023-01-01 03:24:32 +00:00
|
|
|
fn to_bytes(&self) -> Vec<u8> {
|
2022-12-21 11:40:36 +00:00
|
|
|
self.0.clone()
|
|
|
|
}
|
|
|
|
|
2023-01-01 03:24:32 +00:00
|
|
|
fn from_hex(hex: &str) -> Self {
|
2022-12-21 11:40:36 +00:00
|
|
|
Self(hex::decode(hex).unwrap())
|
|
|
|
}
|
|
|
|
|
2023-01-01 03:24:32 +00:00
|
|
|
fn hex(&self) -> String {
|
2022-12-21 11:40:36 +00:00
|
|
|
hex::encode(&self.0)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
};
|
|
|
|
}
|
|
|
|
|
2022-12-21 12:00:07 +00:00
|
|
|
id_type!(pub CommitId);
|
|
|
|
id_type!(pub ChangeId);
|
|
|
|
id_type!(pub TreeId);
|
|
|
|
id_type!(pub FileId);
|
|
|
|
id_type!(pub SymlinkId);
|
|
|
|
id_type!(pub ConflictId);
|
2021-09-12 06:52:38 +00:00
|
|
|
|
|
|
|
pub enum Phase {
|
|
|
|
Public,
|
|
|
|
Draft,
|
|
|
|
}
|
|
|
|
|
2022-11-11 17:33:22 +00:00
|
|
|
content_hash! {
|
|
|
|
#[derive(Debug, PartialEq, Eq, Clone, PartialOrd, Ord)]
|
|
|
|
pub struct MillisSinceEpoch(pub i64);
|
|
|
|
}
|
2021-09-12 06:52:38 +00:00
|
|
|
|
2022-11-11 17:33:22 +00:00
|
|
|
content_hash! {
|
|
|
|
#[derive(Debug, PartialEq, Eq, Clone, PartialOrd, Ord)]
|
|
|
|
pub struct Timestamp {
|
|
|
|
pub timestamp: MillisSinceEpoch,
|
|
|
|
// time zone offset in minutes
|
|
|
|
pub tz_offset: i32,
|
|
|
|
}
|
2021-09-12 06:52:38 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
impl Timestamp {
|
|
|
|
pub fn now() -> Self {
|
2022-03-05 06:33:15 +00:00
|
|
|
Self::from_datetime(chrono::offset::Local::now())
|
|
|
|
}
|
|
|
|
|
|
|
|
pub fn from_datetime<Tz: chrono::TimeZone<Offset = chrono::offset::FixedOffset>>(
|
|
|
|
datetime: chrono::DateTime<Tz>,
|
|
|
|
) -> Self {
|
2021-09-12 06:52:38 +00:00
|
|
|
Self {
|
2022-09-30 04:29:45 +00:00
|
|
|
timestamp: MillisSinceEpoch(datetime.timestamp_millis()),
|
2022-03-05 06:33:15 +00:00
|
|
|
tz_offset: datetime.offset().local_minus_utc() / 60,
|
2021-09-12 06:52:38 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2022-11-12 19:19:03 +00:00
|
|
|
content_hash! {
|
|
|
|
#[derive(Debug, PartialEq, Eq, Clone)]
|
|
|
|
pub struct Signature {
|
|
|
|
pub name: String,
|
|
|
|
pub email: String,
|
|
|
|
pub timestamp: Timestamp,
|
|
|
|
}
|
2021-09-12 06:52:38 +00:00
|
|
|
}
|
|
|
|
|
2022-11-12 19:19:03 +00:00
|
|
|
content_hash! {
|
|
|
|
#[derive(Debug, Clone)]
|
|
|
|
pub struct Commit {
|
|
|
|
pub parents: Vec<CommitId>,
|
|
|
|
pub predecessors: Vec<CommitId>,
|
|
|
|
pub root_tree: TreeId,
|
|
|
|
pub change_id: ChangeId,
|
|
|
|
pub description: String,
|
|
|
|
pub author: Signature,
|
|
|
|
pub committer: Signature,
|
|
|
|
}
|
2021-09-12 06:52:38 +00:00
|
|
|
}
|
|
|
|
|
2022-11-12 19:19:03 +00:00
|
|
|
content_hash! {
|
|
|
|
#[derive(Debug, PartialEq, Eq, Clone)]
|
|
|
|
pub struct ConflictPart {
|
|
|
|
// TODO: Store e.g. CommitId here too? Labels (theirs/ours/base)? Would those still be
|
|
|
|
// useful e.g. after rebasing this conflict?
|
|
|
|
pub value: TreeValue,
|
|
|
|
}
|
2021-09-12 06:52:38 +00:00
|
|
|
}
|
|
|
|
|
2022-11-12 19:19:03 +00:00
|
|
|
content_hash! {
|
|
|
|
#[derive(Default, Debug, PartialEq, Eq, Clone)]
|
|
|
|
pub struct Conflict {
|
|
|
|
// A conflict is represented by a list of positive and negative states that need to be applied.
|
|
|
|
// In a simple 3-way merge of B and C with merge base A, the conflict will be { add: [B, C],
|
|
|
|
// remove: [A] }. Also note that a conflict of the form { add: [A], remove: [] } is the
|
|
|
|
// same as non-conflict A.
|
|
|
|
pub removes: Vec<ConflictPart>,
|
|
|
|
pub adds: Vec<ConflictPart>,
|
|
|
|
}
|
2021-09-12 06:52:38 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
#[derive(Debug, Error, PartialEq, Eq)]
|
|
|
|
pub enum BackendError {
|
2023-01-01 04:30:18 +00:00
|
|
|
#[error(
|
|
|
|
"Invalid hash for object of type {object_type}: {hash} (expected {expected} bytes, got \
|
|
|
|
{actual} bytes)"
|
|
|
|
)]
|
|
|
|
InvalidHashLength {
|
|
|
|
expected: usize,
|
|
|
|
actual: usize,
|
|
|
|
object_type: &'static str,
|
|
|
|
hash: String,
|
|
|
|
},
|
2021-09-12 06:52:38 +00:00
|
|
|
#[error("Object not found")]
|
|
|
|
NotFound,
|
|
|
|
#[error("Error: {0}")]
|
|
|
|
Other(String),
|
|
|
|
}
|
|
|
|
|
|
|
|
pub type BackendResult<T> = Result<T, BackendError>;
|
|
|
|
|
|
|
|
#[derive(Debug, PartialEq, Eq, Clone, Hash)]
|
|
|
|
pub enum TreeValue {
|
2022-11-14 21:27:18 +00:00
|
|
|
File { id: FileId, executable: bool },
|
2021-09-12 06:52:38 +00:00
|
|
|
Symlink(SymlinkId),
|
|
|
|
Tree(TreeId),
|
|
|
|
GitSubmodule(CommitId),
|
|
|
|
Conflict(ConflictId),
|
|
|
|
}
|
|
|
|
|
2022-11-12 19:19:03 +00:00
|
|
|
impl ContentHash for TreeValue {
|
|
|
|
fn hash(&self, state: &mut impl digest::Update) {
|
|
|
|
use TreeValue::*;
|
|
|
|
match *self {
|
2022-11-14 21:27:18 +00:00
|
|
|
File { ref id, executable } => {
|
2022-11-12 19:19:03 +00:00
|
|
|
state.update(&0u32.to_le_bytes());
|
|
|
|
id.hash(state);
|
|
|
|
executable.hash(state);
|
|
|
|
}
|
|
|
|
Symlink(ref id) => {
|
|
|
|
state.update(&1u32.to_le_bytes());
|
|
|
|
id.hash(state);
|
|
|
|
}
|
|
|
|
Tree(ref id) => {
|
|
|
|
state.update(&2u32.to_le_bytes());
|
|
|
|
id.hash(state);
|
|
|
|
}
|
|
|
|
GitSubmodule(ref id) => {
|
|
|
|
state.update(&3u32.to_le_bytes());
|
|
|
|
id.hash(state);
|
|
|
|
}
|
|
|
|
Conflict(ref id) => {
|
|
|
|
state.update(&4u32.to_le_bytes());
|
|
|
|
id.hash(state);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2021-09-12 06:52:38 +00:00
|
|
|
#[derive(Debug, PartialEq, Eq, Clone)]
|
|
|
|
pub struct TreeEntry<'a> {
|
|
|
|
name: &'a RepoPathComponent,
|
|
|
|
value: &'a TreeValue,
|
|
|
|
}
|
|
|
|
|
|
|
|
impl<'a> TreeEntry<'a> {
|
|
|
|
pub fn new(name: &'a RepoPathComponent, value: &'a TreeValue) -> Self {
|
|
|
|
TreeEntry { name, value }
|
|
|
|
}
|
|
|
|
|
|
|
|
pub fn name(&self) -> &'a RepoPathComponent {
|
|
|
|
self.name
|
|
|
|
}
|
|
|
|
|
|
|
|
pub fn value(&self) -> &'a TreeValue {
|
|
|
|
self.value
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2021-11-15 05:16:06 +00:00
|
|
|
pub struct TreeEntriesNonRecursiveIterator<'a> {
|
2021-09-12 06:52:38 +00:00
|
|
|
iter: std::collections::btree_map::Iter<'a, RepoPathComponent, TreeValue>,
|
|
|
|
}
|
|
|
|
|
2021-11-15 05:16:06 +00:00
|
|
|
impl<'a> Iterator for TreeEntriesNonRecursiveIterator<'a> {
|
2021-09-12 06:52:38 +00:00
|
|
|
type Item = TreeEntry<'a>;
|
|
|
|
|
|
|
|
fn next(&mut self) -> Option<Self::Item> {
|
|
|
|
self.iter
|
|
|
|
.next()
|
|
|
|
.map(|(name, value)| TreeEntry { name, value })
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2022-11-12 19:19:03 +00:00
|
|
|
content_hash! {
|
|
|
|
#[derive(Default, Debug, Clone)]
|
|
|
|
pub struct Tree {
|
|
|
|
entries: BTreeMap<RepoPathComponent, TreeValue>,
|
|
|
|
}
|
2021-09-12 06:52:38 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
impl Tree {
|
|
|
|
pub fn is_empty(&self) -> bool {
|
|
|
|
self.entries.is_empty()
|
|
|
|
}
|
|
|
|
|
2021-11-15 05:16:06 +00:00
|
|
|
pub fn entries(&self) -> TreeEntriesNonRecursiveIterator {
|
|
|
|
TreeEntriesNonRecursiveIterator {
|
2021-09-12 06:52:38 +00:00
|
|
|
iter: self.entries.iter(),
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
pub fn set(&mut self, name: RepoPathComponent, value: TreeValue) {
|
|
|
|
self.entries.insert(name, value);
|
|
|
|
}
|
|
|
|
|
|
|
|
pub fn remove(&mut self, name: &RepoPathComponent) {
|
|
|
|
self.entries.remove(name);
|
|
|
|
}
|
|
|
|
|
|
|
|
pub fn entry(&self, name: &RepoPathComponent) -> Option<TreeEntry> {
|
|
|
|
self.entries
|
|
|
|
.get_key_value(name)
|
|
|
|
.map(|(name, value)| TreeEntry { name, value })
|
|
|
|
}
|
|
|
|
|
|
|
|
pub fn value(&self, name: &RepoPathComponent) -> Option<&TreeValue> {
|
|
|
|
self.entries.get(name)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2022-09-19 00:33:39 +00:00
|
|
|
pub fn make_root_commit(empty_tree_id: TreeId) -> Commit {
|
|
|
|
let timestamp = Timestamp {
|
|
|
|
timestamp: MillisSinceEpoch(0),
|
|
|
|
tz_offset: 0,
|
|
|
|
};
|
|
|
|
let signature = Signature {
|
|
|
|
name: String::new(),
|
|
|
|
email: String::new(),
|
|
|
|
timestamp,
|
|
|
|
};
|
|
|
|
let change_id = ChangeId::new(vec![0; 16]);
|
|
|
|
Commit {
|
|
|
|
parents: vec![],
|
|
|
|
predecessors: vec![],
|
|
|
|
root_tree: empty_tree_id,
|
|
|
|
change_id,
|
|
|
|
description: String::new(),
|
|
|
|
author: signature.clone(),
|
|
|
|
committer: signature,
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2021-09-12 06:52:38 +00:00
|
|
|
pub trait Backend: Send + Sync + Debug {
|
2022-09-23 04:01:38 +00:00
|
|
|
/// A unique name that identifies this backend. Written to
|
|
|
|
/// `.jj/repo/store/backend` when the repo is created.
|
|
|
|
fn name(&self) -> &str;
|
|
|
|
|
2021-09-12 06:52:38 +00:00
|
|
|
fn hash_length(&self) -> usize;
|
|
|
|
|
|
|
|
fn git_repo(&self) -> Option<git2::Repository>;
|
|
|
|
|
|
|
|
fn read_file(&self, path: &RepoPath, id: &FileId) -> BackendResult<Box<dyn Read>>;
|
|
|
|
|
|
|
|
fn write_file(&self, path: &RepoPath, contents: &mut dyn Read) -> BackendResult<FileId>;
|
|
|
|
|
|
|
|
fn read_symlink(&self, path: &RepoPath, id: &SymlinkId) -> BackendResult<String>;
|
|
|
|
|
|
|
|
fn write_symlink(&self, path: &RepoPath, target: &str) -> BackendResult<SymlinkId>;
|
|
|
|
|
2022-09-19 00:33:39 +00:00
|
|
|
fn root_commit_id(&self) -> &CommitId;
|
|
|
|
|
2021-09-12 06:52:38 +00:00
|
|
|
fn empty_tree_id(&self) -> &TreeId;
|
|
|
|
|
|
|
|
fn read_tree(&self, path: &RepoPath, id: &TreeId) -> BackendResult<Tree>;
|
|
|
|
|
|
|
|
fn write_tree(&self, path: &RepoPath, contents: &Tree) -> BackendResult<TreeId>;
|
|
|
|
|
2022-03-31 16:21:50 +00:00
|
|
|
fn read_conflict(&self, path: &RepoPath, id: &ConflictId) -> BackendResult<Conflict>;
|
2021-09-12 06:52:38 +00:00
|
|
|
|
2022-03-31 16:21:50 +00:00
|
|
|
fn write_conflict(&self, path: &RepoPath, contents: &Conflict) -> BackendResult<ConflictId>;
|
2022-04-28 20:31:28 +00:00
|
|
|
|
|
|
|
fn read_commit(&self, id: &CommitId) -> BackendResult<Commit>;
|
|
|
|
|
|
|
|
fn write_commit(&self, contents: &Commit) -> BackendResult<CommitId>;
|
2021-09-12 06:52:38 +00:00
|
|
|
}
|