presence stream writer

COPYING

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2020, 2022-2023 Daniel Løvbrøtte Olsen and contributors
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

MIGRATIONS.MD

@@ -1,10 +0,0 @@
-# Migrations
-
-This is a best effort document descibing neccecary changes you might have to do when updating
-
-## 0.5.0
-
-* The module has been renamed from `synapse` to `default`
-* The synapse module now expects a wrapper-style package. This means the module is now incompatible with nixpkgs < 23.11.
-
-

README.MD

@@ -9,10 +9,6 @@ With matrix.YOURDOMAIN pointing at the server:
 
     workers.federationSenders = 1;
     workers.federationReceivers = 1;
-    workers.initialSyncers = 1;
-    workers.normalSyncers = 1;
-    workers.eventPersisters = 2;
-    workers.useUserDirectoryWorker = true;
 
     enableNginx = true;
 
@@ -35,20 +31,4 @@ With matrix.YOURDOMAIN pointing at the server:
 }
 ```
 
-is ~enough to get a functional matrix-server running with some workers
-
-## Sliding Sync (Element X)
-
-Just add the following to your config and point `slidingsync.YOURDOMAIN` at the server
-
-```
-services.matrix-synapse-next = {
-  enableSlidingSync = true;
-};
-
-services.matrix-synapse.sliding-sync.environmentFile = "/some/file/containing/SYNCV3_SECRET=<some secret>";
-
-```
-
-If using [well-known delagation](https://matrix-org.github.io/synapse/v1.37/delegate.html) make sure `YOURDOMAIN/.well-known/matrix/client` matches
-what's in `matrix.YOURDOMAIN/.well-known/matrix/client`
+is ~enough to get a functional matrix-server running one federation sender and one federation receiver

flake.nix

@@ -7,7 +7,7 @@
 
   outputs = { self, nixpkgs-lib }: {
     nixosModules = {
-      default = import ./module.nix;
+      synapse = import ./synapse-module { matrix-lib = self.lib; };
     };
     lib = import ./lib.nix { lib = nixpkgs-lib.lib; };
   };

module.nix

@@ -1,8 +0,0 @@
-{ ... }:
-
-{
-  imports = [
-    ./synapse-module
-    ./sliding-sync
-  ];
-}

sliding-sync/default.nix

@@ -1,117 +0,0 @@
-{ config, lib, pkgs, ... }:
-
-let
-  cfg = config.services.matrix-synapse.sliding-sync;
-in
-{
-  disabledModules = [ "services/matrix/matrix-sliding-sync.nix" ];
-
-  options.services.matrix-synapse.sliding-sync = {
-    enable = lib.mkEnableOption (lib.mdDoc "sliding sync");
-
-    package = lib.mkOption {
-      type = lib.types.package;
-      default = pkgs.matrix-sliding-sync;
-      description = "What package to use for the sliding-sync proxy.";
-    };
-
-    enableNginx = lib.mkEnableOption (lib.mdDoc "autogenerated nginx config");
-    publicBaseUrl = lib.mkOption {
-      type = lib.types.str;
-      description = "The domain where clients connect, only has an effect with enableNginx";
-      example = "slidingsync.matrix.org";
-    };
-
-    settings = lib.mkOption {
-      type = lib.types.submodule {
-        freeformType = with lib.types; attrsOf str;
-        options = {
-          SYNCV3_SERVER = lib.mkOption {
-            type = lib.types.str;
-            description = lib.mdDoc ''
-              The destination homeserver to talk to not including `/_matrix/` e.g `https://matrix.example.org`.
-            '';
-          };
-
-          SYNCV3_DB = lib.mkOption {
-            type = lib.types.str;
-            default = "postgresql:///matrix-sliding-sync?host=/run/postgresql";
-            description = lib.mdDoc ''
-              The postgres connection string.
-              Refer to <https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING>.
-            '';
-          };
-
-          SYNCV3_BINDADDR = lib.mkOption {
-            type = lib.types.str;
-            default = "127.0.0.1:8009";
-            example = "[::]:8008";
-            description = lib.mdDoc "The interface and port to listen on.";
-          };
-
-          SYNCV3_LOG_LEVEL = lib.mkOption {
-            type = lib.types.enum [ "trace" "debug" "info" "warn" "error" "fatal" ];
-            default = "info";
-            description = lib.mdDoc "The level of verbosity for messages logged.";
-          };
-        };
-      };
-      default = { };
-      description = ''
-        Freeform environment variables passed to the sliding sync proxy.
-        Refer to <https://github.com/matrix-org/sliding-sync#setup> for all supported values.
-      '';
-    };
-
-    createDatabase = lib.mkOption {
-      type = lib.types.bool;
-      default = true;
-      description = lib.mdDoc ''
-        Whether to enable and configure `services.postgres` to ensure that the database user `matrix-sliding-sync`
-        and the database `matrix-sliding-sync` exist.
-      '';
-    };
-
-    environmentFile = lib.mkOption {
-      type = lib.types.str;
-      description = lib.mdDoc ''
-        Environment file as defined in {manpage}`systemd.exec(5)`.
-
-        This must contain the {env}`SYNCV3_SECRET` variable which should
-        be generated with {command}`openssl rand -hex 32`.
-      '';
-    };
-  };
-
-  config = lib.mkIf cfg.enable {
-    services.postgresql = lib.optionalAttrs cfg.createDatabase {
-      enable = true;
-      ensureDatabases = [ "matrix-sliding-sync" ];
-      ensureUsers = [ rec {
-        name = "matrix-sliding-sync";
-        ensurePermissions."DATABASE \"${name}\"" = "ALL PRIVILEGES";
-      } ];
-    };
-
-    systemd.services.matrix-sliding-sync = {
-      after = lib.optional cfg.createDatabase "postgresql.service";
-      wantedBy = [ "multi-user.target" ];
-      environment = cfg.settings;
-      serviceConfig = {
-        DynamicUser = true;
-        EnvironmentFile = cfg.environmentFile;
-        ExecStart = lib.getExe cfg.package;
-        StateDirectory = "matrix-sliding-sync";
-        WorkingDirectory = "%S/matrix-sliding-sync";
-      };
-    };
-
-    services.nginx.virtualHosts.${cfg.publicBaseUrl} = lib.mkIf cfg.enableNginx {
-      enableACME = true;
-      forceSSL = true;
-      locations."/" = {
-        proxyPass = lib.replaceStrings [ "0.0.0.0" "::" ] [ "127.0.0.1" "::1" ] "http://${cfg.settings.SYNCV3_BINDADDR}";
-      };
-    };
-  };
-}

