# "The swarm-wide services run HERE."
#
# A swarm has one forge, one matrix, one SSO. This says this host is
# where they live, and asserts the per-service `enable`s that follow —
# the same mode-not-default shape as ./local-defaults.nix, one tier down.
#
# Only the *optional* services derive: matrix and authelia. The forge has
# no `enable` to assert, because it is not optional — it is the canonical
# store for the meta flake and every agent's config repo, so it deploys
# with hyperhive itself.
{
  lib,
  config,
  ...
}:
let
  swarmCfg = config.services.hyperhive.swarm;
in
{
  options.services.hyperhive.swarm.enableRequiredServices = lib.mkOption {
    type = lib.types.bool;
    default = false;
    example = true;
    description = ''
      Host the swarm's shared services on this hive. The services that
      exist once per swarm rather than once per hive and are *optional*
      — the matrix homeserver, the SSO provider — have their `enable`
      asserted from this, so a swarm's service host is declared in one
      place.

      The forge is swarm-wide too but has nothing to assert: it is the
      canonical store for the meta flake and every agent's config repo,
      so it deploys with hyperhive itself and is not optional.

      `services.hyperhive.enableAllLocalDefaults` turns this on as part
      of the all-on-one-box mode. Set it directly to run the swarm's
      services on a host that is not otherwise all-local — a dedicated
      services box with hives elsewhere is exactly that shape.

      With it off, this hive is a *client* of those services: it still
      configures how to reach them, it just doesn't run them.
    '';
  };

  # Same precedence reasoning as ./local-defaults.nix: fills in for an
  # operator who hasn't spoken, yields to one who has.
  config.services.hyperhive.swarm = {
    matrix.enable = lib.mkDefault swarmCfg.enableRequiredServices;
    authelia.enable = lib.mkDefault swarmCfg.enableRequiredServices;
    # The queue. Added later than the two above and missed at the time —
    # this file predates the `swarm-nats` container by nine days and had
    # not been revisited since, so its absence was sequence rather than
    # intent. It meets the rule in the option's own description exactly:
    # once per swarm, and optional.
    #
    # The tell that it was an omission: `local-defaults.nix` already
    # derives `nats.autoGenerateCallout` from the all-local mode, so that
    # mode was minting the queue's callout nkeys and then never starting
    # the queue they authenticate against.
    nats.enable = lib.mkDefault swarmCfg.enableRequiredServices;

    # The metrics pair. Once per swarm and optional, so they meet the rule
    # in the option's description the same way the three above do — a hive
    # that is not the service host is a *client* of this Grafana, not a
    # second one.
    #
    # They derive together on purpose: a store with no UI is unreadable and
    # a UI with no store is empty, so there is no sensible deployment that
    # takes one and not the other from this switch. An operator who wants
    # exactly one still sets it directly, which `mkDefault` allows.
    victoriametrics.enable = lib.mkDefault swarmCfg.enableRequiredServices;
    grafana.enable = lib.mkDefault swarmCfg.enableRequiredServices;
  };

  # The collector that feeds the pair above. Missed for the same reason
  # `nats.enable` was above (found while investigating why grafana showed
  # nothing on a swarm-services host): `otel.nix` predates this file's
  # last revisit, so its absence here was omission, not intent — a
  # swarm-services host otherwise gets victoriametrics + grafana running
  # with nothing feeding them until an operator flips `otel.enable` by
  # hand. `services.hyperhive.otel` (note: no `swarm.` prefix, this is the
  # existing per-hive option from ./otel.nix, not a new swarm-scoped one)
  # already treats a co-located `swarm.victoriametrics.enable` as a
  # complete destination with no `endpoint` required (see that module's
  # own history), so this default is self-sufficient on exactly the host
  # it fires on.
  config.services.hyperhive.otel.enable = lib.mkDefault swarmCfg.enableRequiredServices;
}