naeural-client 3.1.4__py3-none-any.whl → 3.2.0__py3-none-any.whl

naeural_client/base/instance.py

@@ -49,6 +49,7 @@ class Instance():
     self.log = log
     self.pipeline = pipeline
     self.instance_id = instance_id
+    self.last_known_status = None
     self.signature = signature.upper()
     self.config = {}
     self.__debug = debug
@@ -673,3 +674,40 @@ class Instance():
       self.temporary_detach(attachment)
 
       return result_payload
+
+  def get_status(self):
+    """
+    Get the status of the instance.
+    
+    Returns
+    -------
+    dict
+        The status of the instance with keys from `PLUGIN_INFO` class constants
+                
+    Example:
+    --------
+    ```json
+    {
+      "CURRENT_EXEC_ITERATION": 2147088,
+      "CURRENT_PROCESS_ITERATION": 0,
+      "EXEC_TIMESTAMP": "2025-02-28 07:06:40.612999",
+      "FIRST_ERROR_TIME": null,
+      "FREQUENCY": null,
+      "INFO": null,
+      "INIT_TIMESTAMP": "2025-02-27 10:24:56.622480",
+      "INSTANCE_ID": "RECE01_default",
+      "LAST_CONFIG_TIMESTAMP": "2025-02-27 10:24:56.622340",
+      "LAST_ERROR_TIME": null,
+      "LAST_PAYLOAD_TIME": "2025-02-27 10:24:56",
+      "OUTSIDE_WORKING_HOURS": false,
+      "PROCESS_DELAY": 1,
+      "SIGNATURE": "REST_CUSTOM_EXEC_01",
+      "STREAM_ID": "admin_pipeline",
+      "TOTAL_PAYLOAD_COUNT": 1
+    }
+    ```    
+    """
+    result = {} if self.last_known_status is None else self.last_known_status
+    if self.last_known_status is None:
+      self.Pd(f'Instance <{self.instance_id}> has no status yet')
+    return result

naeural_client/base/pipeline.py

@@ -40,6 +40,7 @@ class Pipeline(BaseCodeChecker):
     on_notification=None, 
     is_attached=False, 
     existing_config=None, 
+    plugins_statuses=None,
     debug=False,
     **kwargs
   ) -> None:
@@ -118,6 +119,9 @@ class Pipeline(BaseCodeChecker):
       self.proposed_config = self.__pop_ignored_keys_from_config(self.proposed_config)
     self.__staged_config = None
 
+
+    self.__update_plugins_statuses_data(plugins_statuses)    
+
     self.__was_last_operation_successful = None
 
     self.proposed_remove_instances = []
@@ -172,6 +176,10 @@ class Pipeline(BaseCodeChecker):
       is_attached,
       debug=False,
     ):
+      """
+      This method is used to create a new instance of a plugin and add it to the pipeline.
+              
+      """
       instance_class = None
       str_signature = None
       if isinstance(signature, str):
@@ -202,8 +210,10 @@ class Pipeline(BaseCodeChecker):
       ----------
       plugins : List | None
         The list of plugins, as they are found in the pipeline configuration dictionary in the heartbeat.
+        
       is_attached : bool
         This is used internally to allow the user to create or attach to a pipeline, and then use the same objects in the same way.
