Merge pull request #1359 from AppFlowy-IO/add-folder-view

feat: add endpoint to create view without collab

Author: khorshuheng

libs/client-api/src/http_view.rs

@@ -1,7 +1,8 @@
 use client_api_entity::workspace_dto::{
-  AddRecentPagesParams, AppendBlockToPageParams, CreatePageDatabaseViewParams, CreatePageParams,
-  CreateSpaceParams, DuplicatePageParams, FavoritePageParams, MovePageParams, Page, PageCollab,
-  PublishPageParams, Space, UpdatePageParams, UpdateSpaceParams,
+  AddRecentPagesParams, AppendBlockToPageParams, CreateFolderViewParams,
+  CreatePageDatabaseViewParams, CreatePageParams, CreateSpaceParams, DuplicatePageParams,
+  FavoritePageParams, MovePageParams, Page, PageCollab, PublishPageParams, Space, UpdatePageParams,
+  UpdateSpaceParams,
 };
 use reqwest::Method;
 use serde_json::json;
@@ -11,6 +12,24 @@ use uuid::Uuid;
 use crate::{process_response_data, process_response_error, Client};
 
 impl Client {
+  pub async fn create_folder_view(
+    &self,
+    workspace_id: Uuid,
+    params: &CreateFolderViewParams,
+  ) -> Result<Page, AppResponseError> {
+    let url = format!(
+      "{}/api/workspace/{}/folder-view",
+      self.base_url, workspace_id,
+    );
+    let resp = self
+      .http_client_with_auth(Method::POST, &url)
+      .await?
+      .json(params)
+      .send()
+      .await?;
+    process_response_data::<Page>(resp).await
+  }
+
   pub async fn create_workspace_page_view(
     &self,
     workspace_id: Uuid,

libs/shared-entity/src/dto/workspace_dto.rs

@@ -154,6 +154,15 @@ pub struct CollabResponse {
   pub object_id: Uuid,
 }
 
+/// Create a view in the folder, without an associated collab
+#[derive(Debug, Clone, Serialize, Deserialize)]
+pub struct CreateFolderViewParams {
+  pub parent_view_id: Uuid,
+  pub layout: ViewLayout,
+  pub name: Option<String>,
+  pub view_id: Option<Uuid>,
+}
+
 #[derive(Debug, Clone, Serialize, Deserialize)]
 pub struct Space {
   pub view_id: Uuid,

src/api/workspace.rs

@@ -18,10 +18,11 @@ use crate::biz::workspace::ops::{
   get_reactions_on_published_view, remove_comment_on_published_view, remove_reaction_on_comment,
 };
 use crate::biz::workspace::page_view::{
-  add_recent_pages, append_block_at_the_end_of_page, create_database_view, create_page,
-  create_space, delete_all_pages_from_trash, delete_trash, favorite_page, get_page_view_collab,
-  move_page, move_page_to_trash, publish_page, reorder_favorite_page, restore_all_pages_from_trash,
-  restore_page_from_trash, unpublish_page, update_page, update_page_collab_data, update_space,
+  add_recent_pages, append_block_at_the_end_of_page, create_database_view, create_folder_view,
+  create_page, create_space, delete_all_pages_from_trash, delete_trash, favorite_page,
+  get_page_view_collab, move_page, move_page_to_trash, publish_page, reorder_favorite_page,
+  restore_all_pages_from_trash, restore_page_from_trash, unpublish_page, update_page,
+  update_page_collab_data, update_space,
 };
 use crate::biz::workspace::publish::get_workspace_default_publish_view_info_meta;
 use crate::biz::workspace::quick_note::{
@@ -184,6 +185,9 @@ pub fn workspace_scope() -> Scope {
     .service(
       web::resource("/{workspace_id}/space/{view_id}").route(web::patch().to(update_space_handler)),
     )
+    .service(
+      web::resource("/{workspace_id}/folder-view").route(web::post().to(post_folder_view_handler)),
+    )
     .service(
       web::resource("/{workspace_id}/page-view").route(web::post().to(post_page_view_handler)),
     )
@@ -1253,6 +1257,32 @@ async fn update_space_handler(
   Ok(Json(AppResponse::Ok()))
 }
 
+async fn post_folder_view_handler(
+  user_uuid: UserUuid,
+  path: web::Path<Uuid>,
+  payload: Json<CreateFolderViewParams>,
+  state: Data<AppState>,
+  server: Data<RealtimeServerAddr>,
+  req: HttpRequest,
+) -> Result<Json<AppResponse<Page>>> {
+  let uid = state.user_cache.get_user_uid(&user_uuid).await?;
+  let workspace_uuid = path.into_inner();
+  let user = realtime_user_for_web_request(req.headers(), uid)?;
+  let page = create_folder_view(
+    &state.metrics.appflowy_web_metrics,
+    server,
+    user,
+    &state.collab_access_control_storage,
+    workspace_uuid,
+    &payload.parent_view_id,
+    payload.layout.clone(),
+    payload.name.as_deref(),
+    payload.view_id,
+  )
+  .await?;
+  Ok(Json(AppResponse::Ok().with_data(page)))
+}
+
 async fn post_page_view_handler(
   user_uuid: UserUuid,
   path: web::Path<Uuid>,

src/biz/workspace/page_view.rs

@@ -160,6 +160,42 @@ pub async fn create_space(
   Ok(Space { view_id })
 }
 
+// Different from create page as this function does not create an associated collab
+#[allow(clippy::too_many_arguments)]
+pub async fn create_folder_view(
+  appflowy_web_metrics: &AppFlowyWebMetrics,
+  server: Data<RealtimeServerAddr>,
+  user: RealtimeUser,
+  collab_storage: &CollabAccessControlStorage,
+  workspace_id: Uuid,
+  parent_view_id: &Uuid,
+  view_layout: ViewLayout,
+  name: Option<&str>,
+  view_id: Option<Uuid>,
+) -> Result<Page, AppError> {
+  let view_id = view_id.unwrap_or_else(Uuid::new_v4);
+  let collab_origin = GetCollabOrigin::User { uid: user.uid };
+  let mut folder = get_latest_collab_folder(collab_storage, collab_origin, workspace_id).await?;
+  let folder_update = add_new_view_to_folder(
+    user.uid,
+    parent_view_id,
+    &view_id,
+    &mut folder,
+    name,
+    to_folder_view_layout(view_layout),
+  )
+  .await?;
+  update_workspace_folder_data(
+    appflowy_web_metrics,
+    server,
+    user,
+    workspace_id,
+    folder_update,
+  )
+  .await?;
+  Ok(Page { view_id })
+}
+
 #[allow(clippy::too_many_arguments)]
 pub async fn create_page(
   appflowy_web_metrics: &AppFlowyWebMetrics,

tests/workspace/page_view.rs

@@ -9,9 +9,10 @@ use collab_entity::CollabType;
 use collab_folder::{CollabOrigin, Folder};
 use serde_json::{json, Value};
 use shared_entity::dto::workspace_dto::{
-  AddRecentPagesParams, AppendBlockToPageParams, CreatePageDatabaseViewParams, CreatePageParams,
-  CreateSpaceParams, DuplicatePageParams, FavoritePageParams, IconType, MovePageParams,
-  PublishPageParams, SpacePermission, UpdatePageParams, UpdateSpaceParams, ViewIcon, ViewLayout,
+  AddRecentPagesParams, AppendBlockToPageParams, CreateFolderViewParams,
+  CreatePageDatabaseViewParams, CreatePageParams, CreateSpaceParams, DuplicatePageParams,
+  FavoritePageParams, IconType, MovePageParams, PublishPageParams, SpacePermission,
+  UpdatePageParams, UpdateSpaceParams, ViewIcon, ViewLayout,
 };
 use tokio::time::sleep;
 use uuid::Uuid;
@@ -157,6 +158,51 @@ async fn create_new_page_with_database() {
   }
 }
 
+#[tokio::test]
+async fn create_new_folder_view() {
+  let (c, _user) = generate_unique_registered_user_client().await;
+  let workspaces = c.get_workspaces().await.unwrap();
+  assert_eq!(workspaces.len(), 1);
+  let workspace_id = workspaces[0].workspace_id;
+  let folder_view = c
+    .get_workspace_folder(&workspace_id, Some(2), None)
+    .await
+    .unwrap();
+  let general_space = &folder_view
+    .children
+    .into_iter()
+    .find(|v| v.name == "General")
+    .unwrap();
+  let page = c
+    .create_folder_view(
+      workspace_id,
+      &CreateFolderViewParams {
+        parent_view_id: general_space.view_id,
+        layout: ViewLayout::Document,
+        name: Some("New document".to_string()),
+        view_id: None,
+      },
+    )
+    .await
+    .unwrap();
+  sleep(Duration::from_secs(1)).await;
+  let folder_view = c
+    .get_workspace_folder(&workspace_id, Some(2), None)
+    .await
+    .unwrap();
+  let general_space = &folder_view
+    .children
+    .into_iter()
+    .find(|v| v.name == "General")
+    .unwrap();
+  let view = general_space
+    .children
+    .iter()
+    .find(|v| v.view_id == page.view_id)
+    .unwrap();
+  assert_eq!(view.name, "New document");
+}
+
 #[tokio::test]
 async fn create_new_document_page() {
   let (c, _user) = generate_unique_registered_user_client().await;