feat: add flatpak builds #1230

Jabster28 · 2024-08-21T23:20:57Z

The process is a little bit finicky at the moment, but the general idea is:

The name of the app is read from the core/src/main/java/haveno/core/app/HavenoExecutable.java with a janky regex
Make a new, temporary flatpak manifest with a --filesystem= that matches the app name
Extract the .deb file (should use the app-image (not appimage) from jpackage in the future)
Run all of the flatpak stuff
Delete any residuals, and leave the .flatpak in the binaries folder

If you're repackaging Haveno and would like to change the name and other things:

The icon in the dock while running seems to match whatever icon the binary was built with, so I don't think any renames are necessary. The icon in your launcher will be the same as desktop/src/main/resources/images/task_bar_icon_windows.png.
You almost definitely want to search the whole repo for instances of the Haveno app ID exchange.haveno.Haveno and replace them with something else (perhaps exchange.haveno.${APPNAME} or something similar), as leaving them the same will cause issues with installs
The Flatpaks are given access to ~/.local/share/${APPNAME}, so ensure your app name isn't Steam or something common
- This also means that you should be able to switch from native to flatpak and vice versa without any backup-and-restore dances
- If you'd prefer more security, you can use Flatseal and change the permission from a filesystem to a persist (the data will stay in Flatpak's sandbox instead of your home dir)
The Flatpak build manifest is desktop/package/linux/exchange.haveno.Haveno.yml
- This contains, and is named after, the ID of the app. Remember to rename the file if you Ctrl-F all of the instances of the old ID.
The metainfo is desktop/package/linux/exchange.haveno.Haveno.metainfo.xml
- This has the rest of the juicy metadata like titles, screenshots, descriptions, version history etc.

I've never used Gradle before and a lot of weird choices were from myself and Stack Overflow so if something looks wrong, please let me know.

ZhenyaPav · 2024-08-25T14:50:53Z

I went in a different route by trying to get the app to build for flatpak specifically, but it does seem to create some problems of its own, not to mention the considerable increase in build time (which is probably a concern with GitHub actions)
@Jabster28 do you have a .flatpak file for testing?

Jabster28 · 2024-08-25T16:23:49Z

@ZhenyaPav Heya. I've got a good idea of how I'd do this, but I'd love to see how you decided to do it. Making the Flatpak bundle takes a while already and I'd rather keep the builds short, as runners aren't cheap and if the project ever moves to something without free runners that would be an issue (which is why I'm also testing what amounts of caching works and what doesn't). I'll let you know when the PR is ready to merge and I'm open to any comments or suggestions.

Yes, there's a CI generated Flatpak in the Linux zip of the runner artifacts on my fork.

ZhenyaPav · 2024-08-25T16:41:34Z

What I came up with is this:


runtime: org.freedesktop.Platform
runtime-version: '23.08'
sdk: org.freedesktop.Sdk
sdk-extensions:
  - org.freedesktop.Sdk.Extension.openjdk21
command: haveno-desktop
finish-args:
  - --env=PATH=/app/jre/bin:/usr/bin
  - --env=JAVA_HOME=/app/jre
  - --share=network
  - --share=ipc
  - --socket=x11
  - --socket=wayland
  - --filesystem=home

modules:
  - name: openjdk
    buildsystem: simple
    build-commands:
      - /usr/lib/sdk/openjdk21/install.sh

  - name: build-haveno
    buildsystem: simple
    build-options:
      append-path: /usr/lib/sdk/openjdk21/bin
      build-args:
        - --share=network
    build-commands:
      - make haveno-apps
      - ls
      - install -Dm755 ./haveno-desktop /app/bin/haveno-desktop
    sources:
      - type: git
        url: https://github.com/ZhenyaPav/haveno
        branch: master

I was able to build the flatpak with this, but it didn't launch due to haveno-desktop not being present, for some reason. I only did PKGBUILDs for AUR before, so flatpak is new territory for me.

