Package request: Zen Browser

[BlueFox1616]

Zen
zen-browser

Project description

User-friendly, useful, mods that increase usability can be added from the zen-mods mod store, a customizable browser, features that can be searched for in a browser for the end user, easy to use thanks to the shortcut key assignment feature, theme-store, frequently used progressive web apps, add-on apps, websites can be easily accessed thanks to the sidebar feature, can be viewed as a mobile page. container, work spaces, zen-mods, window management by creating multiple tab sections in a window, sidebar feature.

Metadata

• homepage URL: https://zen-browser.app/
• github homepage URL: https://github.com/zen-browser
• source URL: https://github.com/zen-browser/desktop
• flathub source URL: https://github.com/zen-browser/flatpak
• download URLs: https://github.com/zen-browser/desktop/releases ; flatpak: https://github.com/zen-browser/flatpak/releases ; flathub: https://flathub.org/apps/io.github.zen_browser.zen ; https://zen-browser.app/download
• license: MPL-2, MIT
• platforms: gnu-linux libre, gnu-linux, darwin (apple's), net (ms's)
• OSs: gnu-linux libre distros, gnu-linux distros, windows, macOS
• distribution formats of software: appimage, dmg, exe, flatpak, mar (portable, mozilla archive)

[Lenchog]

I've tried to write a package for it based on the package for the floorp browser, but it's not working for some reason. I get this error:

> Running phase: patchPhase
      > applying patch /nix/store/9lx1746yy56pn3dpc35l1xr6l3lykbin-env_var_for_system_dir-ff111.patch
      > patching file toolkit/xre/nsXREDirProvider.cpp
      > applying patch /nix/store/6wsdh6246xbmlv3jr5q7qpl9ay3acq04-no-buildconfig-ffx121.patch
      > patching file docshell/base/nsAboutRedirector.cpp
      > Hunk #1 succeeded at 73 (offset -15 lines).
      > patching file toolkit/content/jar.mn
      > Hunk #1 FAILED at 41.
      > 1 out of 1 hunk FAILED -- saving rejects to file toolkit/content/jar.mn.rej

This is my first time packaging something so I don't really know how to fix it

[mr-cheffy]

toolkit/content/jar.mn doesnt exist

[Cristiandis]

bumping this

[chaezwav]

bumping this

[pective]

bumping

[mateowoetam]

bumping

[FMGordillo]

This is what I got thus far

...
00:00:06 checking cargo version... 1.77.1
00:00:06 checking for rust host triplet... x86_64-unknown-linux-gnu
00:00:06 checking for rust target triplet... x86_64-unknown-linux-gnu
00:00:06 checking for rustdoc... /nix/store/p8nr5crc52shb4n5b1z266z0g674239g-rustc-wrapper-1.77.2/bin/rustdoc
00:00:06 checking for cbindgen... /nix/store/07i7asifw6pp4a4fgmmxgq8a7r78bfyh-rust-cbindgen-0.26.0/bin/cbindgen
00:00:06 checking for rustfmt... not found
00:00:06 checking for clang for bindgen... /nix/store/v78293y2wi2kyxb93hp30k0ra9r77amf-clang-wrapper-17.0.6/bin/clang++
00:00:06 checking for libclang for bindgen... not found
00:00:06 ERROR: Could not find libclang to generate rust bindings for C/C++. Please install the necessary packages, run `mach bootstrap`, or use --with-libclang-path to give the path containing it.
00:00:06 W Exception when writing resource usage file: [Errno 2] No such file or directory: '/home/me/code/desktop/engine/obj-x86_64-pc-linux-gnu/.mozbuild/profile_build_resources.json'
00:00:07  Config object not found by mach.
00:00:07 *** Fix above errors and then restart with "./mach build"

let
  pkgs = import <nixpkgs> { };
  # I don't know if it needs gcc