+        
 
       """
       if plugins is None:
@@ -215,10 +225,52 @@ class Pipeline(BaseCodeChecker):
         for dct_instance in instances:
           config = {k.upper(): v for k, v in dct_instance.items()}
           instance_id = config.pop('INSTANCE_ID')
-          self.__init_instance(signature, instance_id, config, None, None, is_attached=is_attached)
+          instance_object = self.__init_instance(signature, instance_id, config, None, None, is_attached=is_attached)
+          # now we update the status of the plugin instance with the last known status
+          self._update_plugin_status(instance_object)
         # end for dct_instance
       # end for dct_signature_instances
       return
+    
+    def __update_plugins_statuses_data(self, plugins_statuses):
+      if plugins_statuses is not None:
+        self.last_plugins_statuses = plugins_statuses
+        self.last_plugins_statuses_time = time()
+      else:
+        self.last_plugins_statuses = None
+        self.last_plugins_statuses_time = 0
+      return
+
+
+    def __get_recent_plugin_instance_status(self, signature, instance_id):
+      """
+      Get the most recent status of a plugin instance.
+      """
+      result = None
+      if self.last_plugins_statuses is not None:
+        for plugin_status in self.last_plugins_statuses:
+          if (
+            plugin_status['SIGNATURE'] == signature and 
+            plugin_status['INSTANCE_ID'] == instance_id and
+            plugin_status['STREAM_ID'] == self.name
+          ):
+            result = plugin_status
+            break
+      return result
+    
+
+    def _update_plugin_status(self, instance_object : Instance):
+      """
+      Update the status of a plugin instance using any existing last known status.
+      
+      """
+      signature = instance_object.signature
+      instance_id = instance_object.instance_id
+      plugin_status = self.__get_recent_plugin_instance_status(signature, instance_id)
+      if plugin_status is not None:
+        instance_object.last_known_status = plugin_status
+      return
+
 
     def __get_proposed_pipeline_config(self):
       """
@@ -464,8 +516,22 @@ class Pipeline(BaseCodeChecker):
       -------
       dict
           The configuration dictionary without the ignored keys.
+          
+      Observations
+      ------------
+      
+      Initially the ignored keys were:
+        [
+          "INITIATOR_ADDR", 
+          "INITIATOR_ID", 
+          "LAST_UPDATE_TIME", 
+          "MODIFIED_BY_ADDR", 
+          "MODIFIED_BY_ID"
+        ]
+      However these keys are essential for the pipeline configuration for app
+      monitoring purposes
       """
-      ignored_keys = ["INITIATOR_ADDR", "INITIATOR_ID", "LAST_UPDATE_TIME", "MODIFIED_BY_ADDR", "MODIFIED_BY_ID"]
+      ignored_keys = []
       return {k: v for k, v in config.items() if k not in ignored_keys}
 
     def __get_instance_object(self, signature, instance_id):
@@ -1492,13 +1558,21 @@ class Pipeline(BaseCodeChecker):
           **kwargs
         )
       return instance
-
-    def _sync_configuration_with_remote(self, config={}):
+    
+    
+    def _sync_configuration_with_remote(self, config={}, plugins_statuses : list = None):
+      """
+      Given a configuration, update the pipeline configuration and the 
+      instances configuration.
+            
+      """
       config.pop('NAME', None)
       config.pop('TYPE', None)
       plugins = config.pop('PLUGINS', {})
 
       self.config = {**self.config, **config}
+      
+      self.__update_plugins_statuses_data(plugins_statuses)
 
       active_plugins = []
       for dct_signature_instances in plugins:
@@ -1509,9 +1583,11 @@ class Pipeline(BaseCodeChecker):
           active_plugins.append((signature, instance_id))
           instance_object = self.__get_instance_object(signature, instance_id)
           if instance_object is None:
-            self.__init_instance(signature, instance_id, dct_instance, None, None, is_attached=True)
+            instance_object = self.__init_instance(signature, instance_id, dct_instance, None, None, is_attached=True) # here the plugin status is updated if data is available
           else:
-            instance_object._sync_configuration_with_remote(dct_instance)
+            instance_object._sync_configuration_with_remote(dct_instance) 
+          # next we update the plugin status from known plugins statuses
+          self._update_plugin_status(instance_object)
         # end for dct_instance
       # end for dct_signature_instances
 

naeural_client/base_decentra_object.py

@@ -91,9 +91,11 @@ class BaseDecentrAIObject(object):
     _r = self.log.P(msg, show_time=t, color=color, **kwargs)
     return _r
 
-  def D(self, s, t=False, color=None, prefix=False, **kwargs):
+  def D(self, s, t=False, color=None, prefix=False, forced_debug=False, **kwargs):
     _r = -1
-    if self.DEBUG:
+    if self.DEBUG or forced_debug:
+      if color is None:
+        color = 'd'
       if self.show_prefixes:
         msg = "[DEBUG] {}: {}".format(self.__name__, s)
       else:

naeural_client/bc/base.py

@@ -7,7 +7,7 @@ import datetime
 import uuid
 import requests
 
-
+from collections import defaultdict
 from hashlib import sha256, md5
 from threading import Lock
 from copy import deepcopy
@@ -309,6 +309,9 @@ class BaseBlockEngine(_EVMMixin):
     assert log is not None, "Logger object was not provided!"      
       
     self.log = log
+    
+    self._first_checks_done = defaultdict(lambda: False) # used to store the first check results
+    
     self.__private_key = None
     self.__verbosity = verbosity
     self.__public_key = None    
@@ -325,7 +328,7 @@ class BaseBlockEngine(_EVMMixin):
       pem_name = config.get(BCct.K_PEM_FILE, BCct.DEFAULT_PEM_FILE)
       pem_folder = config.get(BCct.K_PEM_LOCATION, BCct.DEFAULT_PEM_LOCATION)
       pem_fn = os.path.join(log.get_target_folder(pem_folder), pem_name)
-    #endif pem is defined in ~/.naeural/ or in the data folder of the _local_cache
+    #endif pem is defined in ~/.ratio1/ or in the data folder of the _local_cache
     self.__pem_file = pem_fn
     self._init()
     return
@@ -413,7 +416,7 @@ class BaseBlockEngine(_EVMMixin):
     ### end Ethereum
     if self.__eth_enabled:
       self.P(
-        "Address: {} / ETH: {}".format(self.address, self.eth_address), boxed=True, verbosity=1,
+        "{} / ETH: {} ({})".format(self.address, self.eth_address, self.evm_network), boxed=True, verbosity=1,
         color='g'
       )
     else:
@@ -1407,8 +1410,9 @@ class BaseBlockEngine(_EVMMixin):
     the status is still 200, an empty dictionary will be returned).
     """
     if EE_VPN_IMPL:
