Add client ID generation and update CI workflow versions

- Add client_id parameter to MqttTransport constructor with auto-generation
- Support both explicit client_id and auto-generated UUID-based client_id
- Update workflow files to use compas-dev/compas-actions.build@v4
- Update compatibility tests to match new client_id behavior
- Add test for custom client_id functionality

Co-authored-by: gonzalocasas <933277+gonzalocasas@users.noreply.github.com>

Author: Copilot

.github/workflows/build.yml

@@ -18,7 +18,7 @@ jobs:
         python: ['3.9', '3.10', '3.11']
 
     steps:
-      - uses: compas-dev/compas-actions.build@v3
+      - uses: compas-dev/compas-actions.build@v4
         with:
           python: ${{ matrix.python }}
           invoke_lint: true
@@ -54,7 +54,7 @@ jobs:
         run: |
           docker run -d --name nanomq -p 1883:1883 -p 8083:8083 -p 8883:8883 emqx/nanomq:latest
           docker ps -a
-      - uses: compas-dev/compas-actions.build@v3
+      - uses: compas-dev/compas-actions.build@v4
         with:
           python: '3.11'
           invoke_lint: false

.github/workflows/release.yml

@@ -14,7 +14,7 @@ jobs:
         python: ['3.9', '3.10', '3.11']
 
     steps:
-      - uses: compas-dev/compas-actions.build@v3
+      - uses: compas-dev/compas-actions.build@v4
         with:
           python: ${{ matrix.python }}
           invoke_lint: true
@@ -31,7 +31,7 @@ jobs:
         run: |
           docker run -d --name nanomq -p 1883:1883 -p 8083:8083 -p 8883:8883 emqx/nanomq:latest
           docker ps -a
-      - uses: compas-dev/compas-actions.build@v3
+      - uses: compas-dev/compas-actions.build@v4
         with:
           python: '3.11'
           invoke_lint: false

src/compas_eve/mqtt/mqtt_paho.py

@@ -2,6 +2,7 @@
 from ..event_emitter import EventEmitterMixin
 
 import paho.mqtt.client as mqtt
+import uuid
 
 try:
     from paho.mqtt.enums import CallbackAPIVersion
@@ -21,18 +22,25 @@ class MqttTransport(Transport, EventEmitterMixin):
         you are running a local broker on your machine.
     port : int
         MQTT broker port, defaults to ``1883``.
+    client_id : str, optional
+        Client ID for the MQTT connection. If not provided, a unique ID will be generated.
     """
 
-    def __init__(self, host, port=1883, *args, **kwargs):
+    def __init__(self, host, port=1883, client_id=None, *args, **kwargs):
         super(MqttTransport, self).__init__(*args, **kwargs)
         self.host = host
         self.port = port
         self._is_connected = False
         self._local_callbacks = {}
+        
+        # Generate client ID if not provided
+        if client_id is None:
+            client_id = f"compas_eve_{uuid.uuid4().hex[:8]}"
+        
         if PAHO_MQTT_V2_AVAILABLE:
-            self.client = mqtt.Client(callback_api_version=CallbackAPIVersion.VERSION1)
+            self.client = mqtt.Client(client_id=client_id, callback_api_version=CallbackAPIVersion.VERSION1)
         else:
-            self.client = mqtt.Client()  # todo: generate client_id
+            self.client = mqtt.Client(client_id=client_id)
         self.client.on_connect = self._on_connect
         self.client.connect(self.host, self.port)
         self.client.loop_start()

tests/unit/test_mqtt_paho_compatibility.py

@@ -19,8 +19,12 @@ def test_paho_mqtt_v1_compatibility():
         # This should work as if paho-mqtt 1.x is installed
         transport = MqttTransport("localhost")
 
-        # Should have called mqtt.Client() without parameters
-        mock_client_class.assert_called_once_with()
+        # Should have called mqtt.Client() with client_id parameter only (no callback_api_version)
+        mock_client_class.assert_called_once()
+        call_args = mock_client_class.call_args
+        assert "client_id" in call_args.kwargs
+        assert call_args.kwargs["client_id"].startswith("compas_eve_")
+        assert "callback_api_version" not in call_args.kwargs
         assert transport.client == mock_client
 
 
@@ -38,8 +42,13 @@ def test_paho_mqtt_v2_compatibility():
         # This should work as if paho-mqtt 2.x is installed
         transport = MqttTransport("localhost")
 
-        # Should have called mqtt.Client() with callback_api_version parameter
-        mock_client_class.assert_called_once_with(callback_api_version=CallbackAPIVersion.VERSION1)
+        # Should have called mqtt.Client() with both client_id and callback_api_version parameters
+        mock_client_class.assert_called_once()
+        call_args = mock_client_class.call_args
+        assert "client_id" in call_args.kwargs
+        assert call_args.kwargs["client_id"].startswith("compas_eve_")
+        assert "callback_api_version" in call_args.kwargs
+        assert call_args.kwargs["callback_api_version"] == CallbackAPIVersion.VERSION1
         assert transport.client == mock_client
 
 
@@ -55,3 +64,21 @@ def test_version_detection():
         # If v2 is not available, import should fail
         with pytest.raises(ImportError):
             from paho.mqtt.enums import CallbackAPIVersion
+
+
+def test_custom_client_id():
+    """Test that custom client_id parameter works correctly."""
+    with patch("paho.mqtt.client.Client") as mock_client_class:
+        mock_client = Mock()
+        mock_client_class.return_value = mock_client
+
+        # Test with custom client_id
+        custom_client_id = "my_custom_client_id"
+        transport = MqttTransport("localhost", client_id=custom_client_id)
+
+        # Should have called mqtt.Client() with the custom client_id
+        mock_client_class.assert_called_once()
+        call_args = mock_client_class.call_args
+        assert "client_id" in call_args.kwargs
+        assert call_args.kwargs["client_id"] == custom_client_id
+        assert transport.client == mock_client