Merge branch 'Develop'

Author: GodOfAllBeings

App/ConnectedNodes.cs

@@ -1,7 +1,4 @@
 using Newtonsoft.Json;
-using Swashbuckle.AspNetCore.SwaggerGen;
-using System.Xml.Linq;
-using ServiceRegistry.Requests;
 using Newtonsoft.Json.Linq;
 //using ServiceRegistry.App;
 
@@ -14,7 +11,6 @@ public class ConnectedNodes
         static readonly string connectedRepositoriesPath = Path.Combine(Directory.GetCurrentDirectory(), "connectedRepositories.json");  
         private static Dictionary<string, Boolean> onlineStatus = new();
         private static Dictionary<string, JToken> configurations = new();
-
         public static ConnectedNodes Instance
         {
             get
@@ -31,7 +27,6 @@ private static List<string> GetRegisteredNodes(string pathToFile)
         {
             string fileAsString = File.ReadAllText(pathToFile);
             List<string> nodeUrls = JsonConvert.DeserializeObject<List<string>>(fileAsString);
-            //Dictionary<string, Node>? nodes = JsonConvert.DeserializeObject<Dictionary<string, Node>>(fileAsString);
             nodeUrls ??= new List<string>();
             return nodeUrls;
         }
@@ -68,12 +63,13 @@ public async Task<IResult> AddNode(string bodyString, NodeType type)
 
             string nodeUrl = bodyDict["Host"]; // TODO: Consider deserializing this body to avoid problems with capitalized letters
 
-            if (!nodes.Contains(nodeUrl)) // We only add nodes to the file if they don't exist. Overwriting config is fine.
+            if (!nodes.Contains(nodeUrl)) // We only add nodes to the file if they don't exist.
             {
                 nodes.Add(nodeUrl);
                 UpdateNodeFile(nodes, type);
             }
-
+            
+            //Writing or overwriting config.
             string configString = await Requests.Requests.GetConfigFromNode(nodeUrl);
             bool configFetched = AddConfiguration(nodeUrl, configString);
             if(!configFetched) return Results.Ok($"Node {nodeUrl} added but unable to get config.");
@@ -93,7 +89,7 @@ public IResult RemoveNode(string bodyString, NodeType type)
             configurations.Remove(nodeUrl);
             onlineStatus.Remove(nodeUrl);
 
-            return Results.Ok($"Repository {nodeUrl} successfully removed");
+            return Results.Ok($"Node {nodeUrl} successfully removed");
         }
 
         public void UpdateOnlineStatus()

App/Node.cs

@@ -1,7 +1,4 @@
-using Newtonsoft.Json;
-using Newtonsoft.Json.Converters;
-
-namespace ServiceRegistry.ConnectedNodes
+namespace ServiceRegistry.ConnectedNodes
 {
     public enum NodeType
     {

Endpoints/Endpoints.cs

@@ -1,10 +1,5 @@
-using System.Collections.Generic;
-using System.IO;
-using System.Linq;
-using System.Xml.Linq;
-using Newtonsoft.Json;
+using Newtonsoft.Json;
 using ServiceRegistry.ConnectedNodes;
-using ServiceRegistry.Requests;
 
 namespace ServiceRegistry.Endpoints
 {
@@ -61,6 +56,7 @@ public Endpoints(WebApplication app)
                 return "pong";
             });
 
+            // Recieves a list of URLs and responds with online status for each entry
             app.MapPost("/connections/filters", async (HttpRequest request) =>
             {
                 var body = new StreamReader(request.Body);
@@ -75,6 +71,7 @@ public Endpoints(WebApplication app)
                 return Results.Ok(requestedNodeUrls);
             });
 
+            // Recieves a list of URLs and responds with a list of configs for each entry
             app.MapPost("config/filters", async (HttpRequest request) =>
             {
                 var body = new StreamReader(request.Body);

README.md

@@ -1,6 +1,35 @@
 # Service registry
 
+## Starting the service registry
+This section describes how to start the service registry
+
+Open visual studio and click the run button at the top.
+
+## How to add services
+This sections describes how to add services to the service registry
+
+Send a post request to https://{host}:{port}/repository or https://{host}:{port}/miner with a json body consisting of a key-value pair as follows:
+
+```
+{
+	"Host": "http://my_new_host:1234"
+}
+```
+
+## How to remove services
+
+Functions exactly the same as adding hosts, except the request must be a delete request with a key-value pair as follows to https://{host}:{port}/repository or https://{host}:{port}/miner:
+
+```
+{
+	"Host": "http://my_new_host:1234"
+}
+```
+
+
 ## Docker
+This does not fulfill it's intended functionality when all services are running through docker on the same windows machine.
+
 This project supports docker runtime environment, for which you will need to download docker from here: https://www.docker.com/products/docker-desktop/.
 
 For this project, be aware that express listens on a specfic port (can be found in /Endpoints), which must be the same port that is used in the docker file. 
@@ -35,15 +64,15 @@ docker network create -d bridge data
 ## Docker Compose
 It is recommended to use this approach to run the application. To run this project using docker-compose you need to follow the steps below:
 
-Build the docker image:
+Build the docker image:  
 ```
 docker-compose build
 ```
-Run the docker image:
+Run the docker image:  
 ```
 docker-compose up
 ```
-Stop the docker image:
+Stop the docker image:  
 ```
 docker-compose down
 ```

Requests/Requests.cs

@@ -1,11 +1,4 @@
-using System.Text;
-using System;
-using Newtonsoft.Json;
-using System.Collections.Specialized;
-using Newtonsoft.Json.Linq;
-//using ServiceRegistry.App;
-
-namespace ServiceRegistry.Requests
+namespace ServiceRegistry.Requests
 {
     public class Requests
     {
@@ -26,7 +19,6 @@ public static async Task<bool> GetPing(string path)
             {
                 return false;
             }
-            
         }
 
         public static async Task<string> GetConfigFromNode(string nodeUrl)
@@ -36,9 +28,6 @@ public static async Task<string> GetConfigFromNode(string nodeUrl)
             {
                 Console.WriteLine("Requesting config from: " + requestPath);
 
-                //var message = new HttpRequestMessage(HttpMethod.Get, requestPath) { Version = new Version(2, 0) };
-                //var response = await client.SendAsync(message);
-
                 HttpResponseMessage response = await client.GetAsync(requestPath);
                 if (response.IsSuccessStatusCode)
                 {