-      return {}
+      return None # must return None not empty dict for VPNs
     #endif EE_VPN_IMPL
+    
     from naeural_client._ver import __VER__ as sdk_version
     try:
       from ver import __VER__ as app_version
@@ -1444,13 +1448,13 @@ class BaseBlockEngine(_EVMMixin):
         url = network_data[dAuth.EvmNetData.DAUTH_URL_KEY]
       #endif not in env
       
-    if isinstance(url, str) and len(url) > 0:
+    if isinstance(url, str) and len(url) > MIN_LEN:
       # Valid URL
       if dauth_endp is None:
         if in_env:
-          self.P("Found dAuth URL in environment: '{}'".format(url), color='g')
+          self.P("Found dAuth URL in environment: '{}'".format(url))
         else:
-          self.P("Using default dAuth URL: '{}'".format(url), color='g')
+          self.P("Using default dAuth URL: '{}'".format(url))
       eth_short = self.eth_address[:6] + '...' + self.eth_address[-4:]
       while not done:
         self.P(f"<{eth_short}> ({network}) dAuth with `{url}`... (try {tries + 1} / {max_tries})")
@@ -1550,7 +1554,7 @@ class BaseBlockEngine(_EVMMixin):
       #end while
     else:
       # Invalid URL, thus dct_env will remain None
-      self.P(f"dAuth URL is not invalid: {url}", color='r')
+      self.P(f"dAuth URL is not valid: {url}", color='r')
     #end if url is valid
     if return_full_data:
       return dct_response

naeural_client/bc/evm.py

