WIP: create tests

Co-authored-by: h7x4 <h7x4@nani.wtf>

.gitignore

@@ -0,0 +1 @@
+result

MIGRATIONS.MD

@@ -0,0 +1,10 @@
+# Migrations
+
+This is a best effort document descibing neccecary changes you might have to do when updating
+
+## 0.5.0 UNRELEASED
+
+The module has been renamed from `synapse` to `default`
+
+
+

README.MD

@@ -36,3 +36,19 @@ 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`

flake.lock

@@ -1,5 +1,20 @@
 {
   "nodes": {
+    "nixpkgs": {
+      "locked": {
+        "lastModified": 1690789960,
+        "narHash": "sha256-3K+2HuyGTiJUSZNJxXXvc0qj4xFx1FHC/ItYtEa7/Xs=",
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "fb942492b7accdee4e6d17f5447091c65897dde4",
+        "type": "github"
+      },
+      "original": {
+        "id": "nixpkgs",
+        "ref": "nixos-unstable",
+        "type": "indirect"
+      }
+    },
     "nixpkgs-lib": {
       "locked": {
         "lastModified": 1673743903,
@@ -17,6 +32,7 @@
     },
     "root": {
       "inputs": {
+        "nixpkgs": "nixpkgs",
         "nixpkgs-lib": "nixpkgs-lib"
       }
     }

flake.nix

@@ -2,13 +2,27 @@
   description = "NixOS modules for matrix related services";
 
   inputs = {
-    nixpkgs-lib.url = github:nix-community/nixpkgs.lib;
+    nixpkgs-lib.url = "github:nix-community/nixpkgs.lib";
+    nixpkgs.url = "nixpkgs/nixos-unstable";
   };
 
-  outputs = { self, nixpkgs-lib }: {
+  outputs = { self, nixpkgs, nixpkgs-lib }: {
     nixosModules = {
-      synapse = import ./synapse-module;
+      default = import ./module.nix;
     };
+
     lib = import ./lib.nix { lib = nixpkgs-lib.lib; };
+
+    packages = let
+      system = "x86_64-linux";
+      pkgs = nixpkgs.legacyPackages.${system};
+    in {
+        ${system}.tests = import ./tests {
+        inherit system;
+        inherit nixpkgs;
+        inherit pkgs;
+        nixosModule = self.outputs.nixosModules.synapse;
+      };
+    };
   };
 }

module.nix

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

pkgs/matrix-sliding-sync/default.nix

@@ -0,0 +1,37 @@
+{ lib
+, buildGoModule
+, fetchFromGitHub
+}:
+
+buildGoModule rec {
+  pname = "matrix-sliding-sync";
+  version = "0.99.11";
+
+  src = fetchFromGitHub {
+    owner = "matrix-org";
+    repo = "sliding-sync";
+    rev = "refs/tags/v${version}";
+    hash = "sha256-Wd/nnJhKg+BDyOIz42zEScjzQRrpEq6YG9/9Tk24hgg=";
+  };
+
+  vendorHash = "sha256-0QSyYhOht1j1tWNxHQh+NUZA/W1xy7ANu+29H/gusOE=";
+
+  subPackages = [ "cmd/syncv3" ];
+
+  ldflags = [
+    "-s"
+    "-w"
+    "-X main.GitCommit=${src.rev}"
+  ];
+
+  # requires a running matrix-synapse
+  doCheck = false;
+
+  meta = with lib; {
+    description = "A sliding sync implementation of MSC3575 for matrix";
+    homepage = "https://github.com/matrix-org/sliding-sync";
+    license = with licenses; [ asl20 ];
+    maintainers = with maintainers; [ emilylange ];
+    mainProgram = "syncv3";
+  };
+}

sliding-sync/default.nix

@@ -0,0 +1,117 @@
+{ 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.callPackage ../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

@@ -84,6 +84,8 @@ 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;
@@ -394,5 +396,19 @@ in
         };
       };
     };
+
+    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

@@ -230,6 +230,9 @@ in
       locations."/_synapse/client" = {
         proxyPass = "http://$synapse_backend";
       };
+      locations."/.well-known/matrix" = {
+        proxyPass = "http://$synapse_backend";
+      };
     };
   };
 }

synapse-module/workers.nix

@@ -19,6 +19,7 @@
     type = types.ints.unsigned;
     description = "How many automatically configured ${workerType} workers to set up";
     default = 0;
+    example = 1;
   };
 
   genAttrs' = items: f: g: builtins.listToAttrs (map (i: lib.nameValuePair (f i) (g i)) items);
@@ -33,11 +34,25 @@ in {
           type = types.bool;
           internal = true;
           default = false;
+          description = ''
+            This is an internal flag that signals that this worker is part of the
+            workers generated by either of the following:
+
+            - federationSenders
+            - federationReceivers
+            - initialSyncers
+            - normalSyncers
+            - eventPersisters
+            - useUserDirectoryWorker
+          '';
         };
 
         index = mkOption {
           internal = true;
           type = types.ints.positive;
+          description = ''
+            This is an internal variable that indexes the worker of this type.
+          '';
         };
 
         # The custom string type here is mainly for the name to use
@@ -85,17 +100,25 @@ in {
           default = "http";
         };
 
-        port = mkOption {
-          type = types.port;
-          description = "The TCP port to bind to";
+        path = mkOption {
+          type = types.path;
+          default = instanceCfg.name;
+          description = ''
+            A path and filename for a Unix socket.
+          '';
         };
 
-        bind_addresses = mkOption {
-          type = with types; listOf str;
-          description = "A list of local addresses to listen on";
-          default = [ wcfg.defaultListenerAddress ];
-          defaultText = literalExpression "[ ${wcfgText}.defaultListenerAddress ]";
-        };
+        # port = mkOption {
+        #   type = types.port;
+        #   description = "The TCP port to bind to";
+        # };
+
+        # bind_addresses = mkOption {
+        #   type = with types; listOf str;
+        #   description = "A list of local addresses to listen on";
+        #   default = [ wcfg.defaultListenerAddress ];
+        #   defaultText = literalExpression "[ ${wcfgText}.defaultListenerAddress ]";
+        # };
 
         tls = mkOption {
           type = types.bool;
@@ -160,38 +183,6 @@ in {
       };
     };
   in {
-    mainReplicationHost = mkOption {
-      type = types.str;
-      default = let
-        host = (matrix-lib.connectionInfo mainReplicationListener).host;
-      in
-        # To avoid connecting to 0.0.0.0 and so on
-        if builtins.elem host [ "0.0.0.0" "::" ]
-          then "127.0.0.1"
-          else host;
-      # TODO: add defaultText
-      description = "Host of the main synapse instance's replication listener";
-    };
-
-    mainReplicationPort = mkOption {
-      type = types.port;
-      default = mainReplicationListener.port;
-      # TODO: add defaultText
-      description = "Port for the main synapse instance's replication listener";
-    };
-
-    defaultListenerAddress = mkOption {
-      type = types.str;
-      default = "127.0.0.1";
-      description = "The default listener address for the worker";
-    };
-
-    workerStartingPort = mkOption {
-      type = types.port;
-      description = "What port should the automatically configured workers start enumerating from";
-      default = 8083;
-    };
-
     enableMetrics = mkOption {
       type = types.bool;
       default = cfg.settings.enable_metrics;
@@ -199,12 +190,6 @@ in {
       # TODO: add description
     };
 
-    metricsStartingPort = mkOption {
-      type = types.port;
-      default = 18083;
-      # TODO: add description
-    };
-
     federationSenders = mkWorkerCountOption "federation-sender";
     federationReceivers = mkWorkerCountOption "federation-reciever";
     initialSyncers = mkWorkerCountOption "initial-syncer";
@@ -218,13 +203,14 @@ in {
       default = { };
       description = "Worker configuration";
       example = {
-        "federation_sender1" = {
+        "federation-sender-1" = {
           settings = {
-            worker_name = "federation_sender1";
+            worker_name = "federation-sender-1";
             worker_app = "synapse.app.generic_worker";
 
-            worker_replication_host = "127.0.0.1";
-            worker_replication_http_port = 9093;
+            path = "/run/matrix-synapse/federation-sender-1.sock";
+            # worker_replication_host = "127.0.0.1";
+            # worker_replication_http_port = 9093;
             worker_listeners = [ ];
           };
         };
@@ -232,94 +218,59 @@ in {
     };
   };
 
-  config = {
+  config = let 
+    genList1 = f: builtins.genList (i: f (i + 1));
+  in {
     services.matrix-synapse-next.settings = {
       federation_sender_instances =
-        lib.genList (i: "auto-fed-sender${toString (i + 1)}") wcfg.federationSenders;
+        genList1 (i: "auto-fed-sender-${toString i}") 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)
-        (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)));
+      instance_map = lib.mkIf (cfg.workers.instances != { }) ({
+        main.path = "/run/matrix-synapse/main-replication-worker.sock";
+      } // builtins.mapAttrs (n: v: {
+        inherit (builtins.head v.settings.worker_listeners) path;
+      }) wcfg.instances);
 
       stream_writers.events =
         mkIf (wcfg.eventPersisters > 0)
-        (lib.genList (i: "auto-event-persist${toString (i + 1)}") wcfg.eventPersisters); 
+          (genList1 (i: "auto-event-persist-${toString i}") wcfg.eventPersisters); 
 
       update_user_directory_from_worker =
-        mkIf wcfg.useUserDirectoryWorker "auto-user-dir";
+        mkIf wcfg.useUserDirectoryWorker "auto-user-dir-1";
     };
 
-    services.matrix-synapse-next.workers.instances = let
-      sum = lib.foldl lib.add 0;
-      workerListenersWithMetrics = portOffset:
-        lib.singleton ({
-          port = wcfg.workerStartingPort + portOffset - 1;
-        }) 
-        ++ lib.optional wcfg.enableMetrics {
-          port = wcfg.metricsStartingPort + portOffset;
-          resources = [ { names = [ "metrics" ]; } ];
+    services.matrix-synapse-next.workers.instances =
+      let
+        workerInstances = {
+          "fed-sender" = wcfg.federationSenders;
+          "fed-receiver" = wcfg.federationReceivers;
+          "initial-sync" = wcfg.initialSyncers;
+          "normal-sync" = wcfg.normalSyncers;
+          "event-persist" = wcfg.eventPersisters;
+          "user-dir" = if wcfg.useUserDirectoryWorker then 1 else 0;
         };
-
-      makeWorkerInstances = {
-        type,
-        numberOfWorkers,
-        portOffset ? 0,
-        nameFn ? i: "auto-${type}${toString i}",
-        workerListenerFn ? i: workerListenersWithMetrics (portOffset + i)
-      }: genAttrs'
-        (lib.lists.range 1 numberOfWorkers)
-        nameFn
-        (i: {
-          isAuto = true;
-          inherit type;
-          index = i;
-          settings.worker_listeners = workerListenerFn i;
-        });
-
-      workerInstances = {
-        "fed-sender" = wcfg.federationSenders;
-        "fed-receiver" = wcfg.federationReceivers;
-        "initial-sync" = wcfg.initialSyncers;
-        "normal-sync" = wcfg.normalSyncers;
-        "event-persist" = wcfg.eventPersisters;
-      } // (lib.optionalAttrs wcfg.useUserDirectoryWorker {
-        "user-dir" = {
-          numberOfWorkers = 1;
-          nameFn = _: "auto-user-dir";
-        };
-      });
-
-      coerceWorker = { name, value }: if builtins.isInt value then {
-        type = name;
-        numberOfWorkers = value;
-      } else { type = name; } // value;
-
-      # Like foldl, but keeps all intermediate values
-      #
-      # (b -> a -> b) -> b -> [a] -> [b]
-      scanl = f: x1: list: let
-        x2 = lib.head list;
-        x1' = f x1 x2;
-      in if list == [] then [] else [x1'] ++ (scanl f x1' (lib.tail list));
-
-      f = { portOffset, numberOfWorkers, ... }: x: x // { portOffset = portOffset + numberOfWorkers; };
-      init = { portOffset = 0; numberOfWorkers = 0; };
-    in lib.pipe workerInstances [
-      (lib.mapAttrsToList lib.nameValuePair)
-      (map coerceWorker)
-      (scanl f init)
-      (map makeWorkerInstances)
-      mkMerge
-    ];
+      in
+        lib.pipe workerInstances [
+          (lib.mapAttrsToList (type: count: { inherit type count; }))
+          (map ({ type, count }: genList1 (i: rec {
+            name = "auto-${type}-${toString i}";
+            value = {
+              inherit type;
+              isAuto = true;
+              index = i;
+              settings.worker_listeners =
+                [
+                  { path = "/run/matrix-synapse/${name}.sock"; }
+                ] ++ lib.optionals wcfg.enableMetrics [{
+                  path = "/run/matrix-synapse/${name}-metrics.sock";
+                  resources = [{ names = [ "metrics" ]; }];
+                  type = "metrics";
+                }];
+            };
+          }) count))
+          lib.flatten
+          builtins.listToAttrs
+        ];
 
     systemd.services = let
       workerList = lib.mapAttrsToList lib.nameValuePair wcfg.instances;
@@ -328,28 +279,32 @@ in {
     in builtins.listToAttrs (lib.flip map workerList (worker: {
       name = "matrix-synapse-worker-${worker.name}";
       value = {
+        documentation = [ "https://github.com/matrix-org/synapse/blob/develop/docs/workers.md" ];
         description = "Synapse Matrix Worker";
         partOf = [ "matrix-synapse.target" ];
         wantedBy = [ "matrix-synapse.target" ];
         after = [ "matrix-synapse.service" ];
         requires = [ "matrix-synapse.service" ];
+        restartTriggers = [ matrix-synapse-common-config (workerConfig worker) ] ++ cfg.extraConfigFiles;
         environment = {
           PYTHONPATH = lib.makeSearchPathOutput "lib" cfg.package.python.sitePackages [
             pluginsEnv
           ];
         };
         serviceConfig = {
+          Restart = "always";
           Type = "notify";
           User = "matrix-synapse";
           Group = "matrix-synapse";
           Slice = "system-matrix-synapse.slice";
           WorkingDirectory = cfg.dataDir;
-          # ExecStartPre = pkgs.writers.writeBash "wait-for-synapse" ''
-          #   # From https://md.darmstadt.ccc.de/synapse-at-work
-          #   while ! systemctl is-active -q matrix-synapse.service; do
-          #       sleep 1
-          #   done
-          # '';
+          RuntimeDirectory = [ "matrix-synapse" ];
+          ExecStartPre = pkgs.writers.writeBash "wait-for-synapse" ''
+            # From https://md.darmstadt.ccc.de/synapse-at-work
+            while ! systemctl is-active -q matrix-synapse.service; do
+                sleep 1
+            done
+          '';
           ExecStart = let
             flags = lib.cli.toGNUCommandLineShell {} {
               config-path = [ matrix-synapse-common-config (workerConfig worker) ] ++ cfg.extraConfigFiles;

tests/auto-workers-config.nix

@@ -0,0 +1,18 @@
+{ pkgs, lib, ... }:
+{
+  services.matrix-synapse-next = {
+    enable = true;
+    settings.server_name = "matrix.example.com";
+
+    workers = {
+      enableMetrics = true;
+
+      federationSenders = 2;
+      federationReceivers = 2;
+      initialSyncers = 2;
+      normalSyncers = 2;
+      eventPersisters = 2;
+      useUserDirectoryWorker = true;
+    };
+  };
+}

tests/base-config.nix

@@ -0,0 +1,7 @@
+{ pkgs, lib, ... }:
+{
+  services.matrix-synapse-next = {
+    enable = true;
+    settings.server_name = "matrix.example.com";
+  };
+}

tests/default.nix

@@ -0,0 +1,16 @@
+{ nixpkgs, pkgs, system ? pkgs.system, nixosModule, ... }: let
+  buildSystemWithConfig = configPath: (nixpkgs.lib.nixosSystem {
+    inherit system;
+    modules = [
+      nixosModule
+      configPath
+      {
+        boot.isContainer = true;
+      }
+    ];
+  }).config.system.build.toplevel;
+in {
+  a = pkgs.writeText "hello-world" ''a'';
+  base-config = buildSystemWithConfig ./base-config.nix;
+  auto-workers-config = buildSystemWithConfig ./auto-workers-config.nix;
+}