Release v0.5.4-beta.1 (#688)

This release v0.5.4-beta.1 adds:
- tracking of device codes of installation attempts in plausible.io.

New devices:
- none yet

Chores:
- fix flatpak creation
- update flet to version 0.26.0
- fix a bunch of bugs from the flet update

Author: tsterbak

.github/workflows/manual-build.yml

@@ -10,19 +10,69 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: ['ubuntu-20.04', 'ubuntu-latest', 'macos-latest', 'windows-latest']
+        os: ['ubuntu-20.04', 'ubuntu-latest', 'macos-latest']
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v4
+      with:
+        python-version: 3.11
+    - run: pip install -r requirements.txt
+    - run: python scripts/download-tools.py
+    - run: python scripts/build.py
+    - uses: actions/upload-artifact@v4
+      with:
+        name: openandroidinstaller-${{  github.ref_name }}-${{ matrix.os }}
+        path: dist/
 
+  build-windows:
+    runs-on: 'windows-latest'
     steps:
     - uses: actions/checkout@v4
     - uses: actions/setup-python@v4
       with:
-        python-version: 3.9
+        python-version: 3.11
     - run: pip install -r requirements.txt
     - run: python scripts/download-tools.py
     - run: python scripts/build.py
-    # Optionally verify that it works (provided that it does not need user interaction)
-    #- run: ./dist/your-code/your-code
-    - uses: actions/upload-artifact@v3
+    - uses: actions/upload-artifact@v4
       with:
-        name: openandroidinstaller-${{ github.sha }}-${{ matrix.os }}
+        name: openandroidinstaller-${{  github.ref_name }}-windows-latest
         path: dist/
+
+  create-release:
+    needs:
+      - build
+      - build-windows
+    runs-on: 'ubuntu-latest'
+    steps:
+    - uses: actions/checkout@v4
+    - name: Download artifact
+      uses: actions/download-artifact@v4
+    - name: Display structure of downloaded files
+      run: ls -R
+    - uses: montudor/action-zip@v1
+      with:
+        args: zip -qq -r openandroidinstaller-${{ github.ref_name }}-macos-latest.zip openandroidinstaller-${{ github.ref_name }}-macos-latest
+    - uses: montudor/action-zip@v1
+      with:
+        args: zip -qq -r openandroidinstaller-${{ github.ref_name }}-ubuntu-20.04.zip openandroidinstaller-${{ github.ref_name }}-ubuntu-20.04
+    - uses: montudor/action-zip@v1
+      with:
+        args: zip -qq -r openandroidinstaller-${{ github.ref_name }}-ubuntu-latest.zip openandroidinstaller-${{ github.ref_name }}-ubuntu-latest
+    - uses: montudor/action-zip@v1
+      with:
+        args: zip -qq -r openandroidinstaller-${{ github.ref_name }}-windows-latest.zip openandroidinstaller-${{ github.ref_name }}-windows-latest
+    - name: Display structure of downloaded files
+      run: ls -R
+    - name: Create release
+      uses: dciborow/[email protected]
+      if: startsWith(github.ref, 'refs/tags/')
+      with:
+        repo_token: ${{ secrets.GITHUB_TOKEN }}
+        prerelease: false
+        title: Release ${{ github.ref_name }}
+        files: |
+          openandroidinstaller-${{ github.ref_name }}-macos-latest.zip
+          openandroidinstaller-${{ github.ref_name }}-ubuntu-20.04.zip
+          openandroidinstaller-${{ github.ref_name }}-ubuntu-latest.zip
+          openandroidinstaller-${{ github.ref_name }}-windows-latest.zip

Makefile

@@ -29,7 +29,7 @@ format:
 	poetry run black .
 
 lint:
-	poetry run ruff openandroidinstaller/ --ignore E501
+	poetry run ruff check openandroidinstaller/ --ignore E501
 
 typing:
 	poetry run mypy openandroidinstaller/. --ignore-missing-imports

README.md

@@ -261,6 +261,12 @@ Make sure to check if your issue or PR has already been fixed or implemented **b
 - Details on how to contribute: [`CONTRIBUTING.md`](https://github.com/openandroidinstaller-dev/openandroidinstaller/blob/main/CONTRIBUTING.md)
 - More ways to contribute: [openandroidinstaller.org/#contribute](https://openandroidinstaller.org/#contribute)
 
+## Collection of anonymous usage data
+
+The OpenAndroidInstaller application collects anonymous usage data to help us improve the application. This data is collected using [Plausible Analytics](https://plausible.io) and is stored on their servers.
+We do not collect any personal data, and we do not track individual users. We only collect the device code when the installation process is started and finished to see which devices are most commonly used with the application.
+The code is available in the function `send_tracking_info` in the `openandroidinstaller/utils.py` file.
+
 ## Acknowledgements
 
 The project is supported by the following organizations and companies:

flatpak/generated-poetry-sources.json

@@ -55,8 +55,3 @@ steps:
         In some cases, the inactive slot can be unpopulated or contain much older firmware than the active slot, leading to various issues including a potential hard-brick.
         We can ensure none of that will happen by copying the contents of the active slot to the inactive slot. Press 'confirm and run' to to this. Once you are in the bootloader again, continue.
       command: adb_twrp_copy_partitions
-    - type: call_button
-      img: twrp-start.jpeg
-      content: >
-        Now we need to boot into recovery again. Press run and when you see the TWRP screen you can continue.
-      command: fastboot_boot_recovery

flatpak/org.openandroidinstaller.OpenAndroidInstaller.appdata.xml

@@ -30,9 +30,8 @@
     Image,
     Page,
     TextButton,
-    UserControl,
-    colors,
-    icons,
+    Colors,
+    Icons,
 )
 from loguru import logger
 from styles import Text
@@ -50,7 +49,7 @@
 )
 
 # VERSION number
-VERSION = "0.5.4-beta"
+VERSION = "0.5.5-beta"
 
 # detect platform
 PLATFORM = sys.platform
@@ -61,7 +60,7 @@
 BIN_PATH = Path(__file__).parent.joinpath(Path("bin")).resolve()
 
 
-class MainView(UserControl):
+class MainView(Column):
     def __init__(self, state: AppState):
         super().__init__()
         self.state = state
@@ -73,6 +72,8 @@ def __init__(self, state: AppState):
             on_confirm=self.to_next_view,
             state=self.state,
         )
+        # self.state.page.add(welcome_view)
+
         start_view = StartView(
             on_confirm=self.to_next_view,
             on_back=self.to_previous_view,
@@ -221,7 +222,6 @@ def main(page: Page, test: bool = False, test_config: str = "sargo"):
 
     # configure the page
     configure(page)
-
     # header
     page.appbar = AppBar(
         leading=Image(src="/logo-192x192.png", height=40, width=40, border_radius=40),
@@ -236,7 +236,7 @@ def main(page: Page, test: bool = False, test_config: str = "sargo"):
         actions=[
             Container(
                 content=ElevatedButton(
-                    icon=icons.QUESTION_MARK_ROUNDED,
+                    icon=Icons.QUESTION_MARK_ROUNDED,
                     text="FAQ",
                     on_click=lambda _: webbrowser.open(
                         "https://openandroidinstaller.org/faq.html"
@@ -247,7 +247,7 @@ def main(page: Page, test: bool = False, test_config: str = "sargo"):
             ),
             Container(
                 content=ElevatedButton(
-                    icon=icons.FEEDBACK_OUTLINED,
+                    icon=Icons.FEEDBACK_OUTLINED,
                     text="Give feedback",
                     on_click=lambda _: webbrowser.open(
                         "https://openandroidinstaller.org/feedback.html"
@@ -258,7 +258,7 @@ def main(page: Page, test: bool = False, test_config: str = "sargo"):
             ),
             Container(
                 content=ElevatedButton(
-                    icon=icons.BUG_REPORT_OUTLINED,
+                    icon=Icons.BUG_REPORT_OUTLINED,
                     text="Report a bug",
                     on_click=lambda _: webbrowser.open(
                         "https://github.com/openandroidinstaller-dev/openandroidinstaller/issues"
@@ -276,8 +276,8 @@ def close_banner(e):
         page.update()
 
     banner = Banner(
-        bgcolor=colors.AMBER_100,
-        leading=Icon(icons.WARNING_AMBER_ROUNDED, color=colors.AMBER, size=40),
+        bgcolor=Colors.AMBER_100,
+        leading=Icon(Icons.WARNING_AMBER_ROUNDED, color=Colors.AMBER, size=40),
         content=Text(
             "These instructions only work if you follow every section and step precisely. Do not continue after something fails!"
         ),
@@ -287,7 +287,6 @@ def close_banner(e):
     )
     page.overlay.append(banner)
     banner.open = True
-    page.update()
 
     # create the State object
     state = AppState(
@@ -300,7 +299,6 @@ def close_banner(e):
     state.page = page
     # create application instance
     app = MainView(state=state)
-
     # add application's root control to the page
     page.add(app)
 

flatpak/org.openandroidinstaller.OpenAndroidInstaller.desktop

@@ -188,3 +188,25 @@ def recovery_works_with_device(
             CompatibilityStatus.INCOMPATIBLE,
             f"Recovery file {recovery_file_name} is not supported by device code in file name.",
         )
+
+
+def send_tracking_info(device_code: str, event: str):
+    # Plausible API endpoint for tracking events
+    url = "https://plausible.io/api/event"
+
+    # Prepare the JSON payload.
+    data = {
+        "name": event,
+        "url": "app://openandroidinstaller",
+        "domain": "openandroidinstaller.org",
+        "props": {"device_code": device_code},
+    }
+
+    headers = {
+        "Content-Type": "application/json",
+        "User-Agent": "Desktop-App",
+    }
+
+    # Send the POST request
+    _ = requests.post(url, json=data, headers=headers)
+    logger.info(f"Sent tracking event '{event}' for device '{device_code}'.")