synapse-module/default.nix

@@ -1,7 +1,6 @@
+{ matrix-lib }:
 { pkgs, lib, config, ... }:
-let 
-  matrix-lib = (import ../lib.nix { inherit lib; });
-
+let
   cfg = config.services.matrix-synapse-next;
   wcfg = cfg.workers;
 
@@ -11,22 +10,8 @@ let
 
   format = pkgs.formats.yaml {};
   matrix-synapse-common-config = format.generate "matrix-synapse-common-config.yaml" cfg.settings;
-
-  # TODO: Align better with the upstream module
-  wrapped = cfg.package.override { 
-    inherit (cfg) plugins;
-    extras = [
-      "postgres"
-      "saml2"
-      "oidc"
-      "systemd"
-      "url-preview"
-      "sentry"
-      "jwt"
-      "redis"
-      "cache-memory"
-      "user-search"
-    ];
+  pluginsEnv = cfg.package.python.buildEnv.override {
+    extraLibs = cfg.plugins;
   };
 
   inherit (lib)
@@ -47,7 +32,7 @@ in
   imports = [
     ./nginx.nix
     (import ./workers.nix {
-      inherit matrix-lib throw' format matrix-synapse-common-config wrapped;
+      inherit matrix-lib throw' format matrix-synapse-common-config pluginsEnv;
     })
   ];
 
@@ -98,8 +83,6 @@ in
       description = "A yaml python logging config file";
     };
 
-    enableSlidingSync = mkEnableOption (lib.mdDoc "automatic Sliding Sync setup at `slidingsync.<domain>`");
-
     settings = mkOption {
       type = types.submodule {
         freeformType = format.type;
@@ -390,6 +373,9 @@ in
           };
         in "${cfg.package}/bin/synapse_homeserver ${flags}";
 
+        environment.PYTHONPATH =
+          lib.makeSearchPathOutput "lib" cfg.package.python.sitePackages [ pluginsEnv ];
+
         serviceConfig = {
           Type = "notify";
           User = "matrix-synapse";
@@ -401,25 +387,11 @@ in
               config-path = [ matrix-synapse-common-config ] ++ cfg.extraConfigFiles;
               keys-directory = cfg.dataDir;
             };
-          in "${wrapped}/bin/synapse_homeserver ${flags}";
+          in "${cfg.package}/bin/synapse_homeserver ${flags}";
           ExecReload = "${pkgs.utillinux}/bin/kill -HUP $MAINPID";
           Restart = "on-failure";
         };
       };
     };
-
-    services.matrix-synapse-next.settings.extra_well_known_client_content."org.matrix.msc3575.proxy" = mkIf cfg.enableSlidingSync {
-      url = "https://${config.services.matrix-synapse.sliding-sync.publicBaseUrl}";
-    };
-    services.matrix-synapse.sliding-sync = mkIf cfg.enableSlidingSync {
-      enable = true;
-      enableNginx = lib.mkDefault cfg.enableNginx;
-      publicBaseUrl = lib.mkDefault "slidingsync.${cfg.settings.server_name}";
-
-      settings = {
-        SYNCV3_SERVER = lib.mkDefault "https://${cfg.public_baseurl}";
-        SYNCV3_PROM = lib.mkIf cfg.settings.enable_metrics (lib.mkDefault "127.0.0.1:9001");
-      };
-    };
   };
 }

synapse-module/nginx.nix

