pretalx: Change packaging from poetry2nix to buildPythonApplication.

Improve packaging with changes from `nixpkgs` `pretalx` PR: <NixOS/nixpkgs#231684> Co-authored-by: Andres Navarro <git@andresnav.com> Co-authored-by: Ivan Mincik <ivan.mincik@gmail.com> Co-authored-by: kubaneko <kubanek0ondrej@gmail.com> Co-authored-by: Lorenz Leutgeb <lorenz@leutgeb.xyz>
ngi-nix · Sep 11, 2023 · 36892fe · 36892fe
1 parent ca1dcd5
commit 36892fe
Show file tree

Hide file tree

Showing 13 changed files with 335 additions and 1,707 deletions.
diff --git a/all-packages.nix b/all-packages.nix
@@ -1,5 +1,11 @@
-{newScope, ...}: let
-  self = rec {
+{
+  newScope,
+  lib,
+  ...
+}: let
+  self = let
+    pretalxPlugins = lib.recurseIntoAttrs (callPackage ./pkgs/pretalx/plugins.nix {});
+  in rec {
     flarum = callPackage ./pkgs/flarum {};
     gnunet-messenger-cli = callPackage ./pkgs/gnunet-messenger-cli {};
     kikit = callPackage ./pkgs/kikit {};
@@ -13,23 +19,28 @@
 
     libgnunetchat = callPackage ./pkgs/libgnunetchat {};
     librecast = callPackage ./pkgs/librecast {inherit lcrq;};
-    pretalx-mysql = callPackage ./pkgs/pretalx {
-      withPlugins = true;
-      withMysql = true;
-      withRedis = true;
-    };
-    pretalx-postgresql = callPackage ./pkgs/pretalx {
-      withPlugins = true;
-      withPostgresql = true;
-      withRedis = true;
-    };
-    pretalx = callPackage ./pkgs/pretalx {
-      withPlugins = true;
-      withMysql = true;
-      withPostgresql = true;
-      withRedis = true;
-      withTest = true;
+    pretalx = callPackage ./pkgs/pretalx {};
+    pretalx-full = callPackage ./pkgs/pretalx {
+      withPlugins = [
+        pretalx-downstream
+        pretalx-media-ccc-de
+        pretalx-pages
+        pretalx-public-voting
+        pretalx-venueless
+        pretalx-vimeo
+        pretalx-youtube
+      ];
     };
+    inherit
+      (pretalxPlugins)
+      pretalx-downstream
+      pretalx-media-ccc-de
+      pretalx-pages
+      pretalx-public-voting
+      pretalx-venueless
+      pretalx-vimeo
+      pretalx-youtube
+      ;
   };
 
   nixpkgs-candidates = {

diff --git a/configs/pretalx/pretalx.nix b/configs/pretalx/pretalx.nix
@@ -3,9 +3,7 @@
   pkgs,
   ...
 }: {
-  imports = [
-    ./vm.nix
-  ];
+  imports = [./vm.nix];
 
   nixpkgs.hostPlatform = "x86_64-linux";
 
@@ -35,7 +33,7 @@
   services = {
     pretalx = {
       enable = true;
-      package = pkgs.pretalx;
+      package = pkgs.pretalx-full;
       nginx = {
         # For a production configuration use this attribute set to configure the virtual host for pretalx.
       };

diff --git a/flake.nix b/flake.nix
@@ -26,7 +26,7 @@
     with builtins; let
       importPackages = pkgs:
         import ./all-packages.nix {
-          inherit (pkgs) newScope;
+          inherit (pkgs) newScope lib;
         };
 
       importNixpkgs = system: overlays:

diff --git a/modules/pretalx.nix b/modules/pretalx.nix
@@ -16,11 +16,26 @@ with lib; let
   gunicornSocket = "unix:${gunicornSocketPath}";
   pretalxWebServiceName = "pretalx-web";
 
+  extras =
+    cfg.package.optional-dependencies.redis
+    ++ lib.optionals (cfg.database.backend == "mysql") cfg.package.optional-dependencies.mysql
+    ++ lib.optionals (cfg.database.backend == "postgresql") cfg.package.optional-dependencies.postgres;
+
+  PYTHONPATH = "${cfg.package.PYTHONPATH}:${cfg.package.python.pkgs.makePythonPath extras}";
+
+  pretalxWrapped =
+    pkgs.runCommand "pretalx-wrapper"
+    {nativeBuildInputs = [pkgs.makeWrapper pkgs.python3Packages.wrapPython];}
+    ''
+      makeWrapper ${cfg.package}/bin/pretalx \
+        $out/bin/pretalx --prefix PYTHONPATH : "${PYTHONPATH}"
+    '';
+
   # NOTE: This expect script might be replaced as soon as <https://github.com/pretalx/pretalx/issues/1551> is resolved.
   pretalxInit = pkgs.writeScriptBin "expect-pretalx-init" ''
     #! ${pkgs.expect}/bin/expect -f
     set timeout 10
-    spawn ${cfg.package}/bin/pretalx init
+    spawn ${pretalxWrapped}/bin/pretalx init
     log_user 0
 
     expect "E-Mail: "
@@ -47,10 +62,6 @@ with lib; let
     expect eof
   '';
 
-  environmentFile = pkgs.runCommand "pretalx-environ" {
-    buildInputs = [cfg.package gunicorn]; # Sets PYTHONPATH in derivation
-  } "echo PYTHONPATH=$PYTHONPATH > $out;";
-
   secretRecommendation = "Consider using a secret managing scheme such as `agenix` or `sops-nix` to generate this file.";
 in {
   options.services.pretalx = with types; {
@@ -128,7 +139,7 @@ in {
         description = ''
           Directory that contains static files. It needs to be writable by the pretalx process. pretalx will put files there.
         '';
-        default = "${cfg.filesystem.data}/static";
+        default = "${cfg.package.static}";
       };
     };
 
@@ -288,6 +299,16 @@ in {
         default = null;
         example = "/run/secrets/pretalx/celery-broker";
       };
+
+      extraArgs = mkOption {
+        type = listOf str;
+        default = [];
+        description = ''
+          Extra arguments to pass to celery.
+          See <https://docs.celeryq.dev/en/stable/reference/cli.html#celery-worker> for more info.
+        '';
+        apply = escapeShellArgs;
+      };
     };
 
     redis = {
@@ -417,7 +438,7 @@ in {
     users.groups."${cfg.group}" = {};
 
     environment.systemPackages = [
-      cfg.package
+      pretalxWrapped
     ];
 
     environment.etc."pretalx/pretalx.cfg".text = let
@@ -427,9 +448,8 @@ in {
         then s
         else {};
       pretalxCfg =
-        filterAttrs (n: v:
-          v != {}) # Removes empty attrsets, otherwise `generators.toINI` will fail.
-
+        # Removes empty attrsets, otherwise `generators.toINI` will fail.
+        filterAttrs (n: v: v != {})
         (filterAttrsRecursive (n: v: (!(elem n hiddenNames) && v != null)) {
           inherit (cfg) filesystem site database locale;
 
@@ -441,7 +461,24 @@ in {
     in
       generators.toINI {} (recursiveUpdate pretalxCfg cfg.extraConfig);
 
-    systemd = {
+    systemd = let
+      commonUnitConfig = {
+        serviceConfig = {
+          User = cfg.user;
+          Group = cfg.group;
+          StateDirectory = "pretalx";
+          LogsDirectory = "pretalx";
+          WorkingDirectory = libDir;
+          RuntimeDirectory = "pretalx";
+          SupplementaryGroups = ["redis-pretalx"];
+        };
+        after =
+          []
+          ++ lib.optionals cfg.redis.enable ["redis-pretalx.service"]
+          ++ lib.optionals (cfg.database.backend == "postgresql") ["postgresql.service"]
+          ++ lib.optionals (cfg.database.backend == "mysql") ["mysql.service"];
+      };
+    in {
       sockets."pretalx-web" = {
         listenStreams = [gunicornSocketPath];
         socketConfig.SocketUser = config.services.nginx.user;
@@ -456,43 +493,38 @@ in {
           ++ optional (cfg.site.secretFile != null) (catFile "SECRET_KEY" cfg.site.secretFile)
           ++ optional cfg.celery.enable ''
             ${catFile "PRETALX_CELERY_BACKEND" cfg.celery.backendFile}
+            ${catFile "RESULT_BACKEND" cfg.celery.brokerFile}
             ${catFile "PRETALX_CELERY_BROKER" cfg.celery.brokerFile}
+            ${catFile "BROKER_URL" cfg.celery.brokerFile}
           '');
-        oneshotServiceConfig = {
-          Type = "oneshot";
-          EnvironmentFile = environmentFile;
-          User = cfg.user;
-          Group = cfg.group;
-          WorkingDirectory = libDir;
-        };
-        mkOneshot = command: {
-          serviceConfig = oneshotServiceConfig;
-          script = ''
-            ${exportPasswordEnv}
-            ${cfg.package}/bin/pretalx ${command}
-          '';
-        };
+        mkOneshot = command:
+          recursiveUpdate commonUnitConfig {
+            serviceConfig = {
+              Type = "oneshot";
+            };
+            script = ''
+              ${exportPasswordEnv}
+              ${pretalxWrapped}/bin/pretalx ${command}
+            '';
+          };
       in {
-        ${pretalxWebServiceName} = {
+        ${pretalxWebServiceName} = recursiveUpdate commonUnitConfig {
           serviceConfig = {
             Restart = "on-failure";
-            EnvironmentFile = environmentFile;
-            User = cfg.user;
-            Group = cfg.group;
-            WorkingDirectory = libDir;
           };
+          environment.PYTHONPATH = PYTHONPATH;
           script = ''
             ${exportPasswordEnv}
 
             exec ${gunicorn}/bin/gunicorn pretalx.wsgi --name=${pretalxWebServiceName} --bind=${gunicornSocket} ${cfg.gunicorn.extraArgs}
           '';
           wantedBy = ["multi-user.target"];
-          requires = ["pretalx-init.service" "pretalx-rebuild.service" "pretalx-web.socket"];
+          requires = ["pretalx-init.service" "pretalx-web.socket"];
           after = ["pretalx-init.service"];
         };
 
-        pretalx-init = {
-          serviceConfig = oneshotServiceConfig;
+        pretalx-init = recursiveUpdate commonUnitConfig {
+          serviceConfig.Type = "oneshot";
           script = ''
             ${exportPasswordEnv}
             ${pretalxInit}/bin/expect-pretalx-init
@@ -502,9 +534,19 @@ in {
         };
 
         pretalx-migrate = mkOneshot "migrate";
-        pretalx-rebuild = mkOneshot "rebuild";
         pretalx-clearsessions = mkOneshot "clearsessions";
         pretalx-runperiodic = mkOneshot "runperiodic";
+
+        pretalx-worker = mkIf cfg.celery.enable (recursiveUpdate commonUnitConfig {
+          description = "pretalx asynchronous job runner";
+          environment.PYTHONPATH = PYTHONPATH;
+          after = commonUnitConfig.after ++ ["network.target"];
+          wantedBy = ["multi-user.target"];
+          script = ''
+            ${exportPasswordEnv}
+            ${cfg.package.python.pkgs.celery}/bin/celery --app pretalx.celery_app worker ${cfg.celery.extraArgs}
+          '';
+        });
       };
 
       timers = let