ZhenyaPav · 2024-08-25T17:53:09Z

Checked it out on Fedora Silverblue, seems to be working

Jabster28 · 2024-08-25T19:13:24Z

@ZhenyaPav Yeah, the idea of building it within the Flatpak runtime is nice for reproducibility, but it doesn't really add any security guarantees and it seems to add too much overhead (longer build times, more technical debt). Having it existing would be nice, however. I think someone in the community is attempting to do a build with Guix, that could potentially help.
I don't think we have any -bin or -git AUR packages atm, a lot of people would like that as an option. Could you possibly help with that?

it didn't launch due to haveno-desktop not being present

I don't see any immediate issues but I'd imagine you need to (and should) use a full path in the command: section, since it's not run inside of any shell. You might also want to add some metadata and icon files, and limit those permissions for security.

ZhenyaPav · 2024-08-27T17:14:08Z

I don't think we have any -bin or -git AUR packages atm, a lot of people would like that as an option. Could you possibly help with that?

making haveno-git should be trivial, as it's only a matter of changing the url to download from the master branch instead of a tag, but -bin is indeed an interesting idea.

Jabster28 · 2024-09-09T13:44:24Z

The sample Flatpak repo solution using flat-manager instead of GH pages took a lot of files and config to work, so I moved it and the accompanying docs to https://gitlab.com/Jabster28/flatman-haveno-test since I wasn't sure if it belonged here.

woodser · 2024-10-01T23:23:53Z

@TheTollingBell has rebased the AppImage PR.

Do you mind to squash your commits and rebase on the AppImage PR, so there are a total of two commits, please?

Otherwise I can test / merge their AppImage PR, then you'll need to rebase your changes on master, but was hoping to see how both look together.

Jabster28 · 2024-10-02T08:58:29Z

Sure, and I'll try to minimise the number of commits afterwards.

woodser · 2024-10-02T15:06:40Z

@Jabster28 The AppImage PR has been merged to master, so this is ready to rebase on master to resolve the merge conflict, then I can do final testing.

Jabster28 · 2024-10-07T14:26:47Z

Seems to install and work for me. Just needs a bit of testing and final looks over.

woodser · 2024-10-07T14:28:44Z

@ZhenyaPav Maybe you want to review this?

woodser · 2024-10-07T14:53:54Z

.github/workflows/build.yml

            mv desktop/build/temp-*/binaries/haveno_*.AppImage ${{ github.workspace }}/release-appimage/Haveno-${{ env.VERSION }}-linux-x86_64.AppImage
          else
            mv desktop/build/temp-*/binaries/Haveno-*.dmg ${{ github.workspace }}/release/Haveno-${{ env.VERSION }}-mac-installer.dmg
          fi
-          cp desktop/build/temp-*/binaries/desktop-*.jar.SHA-256 ${{ github.workspace }}/release
+          cp desktop/build/temp-*/binaries/desktop-*.jar.SHA-256 ${{ github.workspace }}/release-flat


This cp command is duplicated below for release-flat, so can be removed.

woodser · 2024-10-07T14:54:46Z

core/src/main/java/haveno/core/app/HavenoExecutable.java

@@ -80,8 +80,11 @@
 import java.util.concurrent.atomic.AtomicInteger;

 @Slf4j
