librewolf: use mkFirefoxModule

[chayleaf]

Description

Checklist

• Change is backwards compatible.

• Code formatted with ./format.

• Code tested through nix-shell --pure tests -A run.all or nix develop --ignore-environment .#all using Flakes.

• Test cases updated/added. See example.

• Commit messages are formatted like

  {component}: {description}
  
  {long description}
  

  See CONTRIBUTING for more information and recent commit messages for examples.

• If this PR adds a new module

  • Added myself as module maintainer. See example.

Maintainer CC

@onny

[tomodachi94]

Bookmarks don't appear to work, so they should probably be turned off somehow.

  programs.librewolf.profiles.default.bookmarks = [{
    name = "bookmarklets";
    toolbar = true;
    bookmarks = [
      {
        name = "example.com";
        url = "https://example.com";
      }
    ];
  }];

I vaguely recall someone mentioning this somewhere.

[brckd]

Yea I had shared the same experience with bookmarks in #5128 (comment), but removed it in a later edit of the message.

The option could be marked as internal to hide it from generated documentation and to discourage users from using it. Alternatively the readOnly option could be used with an empty default.

[brckd]

Looks great otherwise!

[chayleaf]

why does it not work though? it doesn't look like librewolf patches out any bookmark-related code

[donovanglover]

Nice to see this finally be a feature. From my initial testing everything works as expected.

For anyone else trying this out, the default search engine won't change in v128 unless you patch #5685 in your fork as well.

[nixos-discourse]

This pull request has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/librewolf-kde-integration-not-working/50464/6

[brckd]

Suggested change

visible = true;

I would probably unset visible, because otherwise it makes the generic Firefox options appear twice in the generated documentation.

[chayleaf]

that seems fine to me, that's how it works in nixpkgs, are the home-manager docs conventions different?

[brckd]

I don't know about the conventions, but that's how the chromite module does it. It also hides generic options for its derivatives.

[brckd]

Suggested change

	name = "LibreWolf";
	name = "LibreWolf";
	description = "LibreWolf is a privacy enhanced Firefox fork.";

Optionally include the original description.

[SpiderUnderUrBed]

How would this implement nativeMessagingHosts and how could i use this for that when this gets merged?

[brckd]

It's implemented in the underlying mkFirefoxModule.
https://github.com/nix-community/home-manager/blob/master/modules/programs/firefox/mkFirefoxModule.nix#L39-L49

https://github.com/nix-community/home-manager/blob/master/modules/programs/firefox/mkFirefoxModule.nix#L830-L834

Custom native messaging hosts can be added using programs.librewolf.nativeMessagingHosts.

[MithicSpirit]

Been using this and #5685 for a couple of days now, and it's been working very well.

[Anomalocaridid]

Is it normal for the tests to take this long? It seems to me like they have said "Waiting for status to be reported" since the beginning of last month.

[brckd]

Hey @chayleaf, in case you aren't busy, could you take a look at my latest review? This way we would give the tests a rerun.

[brckd]

These tests sure take long. Perhaps they haven't started yet because of GitHub limits?

[SpiderUnderUrBed]

I don't think these tests are going to finish anytime soon, is there something wrong with them? Or is there any possibility of running them locally if that will help.

[donovanglover]

The tests won't run until the workflow is approved.

[TilCreator]

I tried this PR and got an error:

home-manager-path> error: collision between `/nix/store/r4af2fhjq0m7sz20fx6apbdj61wzd7yg-librewolf-131.0.2-1/lib/librewolf/distribution/policies.json' and `/nix/store/9fbmav58r0mxlqwrxglz7lwzm3733c6g-librewolf-131.0.2-1/lib/librewolf/distribution/policies.json'

(the only difference of the two files is that one has {"policies": {"DefaultDownloadDirectory": "/tmp"}} set and the other has not)

I limited my librewolf config to

programs.librewolf = {
  enable = true;
  policies.DefaultDownloadDirectory = "/tmp";
};

which still reproduced the error, this noticeably does not fail when replacing librewolf with firefox in this minimal example.

A workaround is:

programs.librewolf = {
  enable = true;
  package = pkgs.librewolf.override (old: {
    extraPolicies = (old.extraPolicies or { }) // {DefaultDownloadDirectory = "/tmp";};
  });
};

or even

programs.librewolf = {
  enable = true;
  package = pkgs.librewolf.override (old: {
    extraPolicies = (old.extraPolicies or { }) // config.programs.librewolf.policies;
  });
  policies.DefaultDownloadDirectory = "/tmp";
};

I also noticed a similar behavior with nativeMessagingHosts, it has no effect applied to programs.librewolf but works fine when applied to programs.librewolf.package = pkgs.librewolf.override (...).

all using github:NixOS/nixpkgs/c4c95cac8161486a52f901a27ccdb5f8e80380b1

[SpiderUnderUrBed]

Is it possible to declare different profiles using mkFirefoxModule? (by profiles i am referring to about:profiles)

[donovanglover]

If you mean multiple profiles in librewolf you can replace firefox with librewolf in the docs and it will work

[sid115]

I cannot set custom search engine entries as default. This is the relevant snippet in my Home Manager configuration:

search = {
  force = true;
  engines = {
    "Startpage" = {
      urls = [{ template = "https://www.startpage.com/do/dsearch?q={searchTerms}"; }];
      iconUpdateURL = "https://www.startpage.com/sp/cdn/favicons/favicon--default.ico";
      updateInterval = 24 * 60 * 60 * 1000; # every day
    };

    "Bing".metaData.hidden = true;
    "DuckDuckGo".metaData.hidden = true;
    "Google".metaData.hidden = true;
  };
  default = "Startpage";
  privateDefault = "Startpage";
  order = [ "Startpage" ];
};

The default search engine is still Google, although it should be hidden. Startpage is the first entry in the drop-down menu under "Default Search Engine" in Librewolf's search settings, so I think it should be available. This exact configuration in the Firefox Home Manager module gives the expected results that Startpage is the default search engine.

I then tried to set an existing search engine as the default:

search = {
  force = true;
  engines = {
    "Bing".metaData.hidden = true;
    "Google".metaData.hidden = true;
  };
  default = "DuckDuckGo";
  privateDefault = "DuckDuckGo";
  order = [ "DuckDuckGo" ];
};

This works as expected. DuckDuckGo is the default search engine and Bing and Google are hidden.

[Anomalocaridid]

@sid115 I think that is addressed by #5685

[MithicSpirit]

I have a similar issue to #5684 (comment), but over the presence of "ExtensionSettings":{} in the policies file instead. Reverting #5840 fixed it, but I suspect that the fundamental issue is that it's even trying to include two librewolfs in the path in the first place.

[Anomalocaridid]

Could someone please approve the test workflow again? This has been sitting for a few weeks waiting for the tests to be re-run.

[nixos-discourse]

This pull request has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/how-to-configure-multiple-packages-using-single-home-manager-module/54587/7