From bb4c62dd382bf1ca89272e8ae208b85a500f9768 Mon Sep 17 00:00:00 2001 From: Luis Fernando Molina Date: Sun, 29 Aug 2021 21:17:21 +0200 Subject: [PATCH] Adding some comments --- Network/Queries/Events.js | 4 +++- Network/Queries/PostReplies.js | 3 +++ Network/Queries/ProfileFollowers.js | 5 ++++- Network/Queries/ProfileFollowing.js | 5 ++++- Network/Queries/ProfilePosts.js | 3 +++ Network/SocialGraphNetwokNode.js | 11 +++++++++++ Network/Utilities/QueriesValidations.js | 4 +++- Network/clientsInterface.js | 11 +++++++++-- 8 files changed, 40 insertions(+), 6 deletions(-) diff --git a/Network/Queries/Events.js b/Network/Queries/Events.js index 87b85f484..e4d10db87 100644 --- a/Network/Queries/Events.js +++ b/Network/Queries/Events.js @@ -1,5 +1,7 @@ exports.newEvents = function newEvents() { - + /* + This is the query executed to fill the timeline of a certain User or Bot Profile. + */ let thisObject = { profile: undefined, initialIndex: undefined, diff --git a/Network/Queries/PostReplies.js b/Network/Queries/PostReplies.js index 41a4f06a9..f5221fa2c 100644 --- a/Network/Queries/PostReplies.js +++ b/Network/Queries/PostReplies.js @@ -3,6 +3,9 @@ exports.newPostReplies = function newPostReplies() { Each Post regardless if it is authored by a User or Bot Profile, can have replies. This query is designed for Network Clients to fetch the posts metadata that are replies to a certain post. + + This is the query executed at the Network Client to fill the page + of a certain post, with all its replies. */ let thisObject = { profile: undefined, diff --git a/Network/Queries/ProfileFollowers.js b/Network/Queries/ProfileFollowers.js index 3fc0a3a9d..bf704f978 100644 --- a/Network/Queries/ProfileFollowers.js +++ b/Network/Queries/ProfileFollowers.js @@ -1,5 +1,8 @@ exports.newProfileFollowers = function newProfileFollowers() { - + /* + This module represents the query that allows a Network Client to know + all the User or Bot profiles that are following a certain User or Bot profile. + */ let thisObject = { profile: undefined, initialIndex: undefined, diff --git a/Network/Queries/ProfileFollowing.js b/Network/Queries/ProfileFollowing.js index 4fea1534d..845ee2c09 100644 --- a/Network/Queries/ProfileFollowing.js +++ b/Network/Queries/ProfileFollowing.js @@ -1,5 +1,8 @@ exports.newProfileFollowing = function newProfileFollowing() { - + /* + This module represents the query that allows a Network Client to know + all the User or Bot profiles that are being followed by a certain User or Bot profile. + */ let thisObject = { profile: undefined, initialIndex: undefined, diff --git a/Network/Queries/ProfilePosts.js b/Network/Queries/ProfilePosts.js index bbeded5d4..7f6255341 100644 --- a/Network/Queries/ProfilePosts.js +++ b/Network/Queries/ProfilePosts.js @@ -3,6 +3,9 @@ exports.newProfilePosts = function newProfilePosts() { Each User or Bot Profile can have posts. This query is designed for Network Clients to fetch the posts metadata they need from the Social Graph. + + This is the query to be executed to fill a Profile page + with all of its posts. */ let thisObject = { profile: undefined, diff --git a/Network/SocialGraphNetwokNode.js b/Network/SocialGraphNetwokNode.js index db8ae95c4..044ce2a2c 100644 --- a/Network/SocialGraphNetwokNode.js +++ b/Network/SocialGraphNetwokNode.js @@ -1,4 +1,15 @@ +/* +The Superalgos Network will have 3 types of nodes: + * Social Graph Nodes + * Search Index Nodes + * Private Message Nodes + +This module is the starting point of the Social Graph Network Node. + +This type of node is responsible for mantaining the whole Social Graph +or relationships between User and Bot profiles and also between their posts. +*/ global.NT = { memory: { diff --git a/Network/Utilities/QueriesValidations.js b/Network/Utilities/QueriesValidations.js index 618c1759b..60a244a3d 100644 --- a/Network/Utilities/QueriesValidations.js +++ b/Network/Utilities/QueriesValidations.js @@ -1,5 +1,7 @@ exports.newProfileFollowers = function newProfileFollowers() { - + /* + This module have a few funcions that are often needed at Queries Modules. + */ let thisObject = { profilesValidations: profilesValidations, postValidations: postValidations, diff --git a/Network/clientsInterface.js b/Network/clientsInterface.js index 1cc17e4d6..2f48f80df 100644 --- a/Network/clientsInterface.js +++ b/Network/clientsInterface.js @@ -1,5 +1,12 @@ exports.newClientInterface = function newClientInterface() { + /* + This module represents the Interface the Network Node have + with Network Clients connected to it. There are two things + Network Clients can do with this Network Node: + * Send an Event that happened at the Network Client to the Network. + * Make a Query to the Network Node for info needed at the Network Client. + */ let thisObject = { eventReceived: eventReceived, queryReceived: queryReceived, @@ -19,7 +26,7 @@ exports.newClientInterface = function newClientInterface() { function eventReceived(eventMessage) { /* - We expect here a JSON string with the following properties: + We expect here a JSON string with some or all of the following properties: { "eventId": "a8de78f0-c3e4-4a2a-b7e8-f659073969db", @@ -49,7 +56,7 @@ exports.newClientInterface = function newClientInterface() { function queryReceived(queryMessage) { /* - We expect here a JSON string with the following properties: + We expect here a JSON string with some or all of the following properties: { "equeryId": "a8de78f0-c3e4-4a2a-b7e8-f659073969db",