Graph Merge

Makefile

@@ -384,7 +384,7 @@ docs/user-guide/nexctl.md: dist/nexctl hack/nexctl-docs.sh
 	$(ECHO_PREFIX) printf "  %-12s nexctl\n" "[DOCS]"
 	$(CMD_PREFIX) hack/nexctl-docs.sh
 
-dist/.generate: $(SWAGGER_YAML) $(PRIVATE_SWAGGER_YAML) dist/.ui-fmt docs/user-guide/nexd.md docs/user-guide/nexctl.md | dist
+dist/.generate: $(SWAGGER_YAML) $(PRIVATE_SWAGGER_YAML)  docs/user-guide/nexd.md docs/user-guide/nexctl.md | dist
 	$(ECHO_PREFIX) printf "  %-12s \n" "[MOD TIDY]"
 	$(CMD_PREFIX) go mod tidy
 

docs/development/design/status-api.md

@@ -0,0 +1,75 @@
+# Design Document: Status API
+
+## Introduction
+
+The goal of this design document is to outline the purpose and implementation of the status API.
+
+## The Problem
+
+There is a visual disconnect for a user's Nexodus network of devices.
+
+## The Solution
+
+With the addition of an API endpoint, device statuses can be created and stored. The status of devices in a user's Nexodus network can then be visualized in a web interface. The network will be displayed as a graph.
+
+## Implementation
+
+A general view of a device's connectivity includes:
+
+  1. Devices a source device is attempting to directly connect to
+  2. Is the device connected to a relay and which devices is it using the relay to connect to
+  3. Which devices can it reach successfully
+  4. The latency of the source to each device in the network
+
+The proposed API additions are as follows:
+
+```go
+    // Create new statuses
+    private.POST("/status", api.CreateStatus)
+    // List all satuses for a user's devices
+    private.GET("/status", api.ListStatuses)
+    // Updates a device status if a status already exists
+    private.PUT("/status", api.UpdateStatus)
+```
+
+## New Tables
+
+    A new table will be defined for device statuses.
+
+### Status Model
+
+- New models
+
+```go
+    // Status represents the status of single user device 
+    type Status struct {
+        Base
+        UserId      uuid.UUID `json:"user_id"`
+        WgIP        string    `json:"wg_ip"`
+        IsReachable bool      `json:"is_reachable"`
+        Hostname    string    `json:"hostname"`
+        Latency     string    `json:"latency"`
+        Method      string    `json:"method"`
+    }
+
+    // AddStatus is the information necessary to add a device status
+    type AddStatus struct {
+        WgIP        string `json:"wg_ip"`
+        IsReachable bool   `json:"is_reachable"`
+        Hostname    string `json:"hostname"`
+        Latency     string `json:"latency"`
+        Method      string `json:"method"`
+    }
+
+    // UpdateStatus is the information needed to update a device status that already exists
+    type UpdateStatus struct{
+        WgIP        string  `json:"wg_ip"`
+        IsReachable bool   `json:"is_reachable"`
+        Latency     string `json:"latency"`
+        Method      string `json:"method"`
+    }
+```
+
+### The Graph Display
+
+React Flow library was chosen for its flexibility and support for customization. The custom nodes were created with a set of criteria in mind including the shape of the node, the border color based on latency, icons for the connection status, and what information to include in the table when the node is clicked on. The device nodes are rectangular in shape, while the relay nodes are oval shaped. The border color will display green if the latency is in the range of 0 to 40 milliseconds, gold/orange if the latency is between 41 to 80 milliseconds, and red if the latency is 81 milliseconds or higher. If a device or relay is reachable, then a green check mark icon will appear on the right side of the node. If a device or relay becomes unreachable, then a red X icon will appear instead. The graph organizes itself show devices connected directly to the host device and those connected to a relay. The nodes are draggable for better organization based on user preferences. The data is fetched every 3 minutes and the information in the nodes is updated.

go.mod

@@ -1,6 +1,6 @@
 module github.com/nexodus-io/nexodus
 