@@ -191,8 +191,17 @@ class _EVMMixin:
 
       """
       if EE_VPN_IMPL:
-        return "VPN"
+        return "VPN"        
       network = os.environ.get(dAuth.DAUTH_NET_ENV_KEY, dAuth.DAUTH_SDK_NET_DEFAULT)
+      
+      if not self._first_checks_done[dAuth.DAUTH_NET_ENV_KEY]:
+        if dAuth.DAUTH_NET_ENV_KEY not in os.environ:
+          self.P(f"Using default {network=}...", verbosity=2)
+        else:
+          self.P(f"Using {network=} from `{dAuth.DAUTH_NET_ENV_KEY}` env key...", verbosity=2)
+        self._first_checks_done[dAuth.DAUTH_NET_ENV_KEY] = True
+      # done first checks
+      
       if not hasattr(self, "current_evm_network") or self.current_evm_network != network:
         self.current_evm_network = network
         network_data = self.get_network_data(network)

naeural_client/cli/cli.py

@@ -105,6 +105,7 @@ def main():
   """
   # Register the SIGINT handler
   signal.signal(signal.SIGINT, handle_sigint)  
+  print("Processing...\r", end="", flush=True)
   
   try:
     # Initialize configuration if necessary

naeural_client/cli/cli_commands.py

@@ -1,11 +1,12 @@
 from naeural_client.cli.nodes import (
   get_nodes, get_supervisors, 
   restart_node, shutdown_node,
+  get_apps
 )
 from naeural_client.cli.oracles import get_availability
 from naeural_client.utils.config import (
   show_config, reset_config, show_address, get_set_network,
-  get_apps, get_networks
+  get_networks, get_set_alias, get_eth_addr
 )
 
 # Define the available commands