@@ -117,6 +117,7 @@ in
         synapse_federation_transaction synapse_worker_federation;
 
         synapse_client_user-dir synapse_worker_user-dir;
+        synapse_client_presence synapse_worker_stream-presence;
       }
 
       # from https://github.com/tswfi/synapse/commit/b3704b936663cc692241e978dce4ac623276b1a6
@@ -187,6 +188,14 @@ in
       '';
     };
 
+    services.nginx.upstreams.synapse_worker_stream-presence = {
+      servers = let
+        workers = getWorkersOfType "stream-presence";
+        socketAddresses = generateSocketAddresses "client" workers;
+      in if workers != { } then
+        lib.genAttrs socketAddresses (_: { })
+      else config.services.nginx.upstreams.synapse_master.servers;
+    };
 
     services.nginx.upstreams.synapse_worker_user-dir = {
       servers = let
@@ -198,7 +207,7 @@ in
     };
 
     services.nginx.virtualHosts."${cfg.public_baseurl}" = {
-      enableACME = lib.mkDefault true;
+      enableACME = true;
       forceSSL = true;
       locations."/_matrix" = {
         proxyPass = "http://$synapse_backend";
@@ -230,9 +239,6 @@ in
       locations."/_synapse/client" = {
         proxyPass = "http://$synapse_backend";
       };
-      locations."/.well-known/matrix" = {
-        proxyPass = "http://$synapse_backend";
-      };
     };
   };
 }

synapse-module/workers.nix

@@ -1,6 +1,6 @@
 { matrix-synapse-common-config,
   matrix-lib,
-  wrapped,
+  pluginsEnv,
   throw',
   format
 }:
@@ -69,6 +69,20 @@ in {
           default = "synapse.app.generic_worker";
         };
 
+        worker_replication_host = mkOption {
+          type = types.str;
+          default = wcfg.mainReplicationHost;
+          defaultText = literalExpression "${wcfgText}.mainReplicationHost";
+          description = "The replication listeners IP on the main synapse process";
+        };
+
+        worker_replication_http_port = mkOption {
+          type = types.port;
+          default = wcfg.mainReplicationPort;
+          defaultText = literalExpression "${wcfgText}.mainReplicationPort";
+          description = "The replication listeners port on the main synapse process";
+        };
+
         worker_listeners = mkOption {
           type = types.listOf (workerListenerType instanceCfg);
           description = "Listener configuration for the worker, similar to the main synapse listener";
@@ -212,6 +226,7 @@ in {
     eventPersisters = mkWorkerCountOption "event-persister";
 
     useUserDirectoryWorker = mkEnableOption "user directory worker";
+    usePresenceStreamWriter = mkEnableOption "prescence stream writer";
 
     instances = mkOption {
       type = types.attrsOf workerInstanceType;
@@ -237,18 +252,11 @@ in {
       federation_sender_instances =
         lib.genList (i: "auto-fed-sender${toString (i + 1)}") wcfg.federationSenders;
 
-      instance_map = (lib.mkIf (cfg.workers.instances != { }) ({
-        main = let
-          host = lib.head mainReplicationListener.bind_addresses;
-        in {
-          host = if builtins.elem host [ "0.0.0.0" "::"] then "127.0.0.1" else host;
-          port = mainReplicationListener.port;
-        };
-      } // genAttrs' (lib.lists.range 1 wcfg.eventPersisters)
+      instance_map = genAttrs' (lib.lists.range 1 wcfg.eventPersisters)
         (i: "auto-event-persist${toString i}")
         (i: let
           wRL = matrix-lib.firstListenerOfType "replication" wcfg.instances."auto-event-persist${toString i}".settings.worker_listeners;
-        in matrix-lib.connectionInfo wRL)));
+        in matrix-lib.connectionInfo wRL);
 
       stream_writers.events =
         mkIf (wcfg.eventPersisters > 0)
@@ -296,6 +304,11 @@ in {
           numberOfWorkers = 1;
           nameFn = _: "auto-user-dir";
         };
+      }) // (lib.optionalAttrs wcfg.usePresenceStreamWriter {
+        "stream-presence" = {
+          numberOfWorkers = 1;
+          nameFn = _: "auto-stream-presence";
+        };
       });
 
       coerceWorker = { name, value }: if builtins.isInt value then {
@@ -333,6 +346,9 @@ in {
         wantedBy = [ "matrix-synapse.target" ];
         after = [ "matrix-synapse.service" ];
         requires = [ "matrix-synapse.service" ];
+        environment.PYTHONPATH = lib.makeSearchPathOutput "lib" cfg.package.python.sitePackages [
+          pluginsEnv
+        ];
         serviceConfig = {
           Type = "notify";
           User = "matrix-synapse";
@@ -350,7 +366,7 @@ in {
               config-path = [ matrix-synapse-common-config (workerConfig worker) ] ++ cfg.extraConfigFiles;
               keys-directory = cfg.dataDir;
             };
-          in "${wrapped}/bin/synapse_worker ${flags}";
+          in "${cfg.package}/bin/synapse_worker ${flags}";
         };
       };
     }));