funkwhale: init at 0.20.0

[mmai]

Motivation for this change

This adds a new package and module which enable the Funkwhale music web service (https://funkwhale.audio/).

Things done

• Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS)
• Built on platform(s)
  • NixOS
  • macOS
  • other Linux distributions
• Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)
• Tested compilation of all pkgs that depend on this change using nix-shell -p nox --run "nox-review wip"
• Tested execution of all binary files (usually in ./result/bin/)
• Determined the impact on package closure size (by running nix path-info -S before and after)
• Assured whether relevant documentation is up to date
• Fits CONTRIBUTING.md.

---

[infinisil]

All in all, this PR is far from done and needs a lot of work. Note that a lot of the comments I left also apply to many other places in your changes.

[matthiasbeyer]

Any progress here?

[ivan]

For the author, reviewers, and committers: this PR was scanned and appears to add a use of the deprecated types.string, which emits a warning as of #66346. Before merging, please change this to another type, possibly:

• types.str for a single string where merging does not make sense, or cannot work
• types.lines for multi-line configuration or scripts where merging is possible
• types.listOf types.str for a mergeable list of strings

[FRidh]

Nothing happening so closing.

[mmai]

@FRidh I'm not sure I understand. Do you expect more actions from me ? I've made all the requested changes for the initial pull request but my fixes didn't received any review.

[worldofpeace]

@mmai I'll see about integrating the python packages later today.

[worldofpeace]

Lol more like today now 🤣

[worldofpeace]

Merged all python modules in #71262.

We need to drop all those commits from here, and the funkwhale commit needs a rewrite to not add you to the maintainer list. I had to do that separately for merging the modules 3895e09.

[mmai]

Thanks @worldofpeace . I've removed the python packages commits.

[infinisil]

Still some important things (and some less important things) to correct, but it's looking much better than initially!

[infinisil]

In nixpkgs there's a structure for $out you need to follow. And since this is a python package, you should use buildPythonPackage to build, which will do a lot of things automatically. See section 10.15.2.2.2 in the Nixpkgs manual. This way you can also specify the dependencies in the package directly.

[FRidh]

This is a Django application and they usually do not provide any installer. While it would be nice if funkwhale would be usable without the NixOS module, given its a Django app it is typically managed using the manage.py script and various other executables are executed (gunicorn e.g.). Therefore, I think this approach is alright.

Note in another PR (https://github.com/NixOS/nixpkgs/pull/67951/files#diff-5e9f694ce07aa22a80eb0c049c03beaf) I recommended putting the contents of the Django application in a site-packages folder using buildPythonPackage because then the application could be added to the env (that would correspond to adding the funkwhale derivation to the Python env. That would be even nicer, especially if the Python env would be moved here!

[infinisil]

Do users.groups.funkwhale = mkIf (cfg.group == "funkwhale") {} instead, and similarly for users.users

[infinisil]

Docs aren't markdown but asciidoc docbook, so here you need <command>the command</command> instead

[infinisil]

Suggested change

	Where static files (such as API css or icons) should be compiled on your system ? Ensure this directory actually exists.
	Where static files (such as API css or icons) should be compiled on your system. Ensure this directory actually exists.

Same for other descriptions where there's a random question mark.

[infinisil]

Syntax for links is <link xlink:href="https://example.com"/>

[infinisil]

No need to specify defaultText when the default is the same. And no need to specify an example if it's the same as the default

[infinisil]

Also here, no need to set defaultText

[infinisil]

This shouldn't be necessary since you set environment in the services already

[infinisil]

Maybe call it musicPath instead

[matthiasbeyer]

It is more consistent with the funkwhaleEnvironment variable name (which is MUSIC_DIRECTORY_PATH), so IMO it should not be changed, because of consistency.

[infinisil]

Split this into more lines, same for other long lines, try to keep them to ~80 chars wide

[FRidh]

Nice work. It's a very big application. I am worried though how we can keep it stable. I imagine that if the pythonEnv is moved to pkgs.funkwhale, that we can provide overrides there as needed. It might also be good to provide a NixOS test or lighter tests for the pkgs.funkwhale package so we know we don't break it. Maybe we should use the requirements.txt to verify deps as well?
Hook to test against a requirements.txt file. #71908

[FRidh]

${python.interpreter}

[FRidh]

This is a Django application and they usually do not provide any installer. While it would be nice if funkwhale would be usable without the NixOS module, given its a Django app it is typically managed using the manage.py script and various other executables are executed (gunicorn e.g.). Therefore, I think this approach is alright.

Note in another PR (https://github.com/NixOS/nixpkgs/pull/67951/files#diff-5e9f694ce07aa22a80eb0c049c03beaf) I recommended putting the contents of the Django application in a site-packages folder using buildPythonPackage because then the application could be added to the env (that would correspond to adding the funkwhale derivation to the Python env. That would be even nicer, especially if the Python env would be moved here!

[mmai]

@FRidh @infinisil I didn't managed to set a structure resembling what you describe. Looking at the mailman package code and the documentation didn't help.

I'm really sorry to say that at this point I am not able to work on this anymore. I feel that my python and nixos abilities are to shallow and I invested way more time than initially planned, and I see that we are far from having a stable package (the master branch already breaks python dependencies).

Feel free to close the pull request.

[agateblue]

Hi, I am one of Funkwhale's maintainer, and I wasn't aware of this packaging effort, so I'm a bit late. I don't have any knowledge about NixOS, however, I'd be willing to help if you need some clarification or tweaks on Funkwhale side to make it easier to packagers.

I can also answer questions you have regarding our dependencies, for instance.

Many thanks to the people who worked on this!

[davidak]

@matthiasbeyer would you be able to finish it?

[matthiasbeyer]

Holy cow. I doubt it. Mainly because I do not know how to properly write services and also because I have little time. I will try next weekend though, if I do not forget.

[matthiasbeyer]

I'm not sure how to push directly to this PR, nor am I convinced I should. I have some patches at https://github.com/matthiasbeyer/nixpkgs/tree/funkwhale though.

[jbaum98]

I'd also be happy to work on this. I've looked at the discussion, but can someone give a list of all the things that need to be changed or fixed to get this PR ready to merge?

[worldofpeace]

@jbaum98 I believe #53416 (review) and maybe https://github.com/NixOS/nixpkgs/pull/53416/files#r338540545?

You should re PR and review can begin again.

[worldofpeace]

We also have #53416 (comment) who responsive to questions so this can be transplanted into NixOS as easily as possible.
But honestly, a lot of the issues here will be ecosystem ones.

[worldofpeace]

I'm going to close this since @mmai said they won't be working on it anymore, so it won't be merged. The code should still be available though.

[jbaum98]

@FRidh I looked at the mailman PR, and I'm not quite clear on what structure we want for the Django app.

Also, this project has a pretty complicated architecture:

The project relies on the following components and services to work:

• A web application server (Python/Django/Gunicorn)
• A PostgreSQL database to store application data
• A redis server to store cache and tasks data
• A celery worker to run asynchronous tasks (such as music import)
• A celery scheduler to run recurrent tasks
• A ntp-synced clock to ensure federation is working seamlessly

It seems like we want package the API server separately from the frontend server, and then hook that together with all the other stuff in the NixOS module.