NS API socks5 support (#6361)

* Add conversion from gw_probe crate type

* Move code around
- split 1000+ LoC files into smaller ones

* Add socks5 field
- code improvements in gw_probe crate

* Fix docker build
- install go
- required as build dependency of gw probe

* Add logs to agent

* NS API: configure DB via env

* rebase fix

* socks5 score calc

* Cargo fmt

* use existing div_ceil

* Code improvements

* Bump NS API version

* Rename variables

* Bump API & agent version

* Try to fix CI

* Build only on linux

Author: dynco-nym

.github/workflows/ci-build.yml

@@ -89,7 +89,7 @@ jobs:
         uses: actions-rs/cargo@v1
         with:
           command: clippy
-          args: --workspace --all-targets --exclude nym-gateway-probe -- -D warnings
+          args: --workspace --all-targets --exclude nym-gateway-probe --exclude nym-node-status-api -- -D warnings
 
       - name: Clippy (non-macos)
         if: contains(matrix.os, 'linux') || contains(matrix.os, 'windows')
@@ -104,6 +104,14 @@ jobs:
         with:
           command: build
 
+        # only build on linux because of wg FFI bindings of its dependency (network probe)
+      - name: Build nym-node-status-api (linux only)
+        if: runner.os == 'Linux'
+        uses: actions-rs/cargo@v1
+        with:
+          command: build
+          args: -p nym-node-status-api
+
       - name: Build all examples
         if: contains(matrix.os, 'linux')
         uses: actions-rs/cargo@v1

Cargo.lock

@@ -185,7 +185,6 @@ default-members = [
     "nym-credential-proxy/nym-credential-proxy",
     "nym-node",
     "nym-node-status-api/nym-node-status-agent",
-    "nym-node-status-api/nym-node-status-api",
     "nym-statistics-api",
     "nym-validator-rewarder",
     "nyx-chain-watcher",

Cargo.toml

@@ -38,6 +38,7 @@ tokio = { workspace = true, features = [
 tokio-util.workspace = true
 tracing-subscriber.workspace = true
 url = { workspace = true }
+utoipa = { workspace = true, optional = true }
 x25519-dalek = { workspace = true, features = [
     "reusable_secrets",
     "static_secrets",
@@ -76,6 +77,9 @@ time = { workspace = true }
 # TEMP: REMOVE BEFORE PR
 nym-topology = { workspace = true }
 
+[features]
+utoipa = ["dep:utoipa"]
+
 [build-dependencies]
 anyhow = { workspace = true }
 vergen-gitcl = { workspace = true, default-features = false, features = [

nym-gateway-probe/Cargo.toml

@@ -13,5 +13,5 @@ pub(crate) mod netstack;
 pub(crate) mod nodes;
 pub(crate) mod probe_tests;
 pub(crate) mod socks5_test;
-pub(crate) mod types;
+pub mod types;
 pub(crate) mod wireguard;

nym-gateway-probe/src/common/mod.rs

@@ -73,6 +73,7 @@ struct SingleHttpsTestResult {
     error: Option<String>,
 }
 
+#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
 #[derive(Debug, Clone, Serialize, Deserialize, Default)]
 pub struct HttpsConnectivityResult {
     /// successfully completed HTTPS request
@@ -88,17 +89,17 @@ pub struct HttpsConnectivityResult {
     endpoint_used: Option<String>,
 
     /// error message(s) (if any)
-    error: Option<Vec<String>>,
+    errors: Option<Vec<String>>,
 }
 
 impl HttpsConnectivityResult {
-    pub fn with_errors(error: Vec<String>) -> Self {
+    pub fn with_errors(errors: Vec<String>) -> Self {
         Self {
             https_success: false,
             https_status_code: None,
             https_latency_ms: None,
             endpoint_used: None,
-            error: Some(error),
+            errors: Some(errors),
         }
     }
 
@@ -135,7 +136,7 @@ impl HttpsConnectivityResult {
             https_latency_ms: Some(avg_latency),
             endpoint_used: last_success.endpoint_used.clone(),
             // even in case of success, some errors were possible
-            error: if errors.is_empty() {
+            errors: if errors.is_empty() {
                 None
             } else {
                 Some(errors)
@@ -158,4 +159,8 @@ impl HttpsConnectivityResult {
     pub fn endpoint_used(&self) -> Option<&String> {
         self.endpoint_used.as_ref()
     }
+
+    pub fn errors(&self) -> Option<&Vec<String>> {
+        self.errors.as_ref()
+    }
 }

nym-gateway-probe/src/common/socks5_test/mod.rs

@@ -10,6 +10,7 @@ pub struct ProbeResult {
     pub outcome: ProbeOutcome,
 }
 
+#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
 #[derive(Debug, Clone, Serialize, Deserialize)]
 pub struct ProbeOutcome {
     pub as_entry: Entry,
@@ -19,6 +20,7 @@ pub struct ProbeOutcome {
     pub lp: Option<LpProbeResults>,
 }
 
+#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
 #[derive(Debug, Clone, Serialize, Deserialize, Default)]
 #[serde(rename = "wg")]
 pub struct WgProbeResults {
@@ -48,6 +50,7 @@ pub struct WgProbeResults {
     pub download_error_v6: String,
 }
 
+#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
 #[derive(Debug, Clone, Serialize, Deserialize, Default)]
 #[serde(rename = "lp")]
 pub struct LpProbeResults {
@@ -57,6 +60,7 @@ pub struct LpProbeResults {
     pub error: Option<String>,
 }
 
+#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
 #[derive(Debug, Clone, Serialize, Deserialize)]
 #[serde(untagged)]
 #[allow(clippy::enum_variant_names)]
@@ -98,12 +102,14 @@ impl Entry {
     }
 }
 
+#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
 #[derive(Debug, Clone, Serialize, Deserialize)]
 pub struct EntryTestResult {
     pub can_connect: bool,
     pub can_route: bool,
 }
 
+#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
 #[derive(Debug, Clone, Serialize, Deserialize)]
 pub struct Exit {
     pub can_connect: bool,
@@ -135,7 +141,8 @@ impl Exit {
     }
 }
 
-#[derive(Debug, Clone, Serialize, Deserialize, Default)]
+#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
+#[derive(Debug, Clone, Serialize, Deserialize)]
 pub struct Socks5ProbeResults {
     /// whether we could establish a SOCKS5 proxy connection
     can_connect_socks5: bool,
@@ -165,6 +172,14 @@ impl Socks5ProbeResults {
             https_connectivity: HttpsConnectivityResult::with_errors(vec![error.into()]),
         }
     }
+
+    pub fn can_connect_socks5(&self) -> bool {
+        self.can_connect_socks5
+    }
+
+    pub fn https_connectivity(&self) -> &HttpsConnectivityResult {
+        &self.https_connectivity
+    }
 }
 
 #[derive(Debug, Clone, Default)]

nym-gateway-probe/src/common/types.rs

@@ -27,6 +27,7 @@ use tracing::*;
 use url::Url;
 
 mod common;
+pub use common::types;
 pub mod config;
 
 use crate::common::bandwidth_helpers::{

nym-gateway-probe/src/lib.rs

@@ -3,7 +3,7 @@
 
 [package]
 name = "nym-node-status-agent"
-version = "1.1.0"
+version = "1.1.1"
 authors.workspace = true
 repository.workspace = true
 homepage.workspace = true
@@ -23,6 +23,8 @@ nym-crypto = { workspace = true, features = ["asymmetric", "rand"] }
 
 nym-node-status-client = { path = "../nym-node-status-client" }
 rand = { workspace = true }
+regex = { workspace = true }
+serde_json = { workspace = true }
 tokio = { workspace = true, features = [
     "macros",
     "rt-multi-thread",

nym-node-status-api/nym-node-status-agent/Cargo.toml

@@ -4,7 +4,6 @@ An agent to run tests and report results back to the Node Status API.
 
 Environment variables that can be set individually are:
 
-- `NYM_NODE_MNEMONICS` - mnemonic to get tickets for tests 
 - `NODE_STATUS_AGENT_SERVER_PORT` - Node Status API port
 - `NODE_STATUS_AGENT_SERVER_ADDRESS` - Node Status API address