Merge branch 'release/4.0.3'

* release/4.0.3:
  Prepare for version 4.0.3
  Bump version: 4.0.2 → 4.0.3
  Fix XMPP message send + tests

Author: javipalanca

HISTORY.rst

@@ -2,6 +2,12 @@
 History
 =======
 
+4.0.3 (2025-02-17)
+--------------------
+* Prepare XMPP messages linked to client stream.
+* Added CLI support for in-memory database in the XMPP server.
+* Added CLI support for custom connection timeout.
+* Fixed bug in XMPP sending method.
 
 4.0.2 (2025-01-09)
 --------------------

requirements.txt

@@ -1,4 +1,4 @@
-slixmpp==1.8.5
+slixmpp>=1.8.5
 aiohttp>=3.10.4
 aiohttp_jinja2==1.6
 jinja2==3.0.3

setup.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 4.0.2
+current_version = 4.0.3
 commit = True
 tag = False
 parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)((?P<release>[a-z]+)(?P<rc>\d+))?

setup.py

@@ -34,7 +34,7 @@ def parse_requirements(filename):
 
 setup(
     name='spade',
-    version='4.0.2',
+    version='4.0.3',
     description="Smart Python Agent Development Environment",
     long_description=readme + '\n\n' + history,
     author="Javi Palanca",

spade/__init__.py

@@ -12,7 +12,7 @@
 
 __author__ = """Javi Palanca"""
 __email__ = "[email protected]"
-__version__ = "4.0.2"
+__version__ = "4.0.3"
 
 __all__ = ["agent", "behaviour", "message", "template"]
 

spade/behaviour.py

@@ -338,7 +338,7 @@ async def send(self, msg: Message) -> None:
         self.agent.traces.append(msg, category=str(self))
 
     async def _xmpp_send(self, msg: Message) -> None:
-        slixmpp_msg = msg.prepare()
+        slixmpp_msg = msg.prepare(self.agent.client)
         slixmpp_msg.send()
 
     async def receive(self, timeout: Optional[float] = None) -> Optional[Message]:

spade/cli.py

@@ -29,6 +29,7 @@ def cli():
     @click.option("--client_port", default=5222, help="Client port")
     @click.option("--server_port", default=5269, help="Server port")
     @click.option("--debug", is_flag=True, default=False, help="Enables debug mode")
+    @click.option("--timeout", default=600, help="Connection timeout")
     @click.option(
         "--db",
         type=str,
@@ -37,9 +38,10 @@ def cli():
         help="Path for database file",
     )
     @click.option(
-        "--purge", is_flag=True, help="Restore database file to default state (empty)"
+        "--purge", is_flag=True, default=False, help="Restore database file to default state (empty)"
     )
-    def run(host, client_port, server_port, debug, db, purge):
+    @click.option("--memory", is_flag=True, default=False, help="Use an in-memory database")
+    def run(host, client_port, server_port, debug, timeout, db, purge, memory):
         """Launch an XMPP server"""
         if check_port_in_use(client_port, host):
             click.echo(f"Error: The port {client_port} is already in use.")
@@ -65,9 +67,10 @@ def run(host, client_port, server_port, debug, db, purge):
             host=host,
             client_port=client_port,
             server_port=server_port,
-            connection_timeout=600,
+            connection_timeout=timeout,
             database_path=db,
             database_purge=purge,
+            database_in_memory=memory,
         )
 
         print_spade_info()

spade/message.py

@@ -2,6 +2,7 @@
 from typing import Optional, Dict, Type
 
 import slixmpp.stanza
+from slixmpp import ClientXMPP
 from slixmpp.plugins.xep_0004 import Form
 
 import spade.message
@@ -252,15 +253,18 @@ def make_reply(self) -> "Message":
             metadata=self.metadata,
         )
 
-    def prepare(self) -> slixmpp.stanza.Message:
+    def prepare(self, client: ClientXMPP) -> slixmpp.stanza.Message:
         """
         Returns a slixmpp.stanza.Message built from the Message and prepared to be sent.
 
+        Args:
+            client (ClientXMPP): An XMPP client, whose stream will be used to send the message
+
         Returns:
-          slixmpp.stanza.Message: the message prepared to be sent
+            slixmpp.stanza.Message: the message prepared to be sent
 
         """
-        msg = slixmpp.stanza.Message()
+        msg = client.Message()
         msg["to"] = self.to
         msg["from"] = self.sender
         msg["body"] = self.body

spade/templates/internal_tpl_base.html

@@ -302,7 +302,7 @@ <h3 class="box-title">Agent Friends</h3>
 
     <footer class="main-footer">
         <div class="pull-right hidden-xs">
-            <b>Version</b> 4.0.2
+            <b>Version</b> 4.0.3
         </div>
         <strong>Copyright © {% now 'local', '%Y' %} <a href="https://github.com/javipalanca/spade">SPADE</a>.</strong>
     </footer>

spade/web.py

@@ -314,7 +314,7 @@ async def send_agent(self, request):
         body = form["message"]
         logger.info("Sending message to {}: {}".format(agent_jid, body))
         msg = Message(to=agent_jid, sender=str(self.agent.jid), body=body)
-        slixmpp_msg = msg.prepare()
+        slixmpp_msg = msg.prepare(self.agent.client)
         self.agent.client.send(slixmpp_msg)
         msg.sent = True
         self.agent.traces.append(msg)