sync plugin endpoint refactor

front/plugins/sync/README.md

@@ -115,7 +115,7 @@ Initially, I had one virtual machine (VM) with 6 network cards, one for each VLA
 2. Set the schedule (5 minutes works for me).
 3. **API Token**: Use any string, but it must match the clients (e.g., `abc123`).
 4. **Encryption Key**: Use any string, but it must match the clients (e.g., `abc123`).
-5. Under **Nodes**, add the full URL for each client, e.g., `http://192.168.1.20.20211/`.
+5. Under **Nodes**, add the full URL for each client, e.g., `http://192.168.1.20.20212/`, where the port `20212` is the value of the `GRAPHQL_PORT` setting of the given node (client)
 6. **Node Name**: Leave blank.
 7. Check **Sync Devices**.
 

front/plugins/sync/config.json

@@ -245,7 +245,7 @@
       "description": [
         {
           "language_code": "en_us",
-          "string": "If specified, the hub will pull Devices data from the listed nodes. The <code>API_TOKEN</code> and <code>SYNC_encryption_key</code> must be set to the same value across the hub and all the nodes to ensure proper authentication and communication."
+          "string": "If specified, the hub will pull Devices data from the listed nodes. The <code>API_TOKEN</code> and <code>SYNC_encryption_key</code> must be set to the same value across the hub and all the nodes to ensure proper authentication and communication. Add full host URL and use the value of the <code>GRAPHQL_PORT</code> setting of the target, as the port."
         }
       ]
     },
@@ -271,7 +271,7 @@
       "description": [
         {
           "language_code": "en_us",
-          "string": "The URL of the hub (target instance). Set on the Node. Without a trailig slash, for example <code>http://192.168.1.82:20211</code>"
+          "string": "The URL of the hub (target instance) with the targets <code>GRAPHQL_PORT</code> set as port. Set on the Node. Without a trailig slash, for example <code>http://192.168.1.82:20212</code>"
         }
       ]
     },

front/plugins/sync/sync.py

@@ -265,66 +265,81 @@ def main():
 
     return 0
 
+# ------------------------------------------------------------------
+# Data retrieval methods
+api_endpoints = [
+    f"/sync",  # New Python-based endpoint
+    f"/plugins/sync/hub.php"  # Legacy PHP endpoint
+]
 
 # send data to the HUB
 def send_data(api_token, file_content, encryption_key, file_path, node_name, pref, hub_url):
-    # Encrypt the log data using the encryption_key
+    """Send encrypted data to HUB, preferring /sync endpoint and falling back to PHP version."""
     encrypted_data = encrypt_data(file_content, encryption_key)
-
     mylog('verbose', [f'[{pluginName}] Sending encrypted_data: "{encrypted_data}"'])
 
-    # Prepare the data payload for the POST request
     data = {
         'data': encrypted_data,
         'file_path': file_path,
         'plugin': pref,
         'node_name': node_name
     }
-    # Set the authorization header with the API token
     headers = {'Authorization': f'Bearer {api_token}'}
-    api_endpoint = f"{hub_url}/plugins/sync/hub.php"
-    response = requests.post(api_endpoint, data=data, headers=headers)
 
-    mylog('verbose', [f'[{pluginName}] response: "{response}"'])
+    for endpoint in api_endpoints:
+
+        final_endpoint = hub_url + endpoint
+
+        try:
+            response = requests.post(final_endpoint, data=data, headers=headers, timeout=5)
+            mylog('verbose', [f'[{pluginName}] Tried endpoint: {final_endpoint}, status: {response.status_code}'])
+
+            if response.status_code == 200:
+                message = f'[{pluginName}] Data for "{file_path}" sent successfully via {final_endpoint}'
+                mylog('verbose', [message])
+                write_notification(message, 'info', timeNowTZ())
+                return True
+
+        except requests.RequestException as e:
+            mylog('verbose', [f'[{pluginName}] Error calling {final_endpoint}: {e}'])
+
+    # If all endpoints fail
+    message = f'[{pluginName}] Failed to send data for "{file_path}" via all endpoints'
+    mylog('verbose', [message])
+    write_notification(message, 'alert', timeNowTZ())
+    return False
+
 
-    if response.status_code == 200:
-        message = f'[{pluginName}] Data for "{file_path}" sent successfully'
-        mylog('verbose', [message])
-        write_notification(message, 'info', timeNowTZ())
-    else:
-        message = f'[{pluginName}] Failed to send data for "{file_path}" (Status code: {response.status_code})'
-        mylog('verbose', [message])
-        write_notification(message, 'alert', timeNowTZ())
-        
 # get data from the nodes to the HUB
 def get_data(api_token, node_url):
+    """Get data from NODE, preferring /sync endpoint and falling back to PHP version."""
     mylog('verbose', [f'[{pluginName}] Getting data from node: "{node_url}"'])
-    
-    # Set the authorization header with the API token
     headers = {'Authorization': f'Bearer {api_token}'}
-    api_endpoint = f"{node_url}/plugins/sync/hub.php"
-    response = requests.get(api_endpoint, headers=headers)
 
-    # mylog('verbose', [f'[{pluginName}] response: "{response.text}"'])
+    for endpoint in api_endpoints:
+
+        final_endpoint = node_url + endpoint
 
-    if response.status_code == 200:
         try:
-            # Parse JSON response
-            response_json = response.json()
-            
-            return response_json
+            response = requests.get(final_endpoint, headers=headers, timeout=5)
+            mylog('verbose', [f'[{pluginName}] Tried endpoint: {final_endpoint}, status: {response.status_code}'])
 
-        except json.JSONDecodeError:
-            message = f'[{pluginName}] Failed to parse JSON response from "{node_url}"'
-            mylog('verbose', [message])
-            write_notification(message, 'alert', timeNowTZ())
-            return ""
+            if response.status_code == 200:
+                try:
+                    return response.json()
+                except json.JSONDecodeError:
+                    message = f'[{pluginName}] Failed to parse JSON from {final_endpoint}'
+                    mylog('verbose', [message])
+                    write_notification(message, 'alert', timeNowTZ())
+                    return ""
+        except requests.RequestException as e:
+            mylog('verbose', [f'[{pluginName}] Error calling {final_endpoint}: {e}'])
 
-    else:
-        message = f'[{pluginName}] Failed to send data for "{node_url}" (Status code: {response.status_code})'
-        mylog('verbose', [message])
-        write_notification(message, 'alert', timeNowTZ())
-        return ""
+    # If all endpoints fail
+    message = f'[{pluginName}] Failed to get data from "{node_url}" via all endpoints'
+    mylog('verbose', [message])
+    write_notification(message, 'alert', timeNowTZ())
+    return ""