Merge pull request #6 from strohganoff/fix/global-commands-context

Author: strohganoff

streamdeck/command_sender.py

@@ -16,8 +16,9 @@
 
 class StreamDeckCommandSender:
     """Class for sending command event messages to the Stream Deck software through a WebSocket client."""
-    def __init__(self, client: WebSocketClient):
+    def __init__(self, client: WebSocketClient, plugin_registration_uuid: str):
         self._client = client
+        self._plugin_registration_uuid = plugin_registration_uuid
 
     def _send_event(self, event: str, **kwargs: Any) -> None:
         self._client.send_event({
@@ -38,18 +39,17 @@ def get_settings(self, context: str) -> None:
             context=context,
         )
 
-    def set_global_settings(self, context: str, payload: dict[str, Any]) -> None:
+    def set_global_settings(self, payload: dict[str, Any]) -> None:
         self._send_event(
             event="setGlobalSettings",
-            context=context,
+            context=self._plugin_registration_uuid,
             payload=payload,
         )
 
-    def get_global_settings(self, context: str) -> None:
-        """FYI: It seems like this causes the 'didReceiveGlobalSettings' event to only the Property Inspector."""
+    def get_global_settings(self) -> None:
         self._send_event(
             event="getGlobalSettings",
-            context=context,
+            context=self._plugin_registration_uuid,
         )
 
     def open_url(self, context: str, url: str) -> None:

streamdeck/manager.py

@@ -95,7 +95,7 @@ def run(self) -> None:
         and triggers the appropriate action handlers based on the received events.
         """
         with WebSocketClient(port=self._port) as client:
-            command_sender = StreamDeckCommandSender(client)
+            command_sender = StreamDeckCommandSender(client, plugin_registration_uuid=self._registration_uuid)
 
             command_sender.send_action_registration(register_event=self._register_event, plugin_registration_uuid=self._registration_uuid)
 

tests/conftest.py

@@ -1,4 +1,5 @@
 import random
+import uuid
 
 import pytest
 
@@ -7,3 +8,8 @@
 def port_number():
     """Fixture to provide a random 4-digit port number for each test."""
     return random.randint(1000, 9999)
+
+
+@pytest.fixture
+def plugin_registration_uuid() -> str:
+    return str(uuid.uuid1())

tests/plugin_manager/conftest.py

@@ -9,14 +9,13 @@
 
 
 @pytest.fixture
-def plugin_manager(port_number: int) -> PluginManager:
+def plugin_manager(port_number: int, plugin_registration_uuid: str) -> PluginManager:
     """Fixture that provides a configured instance of PluginManager for testing.
 
     Returns:
         PluginManager: An instance of PluginManager with test parameters.
     """
     plugin_uuid = "test-plugin-uuid"
-    plugin_registration_uuid = str(uuid.uuid1())
     register_event = "registerPlugin"
     info = {"some": "info"}
 

tests/test_command_sender.py

@@ -14,17 +14,17 @@ def mock_client() -> Mock:
 
 
 @pytest.fixture
-def command_sender(mock_client: Mock) -> StreamDeckCommandSender:
+def command_sender(mock_client: Mock, plugin_registration_uuid: str) -> StreamDeckCommandSender:
     """Fixture to provide an instance of StreamDeckCommandSender with a mocked client."""
-    return StreamDeckCommandSender(client=mock_client)
+    return StreamDeckCommandSender(client=mock_client, plugin_registration_uuid=plugin_registration_uuid)
 
 
 @pytest.mark.parametrize(
     ("method_name", "context", "extra_args", "expected_event", "expected_payload"),
     [
         (
             "get_global_settings",
-            "fake_context",
+            None,  # get_global_settings uses the command_sender's own plugin_registration_uuid attribute as the context.
             {},
             "getGlobalSettings",
             {}
@@ -115,7 +115,7 @@ def command_sender(mock_client: Mock) -> StreamDeckCommandSender:
         ),
         (
             "set_global_settings",
-            "fake_context",
+            None,  # set_global_settings uses the command_sender's own plugin_registration_uuid attribute as the context.
             {"payload": {"key": "value"}},
             "setGlobalSettings",
             {"payload": {"key": "value"}},
@@ -147,7 +147,7 @@ def test_command_sender_methods(
     command_sender: StreamDeckCommandSender,
     mock_client: Mock,
     method_name: str,
-    context: str,
+    context: str | None,
     extra_args: dict,
     expected_event: str,
     expected_payload: dict,
@@ -157,14 +157,17 @@ def test_command_sender_methods(
     assert hasattr(command_sender, method_name)
 
     method = getattr(command_sender, method_name)
-    method(context, **extra_args)
+    if context is not None:
+        method(context, **extra_args)
+    else:
+        method(**extra_args)
 
     # Build the expected data structure to send through the WebSocket
     expected_data = {
-        "context": context,
+        "context": context or command_sender._plugin_registration_uuid,
         "event": expected_event,
         **expected_payload,
     }
 
     # Assert that the client's send_event method was called with the expected data
-    mock_client.send_event.assert_called_once_with(expected_data)
+    mock_client.send_event.assert_called_once_with(expected_data)