AppFlowy build tasks for Android platform #3184

rileyhawk1417 · 2023-08-13T14:15:07Z

Feature Preview

This PR is related to AppFlowy Editor, so its in preparation for when AppFlowy Editor supports the mobile version. The PR just has the build tasks to make it run on android.
There is one issue with it working on Windows platform. The rust backend does not compile for android, otherwise there's nothing wrong with the dart(frontend) part.

PR Checklist

My code adheres to the AppFlowy Style Guide
I've listed at least one issue that this PR fixes in the description above.
I've added a test(s) to validate changes in this PR, or this PR only contains semantic changes.
All existing tests are passing.

codecov · 2023-08-13T14:34:35Z

Codecov Report

All modified lines are covered by tests ✅

Comparison is base (62f1d6e) 11.98% compared to head (4801da7) 66.57%.
Report is 1 commits behind head on main.

Additional details and impacted files

@@             Coverage Diff             @@
##             main    #3184       +/-   ##
===========================================
+ Coverage   11.98%   66.57%   +54.58%     
===========================================
  Files         540      540               
  Lines       25239    25274       +35     
===========================================
+ Hits         3026    16826    +13800     
+ Misses      22213     8448    -13765

Flag	Coverage Δ
appflowy_flutter_integrateion_test	`64.60% <ø> (?)`
appflowy_flutter_unit_test	`11.98% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

see 400 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

…flowy into appflowy_android_build

rileyhawk1417 · 2023-08-20T14:52:14Z

frontend/.vscode/launch.json

@@ -43,6 +43,16 @@
            },
            "cwd": "${workspaceRoot}/appflowy_flutter"
        },
+        {
+            "name": "AF-iOS: Build Dart Only",


Added this task just for people who want to run AppFlowy, without rebuilding the backend

LucasXu0 · 2023-08-28T14:30:46Z

@rileyhawk1417 Can you provide more details on the instructions?

I encountered this error.

error: Could not find any NDK.
note: Set the environment ANDROID_NDK_HOME to your NDK installation's root directory,
or install the NDK using Android Studio.

rileyhawk1417 · 2023-08-31T07:57:25Z

@LucasXu0 I had put instructions in a README inside the android folder. Haven't tested it on MacOS yet, but am sure the setup is similar to that of Linux.

@rileyhawk1417 Can you provide more details on the instructions?

I encountered this error.
error: Could not find any NDK.
note: Set the environment ANDROID_NDK_HOME to your NDK installation's root directory,
or install the NDK using Android Studio.

The error is related to the Android NDK not being found, its what is used to compile the rust backend for android.

AkechiShiro · 2023-09-02T20:31:44Z

@LucasXu0 I believe you should look into the readme that was modified in the commits, there seems TL be a list of requirements where Android NDK is mentioned along other stuff, something called cargo-ndk as well.

Getting the tools

Install cargo-ndk bash cargo install cargo-ndk.

Android NDK .

When downloading Android NDK you can get the compressed version as a standalone from the site. Or you can download it through Android Studio.

After downloading the two you need to set the environment variables. For Windows that's a separate process. On macOS and Linux the process is similar.

The variables needed are '$ANDROID_NDK_HOME', this will point to where the NDK is located.

If I understand correctly, the app is written with a blend of Flutter (Dart) and Rust as well, I don't understand just which kind of part is written in Rust (what is that part achieving ?).

I've stumbled on this project and I'm interesting in having it working on Android, just keeping an eye on this PR since this brings good progress towards building a mobile application.

@rileyhawk1417 Is it recommended in order to test this PR, to use VSCode ? I saw some files related to it.

rileyhawk1417 · 2023-09-03T08:31:31Z

@AkechiShiro there's an article explaining about how flutter & rust work together in the app. As for the testing part of VSCode well its not necessary but it just makes things easier for development, you can run the VSCode tasks individually on a separate terminal.

Xazin · 2023-10-04T21:38:48Z

frontend/.vscode/tasks.json

@@ -84,6 +84,34 @@
        "cwd": "${workspaceFolder}"
      }
    },
+    {
+      "label": "AF: Clean + Rebuild All (Android)",


I think it's easier to see if you're running the right task, if the label include critical information at the beginning.

Suggested change

"label": "AF: Clean + Rebuild All (Android)",

"label": "AF-Android: Clean + Rebuild All",

Xazin · 2023-10-04T21:38:58Z

frontend/.vscode/tasks.json

+      }
+    },
+    {
+      "label": "AF: Build Appflowy Core For Android",


Suggested change

"label": "AF: Build Appflowy Core For Android",

"label": "AF-Android: Build Appflowy Core",

Xazin · 2023-10-04T21:39:58Z

Do you have a take on this PR @LucasXu0 ?

rileyhawk1417 · 2023-10-10T15:15:25Z

Updated the debug labels & added a .gitignore for the android build files.

rileyhawk1417 · 2023-10-10T15:27:21Z

It did fail to build the flowy test crate with this error:

warning: field `storage_service` is never read
  --> flowy-document2/src/manager.rs:35:3
   |
29 | pub struct DocumentManager {
   |            --------------- field in this struct
...
35 |   storage_service: Weak<dyn FileStorageService>,
   |   ^^^^^^^^^^^^^^^
   |
   = note: `#[warn(dead_code)]` on by default

   Compiling flowy-core v0.1.0 (/home/riley/Documents/Github_Repos/appFlowy/app/appflowy/frontend/rust-lib/flowy-core)
