Refactor mullvad-relay-selector

Implement a system for choosing appropriate relay(s) built on 'queries'.
A query is a set of constraints which dictates which relay(s) that *can*
be chosen by the relay selector.

The user's settings can naturally be expressed as a query. The semantics
of merging two queries in a way that always prefer user settings is
defined by the new `Intersection` trait.

Decrust `mullvad-relay-selector` by splitting it up into several modules

- `query.rs`: Definition of a query on different types of relays. This
module is integral to the new API of `mullvad-relay-selector`
- `matcher.rs`: Logic for filtering out candidate relays based on a query.
- `detailer.rs`: Logic for deriving connection details for the selected relay.
- `tests/`: Integration tests for the new relay selector. These tests only use
the public APIs of `RelaySelector` and make sure that the output matches
the expected output in different scenarios.

Author: MarkusPettersson98

Cargo.lock

@@ -68,6 +68,8 @@ chrono = { version = "0.4.26", default-features = false}
 clap = { version = "4.4.18", features = ["cargo", "derive"] }
 once_cell = "1.13"
 
+# Test dependencies
+proptest = "1.4"
 
 [profile.release]
 opt-level = 3

Cargo.toml

@@ -2,9 +2,10 @@ use anyhow::{bail, Result};
 use clap::Subcommand;
 use mullvad_management_interface::MullvadProxyClient;
 use mullvad_types::{
+    constraints::Constraint,
     relay_constraints::{
-        BridgeConstraintsFormatter, BridgeState, BridgeType, Constraint, LocationConstraint,
-        Ownership, Provider, Providers,
+        BridgeConstraintsFormatter, BridgeState, BridgeType, LocationConstraint, Ownership,
+        Provider, Providers,
     },
     relay_list::RelayEndpointData,
 };

mullvad-cli/src/cmds/bridge.rs

@@ -3,8 +3,7 @@ use anyhow::{anyhow, bail, Result};
 use clap::Subcommand;
 use mullvad_management_interface::MullvadProxyClient;
 use mullvad_types::{
-    relay_constraints::{Constraint, GeographicLocationConstraint},
-    relay_list::RelayList,
+    constraints::Constraint, relay_constraints::GeographicLocationConstraint, relay_list::RelayList,
 };
 
 #[derive(Subcommand, Debug)]

mullvad-cli/src/cmds/custom_list.rs

@@ -1,6 +1,9 @@
 use anyhow::Result;
 use mullvad_management_interface::MullvadProxyClient;
