chore: support import appflowy data into current workspace (#4254)

* chore: support import appflowy data into current workspace

* refactor: code

* chore: unused ref

* chore: update url

Author: appflowy

frontend/appflowy_flutter/lib/workspace/application/settings/setting_file_importer_bloc.dart

@@ -3,6 +3,7 @@ import 'package:appflowy_backend/log.dart';
 import 'package:appflowy_backend/protobuf/flowy-error/errors.pb.dart';
 import 'package:appflowy_backend/protobuf/flowy-folder2/import.pb.dart';
 import 'package:dartz/dartz.dart';
+import 'package:easy_localization/easy_localization.dart';
 import 'package:flutter_bloc/flutter_bloc.dart';
 import 'package:freezed_annotation/freezed_annotation.dart';
 
@@ -14,7 +15,11 @@ class SettingFileImporterBloc
     on<SettingFileImportEvent>((event, emit) async {
       await event.when(
         importAppFlowyDataFolder: (String path) async {
-          final payload = ImportAppFlowyDataPB.create()..path = path;
+          final formattedDate =
+              DateFormat('yyyy-MM-dd HH:mm:ss').format(DateTime.now());
+          final payload = ImportAppFlowyDataPB.create()
+            ..path = path
+            ..importContainerName = "appflowy_import_$formattedDate";
           final result =
               await FolderEventImportAppFlowyDataFolder(payload).send();
           result.fold(

frontend/appflowy_flutter/lib/workspace/presentation/settings/widgets/setting_file_import_appflowy_data_view.dart

@@ -2,12 +2,15 @@ import 'package:appflowy/generated/locale_keys.g.dart';
 import 'package:appflowy/startup/startup.dart';
 import 'package:appflowy/workspace/application/settings/setting_file_importer_bloc.dart';
 import 'package:appflowy/workspace/presentation/home/toast.dart';
+import 'package:appflowy_backend/log.dart';
 import 'package:easy_localization/easy_localization.dart';
 import 'package:flowy_infra/file_picker/file_picker_service.dart';
 import 'package:flowy_infra_ui/flowy_infra_ui.dart';
+import 'package:flutter/gestures.dart';
 import 'package:flutter/material.dart';
 import 'package:flutter_bloc/flutter_bloc.dart';
 import 'package:fluttertoast/fluttertoast.dart';
+import 'package:url_launcher/url_launcher.dart';
 
 class ImportAppFlowyData extends StatefulWidget {
   const ImportAppFlowyData({super.key});
@@ -46,20 +49,11 @@ class _ImportAppFlowyDataState extends State<ImportAppFlowyData> {
         },
         child: BlocBuilder<SettingFileImporterBloc, SettingFileImportState>(
           builder: (context, state) {
-            return Column(
+            return const Column(
               children: [
-                const ImportAppFlowyDataButton(),
-                const VSpace(6),
-                IntrinsicHeight(
-                  child: Opacity(
-                    opacity: 0.6,
-                    child: FlowyText.medium(
-                      LocaleKeys.settings_menu_importAppFlowyDataDescription
-                          .tr(),
-                      maxLines: 13,
-                    ),
-                  ),
-                ),
+                ImportAppFlowyDataButton(),
+                VSpace(6),
+                AppFlowyDataImportTip(),
               ],
             );
           },
@@ -76,6 +70,45 @@ class _ImportAppFlowyDataState extends State<ImportAppFlowyData> {
   }
 }
 
+class AppFlowyDataImportTip extends StatelessWidget {
+  final url = "https://docs.appflowy.io/docs/appflowy/product/data-storage";
+  const AppFlowyDataImportTip({super.key});
+
+  @override
+  Widget build(BuildContext context) {
+    return Opacity(
+      opacity: 0.6,
+      child: RichText(
+        text: TextSpan(
+          children: <TextSpan>[
+            TextSpan(
+              text: LocaleKeys.settings_menu_importAppFlowyDataDescription.tr(),
+              style: Theme.of(context).textTheme.bodySmall!,
+            ),
+            TextSpan(
+              text: " ${LocaleKeys.settings_menu_importGuide.tr()} ",
+              style: Theme.of(context).textTheme.bodyMedium!.copyWith(
+                    color: Theme.of(context).colorScheme.primary,
+                    decoration: TextDecoration.underline,
+                  ),
+              recognizer: TapGestureRecognizer()..onTap = () => _launchURL(),
+            ),
+          ],
+        ),
+      ),
+    );
+  }
+
+  Future<void> _launchURL() async {
+    final uri = Uri.parse(url);
+    if (await canLaunchUrl(uri)) {
+      await launchUrl(uri);
+    } else {
+      Log.error("Could not launch $url");
+    }
+  }
+}
+
 class ImportAppFlowyDataButton extends StatefulWidget {
   const ImportAppFlowyDataButton({super.key});
 

frontend/resources/translations/en.json

@@ -303,7 +303,8 @@
       "importAppFlowyData": "Import Data from External AppFlowy Folder",
       "importAppFlowyDataDescription": "Copy data from an external AppFlowy data folder and import it into the current AppFlowy data folder",
       "importSuccess": "Successfully imported the AppFlowy data folder",
-      "importFailed": "Importing the AppFlowy data folder failed"
+      "importFailed": "Importing the AppFlowy data folder failed",
+      "importGuide": "For further details, please check the referenced document"
     },
     "notifications": {
       "enableNotifications": {

frontend/rust-lib/event-integration/src/user_event.rs

@@ -190,10 +190,14 @@ impl EventIntegrationTest {
     Ok(user_profile)
   }
 
-  pub async fn import_appflowy_data(&self, path: String, name: &str) -> Result<(), FlowyError> {
+  pub async fn import_appflowy_data(
+    &self,
+    path: String,
+    name: Option<String>,
+  ) -> Result<(), FlowyError> {
     let payload = ImportAppFlowyDataPB {
       path,
-      import_container_name: name.to_string(),
+      import_container_name: name,
     };
     match EventBuilder::new(self.clone())
       .event(FolderEvent::ImportAppFlowyDataFolder)

frontend/rust-lib/event-integration/tests/user/af_cloud_test/anon_user_test.rs

@@ -78,6 +78,8 @@ async fn migrate_anon_user_data_to_af_cloud_test() {
   assert_eq!(user.authenticator, AuthenticatorPB::AppFlowyCloud);
 
   let user_first_level_views = test.get_all_workspace_views().await;
+  // assert_eq!(user_first_level_views.len(), 2);
+
   println!("user first level views: {:?}", user_first_level_views);
   let user_second_level_views = test
     .get_views(&user_first_level_views[0].id)

frontend/rust-lib/event-integration/tests/user/af_cloud_test/import_af_data_folder_test.rs

@@ -9,7 +9,7 @@ use serde_json::{json, Value};
 use std::env::temp_dir;
 
 #[tokio::test]
-async fn import_appflowy_data_folder_test() {
+async fn import_appflowy_data_folder_into_new_view_test() {
   let import_container_name = "040_local".to_string();
   let (cleaner, user_db_path) =
     unzip_history_user_db("./tests/asset", &import_container_name).unwrap();
@@ -29,7 +29,7 @@ async fn import_appflowy_data_folder_test() {
   test
     .import_appflowy_data(
       user_db_path.to_str().unwrap().to_string(),
-      &import_container_name,
+      Some(import_container_name.clone()),
     )
     .await
     .unwrap();
@@ -65,7 +65,55 @@ async fn import_appflowy_data_folder_test() {
 }
 
 #[tokio::test]
-async fn import_appflowy_data_folder_test2() {
+async fn import_appflowy_data_folder_into_current_workspace_test() {
+  let import_container_name = "040_local".to_string();
+  let (cleaner, user_db_path) =
+    unzip_history_user_db("./tests/asset", &import_container_name).unwrap();
+  // In the 040_local, the structure is:
+  // workspace:
+  //  view: Document1
+  //    view: Document2
+  //      view: Grid1
+  //      view: Grid2
+  user_localhost_af_cloud().await;
+  let test = EventIntegrationTest::new_with_name(DEFAULT_NAME).await;
+  let _ = test.af_cloud_sign_up().await;
+  // after sign up, the initial workspace is created, so the structure is:
+  // workspace:
+  //   view: Getting Started
+
+  test
+    .import_appflowy_data(user_db_path.to_str().unwrap().to_string(), None)
+    .await
+    .unwrap();
+  // after import, the structure is:
+  // workspace:
+  //   view: Getting Started
+  //   view: Document1
+  //      view: Document2
+  //        view: Grid1
+  //        view: Grid2
+  let views = test.get_all_workspace_views().await;
+  assert_eq!(views.len(), 2);
+  assert_eq!(views[1].name, "Document1");
+
+  let document_1_child_views = test.get_views(&views[1].id).await.child_views;
+  assert_eq!(document_1_child_views.len(), 1);
+  assert_eq!(document_1_child_views[0].name, "Document2");
+
+  let document2_child_views = test
+    .get_views(&document_1_child_views[0].id)
+    .await
+    .child_views;
+  assert_eq!(document2_child_views.len(), 2);
+  assert_eq!(document2_child_views[0].name, "Grid1");
+  assert_eq!(document2_child_views[1].name, "Grid2");
+
+  drop(cleaner);
+}
+
+#[tokio::test]
+async fn import_appflowy_data_folder_into_new_view_test2() {
   let import_container_name = "040_local_2".to_string();
   let (cleaner, user_db_path) =
     unzip_history_user_db("./tests/asset", &import_container_name).unwrap();
@@ -75,7 +123,7 @@ async fn import_appflowy_data_folder_test2() {
   test
     .import_appflowy_data(
       user_db_path.to_str().unwrap().to_string(),
-      &import_container_name,
+      Some(import_container_name.clone()),
     )
     .await
     .unwrap();
@@ -95,7 +143,10 @@ async fn import_empty_appflowy_data_folder_test() {
   let test = EventIntegrationTest::new_with_name(DEFAULT_NAME).await;
   let _ = test.af_cloud_sign_up().await;
   let error = test
-    .import_appflowy_data(path.to_str().unwrap().to_string(), "empty_folder")
+    .import_appflowy_data(
+      path.to_str().unwrap().to_string(),
+      Some("empty_folder".to_string()),
+    )
     .await
     .unwrap_err();
   assert_eq!(error.code, ErrorCode::AppFlowyDataFolderImportError);
@@ -121,7 +172,7 @@ async fn import_appflowy_data_folder_multiple_times_test() {
   test
     .import_appflowy_data(
       user_db_path.to_str().unwrap().to_string(),
-      &import_container_name,
+      Some(import_container_name.clone()),
     )
     .await
     .unwrap();
@@ -137,7 +188,7 @@ async fn import_appflowy_data_folder_multiple_times_test() {
   test
     .import_appflowy_data(
       user_db_path.to_str().unwrap().to_string(),
-      &import_container_name,
+      Some(import_container_name.clone()),
     )
     .await
     .unwrap();