warning: `flowy-document2` (lib) generated 1 warning
   Compiling flowy-test v0.1.0 (/home/riley/Documents/Github_Repos/appFlowy/app/appflowy/frontend/rust-lib/flowy-test)
error[E0599]: no method named `get_cloud_service` found for struct `Arc<DocumentManager>` in the current scope
  --> flowy-test/src/lib.rs:90:47
   |
90 |     let cloud_service = self.document_manager.get_cloud_service().clone();
   |                                               ^^^^^^^^^^^^^^^^^ method not found in `Arc<DocumentManager>`

I did pull from the latest code so maybe something is missing?

rileyhawk1417 · 2023-10-24T09:12:08Z

Closing this PR as its been solved by this PR

feat: ensure AppFlowy builds for Android platform

1aa3cbf

rileyhawk1417 added 4 commits August 20, 2023 16:31

Merge remote-tracking branch 'origin' into appflowy_android_build

ca85694

Merge branch 'AppFlowy-IO:main' into appflowy_android_build

b53d6cb

Merge branch 'appflowy_android_build' of github.com:rileyhawk1417/app…

850116d

…flowy into appflowy_android_build

chore: restore iOS sim tasks & launch

702c193

rileyhawk1417 commented Aug 20, 2023

View reviewed changes

rileyhawk1417 added 2 commits September 15, 2023 14:33

Merge branch 'main' into appflowy_android_build

2bf67c4

Merge branch 'AppFlowy-IO:main' into appflowy_android_build

32608fd

Xazin reviewed Oct 4, 2023

View reviewed changes

rileyhawk1417 added 3 commits October 10, 2023 16:59

Merge branch 'AppFlowy-IO:main' into appflowy_android_build

ac31594

fix: rename android vscode label

0b906e4

chore: ignore android generated build files

6eae665

rileyhawk1417 added 2 commits October 11, 2023 13:41

Merge branch 'AppFlowy-IO:main' into appflowy_android_build

39107af

Merge branch 'AppFlowy-IO:main' into appflowy_android_build

4801da7

LucasXu0 self-requested a review October 16, 2023 02:58

LucasXu0 mentioned this pull request Oct 17, 2023

feat: support building on Android #3713

Merged

rileyhawk1417 closed this Oct 24, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

AppFlowy build tasks for Android platform #3184

AppFlowy build tasks for Android platform #3184

rileyhawk1417 commented Aug 13, 2023 •

edited

Loading

codecov bot commented Aug 13, 2023 •

edited

Loading

rileyhawk1417 Aug 20, 2023

LucasXu0 commented Aug 28, 2023

rileyhawk1417 commented Aug 31, 2023

AkechiShiro commented Sep 2, 2023 •

edited

Loading

rileyhawk1417 commented Sep 3, 2023

Xazin Oct 4, 2023

Xazin Oct 4, 2023

Xazin commented Oct 4, 2023

rileyhawk1417 commented Oct 10, 2023

rileyhawk1417 commented Oct 10, 2023

rileyhawk1417 commented Oct 24, 2023

	"label": "AF: Clean + Rebuild All (Android)",
	"label": "AF-Android: Clean + Rebuild All",

	"label": "AF: Build Appflowy Core For Android",
	"label": "AF-Android: Build Appflowy Core",

AppFlowy build tasks for Android platform #3184

AppFlowy build tasks for Android platform #3184

Conversation

rileyhawk1417 commented Aug 13, 2023 • edited Loading

Feature Preview

PR Checklist

codecov bot commented Aug 13, 2023 • edited Loading

Codecov Report

rileyhawk1417 Aug 20, 2023

Choose a reason for hiding this comment

LucasXu0 commented Aug 28, 2023

rileyhawk1417 commented Aug 31, 2023

AkechiShiro commented Sep 2, 2023 • edited Loading

rileyhawk1417 commented Sep 3, 2023

Xazin Oct 4, 2023

Choose a reason for hiding this comment

Xazin Oct 4, 2023

Choose a reason for hiding this comment

Xazin commented Oct 4, 2023

rileyhawk1417 commented Oct 10, 2023

rileyhawk1417 commented Oct 10, 2023

rileyhawk1417 commented Oct 24, 2023

rileyhawk1417 commented Aug 13, 2023 •

edited

Loading

codecov bot commented Aug 13, 2023 •

edited

Loading

AkechiShiro commented Sep 2, 2023 •

edited

Loading