From 380d3f4a7c36622931e7d90f81ff48e7be3ca373 Mon Sep 17 00:00:00 2001 From: "Elf M. Sternberg" Date: Sun, 11 Oct 2020 12:14:44 -0700 Subject: [PATCH] FEAT: It is now theoretically possible to add a nested note. --- server/nm-store/src/row_structs.rs | 123 ++++----- server/nm-store/src/store.rs | 401 +++++++++++++++++------------ 2 files changed, 306 insertions(+), 218 deletions(-) diff --git a/server/nm-store/src/row_structs.rs b/server/nm-store/src/row_structs.rs index d4eb467..ac5a7a3 100644 --- a/server/nm-store/src/row_structs.rs +++ b/server/nm-store/src/row_structs.rs @@ -5,87 +5,92 @@ use sqlx::{self, FromRow}; #[derive(Clone, Serialize, Deserialize, Debug, FromRow)] pub struct RawPage { - pub id: i64, - pub slug: String, - pub title: String, - pub note_id: i64, - pub creation_date: DateTime, - pub updated_date: DateTime, - pub lastview_date: DateTime, - pub deleted_date: Option>, + pub id: i64, + pub slug: String, + pub title: String, + pub note_id: i64, + pub creation_date: DateTime, + pub updated_date: DateTime, + pub lastview_date: DateTime, + pub deleted_date: Option>, } #[derive(Clone, Serialize, Deserialize, Debug, FromRow)] pub struct RawNote { - pub id: i64, - pub uuid: String, - pub parent_id: i64, - pub parent_uuid: String, - pub content: String, - pub position: i64, - pub notetype: String, - pub creation_date: DateTime, - pub updated_date: DateTime, - pub lastview_date: DateTime, - pub deleted_date: Option>, + pub id: i64, + pub uuid: String, + pub parent_id: i64, + pub parent_uuid: String, + pub content: String, + pub position: i64, + pub notetype: String, + pub creation_date: DateTime, + pub updated_date: DateTime, + pub lastview_date: DateTime, + pub deleted_date: Option>, } #[derive(Clone, Serialize, Deserialize, Debug, Builder)] pub struct NewPage { - pub slug: String, - pub title: String, - pub note_id: i64, - #[builder(default = r#"chrono::Utc::now()"#)] - pub creation_date: DateTime, - #[builder(default = r#"chrono::Utc::now()"#)] - pub updated_date: DateTime, - #[builder(default = r#"chrono::Utc::now()"#)] - pub lastview_date: DateTime, - #[builder(default = r#"None"#)] - pub deleted_date: Option>, + pub slug: String, + pub title: String, + pub note_id: i64, + #[builder(default = r#"chrono::Utc::now()"#)] + pub creation_date: DateTime, + #[builder(default = r#"chrono::Utc::now()"#)] + pub updated_date: DateTime, + #[builder(default = r#"chrono::Utc::now()"#)] + pub lastview_date: DateTime, + #[builder(default = r#"None"#)] + pub deleted_date: Option>, } #[derive(Clone, Serialize, Deserialize, Debug, Builder)] pub struct NewNote { - pub uuid: String, - pub content: String, - #[builder(default = r#""note".to_string()"#)] - pub notetype: String, - #[builder(default = r#"chrono::Utc::now()"#)] - pub creation_date: DateTime, - #[builder(default = r#"chrono::Utc::now()"#)] - pub updated_date: DateTime, - #[builder(default = r#"chrono::Utc::now()"#)] - pub lastview_date: DateTime, - #[builder(default = r#"None"#)] - pub deleted_date: Option>, + pub uuid: String, + pub content: String, + #[builder(default = r#""note".to_string()"#)] + pub notetype: String, + #[builder(default = r#"chrono::Utc::now()"#)] + pub creation_date: DateTime, + #[builder(default = r#"chrono::Utc::now()"#)] + pub updated_date: DateTime, + #[builder(default = r#"chrono::Utc::now()"#)] + pub lastview_date: DateTime, + #[builder(default = r#"None"#)] + pub deleted_date: Option>, } #[derive(Clone, Serialize, Deserialize, Debug, FromRow)] pub(crate) struct JustSlugs { - pub slug: String, + pub slug: String, } #[derive(Clone, Serialize, Deserialize, Debug, FromRow)] -pub struct JustTitles { - title: String, +pub(crate) struct JustTitles { + title: String, +} + +#[derive(Clone, Serialize, Deserialize, Debug, FromRow)] +pub(crate) struct JustId { + pub id: i64, } #[cfg(test)] mod tests { - use super::*; + use super::*; - #[test] - fn can_build_new_note() { - let now = chrono::Utc::now(); - let newnote = NewNoteBuilder::default() - .uuid("foo".to_string()) - .content("bar".to_string()) - .build() - .unwrap(); - assert!((newnote.creation_date - now).num_minutes() < 1); - assert!((newnote.updated_date - now).num_minutes() < 1); - assert!((newnote.lastview_date - now).num_minutes() < 1); - assert!(newnote.deleted_date.is_none()); - } + #[test] + fn can_build_new_note() { + let now = chrono::Utc::now(); + let newnote = NewNoteBuilder::default() + .uuid("foo".to_string()) + .content("bar".to_string()) + .build() + .unwrap(); + assert!((newnote.creation_date - now).num_minutes() < 1); + assert!((newnote.updated_date - now).num_minutes() < 1); + assert!((newnote.lastview_date - now).num_minutes() < 1); + assert!(newnote.deleted_date.is_none()); + } } diff --git a/server/nm-store/src/store.rs b/server/nm-store/src/store.rs index 96c7c6b..b68bd31 100644 --- a/server/nm-store/src/store.rs +++ b/server/nm-store/src/store.rs @@ -1,13 +1,15 @@ use crate::errors::NoteStoreError; -use crate::row_structs::{JustSlugs, NewNote, NewNoteBuilder, NewPage, NewPageBuilder, RawNote, RawPage}; +use crate::row_structs::{ + JustId, JustSlugs, NewNote, NewNoteBuilder, NewPage, NewPageBuilder, RawNote, RawPage, +}; use friendly_id; use lazy_static::lazy_static; use regex::Regex; use slug::slugify; use sqlx; use sqlx::{ - sqlite::{Sqlite, SqlitePool}, - Executor, + sqlite::{Sqlite, SqlitePool}, + Executor, }; use std::sync::Arc; @@ -19,51 +21,56 @@ type NoteResult = core::result::Result; type SqlResult = sqlx::Result; impl NoteStore { - pub async fn new(url: &str) -> NoteResult { - let pool = SqlitePool::connect(url).await?; - Ok(NoteStore(Arc::new(pool))) - } + pub async fn new(url: &str) -> NoteResult { + let pool = SqlitePool::connect(url).await?; + Ok(NoteStore(Arc::new(pool))) + } - // Erase all the data in the database and restore it - // to its original empty form. Do not use unless you - // really, really want that to happen. - pub async fn reset_database(&self) -> NoteResult<()> { - reset_database(&*self.0).await.map_err(NoteStoreError::DBError) - } + // Erase all the data in the database and restore it + // to its original empty form. Do not use unless you + // really, really want that to happen. + pub async fn reset_database(&self) -> NoteResult<()> { + reset_database(&*self.0) + .await + .map_err(NoteStoreError::DBError) + } - /// Fetch page by slug - /// - /// Supports the use case of the user navigating to a known place - /// via a bookmark or other URL. Since the title isn't clear from - /// the slug, the slug is insufficient to generate a new page, so - /// this use case says that in the event of a failure to find the - /// requested page, return a basic NotFound. - pub async fn get_page_by_slug(&self, slug: &str) -> NoteResult<(RawPage, Vec)> { - // let select_note_collection_for_root = include_str!("sql/select_note_collection_for_root.sql"); - let mut tx = self.0.begin().await?; - let page = select_page_by_slug(&mut tx, slug).await?; - // let notes = sqlx::query_as(select_note_collection_for_root) - // .bind(page.note_id) - // .fetch(&tx) - // .await?; - tx.commit().await?; - Ok((page, vec![])) - } + /// Fetch page by slug + /// + /// Supports the use case of the user navigating to a known place + /// via a bookmark or other URL. Since the title isn't clear from + /// the slug, the slug is insufficient to generate a new page, so + /// this use case says that in the event of a failure to find the + /// requested page, return a basic NotFound. + pub async fn get_page_by_slug(&self, slug: &str) -> NoteResult<(RawPage, Vec)> { + // let select_note_collection_for_root = include_str!("sql/select_note_collection_for_root.sql"); + let mut tx = self.0.begin().await?; + let page = select_page_by_slug(&mut tx, slug).await?; + // let notes = sqlx::query_as(select_note_collection_for_root) + // .bind(page.note_id) + // .fetch(&tx) + // .await?; + tx.commit().await?; + Ok((page, vec![])) + } - /// Fetch page by title - /// - /// Supports the use case of the user navigating to a page via - /// the page's formal title. Since the title is the key reference - /// of the system, if no page with that title is found, a page with - /// that title is generated automatically. - pub async fn get_page_by_title(&self, title: &str) -> NoteResult<(RawPage, Vec)> { - let mut tx = self.0.begin().await?; - let (page, notes) = match select_page_by_title(&mut tx, title).await { - Ok(page) => { + /// Fetch page by title + /// + /// Supports the use case of the user navigating to a page via + /// the page's formal title. Since the title is the key reference + /// of the system, if no page with that title is found, a page with + /// that title is generated automatically. + pub async fn get_page_by_title(&self, title: &str) -> NoteResult<(RawPage, Vec)> { + let mut tx = self.0.begin().await?; + let (page, notes) = match select_page_by_title(&mut tx, title).await { + Ok(page) => { let note_id = page.note_id; - (page, select_note_collection_from_root(&mut tx, note_id).await?) + ( + page, + select_note_collection_from_root(&mut tx, note_id).await?, + ) } - Err(sqlx::Error::RowNotFound) => { + Err(sqlx::Error::RowNotFound) => { let page = { let new_root_note = create_unique_root_note(); let new_root_note_id = insert_one_new_note(&mut tx, &new_root_note).await?; @@ -73,14 +80,33 @@ impl NoteStore { select_page_by_title(&mut tx, &title).await? }; let note_id = page.note_id; - (page, select_note_collection_from_root(&mut tx, note_id).await?) - }, - Err(e) => return Err(NoteStoreError::DBError(e)), - }; - // Todo: Replace vec with the results of the CTE + ( + page, + select_note_collection_from_root(&mut tx, note_id).await?, + ) + } + Err(e) => return Err(NoteStoreError::DBError(e)), + }; tx.commit().await?; - return Ok((page, notes)); - } + Ok((page, notes)) + } + + pub async fn insert_nested_note( + &self, + note: NewNote, + parent_note_uuid: &str, + position: i32, + ) -> NoteResult { + let mut new_note = note.clone(); + new_note.uuid = friendly_id::create(); + let mut tx = self.0.begin().await?; + let parent_id = select_note_id_for_uuid(&mut tx, parent_note_uuid).await?; + let new_note_id = insert_one_new_note(&mut tx, &new_note).await?; + let _ = make_room_for_new_note(&mut tx, parent_id, position).await?; + let _ = insert_note_note_relationship(&mut tx, parent_id, new_note_id, position).await?; + tx.commit().await?; + Ok(new_note.uuid) + } } // ___ _ _ @@ -96,94 +122,152 @@ impl NoteStore { async fn reset_database<'a, E>(executor: E) -> SqlResult<()> where - E: Executor<'a, Database = Sqlite> + E: Executor<'a, Database = Sqlite>, { - let initialize_sql = include_str!("sql/initialize_database.sql"); - sqlx::query(initialize_sql).execute(executor).await.map(|_| ()) + let initialize_sql = include_str!("sql/initialize_database.sql"); + sqlx::query(initialize_sql) + .execute(executor) + .await + .map(|_| ()) } async fn select_page_by_slug<'a, E>(executor: E, slug: &str) -> SqlResult where - E: Executor<'a, Database = Sqlite> + E: Executor<'a, Database = Sqlite>, { - let select_one_page_by_slug_sql = concat!( - "SELECT id, title, slug, note_id, creation_date, updated_date, ", - "lastview_date, deleted_date FROM pages WHERE slug=?;" - ); - Ok(sqlx::query_as(&select_one_page_by_slug_sql) - .bind(&slug) - .fetch_one(executor) - .await?) + let select_one_page_by_slug_sql = concat!( + "SELECT id, title, slug, note_id, creation_date, updated_date, ", + "lastview_date, deleted_date FROM pages WHERE slug=?;" + ); + Ok(sqlx::query_as(&select_one_page_by_slug_sql) + .bind(&slug) + .fetch_one(executor) + .await?) } async fn select_page_by_title<'a, E>(executor: E, title: &str) -> SqlResult where - E: Executor<'a, Database = Sqlite>, + E: Executor<'a, Database = Sqlite>, { - let select_one_page_by_title_sql = concat!( - "SELECT id, title, slug, note_id, creation_date, updated_date, ", - "lastview_date, deleted_date FROM pages WHERE title=?;" - ); - Ok(sqlx::query_as(&select_one_page_by_title_sql) - .bind(&title) - .fetch_one(executor) - .await?) + let select_one_page_by_title_sql = concat!( + "SELECT id, title, slug, note_id, creation_date, updated_date, ", + "lastview_date, deleted_date FROM pages WHERE title=?;" + ); + Ok(sqlx::query_as(&select_one_page_by_title_sql) + .bind(&title) + .fetch_one(executor) + .await?) +} + +async fn select_note_id_for_uuid<'a, E>(executor: E, uuid: &str) -> SqlResult +where + E: Executor<'a, Database = Sqlite>, +{ + let select_note_id_for_uuid_sql = "SELECT id FROM notes WHERE uuid = ?"; + let id: JustId = sqlx::query_as(&select_note_id_for_uuid_sql) + .bind(&uuid) + .fetch_one(executor) + .await?; + Ok(id.id) +} + +async fn make_room_for_new_note<'a, E>(executor: E, parent_id: i64, position: i32) -> SqlResult<()> +where + E: Executor<'a, Database = Sqlite>, +{ + let make_room_for_new_note_sql = concat!( + "UPDATE note_relationships ", + "SET position = position + 1 ", + "WHERE position >= ? and parent_id = ?;" + ); + + sqlx::query(make_room_for_new_note_sql) + .bind(&position) + .bind(&parent_id) + .execute(executor) + .await + .map(|_| ()) +} + +async fn insert_note_note_relationship<'a, E>( + executor: E, + parent_id: i64, + note_id: i64, + position: i32, +) -> SqlResult<()> +where + E: Executor<'a, Database = Sqlite>, +{ + let insert_note_note_relationship_sql = concat!( + "INSERT INTO note_relationships (parent_id, note_id, position, nature) ", + "values (?, ?, ?, ?)" + ); + + sqlx::query(insert_note_note_relationship_sql) + .bind(&parent_id) + .bind(¬e_id) + .bind(&position) + .bind("note") + .execute(executor) + .await + .map(|_| ()) } async fn select_note_collection_from_root<'a, E>(executor: E, root: i64) -> SqlResult> where - E: Executor<'a, Database = Sqlite>, + E: Executor<'a, Database = Sqlite>, { - let select_note_collection_from_root_sql = include_str!("sql/select_note_collection_from_root.sql"); - Ok(sqlx::query_as(&select_note_collection_from_root_sql) - .bind(&root) - .fetch_all(executor) - .await?) + let select_note_collection_from_root_sql = + include_str!("sql/select_note_collection_from_root.sql"); + Ok(sqlx::query_as(&select_note_collection_from_root_sql) + .bind(&root) + .fetch_all(executor) + .await?) } async fn insert_one_new_note<'a, E>(executor: E, note: &NewNote) -> SqlResult where - E: Executor<'a, Database = Sqlite>, + E: Executor<'a, Database = Sqlite>, { - let insert_one_note_sql = concat!( - "INSERT INTO notes ( ", - " uuid, ", - " content, ", - " notetype, ", - " creation_date, ", - " updated_date, ", - " lastview_date) ", - "VALUES (?, ?, ?, ?, ?, ?);" - ); + let insert_one_note_sql = concat!( + "INSERT INTO notes ( ", + " uuid, ", + " content, ", + " notetype, ", + " creation_date, ", + " updated_date, ", + " lastview_date) ", + "VALUES (?, ?, ?, ?, ?, ?);" + ); - Ok(sqlx::query(insert_one_note_sql) - .bind(¬e.uuid) - .bind(¬e.content) - .bind(¬e.notetype) - .bind(¬e.creation_date) - .bind(¬e.updated_date) - .bind(¬e.lastview_date) - .execute(executor) - .await? - .last_insert_rowid()) + Ok(sqlx::query(insert_one_note_sql) + .bind(¬e.uuid) + .bind(¬e.content) + .bind(¬e.notetype) + .bind(¬e.creation_date) + .bind(¬e.updated_date) + .bind(¬e.lastview_date) + .execute(executor) + .await? + .last_insert_rowid()) } fn find_maximal_slug(slugs: &Vec) -> Option { - lazy_static! { - static ref RE_CAP_NUM: Regex = Regex::new(r"-(\d+)$").unwrap(); - } + lazy_static! { + static ref RE_CAP_NUM: Regex = Regex::new(r"-(\d+)$").unwrap(); + } - if slugs.len() == 0 { - return None; - } + if slugs.len() == 0 { + return None; + } - let mut slug_counters: Vec = slugs - .iter() - .filter_map(|slug| RE_CAP_NUM.captures(&slug.slug)) - .map(|cap| cap.get(1).unwrap().as_str().parse::().unwrap()) - .collect(); - slug_counters.sort_unstable(); - slug_counters.pop() + let mut slug_counters: Vec = slugs + .iter() + .filter_map(|slug| RE_CAP_NUM.captures(&slug.slug)) + .map(|cap| cap.get(1).unwrap().as_str().parse::().unwrap()) + .collect(); + slug_counters.sort_unstable(); + slug_counters.pop() } // Given an initial string and an existing collection of slugs, @@ -191,68 +275,67 @@ fn find_maximal_slug(slugs: &Vec) -> Option { // collection. async fn generate_slug<'a, E>(executor: E, title: &str) -> SqlResult where - E: Executor<'a, Database = Sqlite> + E: Executor<'a, Database = Sqlite>, { - lazy_static! { - static ref RE_STRIP_NUM: Regex = Regex::new(r"-\d+$").unwrap(); - } + lazy_static! { + static ref RE_STRIP_NUM: Regex = Regex::new(r"-\d+$").unwrap(); + } - let initial_slug = slugify(title); - let sample_slug = RE_STRIP_NUM.replace_all(&initial_slug, ""); - let slug_finder_sql = "SELECT slug FROM pages WHERE slug LIKE '?%';"; - let similar_slugs: Vec = sqlx::query_as(&slug_finder_sql) - .bind(&*sample_slug) - .fetch_all(executor) - .await?; - let maximal_slug = find_maximal_slug(&similar_slugs); - match maximal_slug { - None => Ok(initial_slug), - Some(max_slug) => Ok(format!("{}-{}", initial_slug, max_slug + 1)), - } + let initial_slug = slugify(title); + let sample_slug = RE_STRIP_NUM.replace_all(&initial_slug, ""); + let slug_finder_sql = "SELECT slug FROM pages WHERE slug LIKE '?%';"; + let similar_slugs: Vec = sqlx::query_as(&slug_finder_sql) + .bind(&*sample_slug) + .fetch_all(executor) + .await?; + let maximal_slug = find_maximal_slug(&similar_slugs); + match maximal_slug { + None => Ok(initial_slug), + Some(max_slug) => Ok(format!("{}-{}", initial_slug, max_slug + 1)), + } } async fn insert_one_new_page<'a, E>(executor: E, page: &NewPage) -> SqlResult where - E: Executor<'a, Database = Sqlite>, + E: Executor<'a, Database = Sqlite>, { - let insert_one_page_sql = concat!( - "INSERT INTO pages ( ", - " slug, ", - " title, ", - " note_id, ", - " creation_date, ", - " updated_date, ", - " lastview_date) ", - "VALUES (?, ?, ?, ?, ?, ?);" - ); + let insert_one_page_sql = concat!( + "INSERT INTO pages ( ", + " slug, ", + " title, ", + " note_id, ", + " creation_date, ", + " updated_date, ", + " lastview_date) ", + "VALUES (?, ?, ?, ?, ?, ?);" + ); - Ok(sqlx::query(insert_one_page_sql) - .bind(&page.slug) - .bind(&page.title) - .bind(&page.note_id) - .bind(&page.creation_date) - .bind(&page.updated_date) - .bind(&page.lastview_date) - .execute(executor) - .await? - .last_insert_rowid()) + Ok(sqlx::query(insert_one_page_sql) + .bind(&page.slug) + .bind(&page.title) + .bind(&page.note_id) + .bind(&page.creation_date) + .bind(&page.updated_date) + .bind(&page.lastview_date) + .execute(executor) + .await? + .last_insert_rowid()) } fn create_unique_root_note() -> NewNote { NewNoteBuilder::default() - .uuid(friendly_id::create()) - .content("".to_string()) - .notetype("root".to_string()) - .build() - .unwrap() + .uuid(friendly_id::create()) + .content("".to_string()) + .notetype("root".to_string()) + .build() + .unwrap() } fn create_new_page_for(title: &str, slug: &str, note_id: i64) -> NewPage { NewPageBuilder::default() - .slug(slug.to_string()) - .title(title.to_string()) - .note_id(note_id) - .build() - .unwrap() + .slug(slug.to_string()) + .title(title.to_string()) + .note_id(note_id) + .build() + .unwrap() } -