-public abstract class HavenoExecutable implements GracefulShutDownHandler, HavenoSetup.HavenoSetupListener, UncaughtExceptionHandler {
+public abstract class HavenoExecutable
+        implements GracefulShutDownHandler, HavenoSetup.HavenoSetupListener, UncaughtExceptionHandler {


Please preserve the formatting here, so it's on one line.

woodser · 2024-10-07T14:59:46Z

core/src/main/java/haveno/core/app/HavenoExecutable.java


+    // TODO: find a less janky way to get the app name


Please update comment with more context, i.e.:

// TODO: regular expression is used to parse application name for flatpak installer, find less janky way // Don't edit the next line unless you're only editing in between the quotes.

woodser · 2024-10-07T14:59:57Z

desktop/package/README.md

+Note: Please see [flatpak.md](../../docs/flatpak.md) for information on
+distributing Haveno via Flatpak.
+
+Note: Please see [flatpak.md](../../docs/flatpak.md) for information on


This note is duplicated and can be removed.

woodser · 2024-10-07T15:00:30Z

desktop/package/README.md

@@ -42,7 +48,7 @@ Haveno data folder on Mac: `/Users/<username>/Library/Application Support/Haveno
    6. Click "OK" to save the changes and exit the dialog box.
    7. Windows will download and install the required files and components to enable the .NET Framework 3.5. This may take several minutes, depending on your internet connection speed and system configuration.
    8. Once the installation is complete, you will need to restart your computer to apply the changes.
-2. Install Wix Toolset 3: https://github.com/wixtoolset/wix3/releases/tag/wix314rtm
+2. Install Wix Toolset 3: <https://github.com/wixtoolset/wix3/releases/tag/wix314rtm>


Why add <> here?

woodser · 2024-10-07T15:01:21Z

desktop/package/README.md

-	at haveno.tools.Utils.renameFile(Utils.java:36)
-	at io.github.zlika.reproducible.StipZipFile.strip(StipZipFile.java:35)
-	at haveno.tools.DeterministicBuildTool.main(DeterministicBuildTool.java:24)
+ at haveno.tools.Utils.renameFile(Utils.java:36)


Please preserve this indentation which is standard for exception stack traces.

woodser · 2024-10-07T15:03:33Z

desktop/package/README.md

 export _JAVA_OPTIONS="-Djava.io.tmpdir=/storage/tmp"
 ```

-#### MacOs
+You will also need `flatpak` and `flatpak-builder`. On Debian/Ubuntu:


These dependencies are always needed on Debian/Ubuntu?

In that case they should be added to the Linux instructions above, which currently has sudo apt install -y rpm fuse.

woodser · 2024-10-07T15:13:44Z

desktop/package/linux/exchange.haveno.Haveno.metainfo.xml

+  </description>
+  <screenshots>
+    <screenshot type="default">
+      <image>https://files.catbox.moe/8pahgg.png</image>


We should not be fetching this screenshot from a remote repo imo, which could become unavailable.

Can we read it locally from the desktop package instead, if it's useful?

woodser · 2024-10-07T15:16:03Z

desktop/package/linux/exchange.haveno.Haveno.metainfo.xml

+      </li>
+      <li>There is No token, because we don&#39;t need it. Transactions between traders are secured by non-custodial multisignature transactions on the Monero network.
+      </li>
+      <li>The revenue generated by Haveno will be managed by an entity called Council (more info soon), composed by members of the Monero/Haveno community, not the Haveno Core Team and will be used to fund Haveno and Monero development.


This part of the description is outdated and should be removed (using a council has been abandoned).

woodser · 2024-10-07T15:18:31Z

desktop/package/package.gradle

+            def newManifest = file('exchange.haveno.Haveno.yaml')
+            newManifest.write(manifest.text.replace("- --share=network", "- --share=network\n  - --filesystem=~/.local/share/${defaultAppName}:create"))
+            flatpakManifestFile = 'exchange.haveno.Haveno.yaml'
+


Please remove 3 newlines, so there's only one extra newline, since it's all related to flatpak.

woodser · 2024-10-07T15:18:47Z

desktop/package/package.gradle

@@ -415,6 +468,8 @@ task packageInstallers {
            }
        }

+


Remove extra newlines.

woodser · 2024-10-07T15:25:51Z

docs/flatpak.md

+[flat-manager](https://github.com/flatpak/flat-manager).
+
+An example Haveno flat-manager solution using `docker-compose` has been created
+and documented at <https://gitlab.com/Jabster28/flatman-haveno-test.git> if you


This test resource should be self-contained within the Haveno repos, to avoid creating dependencies on third party repositories which are outside our control.

I've created a new repository for this purpose: https://github.com/haveno-dex/flatman-haveno-test

Do you mind opening a PR with these changes so it's all under the haveno-dex umbrella?

woodser · 2024-10-07T15:37:23Z

@Jabster28 Thanks very much for the update! Some changes requested and I think it's ready to merge.

woodser mentioned this pull request Aug 25, 2024

Support building Flatpak installer [1 XMR] #1223

Open

Jabster28 marked this pull request as ready for review August 25, 2024 21:55

Jabster28 requested a review from woodser as a code owner August 25, 2024 21:56

Jabster28 requested a review from a team as a code owner September 9, 2024 13:38

Jabster28 added 15 commits September 16, 2024 17:07

chore: perhamps?

79cc7b8

forgot to stage this bit

8a26131

only run on linux

bf44a87

install flatpak

b489371

flatpak moment

b4ab224

ugh

a23b5c6

naturally

a7ff199

oops

b299b8b

create if not exists

f41347e

test separate binaries

cd8bd3c

get version b4 rename

aaccd5f

add names of upload steps

09cb5a9

minor string manipulation changes

f71eacc

docs(flatpak): add info about flatpak repos

fa319ac

chore: sorry codeql

884a0eb

Jabster28 force-pushed the master branch from fb4f2e3 to 884a0eb Compare September 16, 2024 16:17

Merge branch 'master' into master

cca3bc9

Jabster28 added 3 commits October 3, 2024 15:40

feat: add flatpak support

cb7aba2

edits

11fde19

Merge remote-tracking branch 'me/add-flatpak-support'

b355a4b

woodser reviewed Oct 7, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add flatpak builds #1230

feat: add flatpak builds #1230

Jabster28 commented Aug 21, 2024 •

edited

Loading

ZhenyaPav commented Aug 25, 2024

Jabster28 commented Aug 25, 2024

ZhenyaPav commented Aug 25, 2024

ZhenyaPav commented Aug 25, 2024

Jabster28 commented Aug 25, 2024 •

edited

Loading

ZhenyaPav commented Aug 27, 2024 •

edited

Loading

Jabster28 commented Sep 9, 2024

woodser commented Oct 1, 2024

Jabster28 commented Oct 2, 2024

woodser commented Oct 2, 2024

Jabster28 commented Oct 7, 2024

woodser commented Oct 7, 2024

woodser Oct 7, 2024

woodser Oct 7, 2024

woodser Oct 7, 2024

woodser Oct 7, 2024

woodser Oct 7, 2024

woodser Oct 7, 2024

woodser Oct 7, 2024

woodser Oct 7, 2024

woodser Oct 7, 2024

woodser Oct 7, 2024

woodser Oct 7, 2024

woodser Oct 7, 2024 •

edited

Loading

woodser commented Oct 7, 2024

feat: add flatpak builds #1230

Are you sure you want to change the base?

feat: add flatpak builds #1230

Conversation

Jabster28 commented Aug 21, 2024 • edited Loading

ZhenyaPav commented Aug 25, 2024

Jabster28 commented Aug 25, 2024

ZhenyaPav commented Aug 25, 2024

ZhenyaPav commented Aug 25, 2024

Jabster28 commented Aug 25, 2024 • edited Loading

ZhenyaPav commented Aug 27, 2024 • edited Loading

Jabster28 commented Sep 9, 2024

woodser commented Oct 1, 2024

Jabster28 commented Oct 2, 2024

woodser commented Oct 2, 2024

Jabster28 commented Oct 7, 2024

woodser commented Oct 7, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

woodser Oct 7, 2024 • edited Loading

Choose a reason for hiding this comment

woodser commented Oct 7, 2024

Jabster28 commented Aug 21, 2024 •

edited

Loading

Jabster28 commented Aug 25, 2024 •

edited

Loading

ZhenyaPav commented Aug 27, 2024 •

edited

Loading

woodser Oct 7, 2024 •

edited

Loading