StorageProvider development

aquadoggo/Cargo.toml

@@ -23,6 +23,7 @@ bamboo-rs-core-ed25519-yasmf = "0.1.1"
 crossbeam-queue = "0.3.5"
 directories = "3.0.2"
 envy = "0.4.2"
+futures = "0.3.17"
 hex = "0.4.3"
 jsonrpc-v2 = { version = "0.10.1", features = [
     "easy-errors",
@@ -32,7 +33,8 @@ log = "0.4.14"
 openssl-probe = "0.1.4"
 # We can not publish the `aquadoggo` crate yet, since `p2panda-rs` is an
 # unpublished dependency.
-p2panda-rs = { git = "https://github.com/p2panda/p2panda", branch = "main" }
+# @TODO: This points at a WIP branch in p2panda_rs which is used as long as things are slightly unstable
+p2panda-rs = { git = "https://github.com/p2panda/p2panda", branch = "aquadoggo-wip" }
 rand = "0.8.4"
 serde = { version = "1.0.130", features = ["derive"] }
 serde_json = "1.0.67"
@@ -59,6 +61,7 @@ reqwest = { version = "0.11.9", default-features = false, features = [
     "json",
     "stream",
 ] }
+rstest = "0.12.0"
 tower-service = "0.3.1"
 hyper = "0.14.17"
 http = "0.2.6"

aquadoggo/migrations/20220424125654_create-operations.sql

@@ -0,0 +1,32 @@
+-- SPDX-License-Identifier: AGPL-3.0-or-later
+
+CREATE TABLE IF NOT EXISTS operations_v1 (
+    author              VARCHAR(64)       NOT NULL,
+    document_id         VARCHAR(64)       NOT NULL,
+    operation_id        VARCHAR(64)       NOT NULL UNIQUE,
+    entry_hash          VARCHAR(68)       NOT NULL UNIQUE,
+    action              VARCHAR(16)       NOT NULL,
+    schema_id           TEXT              NOT NULL,
+    previous_operations TEXT              NULL,
+    -- FOREIGN KEY(entry_hash) REFERENCES entries(entry_hash),
+    PRIMARY KEY (operation_id)
+);
+
+-- With the above "previous_operations" column in operations_v1 table we technically no longer need this 
+-- relation table. Can we remove it or are there reasons it's useful?
+CREATE TABLE IF NOT EXISTS previous_operations_v1 (
+    parent_operation_id    VARCHAR(64)       NOT NULL,
+    child_operation_id     VARCHAR(64)       NOT NULL,
+    FOREIGN KEY(parent_operation_id) REFERENCES operations_v1(operation_id)
+    FOREIGN KEY(child_operation_id)  REFERENCES operations_v1(operation_id)
+);
+
+CREATE TABLE IF NOT EXISTS operation_fields_v1 (
+    operation_id           VARCHAR(64)       NOT NULL,
+    name                   VARCHAR(128)      NOT NULL,
+    field_type             TEXT              NOT NULL,
+    value                  BLOB              NULL,
+    FOREIGN KEY(operation_id) REFERENCES operations_v1(operation_id)
+);
+
+CREATE INDEX idx_operation_fields_v1 ON operation_fields_v1 (operation_id, name);

aquadoggo/migrations/20220502013246_create-documents.sql

@@ -0,0 +1,21 @@
+-- SPDX-License-Identifier: AGPL-3.0-or-later
+
+CREATE TABLE IF NOT EXISTS document_view_fields (
+    document_view_id        VARCHAR(64)     NOT NULL,
+    operation_id            VARCHAR(64)     NOT NULL,
+    name                    VARCHAR(128)    NOT NULL
+);
+
+CREATE INDEX idx_document_view_fields ON document_view_fields (document_view_id, operation_id, name);
+
+CREATE TABLE IF NOT EXISTS document_views (
+    document_view_id            VARCHAR(64)     NOT NULL UNIQUE,
+    schema_id                   TEXT            NOT NULL,
+    PRIMARY KEY (document_view_id)
+);
+
+CREATE TABLE IF NOT EXISTS documents (
+    document_id                 VARCHAR(64)     NOT NULL UNIQUE,
+    document_view_id            VARCHAR(64)     NOT NULL,
+    PRIMARY KEY (document_id)
+);

aquadoggo/src/db/errors.rs

@@ -0,0 +1,17 @@
+// SPDX-License-Identifier: AGPL-3.0-or-later
+
+/// `OperationStore` errors.
+#[derive(thiserror::Error, Debug)]
+pub enum OperationStorageError {
+    /// Catch all error which implementers can use for passing their own errors up the chain.
+    #[error("Ahhhhh!!!!: {0}")]
+    Custom(String),
+}
+
+/// `DocumentStore` errors.
+#[derive(thiserror::Error, Debug)]
+pub enum DocumentViewStorageError {
+    /// Catch all error which implementers can use for passing their own errors up the chain.
+    #[error("Ahhhhh!!!!: {0}")]
+    Custom(String),
+}

aquadoggo/src/db/mod.rs

@@ -5,8 +5,12 @@ use sqlx::any::{Any, AnyPool, AnyPoolOptions};
 use sqlx::migrate;
 use sqlx::migrate::MigrateDatabase;
 
+pub mod errors;
 pub mod models;
-pub mod store;
+pub mod provider;
+pub mod stores;
+pub mod traits;
+pub mod utils;
 
 /// Re-export of generic connection pool type.
 pub type Pool = AnyPool;