@@ -27,6 +28,13 @@ CLI_COMMANDS = {
         "supervisors": {
             "func": get_supervisors, # DONE
         },
+        "eth" : {
+            "func": get_eth_addr,
+            "description": "Get the ETH address given a node address",
+            "params": {
+                "node": "The node address to get the ETH address for"
+            }
+        },
         "avail": {    
             "func": get_availability,
             "params": {
@@ -43,7 +51,8 @@ CLI_COMMANDS = {
             "func": get_apps,
             "description": "Get the apps running on a given node, if the client is allowed on that node.",
             "params": {
-                "node": "The ETH address or the specific address of the node to get the apps from",
+                "--node": "The ETH address or the specific address of the node to get the apps from",
+                "--owner" : "Get the apps for a particular owner/initiator",
                 "--full": "Include admin apps (flag)",
                 "--json": "Output the entire JSON config of applications (flag)",
             }
@@ -80,6 +89,14 @@ CLI_COMMANDS = {
                 "--set": "The network to set either 'mainnet' or 'testnet' (same as --new)",
             }
         },
+        
+        "alias" :{
+            "func": get_set_alias, # DONE
+            "description": "Show and sets the current client alias",
+            "params": {
+              "--set": "The alias to set for this SDK client",
+            }
+        }        
     },
     "restart": {
         "func": restart_node, # TODO

naeural_client/cli/nodes.py

@@ -1,7 +1,13 @@
 import os
+import json
+
 from time import time
 from naeural_client.utils.config import log_with_color
 from naeural_client.const import SESSION_CT, COMMANDS, BASE_CT
+from naeural_client._ver import __VER__ as version
+
+from pandas import DataFrame
+from datetime import datetime
 
 
 def _get_netstats(
@@ -53,32 +59,41 @@ def get_nodes(args):
   4. Get the active nodes union via Session and display the nodes marking those peered vs non-peered.
   """
   supervisor_addr = args.supervisor
+  online = args.online
+  online = True # always online, flag deprecated
   wide = args.wide
   if args.verbose:
     log_with_color(f"Getting nodes from supervisor <{supervisor_addr}>...", color='b')
 
   res = _get_netstats(
     silent=not args.verbose,
-    online_only=args.online or args.peered,
+    online_only=online or args.peered,
     allowed_only=args.peered,
     supervisor=supervisor_addr,
     eth=args.eth,
     all_info=wide,
+    return_session=True,
   )
-  df, supervisor, super_alias, nr_supers, elapsed = res
+  df, supervisor, super_alias, nr_supers, elapsed, sess = res
   if args.online:
     FILTERED = ['State']
     df = df[[c for c in df.columns if c not in FILTERED]]
 
-  prefix = "Online n" if (args.online or args.peered) else "N"
-  network = os.environ.get(BASE_CT.dAuth.DAUTH_NET_ENV_KEY, BASE_CT.dAuth.DAUTH_SDK_NET_DEFAULT)
+  prefix = "Online n" if (online or args.peered) else "N"
+  # network = os.environ.get(BASE_CT.dAuth.DAUTH_NET_ENV_KEY, BASE_CT.dAuth.DAUTH_SDK_NET_DEFAULT)
+  network = sess.bc_engine.evm_network
   if supervisor == "ERROR":
     log_with_color(f"No supervisors or no comms available in {elapsed:.1f}s. Please check your settings.", color='r')
   else:
-    log_with_color(f"<{network}> {prefix}odes reported by <{supervisor}> '{super_alias}' in {elapsed:.1f}s ({nr_supers} supervisors seen):", color='b')
+    log_with_color(f"Ratio1 client v{version}:\n", color='b')
+    log_with_color(
+      "{}odes on '{}' reported by <{}> '{}' in {:.1f}s ({} supervisors seen):".format(
+      prefix, network, supervisor, super_alias, elapsed, nr_supers), 
+      color='b'
+    )
     import pandas as pd
     pd.set_option('display.float_format', '{:.4f}'.format)
-    log_with_color(f"{df}")    
+    log_with_color(f"{df}\n")    
   return
   
   
@@ -93,18 +108,95 @@ def get_supervisors(args):
     silent=not args.verbose,
     online_only=True,
     supervisors_only=True,
+    return_session=True,
   )
-  df, supervisor, super_alias, nr_supers, elapsed = res
+  df, supervisor, super_alias, nr_supers, elapsed, sess = res
   FILTERED = ['Oracle', 'State']
   df = df[[c for c in df.columns if c not in FILTERED]]
   
   if supervisor == "ERROR":
     log_with_color(f"No supervisors or no comms available in {elapsed:.1f}s. Please check your settings.", color='r')
   else:
-    log_with_color(f"Supervisors reported by <{supervisor}> '{super_alias}' in {elapsed:.1f}s", color='b')
+    log_with_color(
+      "Supervisors on '{}' reported by <{}> '{}' in {:.1f}s".format(
+      sess.bc_engine.evm_network, supervisor, super_alias, elapsed), 
+      color='b'
+    )
     log_with_color(f"{df}")
   return
 
+
+def get_apps(args):
+  """
+  Shows the apps running on a given node, if the client is allowed on that node.
+  Parameters
+  ----------
+  args : argparse.Namespace
+      Arguments passed to the function.
+
+  """
+  verbose = args.verbose
+  node = args.node
+  show_full = args.full
+  as_json = args.json
+  owner = args.owner
+
+  # 1. Init session
+  from naeural_client import Session
+  sess = Session(
+    silent=not verbose
+  )
+  
+  res = sess.get_nodes_apps(
+    node=node, owner=owner, show_full=show_full, 
+    as_json=as_json, as_df=not as_json
+  )
+  if res is not None:
+    network = sess.bc_engine.evm_network
+    node_alias = sess.get_node_alias(node) if node else None
+    if as_json:
+      log_with_color(json.dumps(res, indent=2))
+    else:
+      df_apps = res
+      if df_apps.shape[0] == 0:
+        log_with_color(
+          "No user apps found on node <{}> '{}' of network '{}'".format(
+            node, node_alias, network            
+          ), 
+          color='r'
+        )
+        return
+      # remove Node column
+      if node is not None and owner is None:
+        df_apps.drop(columns=['Node'], inplace=True)
+      
+      if node is None and owner is not None:
+        df_apps.drop(columns=['Owner'], inplace=True)
+      
+      if node is not None:
+        last_seen = sess.get_last_seen_time(node)
+        last_seen_str = datetime.fromtimestamp(last_seen).strftime('%Y-%m-%d %H:%M:%S') if last_seen else None
+        is_online = sess.check_node_online(node)    
+        node_status = 'Online' if is_online else 'Offline'
+      else:
+        last_seen_str = "N/A"
+        node_status = "N/A"
+      #end if node
+      if node == None:
+        node = "[All available]"
+      by_owner = f" by owner <{owner}>" if owner else ""    
+      log_with_color(f"Ratio1 client v{version}:\n", color='b')
+      log_with_color(
+        "Apps on <{}> ({}) [Status: {}| Last seen: {}]{}:".format(
+          node, network, node_status, last_seen_str, by_owner
+        ), 
+        color='b'
+      )
+      log_with_color(f"{df_apps}\n")
+    #end if as_json
+  #end if res is not None
+  return
+
 def _send_command_to_node(args, command, ignore_not_found=False):
   node = args.node
   silent = not args.verbose   

naeural_client/cli/oracles.py

@@ -133,11 +133,17 @@ def get_availability(args):
   # endif full
 
   tester = oracle_tester_init()
+  
+  if not tester.bc.is_valid_eth_address(node):
+    node = tester.bc.node_address_to_eth_address(node)
+  
   log_with_color("Checking {}availability of node <{}> from {} to {}.".format(
     "(DEBUG MODE) " if rounds > 1 else "", node, start,
     end if end else "last epoch"
     ), color='b'
   )
+    
+  
   res = tester.execute_command(
     node_eth_addr=node,
     start=start,

naeural_client/comm/mqtt_wrapper.py

@@ -41,11 +41,11 @@ class MQTTWrapper(object):
     self._config = config
     self._recv_buff = recv_buff
     self._mqttc = None
-    self.debug_errors = debug_errors
+    self.debug_errors = debug_errors if verbosity <=1 else True
     self._thread_name = None
     self.connected = False
     self.disconnected = False
-    self.__verbosity = verbosity
+    self.__verbosity = verbosity    
     self._send_to = None
     self._nr_full_retries = 0
     self.__nr_dropped_messages = 0
@@ -240,6 +240,8 @@ class MQTTWrapper(object):
     return
 
   def __create_mqttc_object(self, comtype, client_uid):
+    if self.__verbosity > 1:
+      self.P(f"Creating MQTT client: {self._connection_name} - {comtype} - {client_uid}")
     client_id = self._connection_name + '_' + comtype + '_' + client_uid
     if mqtt_version.startswith('2'):
       mqttc = mqtt.Client(

naeural_client/const/base.py

@@ -23,6 +23,8 @@ DAUTH_NONCE = 'nonce'
 DAUTH_VARS = [DAUTH_NONCE, BCctbase.SIGN, BCctbase.SENDER, BCctbase.HASH]
 
 
+EE_SDK_ALIAS_ENV_KEY = "EE_SDK_ALIAS"
+EE_SDK_ALIAS_DEFAULT = "R1SDK"
 
 
 

naeural_client/const/payload.py

@@ -209,6 +209,8 @@ class PAYLOAD_DATA:
   NETMON_NODE_SECURED = 'secured'
   NETMON_NODE_VERSION = 'version'
   
+
+  
   
 class NET_CONFIG:
   STORE_COMMAND = "SET_CONFIG"
@@ -216,4 +218,8 @@ class NET_CONFIG:
   NET_CONFIG_DATA = 'NET_CONFIG_DATA'
   OPERATION = 'OP'
   DESTINATION = 'DEST'
-  DATA = 'DATA'
+  DATA = 'DATA'
+  
+  PIPELINES = "PIPELINES"
+  PLUGINS_STATUSES = "PLUGIN_STATUSES"
+