-go 1.22
+go 1.22.0
 
 require (
 	github.com/Nerzal/gocloak/v13 v13.9.0
@@ -60,10 +60,10 @@ require (
 	go.opentelemetry.io/otel/trace v1.22.0
 	go.uber.org/zap v1.26.0
 	golang.org/x/exp v0.0.0-20230905200255-921286631fa9
-	golang.org/x/net v0.23.0
+	golang.org/x/net v0.21.0
 	golang.org/x/oauth2 v0.17.0
-	golang.org/x/sys v0.18.0
-	golang.org/x/term v0.18.0
+	golang.org/x/sys v0.17.0
+	golang.org/x/term v0.17.0
 	golang.zx2c4.com/wireguard v0.0.0-20230325221338-052af4a8072b
 	golang.zx2c4.com/wireguard/wgctrl v0.0.0-20230215201556-9c5414ab4bde
 	google.golang.org/genproto/googleapis/rpc v0.0.0-20240213162025-012b6fc9bca9

go.sum

@@ -684,11 +684,11 @@ golang.org/x/net v0.6.0/go.mod h1:2Tu9+aMcznHK/AK1HMvgo6xiTLG5rD5rZLDS+rp2Bjs=
 golang.org/x/net v0.7.0/go.mod h1:2Tu9+aMcznHK/AK1HMvgo6xiTLG5rD5rZLDS+rp2Bjs=
 golang.org/x/net v0.9.0/go.mod h1:d48xBJpPfHeWQsugry2m+kC02ZBRGRgulfHnEXEuWns=
 golang.org/x/net v0.10.0/go.mod h1:0qNGK6F8kojg2nk9dLZ2mShWaEBan6FAoqfSigmmuDg=
-golang.org/x/net v0.23.0 h1:7EYJ93RZ9vYSZAIb2x3lnuvqO5zneoD6IvWjuhfxjTs=
-golang.org/x/net v0.23.0/go.mod h1:JKghWKKOSdJwpW2GEx0Ja7fmaKnMsbu+MWVZTokSYmg=
+golang.org/x/net v0.21.0 h1:AQyQV4dYCvJ7vGmJyKki9+PBdyvhkSd8EIx/qb0AYv4=
+golang.org/x/net v0.21.0/go.mod h1:bIjVDfnllIU7BJ2DNgfnXvpSvtn8VRwhlsaeUTyUS44=
 golang.org/x/oauth2 v0.0.0-20180821212333-d2e6202438be/go.mod h1:N/0e6XlmueqKjAGxoOufVs8QHGRruUQn6yWY3a++T0U=
-golang.org/x/oauth2 v0.17.0 h1:6m3ZPmLEFdVxKKWnKq4VqZ60gutO35zm+zrAHVmHyDQ=
-golang.org/x/oauth2 v0.17.0/go.mod h1:OzPDGQiuQMguemayvdylqddI7qcD9lnSDb+1FiwQ5HA=
+golang.org/x/oauth2 v0.18.0 h1:09qnuIAgzdx1XplqJvW6CQqMCtGZykZWcXzPMPUusvI=
+golang.org/x/oauth2 v0.18.0/go.mod h1:Wf7knwG0MPoWIMMBgFlEaSUDaKskp0dCfrlJRJXbBi8=
 golang.org/x/sync v0.0.0-20180314180146-1d60e4601c6f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
 golang.org/x/sync v0.0.0-20181108010431-42b317875d0f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
 golang.org/x/sync v0.0.0-20181221193216-37e7f081c4d4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=

internal/client/.openapi-generator/FILES

@@ -9,6 +9,8 @@ api_reg_key.go
 api_security_group.go
 api_service_network.go
 api_sites.go
+api_status.go
+api_statuses.go
 api_users.go
 api_vpc.go
 client.go
@@ -20,6 +22,7 @@ model_models_add_reg_key.go
 model_models_add_security_group.go
 model_models_add_service_network.go
 model_models_add_site.go
+model_models_add_status.go
 model_models_add_vpc.go
 model_models_base_error.go
 model_models_certificate_signing_request.go
@@ -39,6 +42,7 @@ model_models_security_group.go
 model_models_security_rule.go
 model_models_service_network.go
 model_models_site.go
+model_models_status.go
 model_models_tunnel_ip.go
 model_models_update_device.go
 model_models_update_reg_key.go