in pkgs.mkShell {
  nativeBuildInputs = with pkgs; [
    # TODO: Install from cargo? Or use this instead?
    rust-cbindgen
    # TODO: Install from cargo? Or use this instead?
    rust-bindgen

    alsa-lib
    cargo
    clang
    gcc
    libpulseaudio
    libclang
    llvm
    pkg-config
    python3
    rustc
  ];
}

Maybe someone with experience building with Firefox could help it out on this one

[chaezwav]

Isn't there a firefox builder? Just looking at the Floorp expression they didn't use mkshell

[baduhai]

Building this doesn't seem to be the same as building other firefox forks, since it uses surfer to automate building.

[MarceColl]

Meanwhile to avoid the flatpak I have this flake that uses the binary release while a proper build works: https://github.com/MarceColl/zen-browser-flake

[fndov]

bumping

[chaezwav]

Meanwhile to avoid the flatpak I have this flake that uses the binary release while a proper build works: https://github.com/MarceColl/zen-browser-flake

Is there anyway you could make it for the generic version too?

[dit7ya]

I spent some time tinkering with this only to later realize Firefox itself doesn't build on aarch64-darwin (my current machine) via nixpkgs.

{
  lib,
  stdenv,
  fetchFromGitHub,
  buildNpmPackage,
  vips,
  pkg-config,
  fetchurl,
  gnutar,
  git,
}: let
  firefoxVersion = "129.0.2";
  firefoxSrc = fetchurl {
    url = "mirror://mozilla/firefox/releases/${firefoxVersion}/source/firefox-${firefoxVersion}.source.tar.xz";
    hash = "sha512-9oBah+XLTkN1g5FuPsGzEtxz7sX8Bs56A4sTvXxoJ7GM84PDBkXZZiPOQWdTUfMCPsa5+J1nbxyImZTq558sEw==";
  };
in
  buildNpmPackage rec {
    pname = "zen-browser";
    version = "1.0.0-a.26";

    src = fetchFromGitHub {
      owner = "zen-browser";
      repo = "desktop";
      rev = version;
      hash = "sha256-SFLleJXchumnA28eYjSkMlFMqngoH8bp02q2WkGlYas=";
      fetchSubmodules = true;
    };

    nativeBuildInputs = [git pkg-config];
    buildInputs = [vips gnutar];
    patches = [./changes.patch];

    preBuild = ''
      patch node_modules/@zen-browser/surfer/dist/utils/version.js < ${./dist_utils_version.js.patch}
      patch node_modules/@zen-browser/surfer/dist/commands/download/firefox.js < ${./dist_commands_download_firefox.js.patch}


      # put the firefox source in the right place (.surfer/engine)
      mkdir -p .surfer/engine

      cp -r ${firefoxSrc} .surfer/engine/firefox-${firefoxVersion}.source.tar.xz

      npm run init
    '';

    makeCacheWritable = true;
    npmDepsHash = "sha256-AxGh/MC8Kw2SHw4wYOTyZjmC1q+hemPxSJZkjWNrYbo=";

    meta = with lib; {
      description = "Experience tranquillity while browsing the web without people tracking you";
      homepage = "https://github.com/zen-browser/desktop";
      license = licenses.mpl20;
      maintainers = with maintainers; [];
      mainProgram = "zen-browser";
      platforms = platforms.all;
    };
  }

The main issue with this package is that it depends on @zen-browser/surfer which does the main heavy-lifting of downloading various things via Javascript.

I think there are two approaches we can take here to build this from source.

1. Patch aggressively inside the @zen-browser/surfer to replace all network calls with FODs, but still using their build pattern and scripts. Not sure if this can work, and how much effort it is going to be to make everything compatible with Nix.

2. Utilizing buildMozillaMach to essentially replace what surfer does, but I am not sure how feasible this is.

[MarceColl]

Meanwhile to avoid the flatpak I have this flake that uses the binary release while a proper build works: https://github.com/MarceColl/zen-browser-flake

Is there anyway you could make it for the generic version too?

@chaezwav I've pushed an update that adds the generic version, you can find more information in the README. Let me know if it works for you and if not feel free to open an issue in the repo.