-use mullvad_types::relay_constraints::{Constraint, RelayConstraints, RelaySettings};
+use mullvad_types::{
+    constraints::Constraint,
+    relay_constraints::{RelayConstraints, RelaySettings},
+};
 
 #[derive(clap::Subcommand, Debug)]
 pub enum DebugCommands {

mullvad-cli/src/cmds/debug.rs

@@ -1,8 +1,9 @@
 use anyhow::Result;
 use clap::Subcommand;
 use mullvad_management_interface::MullvadProxyClient;
-use mullvad_types::relay_constraints::{
-    Constraint, ObfuscationSettings, SelectedObfuscation, Udp2TcpObfuscationSettings,
+use mullvad_types::{
+    constraints::Constraint,
+    relay_constraints::{ObfuscationSettings, SelectedObfuscation, Udp2TcpObfuscationSettings},
 };
 
 #[derive(Subcommand, Debug)]

mullvad-cli/src/cmds/obfuscation.rs

@@ -3,10 +3,11 @@ use clap::Subcommand;
 use itertools::Itertools;
 use mullvad_management_interface::MullvadProxyClient;
 use mullvad_types::{
+    constraints::{Constraint, Match},
     location::{CountryCode, Location},
     relay_constraints::{
-        Constraint, GeographicLocationConstraint, LocationConstraint, LocationConstraintFormatter,
-        Match, OpenVpnConstraints, Ownership, Provider, Providers, RelayConstraints, RelayOverride,
+        GeographicLocationConstraint, LocationConstraint, LocationConstraintFormatter,
+        OpenVpnConstraints, Ownership, Provider, Providers, RelayConstraints, RelayOverride,
         RelaySettings, TransportPort, WireguardConstraints,
     },
     relay_list::{RelayEndpointData, RelayListCountry},
@@ -318,7 +319,7 @@ impl Relay {
 
                 print_option!(
                     "Multihop state",
-                    if constraints.wireguard_constraints.use_multihop {
+                    if constraints.wireguard_constraints.multihop() {
                         "enabled"
                     } else {
                         "disabled"
@@ -679,7 +680,7 @@ impl Relay {
             wireguard_constraints.ip_version = ipv;
         }
         if let Some(use_multihop) = use_multihop {
-            wireguard_constraints.use_multihop = *use_multihop;
+            wireguard_constraints.use_multihop(*use_multihop);
         }
         match entry_location {
             Some(EntryArgs::Location(location_args)) => {

mullvad-cli/src/cmds/relay.rs

@@ -1,7 +1,8 @@
 use clap::Args;
 use mullvad_types::{
+    constraints::Constraint,
     location::{CityCode, CountryCode, Hostname},
-    relay_constraints::{Constraint, GeographicLocationConstraint, LocationConstraint},
+    relay_constraints::{GeographicLocationConstraint, LocationConstraint},
 };
 
 #[derive(Args, Debug, Clone)]

mullvad-cli/src/cmds/relay_constraints.rs

@@ -2,7 +2,7 @@ use anyhow::Result;
 use clap::Subcommand;
 use mullvad_management_interface::MullvadProxyClient;
 use mullvad_types::{
-    relay_constraints::Constraint,
+    constraints::Constraint,
     wireguard::{QuantumResistantState, RotationInterval, DEFAULT_ROTATION_INTERVAL},
 };
 

mullvad-cli/src/cmds/tunnel.rs

@@ -1,9 +1,8 @@
 use crate::{new_selector_config, Daemon, Error, EventListener};
 use mullvad_types::{
+    constraints::Constraint,
     custom_list::{CustomList, Id},
-    relay_constraints::{
-        BridgeState, Constraint, LocationConstraint, RelaySettings, ResolvedBridgeSettings,
-    },
+    relay_constraints::{BridgeState, LocationConstraint, RelaySettings, ResolvedBridgeSettings},
 };
 use talpid_types::net::TunnelType;
 
@@ -133,7 +132,7 @@ where
             {
                 match endpoint.tunnel_type {
                     TunnelType::Wireguard => {
-                        if relay_settings.wireguard_constraints.use_multihop {
+                        if relay_settings.wireguard_constraints.multihop() {
                             if let Constraint::Only(LocationConstraint::CustomList { list_id }) =
                                 &relay_settings.wireguard_constraints.entry_location
                             {

mullvad-daemon/src/custom_list.rs

@@ -1348,12 +1348,10 @@ impl TunnelStateChangeHandler {
 #[cfg(test)]
 mod test {
     use super::{Error, TunnelStateChangeHandler, WG_DEVICE_CHECK_THRESHOLD};
-    use mullvad_relay_selector::RelaySelector;
     use std::sync::{
         atomic::{AtomicBool, Ordering},
         Arc,
     };
-    use talpid_types::net::TunnelType;
 
     const TIMEOUT_ERROR: Error = Error::OtherRestError(mullvad_api::rest::Error::TimeoutError);
 
@@ -1437,24 +1435,26 @@ mod test {
         );
     }
 
-    /// Test whether the relay selector selects wireguard often enough, given no special
-    /// constraints, to verify that the device is valid
-    #[test]
-    fn test_validates_by_default() {
-        for attempt in 0.. {
-            let should_validate =
-                TunnelStateChangeHandler::should_check_validity_on_attempt(attempt);
-            let (_, _, tunnel_type) =
-                RelaySelector::preferred_tunnel_constraints(attempt.try_into().unwrap());
-            assert_eq!(
-                tunnel_type,
-                TunnelType::Wireguard,
-                "failed on attempt {attempt}"
-            );
-            if should_validate {
-                // Now that we've triggered a device check, we can give up
-                break;
-            }
-        }
-    }
+    // TODO(markus): `preferred_tunnel_constraints` is slated for removal - consider writing a new test which
+    // does not depend on relay selector internals.
+    // /// Test whether the relay selector selects wireguard often enough, given no special
+    // /// constraints, to verify that the device is valid
+    // #[test]
+    // fn test_validates_by_default() {
+    //     for attempt in 0.. {
+    //         let should_validate =
+    //             TunnelStateChangeHandler::should_check_validity_on_attempt(attempt);
+    //         let (_, _, tunnel_type) =
+    //             RelaySelector::preferred_tunnel_constraints(attempt.try_into().unwrap());
+    //         assert_eq!(
+    //             tunnel_type,
+    //             TunnelType::Wireguard,
+    //             "failed on attempt {attempt}"
+    //         );
+    //         if should_validate {
+    //             // Now that we've triggered a device check, we can give up
+    //             break;
+    //         }
+    //     }
+    // }
 }

mullvad-daemon/src/device/mod.rs

@@ -1105,7 +1105,7 @@ where
                     // Note that `Constraint::Any` corresponds to just IPv4
                     matches!(
                         relay_constraints.wireguard_constraints.ip_version,
-                        mullvad_types::relay_constraints::Constraint::Only(IpVersion::V6)
+                        mullvad_types::constraints::Constraint::Only(IpVersion::V6)
                     )
                 } else {
                     false

mullvad-daemon/src/lib.rs

@@ -1,5 +1,5 @@
 use super::Result;
-use mullvad_types::{relay_constraints::Constraint, settings::SettingsVersion};
+use mullvad_types::{constraints::Constraint, settings::SettingsVersion};
 use serde::{Deserialize, Serialize};
 
 // ======================================================

mullvad-daemon/src/migrations/v1.rs

@@ -1,5 +1,5 @@
 use super::{Error, Result};
-use mullvad_types::{relay_constraints::Constraint, settings::SettingsVersion};
+use mullvad_types::{constraints::Constraint, settings::SettingsVersion};
 use serde::{Deserialize, Serialize};
 
 // ======================================================

mullvad-daemon/src/migrations/v4.rs

@@ -1,5 +1,5 @@
 use super::{Error, Result};
-use mullvad_types::{relay_constraints::Constraint, settings::SettingsVersion};
+use mullvad_types::{constraints::Constraint, settings::SettingsVersion};
 use serde::{Deserialize, Serialize};
 
 // ======================================================

mullvad-daemon/src/migrations/v5.rs

@@ -1,5 +1,5 @@
 use super::{Error, Result};
-use mullvad_types::{relay_constraints::Constraint, settings::SettingsVersion};
+use mullvad_types::{constraints::Constraint, settings::SettingsVersion};
 use serde::{Deserialize, Serialize};
 
 // ======================================================

mullvad-daemon/src/migrations/v6.rs

@@ -376,16 +376,13 @@ impl<'a> Display for SettingsSummary<'a> {
             write!(f, ", wg ip version: {ip_version}")?;
         }
 
-        let multihop = matches!(
-            relay_settings,
+        let multihop = match relay_settings {
             RelaySettings::Normal(RelayConstraints {
-                wireguard_constraints: WireguardConstraints {
-                    use_multihop: true,
-                    ..
-                },
+                wireguard_constraints,
                 ..
-            })
-        );
+            }) => wireguard_constraints.multihop(),
+            _ => false,
+        };
 
         write!(
             f,