naeural-client 2.5.10__tar.gz → 2.5.12__tar.gz

{naeural_client-2.5.10 → naeural_client-2.5.12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: naeural_client
-Version: 2.5.10
+Version: 2.5.12
 Summary: `naeural_client` is the Python SDK required for client app development for the Naeural Edge Protocol Edge Protocol framework
 Project-URL: Homepage, https://github.com/NaeuralEdgeProtocol/naeural_client
 Project-URL: Bug Tracker, https://github.com/NaeuralEdgeProtocol/naeural_client/issues

{naeural_client-2.5.10 → naeural_client-2.5.12}/naeural_client/_ver.py

@@ -1,4 +1,4 @@
-__VER__ = "2.5.10"
+__VER__ = "2.5.12"
 
 if __name__ == "__main__":
   with open("pyproject.toml", "rt") as fd:

{naeural_client-2.5.10 → naeural_client-2.5.12}/naeural_client/base/generic_session.py

@@ -1374,7 +1374,8 @@ class GenericSession(BaseDecentrAIObject):
 
     def get_allowed_nodes(self):
       """
-      Get the list of all active Naeural Edge Protocol edge nodes to whom this session can send messages
+      Get the list of all active Naeural Edge Protocol edge nodes to whom this 
+      ssion can send messages. This is based on the last heartbeat received from each individual node.
 
       Returns
       -------
@@ -1810,9 +1811,6 @@ class GenericSession(BaseDecentrAIObject):
       """
 
       ngrok_use_api = True
-      
-      # if isinstance(signature, str):
-        
 
       pipeline: WebappPipeline = self.create_pipeline(
         node=node,
@@ -1887,14 +1885,15 @@ class GenericSession(BaseDecentrAIObject):
       kwargs.pop('use_ngrok', None)
       kwargs.pop('ngrok_use_api', None)
       
-      # if isinstance(signature, str):
-      
+      if ngrok_edge_label is None:
+        raise ValueError("The `ngrok_edge_label` parameter is mandatory when creating a balanced web app, in order for all instances to respond to the same URL.")
+
       pipelines, instances = [], []
       
       for node in nodes:
         self.P("Creating web app on node {}...".format(node), color='b')
         pipeline: WebappPipeline = self.create_pipeline(
-          node=nodes[0],
+          node=node,
           name=name,
           pipeline_type=WebappPipeline,
           extra_debug=extra_debug,
@@ -2240,11 +2239,43 @@ class GenericSession(BaseDecentrAIObject):
       online_only=False, 
       supervisors_only=False,
       min_supervisors=2,
+      allowed_only=False,
       supervisor=None,
     ):
       """
       This function will return a Pandas dataframe  known nodes in the network based on
       all the net-mon messages received so far.
+      
+      Parameters
+      ----------
+      
+      timeout : int, optional
+          The maximum time to wait for the desired number of supervisors to appear online.
+          Defaults to 10.
+          
+      online_only : bool, optional  
+          If True, will return only the online nodes. Defaults to False.
+      
+      supervisors_only : bool, optional
+          If True, will return only the supervisors. Defaults to False.
+          
+      min_supervisors : int, optional 
+          The minimum number of supervisors to wait for. Defaults to 2.
+          
+      allowed_only : bool, optional 
+          If True, will return only the allowed nodes. Defaults to False.
+          
+      supervisor : str, optional  
+          The supervisor to wait for. Defaults to None.
+          
+      Returns
+      -------
+      
+      dict
+          A dictionary containing the report, the reporter and the number of supervisors.
+          
+
+      
       """
       mapping = OrderedDict({
         'Address': PAYLOAD_DATA.NETMON_ADDRESS,
@@ -2254,13 +2285,16 @@ class GenericSession(BaseDecentrAIObject):
         'Last probe' : PAYLOAD_DATA.NETMON_LAST_REMOTE_TIME,
         'Zone' : PAYLOAD_DATA.NETMON_NODE_UTC,
         'Supervisor' : PAYLOAD_DATA.NETMON_IS_SUPERVISOR,
+        'Peered' : PAYLOAD_DATA.NETMON_WHITELIST,
       })
       reverse_mapping = {v: k for k, v in mapping.items()}
       res = OrderedDict()
       for k in mapping:
         res[k] = []
+
+      # the following loop will wait for the desired number of supervisors to appear online
+      # for the current session
       start = tm()      
-  
       while (tm() - start) < timeout:
         if supervisor is not None:
           if supervisor in self.__current_network_statuses:
@@ -2268,7 +2302,10 @@ class GenericSession(BaseDecentrAIObject):
         elif len(self.__current_network_statuses) >= min_supervisors:
           break
         sleep(0.1)
+      elapsed = tm() - start
       # end while
+      # done waiting for supervisors
+      
       if len(self.__current_network_statuses) > 0:
         best_info = {}
         best_super = None
@@ -2276,10 +2313,17 @@ class GenericSession(BaseDecentrAIObject):
           if len(net_info) > len(best_info):
             best_info = net_info
             best_super = supervisor
+        best_super_alias = None
         # done found best supervisor
         for _, node_info in best_info.items():
           is_online = node_info.get(PAYLOAD_DATA.NETMON_STATUS_KEY, None) == PAYLOAD_DATA.NETMON_STATUS_ONLINE
           is_supervisor = node_info.get(PAYLOAD_DATA.NETMON_IS_SUPERVISOR, False)
+          # the following will get the whitelist for the current inspected  node
+          # without calling self.get_allowed_nodes but instead using the netmon data
+          whitelist = node_info.get(PAYLOAD_DATA.NETMON_WHITELIST, [])
+          client_is_allowed = self.bc_engine.contains_current_address(whitelist)          
+          if allowed_only and not client_is_allowed:
+            continue
           if online_only and not is_online:
             continue
           if supervisors_only and not is_supervisor:
@@ -2294,9 +2338,21 @@ class GenericSession(BaseDecentrAIObject):
               # convert val (seconds) to a human readable format
               val = seconds_to_short_format(val)
             elif key == PAYLOAD_DATA.NETMON_ADDRESS:
+              if self.bc_engine._remove_prefix(val) == self.bc_engine._remove_prefix(best_super):
+                # again self.get_node_name(best_super) might not work if using the hb data
+                best_super_alias = node_info.get(PAYLOAD_DATA.NETMON_EEID, None)
               val = self.bc_engine._add_prefix(val)
+            elif key == PAYLOAD_DATA.NETMON_WHITELIST:
+              val = client_is_allowed
             res[column].append(val)          
         # end for
       # end if
       pd.options.display.float_format = '{:.1f}'.format
-      return pd.DataFrame(res), best_super
+      dct_result ={
+        'report' : pd.DataFrame(res),
+        'reporter' : best_super,
+        'reporter_alias' : best_super_alias,
+        'nr_super' : len(self.__current_network_statuses),
+        'elapsed' : elapsed,
+      }
+      return dct_result

{naeural_client-2.5.10 → naeural_client-2.5.12}/naeural_client/bc/base.py

@@ -847,10 +847,30 @@ class BaseBlockEngine:
   ####                                                                     ####
   #############################################################################
   
+  
+  def contains_current_address(self, lst_addresses):
+    """
+    Checks if the current address is in the list of addresses
+
+    Parameters
+    ----------
+    lst_addresses : list
+      the list of addresses.
+
+    Returns
+    -------
+    bool
+      True if the current address is in the list.
+
+    """
+    lst = [self._remove_prefix(x) for x in lst_addresses]
+    return self.address_no_prefix in lst
+  
   @property
   def address(self):
     """Returns the public address"""
     return self.__address
+    
   
   @property
   def address_no_prefix(self):

{naeural_client-2.5.10 → naeural_client-2.5.12}/naeural_client/cli/cli_commands.py

@@ -11,10 +11,12 @@ CLI_COMMANDS = {
         "nodes": {
             "func": get_nodes,
             "params": {
-                "--all": "Get all known nodes flag",  # DONE
-                "--online" : "Get only online nodes flag", # DONE
-                # "--peered": "Get only peered nodes"
-                "--supervisor" : "Use a specific supervisor node"
+              ### use "flag" to indicate a boolean flag otherwise it will be 
+              ### treated as a str parameter
+              "--all": "Get all known nodes flag",  # DONE
+              "--online" : "Get only online nodes flag", # DONE
+              "--peered": "Get only peered nodes flag",  # DONE
+              "--supervisor" : "Use a specific supervisor node"
             }
         },
         "supervisors": {

{naeural_client-2.5.10 → naeural_client-2.5.12}/naeural_client/cli/nodes.py

@@ -15,22 +15,20 @@ def get_nodes(args):
     log_with_color(f"Getting nodes from supervisor <{supervisor_addr}>...", color='b')
   from naeural_client import Session
   sess = Session(silent=not args.verbose)
-  if args.all:
-    df, supervisor = sess.get_network_known_nodes(supervisor=supervisor_addr)
-    log_with_color(f"Network full map reported by <{supervisor}>:", color='b')
-    log_with_color(f"{df}")    
-  elif args.online:
-    df, supervisor = sess.get_network_known_nodes(
-      online_only=True, supervisor=supervisor_addr
-    )
-    log_with_color(f"Online nodes reported by <{supervisor}>:", color='b')
-    log_with_color(f"{df}")    
-  else:
-    df, supervisor = sess.get_network_known_nodes(
-      online_only=True, supervisor=supervisor_addr
-    )
-    log_with_color(f"Online nodes reported by <{supervisor}>:", color='b')
-    log_with_color(f"{df}")    
+  online_only = args.online or args.peered
+  allowed_only = args.peered
+  
+  dct_info = sess.get_network_known_nodes(
+    online_only=online_only, allowed_only=allowed_only, supervisor=supervisor_addr
+  )
+  df = dct_info['report']
+  supervisor = dct_info['reporter']
+  super_alias = dct_info['reporter_alias']
+  nr_supers = dct_info['nr_super']
+  elapsed = dct_info['elapsed']
+  prefix = "Online n" if online_only else "N"
+  log_with_color(f"{prefix}odes reported by <{supervisor}> '{super_alias}' in {elapsed:.1f}s ({nr_supers} supervisors seen):", color='b')
+  log_with_color(f"{df}")    
   return
   
   
@@ -42,8 +40,12 @@ def get_supervisors(args):
     log_with_color("Getting supervisors...", color='b')
   from naeural_client import Session  
   sess = Session(silent=not args.verbose)
-  df, supervisor = sess.get_network_known_nodes(online_only=True, supervisors_only=True)
-  log_with_color(f"Supervisors reported by <{supervisor}>", color='b')
+  dct_info = sess.get_network_known_nodes(online_only=True, supervisors_only=True)
+  df = dct_info['report']
+  supervisor = dct_info['reporter']
+  super_alias = dct_info['reporter_alias']
+  elapsed = dct_info['elapsed']  
+  log_with_color(f"Supervisors reported by <{supervisor}> '{super_alias}' in {elapsed:.1f}s", color='b')
   log_with_color(f"{df}")
   return
 

{naeural_client-2.5.10 → naeural_client-2.5.12}/naeural_client/const/apps.py

@@ -6,6 +6,7 @@ class PLUGIN_SIGNATURES:
   NET_MON_01 = 'NET_MON_01'
   VIEW_SCENE_01 = 'VIEW_SCENE_01'
   CUSTOM_WEBAPI_01 = 'CUSTOM_CODE_FASTAPI_01'
+  GENERIC_WEB_APP = 'GENERIC_WEB_APP'
   CHAIN_DIST_CUSTOM_JOB_01 = 'PROCESS_REAL_TIME_COLLECTED_DATA_CUSTOM_EXEC_CHAIN_DIST'
   TELEGRAM_BASIC_BOT_01 = 'TELEGRAM_BASIC_BOT_01'  
   TELEGRAM_CONVERSATIONAL_BOT_01 = 'TELEGRAM_CONVERSATIONAL_BOT_01'

{naeural_client-2.5.10 → naeural_client-2.5.12}/naeural_client/const/payload.py

@@ -204,6 +204,7 @@ class PAYLOAD_DATA:
   NETMON_NODE_UTC = 'node_utc'
   NETMON_LAST_SEEN = 'last_seen_sec'
   NETMON_IS_SUPERVISOR = 'is_supervisor'
+  NETMON_WHITELIST = 'whitelist'
   
   
 class NET_CONFIG:

{naeural_client-2.5.10 → naeural_client-2.5.12}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "naeural_client"
-version = "2.5.10"
+version = "2.5.12"
 authors = [
   { name="Andrei Ionut Damian", email="andrei.damian@me.com" },
   { name="Cristan Bleotiu", email="cristibleotiu@gmail.com" },

naeural_client-2.5.12/tutorials/ex13_launch_repo_based_webapp.py

@@ -0,0 +1,70 @@
+"""
+
+This demo starts a generic webapp and generates a dynamic URL that can be used to access the webapp.
+For this demo, we will use a custom webapp that resides at a public repository.
+
+"""
+from os import environ
+from naeural_client import Session, PLUGIN_SIGNATURES
+
+
+if __name__ == "__main__":
+  session = Session()
+
+  nodes = [
+    environ.get("TARGET_NODE_1", "INSERT_YOUR_NODE_ADDRESS_HERE"),
+    environ.get("TARGET_NODE_2", "INSERT_YOUR_NODE_ADDRESS_HERE")
+  ]
+
+  if isinstance(nodes, str):
+    nodes = [nodes]
+
+  for node in nodes:
+    session.wait_for_node(node)
+
+  # In case this is not provided and create_and_deploy_balanced_web_app is used an exception will be raised.
+  # In case this is not provided by the user, but create_webapp method is used, a unique URL will be generated by the ngrok service.
+  # Warning! create_webapp method does not support multiple nodes.
+  ngrok_edge_label = environ.get("NGROK_EDGE_LABEL", None)
+
+  # Defining the environment variables for the webapp.
+  port = 3000
+  env_vars = {
+    'APP_PORT': port,
+    'LOCAL_ADDRESS': '/edge_node/_local_cache/_data/local_address.txt'
+  }
+
+  # Defining the webapp setup commands.
+  setup_commands = [
+    "npm install"
+  ]
+
+  # Defining the assets of the application.
+  assets = {
+    'operation': "clone",
+    "url": "https://github.com/NaeuralEdgeProtocol/demo-deploy-nodejs",
+  }
+
+  # Defining the webapp run commands.
+  run_command = "npm start"
+
+  # instance: PLUGIN_TYPES.CUSTOM_WEBAPI_01
+  session.create_and_deploy_balanced_web_app(
+    nodes=nodes,
+    name="Ratio1_WebApp_tutorial",
+    signature=PLUGIN_SIGNATURES.GENERIC_WEB_APP,
+    env_vars=env_vars,
+    port=port,
+    setup_commands=setup_commands,
+    run_command=run_command,
+    ngrok_edge_label=ngrok_edge_label,
+    assets=assets
+  )
+
+  # Observation:
+  #   next code is not mandatory - it is used to keep the session open and cleanup the resources
+  #   in production, you would not need this code as the script can close after the pipeline will be sent
+  session.run(
+    wait=True,  # wait for the user to stop the execution
+    close_pipelines=True  # when the user stops the execution, the remote edge-node pipelines will be closed
+  )

naeural_client-2.5.10/tutorials/ex13_launch_repo_based_webapp.py

@@ -1,26 +0,0 @@
-"""
-
-This demo starts a generic webapp and generates a dynamic URL that can be used to access the webapp.
-For this demo, we will use a custom webapp that resides at a public repository.
-
-"""
-
-from naeural_client import CustomPluginTemplate, Session, PLUGIN_TYPES
-
-
-if __name__ == "__main__":
-  session = Session()
-
-  node = "INSERT_YOUR_NODE_ADDRESS_HERE"
-  session.wait_for_node(node)
-
-  instance: PLUGIN_TYPES.CUSTOM_WEBAPI_01
-  pipeline, instance = session.create_web_app(
-  
-  )
-
-
-  url = pipeline.deploy()
-  
-  print(f"Webapp is now available at: {url}")
-