Update STOMP version handling and modify dependencies for compatibility

Author: craig8

gridappsd-field-bus-lib/gridappsd_field_bus/field_interface/field_proxy_forwarder.py

@@ -4,6 +4,12 @@
 from gridappsd import GridAPPSD
 from gridappsd import topics
 
+try:
+    from importlib.metadata import version as _pkg_version
+    _STOMP_V8 = int(_pkg_version('stomp-py').split('.')[0]) >= 8
+except Exception:
+    _STOMP_V8 = False
+
 from cimgraph.databases import BlazegraphConnection
 from cimgraph.models import BusBranchModel
 
@@ -18,8 +24,13 @@ def __init__(self, ot_connection: GridAPPSD, proxy_connection: stomp.Connection)
         self.ot_connection = ot_connection
         self.proxy_connection = proxy_connection
 
-    def on_message(self, headers, message):
+    def on_message(self, *args):
         "Receives messages coming from Proxy bus (e.g. ARTEMIS) and forwards to OT bus"
+        if _STOMP_V8:
+            frame = args[0]
+            headers, message = frame.headers, frame.body
+        else:
+            headers, message = args[0], args[1]
         try:
             print(f"Received message at Proxy. destination: {headers['destination']}, message: {headers}")
 

gridappsd-python-lib/gridappsd/goss.py

@@ -57,6 +57,7 @@
 from logging import Logger
 from queue import Queue
 
+import stomp as _stomp_module
 from stomp import Connection12 as Connection
 from stomp.exception import NotConnectedException
 from time import sleep
@@ -65,6 +66,15 @@
 
 _log: Logger = logging.getLogger(inspect.getmodulename(__file__))
 
+# stomp.py 8.x changed listener callbacks from (headers, body) to (frame)
+_stomp_major = int(getattr(_stomp_module, '__version__', (0,))[0]) if isinstance(getattr(_stomp_module, '__version__', None), tuple) else 0
+try:
+    from importlib.metadata import version as _pkg_version
+    _stomp_major = int(_pkg_version('stomp-py').split('.')[0])
+except Exception:
+    pass
+_STOMP_V8 = _stomp_major >= 8
+
 
 class GRIDAPPSD_ENV_ENUM(Enum):
     GRIDAPPSD_USER = "GRIDAPPSD_USER"
@@ -182,7 +192,12 @@ def __init__(self, topic, result_format):
                 self._topic = topic
                 self.result_format = result_format
 
-            def on_message(self, header, message):
+            def on_message(self, *args):
+                if _STOMP_V8:
+                    frame = args[0]
+                    header, message = frame.headers, frame.body
+                else:
+                    header, message = args[0], args[1]
                 _log.debug("Internal on message is: {} {}".format(header, message))
                 try:
                     if self.result_format == "JSON":
@@ -195,13 +210,15 @@ def on_message(self, header, message):
                 except ValueError:
                     self.response = dict(error="Invalid json returned", header=header, message=message)
 
-            def on_error(self, headers, message):
+            def on_error(self, *args):
+                if _STOMP_V8:
+                    frame = args[0]
+                    headers, message = frame.headers, frame.body
+                else:
+                    headers, message = args[0], args[1]
                 _log.error("ERR: {}".format(headers))
                 _log.error("OUR ERROR: {}".format(message))
 
-            def on_disconnect(self, header, message):
-                _log.debug("Disconnected")
-
         listener = ResponseListener(reply_to, self.result_format)
         self.subscribe(reply_to, listener)
 
@@ -314,18 +331,25 @@ def __init__(self):
                     def get_token(self):
                         return self.__token
 
-                    def on_message(self, header, message):
+                    def on_message(self, *args):
+                        if _STOMP_V8:
+                            frame = args[0]
+                            header, message = frame.headers, frame.body
+                        else:
+                            header, message = args[0], args[1]
                         _log.debug("Internal on message is: {} {}".format(header, message))
 
                         self.__token = str(message)
 
-                    def on_error(self, headers, message):
+                    def on_error(self, *args):
+                        if _STOMP_V8:
+                            frame = args[0]
+                            headers, message = frame.headers, frame.body
+                        else:
+                            headers, message = args[0], args[1]
                         _log.error("ERR: {}".format(headers))
                         _log.error("OUR ERROR: {}".format(message))
 
-                    def on_disconnect(self, header, message):
-                        _log.debug("Disconnected")
-
                 # receive token and set token variable
                 # set callback
                 listener = TokenResponseListener()
@@ -399,15 +423,25 @@ def remove_callback(self, topic, callback):
             except ValueError:
                 pass
 
-    def on_message(self, headers, message):
+    def on_message(self, *args):
+        if _STOMP_V8:
+            frame = args[0]
+            headers, message = frame.headers, frame.body
+        else:
+            headers, message = args[0], args[1]
         destination = headers["destination"]
         # _log.debug("Topic map keys are: {keys}".format(keys=self._topics_callback_map.keys()))
         if destination in self._topics_callback_map:
             self._queue_callerback.put((self._topics_callback_map[destination], headers, message))
         else:
             _log.error("INVALID DESTINATION {destination}".format(destination=destination))
 
-    def on_error(self, header, message):
+    def on_error(self, *args):
+        if _STOMP_V8:
+            frame = args[0]
+            header, message = frame.headers, frame.body
+        else:
+            header, message = args[0], args[1]
         _log.error("Error in callback router")
         _log.error(header)
         _log.error(message)

gridappsd-python-lib/pyproject.toml

@@ -19,7 +19,7 @@ dependencies = [
     "PyYAML>=6.0",
     "pytz>=2022.7",
     "dateutils>=0.6.7",
-    "stomp-py==6.0.0",
+    "stomp-py>=6.0.0",
     "requests>=2.28",
     "python-dotenv>=0.9",
     "loguru>=0.7",