feat: Add GENERICSYSTEMEVENT support to RealTimeEvent enum and RealTimeEventListener#384

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Alex-Nalin wants to merge 2 commits into
base:main
Choose a base branch
from
Open

feat: Add GENERICSYSTEMEVENT support to RealTimeEvent enum and RealTimeEventListener #384

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1f5f9d5
feat: Add GENERICSYSTEMEVENT support to RealTimeEvent enum and RealTi…
Alex-Nalin Mar 23, 2026
374571e
feat: Add GENERICSYSTEMEVENT support to RealTimeEvent enum and RealTi…
Alex-Nalin Mar 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions docsrc/markdown/datafeed.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -197,7 +197,8 @@ datahose:
eventTypes: # mandatory field, events you want to receive
- INSTANTMESSAGECREATED
- ROOMCREATED
- ROOMUPDATED
- ROOMUPDATED
- GENERICSYSTEMEVENT

retry: # optional
maxAttempts: 6 # maximum number of retry attempts
Expand All@@ -206,10 +207,10 @@ datahose:
maxIntervalMillis: 10000 # limit of the interval between two attempts
```

The minimal configuration for the datahose service is the `eventTypes` field. It should contain at least one value
chosen among [_Real Time Events_](https://docs.developers.symphony.com/building-bots-on-symphony/datafeed/real-time-events)
list and that `MESSAGESENT`, `MESSAGESUPPRESSED` and `SYMPHONYELEMENTSACTION` values can be set only if the ceservice is
properly configured and running in your Symphony agent.
The minimal configuration for the datahose service is the `eventTypes` field. It should contain at least one value
chosen among [_Real Time Events_](...) list. Note that `MESSAGESENT`, `MESSAGESUPPRESSED`, `SYMPHONYELEMENTSACTION`
and `GENERICSYSTEMEVENT` values can be set only if the ceservice is properly configured and running in your
Symphony agent.

The `tag` field is optional and is used when creating and reusing datahose feeds. If you have several instances of the
same bot and want them to use the same datahose feed (so that events are spread over bot instances),
Expand Down
68 changes: 68 additions & 0 deletions examples/datafeed/datahose_generic_system_event.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
import asyncio
import logging
import logging.config
from pathlib import Path

from symphony.bdk.core.config.loader import BdkConfigLoader
from symphony.bdk.core.service.datafeed.real_time_event_listener import RealTimeEventListener
from symphony.bdk.core.symphony_bdk import SymphonyBdk
from symphony.bdk.gen.agent_model.v4_generic_system_event import V4GenericSystemEvent
from symphony.bdk.gen.agent_model.v4_initiator import V4Initiator

# Required config.yaml datahose section:
#
# datahose:
# tag: my-bot-tag
# eventTypes:
# - GENERICSYSTEMEVENT


async def run():
config = BdkConfigLoader.load_from_symphony_dir("config.yaml")

async with SymphonyBdk(config) as bdk:
datahose_loop = bdk.datahose()
datahose_loop.subscribe(RealTimeEventListenerImpl())
await datahose_loop.start()


class RealTimeEventListenerImpl(RealTimeEventListener):
async def on_generic_system_event(self, initiator: V4Initiator, event: V4GenericSystemEvent):
"""Called for every GENERICSYSTEMEVENT received from the datahose.

GENERICSYSTEMEVENT is a platform-level envelope emitted by Symphony's internal
Maestro event bus. The ``event_subtype`` field identifies the specific event;
``parameters`` carries subtype-specific data whose structure varies per subtype.

Always filter on ``event_subtype`` — do not act on every generic event blindly.
"""
subtype = event.event_subtype

# We do not recommend logging full events in production as it could expose sensitive data
logging.debug("GenericSystemEvent received — subtype: %s", subtype)

# Filter on the specific subtype relevant to your use case.
# The subtype values are defined by your Symphony deployment; log them first
# to discover which ones are relevant before adding conditional logic.
if subtype == "CONNECTION_REQUEST_ALERT":
# Example: a federation connection lifecycle event.
# event.parameters contains subtype-specific fields.
logging.info("Connection request alert — parameters: %s", event.parameters)

elif subtype is None:
logging.warning("Received GENERICSYSTEMEVENT with no event_subtype — skipping")

else:
logging.debug("Unhandled GENERICSYSTEMEVENT subtype: %s", subtype)


logging.config.fileConfig(
Path(__file__).parent.parent / "logging.conf", disable_existing_loggers=False
)


try:
logging.info("Running datahose generic system event example...")
asyncio.run(run())
except KeyboardInterrupt:
logging.info("Ending datahose generic system event example")
4 changes: 3 additions & 1 deletion symphony/bdk/core/service/datafeed/abstract_datafeed_loop.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -57,6 +57,7 @@ class RealTimeEvent(Enum):
CONNECTIONACCEPTED = ("on_connection_accepted", "connection_accepted")
SYMPHONYELEMENTSACTION = ("on_symphony_elements_action", "symphony_elements_action")
MESSAGESUPPRESSED = ("on_message_suppressed", "message_suppressed")
GENERICSYSTEMEVENT = ("on_generic_system_event", "generic_system_event")


def _set_context_var(current_task, event, listener):
Expand DownExpand Up@@ -202,7 +203,8 @@ async def _run_listener_method(listener: RealTimeEventListener, event: V4Event):
listener_method_name, payload_field_name = RealTimeEvent[event.type].value
except KeyError:
logger.info("Received event with an unknown type: %s", event.type)
return
return # <-- GENERICSYSTEMEVENT hits this branch
# GENERICSYSTEMEVENT is not in the enum, so every event is dropped.

listener_method = getattr(listener, listener_method_name)
event_field = getattr(event.payload, payload_field_name)
Expand Down
18 changes: 18 additions & 0 deletions symphony/bdk/core/service/datafeed/real_time_event_listener.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
from symphony.bdk.gen.agent_model.v4_generic_system_event import V4GenericSystemEvent
from symphony.bdk.gen.agent_model.v4_connection_accepted import V4ConnectionAccepted
from symphony.bdk.gen.agent_model.v4_connection_requested import V4ConnectionRequested
from symphony.bdk.gen.agent_model.v4_event import V4Event
Expand DownExpand Up@@ -166,3 +167,20 @@ async def on_symphony_elements_action(
:param initiator: Event initiator.
:param event: Symphony Elements Action payload.
"""

async def on_generic_system_event(
self, initiator: V4Initiator, event: V4GenericSystemEvent
):
"""
Called when a GENERICSYSTEMEVENT event is received.

Generic system events are platform-level notifications emitted by Symphony's internal Maestro event bus.
The ``event_subtype`` field on the payload identifies the specific event; ``parameters`` carries
subtype-specific data.

Bot developers should filter on ``event.event_subtype`` rather than relying solely on the outer
``GENERICSYSTEMEVENT`` type.

:param initiator: Event initiator.
:param event: Generic system event payload (``V4GenericSystemEvent``).
"""
17 changes: 17 additions & 0 deletions tests/core/service/datafeed/abstract_datafeed_loop_test.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
# ruff: noqa
import asyncio
from unittest.mock import AsyncMock, call, patch
from symphony.bdk.gen.agent_model.v4_generic_system_event import V4GenericSystemEvent

import pytest

Expand DownExpand Up@@ -492,6 +493,22 @@ async def test_handle_symphony_element(df_loop, listener, initiator_userid):
initiator_userid, payload.symphony_elements_action
)

# This test verifies the full dispatch path: enum lookup → payload extraction → listener method called with correct
# arguments
@pytest.mark.asyncio
async def test_handle_generic_system_event(df_loop, listener, initiator_userid):
payload = V4Payload(generic_system_event=V4GenericSystemEvent())
event = V4Event(
type=RealTimeEvent.GENERICSYSTEMEVENT.name,
payload=payload,
initiator=initiator_userid,
)

await create_and_await_tasks(df_loop, [event])

listener.on_generic_system_event.assert_called_once_with(
initiator_userid, payload.generic_system_event
)

@pytest.mark.asyncio
async def test_handle_unknown_type(df_loop, listener, initiator_userid):
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
feat: Add GENERICSYSTEMEVENT support to RealTimeEvent enum and RealTimeEventListener#384

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Open

Alex-Nalin
wants to merge
2
commits into

base:main
Choose a base branch

from

 Open


feat: Add GENERICSYSTEMEVENT support to RealTimeEvent enum and RealTimeEventListener
#384
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
1f5f9d5

feat: Add GENERICSYSTEMEVENT support to RealTimeEvent enum and RealTi…


Alex-Nalin Mar 23, 2026
374571e

feat: Add GENERICSYSTEMEVENT support to RealTimeEvent enum and RealTi…


Alex-Nalin Mar 23, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


11 changes: 6 additions & 5 deletions
docsrc/markdown/datafeed.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -197,7 +197,8 @@ datahose:
 eventTypes: # mandatory field, events you want to receive
 - INSTANTMESSAGECREATED
 - ROOMCREATED
 - ROOMUPDATED 
 - ROOMUPDATED
 - GENERICSYSTEMEVENT

 retry: # optional
 maxAttempts: 6 # maximum number of retry attempts
Expand All@@ -206,10 +207,10 @@ datahose:
 maxIntervalMillis: 10000 # limit of the interval between two attempts
```

The minimal configuration for the datahose service is the `eventTypes` field. It should contain at least one value
chosen among [_Real Time Events_](https://docs.developers.symphony.com/building-bots-on-symphony/datafeed/real-time-events) 
list and that `MESSAGESENT`, `MESSAGESUPPRESSED` and `SYMPHONYELEMENTSACTION` values can be set only if the ceservice is
properly configured and running in your Symphony agent.
The minimal configuration for the datahose service is the `eventTypes` field. It should contain at least one value
chosen among [_Real Time Events_](...) list. Note that `MESSAGESENT`, `MESSAGESUPPRESSED`, `SYMPHONYELEMENTSACTION`
and `GENERICSYSTEMEVENT` values can be set only if the ceservice is properly configured and running in your
Symphony agent.

The `tag` field is optional and is used when creating and reusing datahose feeds. If you have several instances of the
same bot and want them to use the same datahose feed (so that events are spread over bot instances),
Expand Down

68 changes: 68 additions & 0 deletions
examples/datafeed/datahose_generic_system_event.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
import asyncio
import logging
import logging.config
from pathlib import Path

from symphony.bdk.core.config.loader import BdkConfigLoader
from symphony.bdk.core.service.datafeed.real_time_event_listener import RealTimeEventListener
from symphony.bdk.core.symphony_bdk import SymphonyBdk
from symphony.bdk.gen.agent_model.v4_generic_system_event import V4GenericSystemEvent
from symphony.bdk.gen.agent_model.v4_initiator import V4Initiator

# Required config.yaml datahose section:
#
# datahose:
# tag: my-bot-tag
# eventTypes:
# - GENERICSYSTEMEVENT


async def run():
 config = BdkConfigLoader.load_from_symphony_dir("config.yaml")

 async with SymphonyBdk(config) as bdk:
 datahose_loop = bdk.datahose()
 datahose_loop.subscribe(RealTimeEventListenerImpl())
 await datahose_loop.start()


class RealTimeEventListenerImpl(RealTimeEventListener):
 async def on_generic_system_event(self, initiator: V4Initiator, event: V4GenericSystemEvent):
 """Called for every GENERICSYSTEMEVENT received from the datahose.

 GENERICSYSTEMEVENT is a platform-level envelope emitted by Symphony's internal
 Maestro event bus. The ``event_subtype`` field identifies the specific event;
 ``parameters`` carries subtype-specific data whose structure varies per subtype.

 Always filter on ``event_subtype`` — do not act on every generic event blindly.
 """
 subtype = event.event_subtype

 # We do not recommend logging full events in production as it could expose sensitive data
 logging.debug("GenericSystemEvent received — subtype: %s", subtype)

 # Filter on the specific subtype relevant to your use case.
 # The subtype values are defined by your Symphony deployment; log them first
 # to discover which ones are relevant before adding conditional logic.
 if subtype == "CONNECTION_REQUEST_ALERT":
 # Example: a federation connection lifecycle event.
 # event.parameters contains subtype-specific fields.
 logging.info("Connection request alert — parameters: %s", event.parameters)

 elif subtype is None:
 logging.warning("Received GENERICSYSTEMEVENT with no event_subtype — skipping")

 else:
 logging.debug("Unhandled GENERICSYSTEMEVENT subtype: %s", subtype)


logging.config.fileConfig(
 Path(__file__).parent.parent / "logging.conf", disable_existing_loggers=False
)


try:
 logging.info("Running datahose generic system event example...")
 asyncio.run(run())
except KeyboardInterrupt:
 logging.info("Ending datahose generic system event example")

4 changes: 3 additions & 1 deletion
symphony/bdk/core/service/datafeed/abstract_datafeed_loop.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,6 +57,7 @@ class RealTimeEvent(Enum):
 CONNECTIONACCEPTED = ("on_connection_accepted", "connection_accepted")
 SYMPHONYELEMENTSACTION = ("on_symphony_elements_action", "symphony_elements_action")
 MESSAGESUPPRESSED = ("on_message_suppressed", "message_suppressed")
 GENERICSYSTEMEVENT = ("on_generic_system_event", "generic_system_event")


def _set_context_var(current_task, event, listener):
Expand DownExpand Up@@ -202,7 +203,8 @@ async def _run_listener_method(listener: RealTimeEventListener, event: V4Event):
 listener_method_name, payload_field_name = RealTimeEvent[event.type].value
 except KeyError:
 logger.info("Received event with an unknown type: %s", event.type)
 return
 return # <-- GENERICSYSTEMEVENT hits this branch
 # GENERICSYSTEMEVENT is not in the enum, so every event is dropped.

 listener_method = getattr(listener, listener_method_name)
 event_field = getattr(event.payload, payload_field_name)
Expand Down

18 changes: 18 additions & 0 deletions
symphony/bdk/core/service/datafeed/real_time_event_listener.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
from symphony.bdk.gen.agent_model.v4_generic_system_event import V4GenericSystemEvent
from symphony.bdk.gen.agent_model.v4_connection_accepted import V4ConnectionAccepted
from symphony.bdk.gen.agent_model.v4_connection_requested import V4ConnectionRequested
from symphony.bdk.gen.agent_model.v4_event import V4Event
Expand DownExpand Up@@ -166,3 +167,20 @@ async def on_symphony_elements_action(
 :param initiator: Event initiator.
 :param event: Symphony Elements Action payload.
 """

 async def on_generic_system_event(
 self, initiator: V4Initiator, event: V4GenericSystemEvent
 ):
 """
 Called when a GENERICSYSTEMEVENT event is received.

 Generic system events are platform-level notifications emitted by Symphony's internal Maestro event bus.
 The ``event_subtype`` field on the payload identifies the specific event; ``parameters`` carries
 subtype-specific data.

 Bot developers should filter on ``event.event_subtype`` rather than relying solely on the outer
 ``GENERICSYSTEMEVENT`` type.

 :param initiator: Event initiator.
 :param event: Generic system event payload (``V4GenericSystemEvent``).
 """

17 changes: 17 additions & 0 deletions
tests/core/service/datafeed/abstract_datafeed_loop_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
# ruff: noqa
import asyncio
from unittest.mock import AsyncMock, call, patch
from symphony.bdk.gen.agent_model.v4_generic_system_event import V4GenericSystemEvent

import pytest

Expand DownExpand Up@@ -492,6 +493,22 @@ async def test_handle_symphony_element(df_loop, listener, initiator_userid):
 initiator_userid, payload.symphony_elements_action
 )

# This test verifies the full dispatch path: enum lookup → payload extraction → listener method called with correct
# arguments
@pytest.mark.asyncio
async def test_handle_generic_system_event(df_loop, listener, initiator_userid):
 payload = V4Payload(generic_system_event=V4GenericSystemEvent())
 event = V4Event(
 type=RealTimeEvent.GENERICSYSTEMEVENT.name,
 payload=payload,
 initiator=initiator_userid,
 )

 await create_and_await_tasks(df_loop, [event])

 listener.on_generic_system_event.assert_called_once_with(
 initiator_userid, payload.generic_system_event
 )

@pytest.mark.asyncio
async def test_handle_unknown_type(df_loop, listener, initiator_userid):
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat: Add GENERICSYSTEMEVENT support to RealTimeEvent enum and RealTimeEventListener#384

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Open

Alex-Nalin
wants to merge
2
commits into

base:main
Choose a base branch

from

 Open


feat: Add GENERICSYSTEMEVENT support to RealTimeEvent enum and RealTimeEventListener
#384
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
1f5f9d5

feat: Add GENERICSYSTEMEVENT support to RealTimeEvent enum and RealTi…


Alex-Nalin Mar 23, 2026
374571e

feat: Add GENERICSYSTEMEVENT support to RealTimeEvent enum and RealTi…


Alex-Nalin Mar 23, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


11 changes: 6 additions & 5 deletions
docsrc/markdown/datafeed.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -197,7 +197,8 @@ datahose:
 eventTypes: # mandatory field, events you want to receive
 - INSTANTMESSAGECREATED
 - ROOMCREATED
 - ROOMUPDATED 
 - ROOMUPDATED
 - GENERICSYSTEMEVENT

 retry: # optional
 maxAttempts: 6 # maximum number of retry attempts
Expand All@@ -206,10 +207,10 @@ datahose:
 maxIntervalMillis: 10000 # limit of the interval between two attempts
```

The minimal configuration for the datahose service is the `eventTypes` field. It should contain at least one value
chosen among [_Real Time Events_](https://docs.developers.symphony.com/building-bots-on-symphony/datafeed/real-time-events) 
list and that `MESSAGESENT`, `MESSAGESUPPRESSED` and `SYMPHONYELEMENTSACTION` values can be set only if the ceservice is
properly configured and running in your Symphony agent.
The minimal configuration for the datahose service is the `eventTypes` field. It should contain at least one value
chosen among [_Real Time Events_](...) list. Note that `MESSAGESENT`, `MESSAGESUPPRESSED`, `SYMPHONYELEMENTSACTION`
and `GENERICSYSTEMEVENT` values can be set only if the ceservice is properly configured and running in your
Symphony agent.

The `tag` field is optional and is used when creating and reusing datahose feeds. If you have several instances of the
same bot and want them to use the same datahose feed (so that events are spread over bot instances),
Expand Down

68 changes: 68 additions & 0 deletions
examples/datafeed/datahose_generic_system_event.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
import asyncio
import logging
import logging.config
from pathlib import Path

from symphony.bdk.core.config.loader import BdkConfigLoader
from symphony.bdk.core.service.datafeed.real_time_event_listener import RealTimeEventListener
from symphony.bdk.core.symphony_bdk import SymphonyBdk
from symphony.bdk.gen.agent_model.v4_generic_system_event import V4GenericSystemEvent
from symphony.bdk.gen.agent_model.v4_initiator import V4Initiator

# Required config.yaml datahose section:
#
# datahose:
# tag: my-bot-tag
# eventTypes:
# - GENERICSYSTEMEVENT


async def run():
 config = BdkConfigLoader.load_from_symphony_dir("config.yaml")

 async with SymphonyBdk(config) as bdk:
 datahose_loop = bdk.datahose()
 datahose_loop.subscribe(RealTimeEventListenerImpl())
 await datahose_loop.start()


class RealTimeEventListenerImpl(RealTimeEventListener):
 async def on_generic_system_event(self, initiator: V4Initiator, event: V4GenericSystemEvent):
 """Called for every GENERICSYSTEMEVENT received from the datahose.

 GENERICSYSTEMEVENT is a platform-level envelope emitted by Symphony's internal
 Maestro event bus. The ``event_subtype`` field identifies the specific event;
 ``parameters`` carries subtype-specific data whose structure varies per subtype.

 Always filter on ``event_subtype`` — do not act on every generic event blindly.
 """
 subtype = event.event_subtype

 # We do not recommend logging full events in production as it could expose sensitive data
 logging.debug("GenericSystemEvent received — subtype: %s", subtype)

 # Filter on the specific subtype relevant to your use case.
 # The subtype values are defined by your Symphony deployment; log them first
 # to discover which ones are relevant before adding conditional logic.
 if subtype == "CONNECTION_REQUEST_ALERT":
 # Example: a federation connection lifecycle event.
 # event.parameters contains subtype-specific fields.
 logging.info("Connection request alert — parameters: %s", event.parameters)

 elif subtype is None:
 logging.warning("Received GENERICSYSTEMEVENT with no event_subtype — skipping")

 else:
 logging.debug("Unhandled GENERICSYSTEMEVENT subtype: %s", subtype)


logging.config.fileConfig(
 Path(__file__).parent.parent / "logging.conf", disable_existing_loggers=False
)


try:
 logging.info("Running datahose generic system event example...")
 asyncio.run(run())
except KeyboardInterrupt:
 logging.info("Ending datahose generic system event example")

4 changes: 3 additions & 1 deletion
symphony/bdk/core/service/datafeed/abstract_datafeed_loop.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,6 +57,7 @@ class RealTimeEvent(Enum):
 CONNECTIONACCEPTED = ("on_connection_accepted", "connection_accepted")
 SYMPHONYELEMENTSACTION = ("on_symphony_elements_action", "symphony_elements_action")
 MESSAGESUPPRESSED = ("on_message_suppressed", "message_suppressed")
 GENERICSYSTEMEVENT = ("on_generic_system_event", "generic_system_event")


def _set_context_var(current_task, event, listener):
Expand DownExpand Up@@ -202,7 +203,8 @@ async def _run_listener_method(listener: RealTimeEventListener, event: V4Event):
 listener_method_name, payload_field_name = RealTimeEvent[event.type].value
 except KeyError:
 logger.info("Received event with an unknown type: %s", event.type)
 return
 return # <-- GENERICSYSTEMEVENT hits this branch
 # GENERICSYSTEMEVENT is not in the enum, so every event is dropped.

 listener_method = getattr(listener, listener_method_name)
 event_field = getattr(event.payload, payload_field_name)
Expand Down

18 changes: 18 additions & 0 deletions
symphony/bdk/core/service/datafeed/real_time_event_listener.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
from symphony.bdk.gen.agent_model.v4_generic_system_event import V4GenericSystemEvent
from symphony.bdk.gen.agent_model.v4_connection_accepted import V4ConnectionAccepted
from symphony.bdk.gen.agent_model.v4_connection_requested import V4ConnectionRequested
from symphony.bdk.gen.agent_model.v4_event import V4Event
Expand DownExpand Up@@ -166,3 +167,20 @@ async def on_symphony_elements_action(
 :param initiator: Event initiator.
 :param event: Symphony Elements Action payload.
 """

 async def on_generic_system_event(
 self, initiator: V4Initiator, event: V4GenericSystemEvent
 ):
 """
 Called when a GENERICSYSTEMEVENT event is received.

 Generic system events are platform-level notifications emitted by Symphony's internal Maestro event bus.
 The ``event_subtype`` field on the payload identifies the specific event; ``parameters`` carries
 subtype-specific data.

 Bot developers should filter on ``event.event_subtype`` rather than relying solely on the outer
 ``GENERICSYSTEMEVENT`` type.

 :param initiator: Event initiator.
 :param event: Generic system event payload (``V4GenericSystemEvent``).
 """

17 changes: 17 additions & 0 deletions
tests/core/service/datafeed/abstract_datafeed_loop_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
# ruff: noqa
import asyncio
from unittest.mock import AsyncMock, call, patch
from symphony.bdk.gen.agent_model.v4_generic_system_event import V4GenericSystemEvent

import pytest

Expand DownExpand Up@@ -492,6 +493,22 @@ async def test_handle_symphony_element(df_loop, listener, initiator_userid):
 initiator_userid, payload.symphony_elements_action
 )

# This test verifies the full dispatch path: enum lookup → payload extraction → listener method called with correct
# arguments
@pytest.mark.asyncio
async def test_handle_generic_system_event(df_loop, listener, initiator_userid):
 payload = V4Payload(generic_system_event=V4GenericSystemEvent())
 event = V4Event(
 type=RealTimeEvent.GENERICSYSTEMEVENT.name,
 payload=payload,
 initiator=initiator_userid,
 )

 await create_and_await_tasks(df_loop, [event])

 listener.on_generic_system_event.assert_called_once_with(
 initiator_userid, payload.generic_system_event
 )

@pytest.mark.asyncio
async def test_handle_unknown_type(df_loop, listener, initiator_userid):
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat: Add GENERICSYSTEMEVENT support to RealTimeEvent enum and RealTimeEventListener#384

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Open

Alex-Nalin
wants to merge
2
commits into

base:main
Choose a base branch

from

 Open


feat: Add GENERICSYSTEMEVENT support to RealTimeEvent enum and RealTimeEventListener
#384
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
1f5f9d5

feat: Add GENERICSYSTEMEVENT support to RealTimeEvent enum and RealTi…


Alex-Nalin Mar 23, 2026
374571e

feat: Add GENERICSYSTEMEVENT support to RealTimeEvent enum and RealTi…


Alex-Nalin Mar 23, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


11 changes: 6 additions & 5 deletions
docsrc/markdown/datafeed.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -197,7 +197,8 @@ datahose:
 eventTypes: # mandatory field, events you want to receive
 - INSTANTMESSAGECREATED
 - ROOMCREATED
 - ROOMUPDATED 
 - ROOMUPDATED
 - GENERICSYSTEMEVENT

 retry: # optional
 maxAttempts: 6 # maximum number of retry attempts
Expand All@@ -206,10 +207,10 @@ datahose:
 maxIntervalMillis: 10000 # limit of the interval between two attempts
```

The minimal configuration for the datahose service is the `eventTypes` field. It should contain at least one value
chosen among [_Real Time Events_](https://docs.developers.symphony.com/building-bots-on-symphony/datafeed/real-time-events) 
list and that `MESSAGESENT`, `MESSAGESUPPRESSED` and `SYMPHONYELEMENTSACTION` values can be set only if the ceservice is
properly configured and running in your Symphony agent.
The minimal configuration for the datahose service is the `eventTypes` field. It should contain at least one value
chosen among [_Real Time Events_](...) list. Note that `MESSAGESENT`, `MESSAGESUPPRESSED`, `SYMPHONYELEMENTSACTION`
and `GENERICSYSTEMEVENT` values can be set only if the ceservice is properly configured and running in your
Symphony agent.

The `tag` field is optional and is used when creating and reusing datahose feeds. If you have several instances of the
same bot and want them to use the same datahose feed (so that events are spread over bot instances),
Expand Down

68 changes: 68 additions & 0 deletions
examples/datafeed/datahose_generic_system_event.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
import asyncio
import logging
import logging.config
from pathlib import Path

from symphony.bdk.core.config.loader import BdkConfigLoader
from symphony.bdk.core.service.datafeed.real_time_event_listener import RealTimeEventListener
from symphony.bdk.core.symphony_bdk import SymphonyBdk
from symphony.bdk.gen.agent_model.v4_generic_system_event import V4GenericSystemEvent
from symphony.bdk.gen.agent_model.v4_initiator import V4Initiator

# Required config.yaml datahose section:
#
# datahose:
# tag: my-bot-tag
# eventTypes:
# - GENERICSYSTEMEVENT


async def run():
 config = BdkConfigLoader.load_from_symphony_dir("config.yaml")

 async with SymphonyBdk(config) as bdk:
 datahose_loop = bdk.datahose()
 datahose_loop.subscribe(RealTimeEventListenerImpl())
 await datahose_loop.start()


class RealTimeEventListenerImpl(RealTimeEventListener):
 async def on_generic_system_event(self, initiator: V4Initiator, event: V4GenericSystemEvent):
 """Called for every GENERICSYSTEMEVENT received from the datahose.

 GENERICSYSTEMEVENT is a platform-level envelope emitted by Symphony's internal
 Maestro event bus. The ``event_subtype`` field identifies the specific event;
 ``parameters`` carries subtype-specific data whose structure varies per subtype.

 Always filter on ``event_subtype`` — do not act on every generic event blindly.
 """
 subtype = event.event_subtype

 # We do not recommend logging full events in production as it could expose sensitive data
 logging.debug("GenericSystemEvent received — subtype: %s", subtype)

 # Filter on the specific subtype relevant to your use case.
 # The subtype values are defined by your Symphony deployment; log them first
 # to discover which ones are relevant before adding conditional logic.
 if subtype == "CONNECTION_REQUEST_ALERT":
 # Example: a federation connection lifecycle event.
 # event.parameters contains subtype-specific fields.
 logging.info("Connection request alert — parameters: %s", event.parameters)

 elif subtype is None:
 logging.warning("Received GENERICSYSTEMEVENT with no event_subtype — skipping")

 else:
 logging.debug("Unhandled GENERICSYSTEMEVENT subtype: %s", subtype)


logging.config.fileConfig(
 Path(__file__).parent.parent / "logging.conf", disable_existing_loggers=False
)


try:
 logging.info("Running datahose generic system event example...")
 asyncio.run(run())
except KeyboardInterrupt:
 logging.info("Ending datahose generic system event example")

4 changes: 3 additions & 1 deletion
symphony/bdk/core/service/datafeed/abstract_datafeed_loop.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,6 +57,7 @@ class RealTimeEvent(Enum):
 CONNECTIONACCEPTED = ("on_connection_accepted", "connection_accepted")
 SYMPHONYELEMENTSACTION = ("on_symphony_elements_action", "symphony_elements_action")
 MESSAGESUPPRESSED = ("on_message_suppressed", "message_suppressed")
 GENERICSYSTEMEVENT = ("on_generic_system_event", "generic_system_event")


def _set_context_var(current_task, event, listener):
Expand DownExpand Up@@ -202,7 +203,8 @@ async def _run_listener_method(listener: RealTimeEventListener, event: V4Event):
 listener_method_name, payload_field_name = RealTimeEvent[event.type].value
 except KeyError:
 logger.info("Received event with an unknown type: %s", event.type)
 return
 return # <-- GENERICSYSTEMEVENT hits this branch
 # GENERICSYSTEMEVENT is not in the enum, so every event is dropped.

 listener_method = getattr(listener, listener_method_name)
 event_field = getattr(event.payload, payload_field_name)
Expand Down

18 changes: 18 additions & 0 deletions
symphony/bdk/core/service/datafeed/real_time_event_listener.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
from symphony.bdk.gen.agent_model.v4_generic_system_event import V4GenericSystemEvent
from symphony.bdk.gen.agent_model.v4_connection_accepted import V4ConnectionAccepted
from symphony.bdk.gen.agent_model.v4_connection_requested import V4ConnectionRequested
from symphony.bdk.gen.agent_model.v4_event import V4Event
Expand DownExpand Up@@ -166,3 +167,20 @@ async def on_symphony_elements_action(
 :param initiator: Event initiator.
 :param event: Symphony Elements Action payload.
 """

 async def on_generic_system_event(
 self, initiator: V4Initiator, event: V4GenericSystemEvent
 ):
 """
 Called when a GENERICSYSTEMEVENT event is received.

 Generic system events are platform-level notifications emitted by Symphony's internal Maestro event bus.
 The ``event_subtype`` field on the payload identifies the specific event; ``parameters`` carries
 subtype-specific data.

 Bot developers should filter on ``event.event_subtype`` rather than relying solely on the outer
 ``GENERICSYSTEMEVENT`` type.

 :param initiator: Event initiator.
 :param event: Generic system event payload (``V4GenericSystemEvent``).
 """

17 changes: 17 additions & 0 deletions
tests/core/service/datafeed/abstract_datafeed_loop_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
# ruff: noqa
import asyncio
from unittest.mock import AsyncMock, call, patch
from symphony.bdk.gen.agent_model.v4_generic_system_event import V4GenericSystemEvent

import pytest

Expand DownExpand Up@@ -492,6 +493,22 @@ async def test_handle_symphony_element(df_loop, listener, initiator_userid):
 initiator_userid, payload.symphony_elements_action
 )

# This test verifies the full dispatch path: enum lookup → payload extraction → listener method called with correct
# arguments
@pytest.mark.asyncio
async def test_handle_generic_system_event(df_loop, listener, initiator_userid):
 payload = V4Payload(generic_system_event=V4GenericSystemEvent())
 event = V4Event(
 type=RealTimeEvent.GENERICSYSTEMEVENT.name,
 payload=payload,
 initiator=initiator_userid,
 )

 await create_and_await_tasks(df_loop, [event])

 listener.on_generic_system_event.assert_called_once_with(
 initiator_userid, payload.generic_system_event
 )

@pytest.mark.asyncio
async def test_handle_unknown_type(df_loop, listener, initiator_userid):
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
feat: Add GENERICSYSTEMEVENT support to RealTimeEvent enum and RealTimeEventListener#384

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Open

Alex-Nalin
wants to merge
2
commits into

base:main
Choose a base branch

from

 Open


feat: Add GENERICSYSTEMEVENT support to RealTimeEvent enum and RealTimeEventListener
#384
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
1f5f9d5

feat: Add GENERICSYSTEMEVENT support to RealTimeEvent enum and RealTi…


Alex-Nalin Mar 23, 2026
374571e

feat: Add GENERICSYSTEMEVENT support to RealTimeEvent enum and RealTi…


Alex-Nalin Mar 23, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


11 changes: 6 additions & 5 deletions
docsrc/markdown/datafeed.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -197,7 +197,8 @@ datahose:
 eventTypes: # mandatory field, events you want to receive
 - INSTANTMESSAGECREATED
 - ROOMCREATED
 - ROOMUPDATED 
 - ROOMUPDATED
 - GENERICSYSTEMEVENT

 retry: # optional
 maxAttempts: 6 # maximum number of retry attempts
Expand All@@ -206,10 +207,10 @@ datahose:
 maxIntervalMillis: 10000 # limit of the interval between two attempts
```

The minimal configuration for the datahose service is the `eventTypes` field. It should contain at least one value
chosen among [_Real Time Events_](https://docs.developers.symphony.com/building-bots-on-symphony/datafeed/real-time-events) 
list and that `MESSAGESENT`, `MESSAGESUPPRESSED` and `SYMPHONYELEMENTSACTION` values can be set only if the ceservice is
properly configured and running in your Symphony agent.
The minimal configuration for the datahose service is the `eventTypes` field. It should contain at least one value
chosen among [_Real Time Events_](...) list. Note that `MESSAGESENT`, `MESSAGESUPPRESSED`, `SYMPHONYELEMENTSACTION`
and `GENERICSYSTEMEVENT` values can be set only if the ceservice is properly configured and running in your
Symphony agent.

The `tag` field is optional and is used when creating and reusing datahose feeds. If you have several instances of the
same bot and want them to use the same datahose feed (so that events are spread over bot instances),
Expand Down

68 changes: 68 additions & 0 deletions
examples/datafeed/datahose_generic_system_event.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
import asyncio
import logging
import logging.config
from pathlib import Path

from symphony.bdk.core.config.loader import BdkConfigLoader
from symphony.bdk.core.service.datafeed.real_time_event_listener import RealTimeEventListener
from symphony.bdk.core.symphony_bdk import SymphonyBdk
from symphony.bdk.gen.agent_model.v4_generic_system_event import V4GenericSystemEvent
from symphony.bdk.gen.agent_model.v4_initiator import V4Initiator

# Required config.yaml datahose section:
#
# datahose:
# tag: my-bot-tag
# eventTypes:
# - GENERICSYSTEMEVENT


async def run():
 config = BdkConfigLoader.load_from_symphony_dir("config.yaml")

 async with SymphonyBdk(config) as bdk:
 datahose_loop = bdk.datahose()
 datahose_loop.subscribe(RealTimeEventListenerImpl())
 await datahose_loop.start()


class RealTimeEventListenerImpl(RealTimeEventListener):
 async def on_generic_system_event(self, initiator: V4Initiator, event: V4GenericSystemEvent):
 """Called for every GENERICSYSTEMEVENT received from the datahose.

 GENERICSYSTEMEVENT is a platform-level envelope emitted by Symphony's internal
 Maestro event bus. The ``event_subtype`` field identifies the specific event;
 ``parameters`` carries subtype-specific data whose structure varies per subtype.

 Always filter on ``event_subtype`` — do not act on every generic event blindly.
 """
 subtype = event.event_subtype

 # We do not recommend logging full events in production as it could expose sensitive data
 logging.debug("GenericSystemEvent received — subtype: %s", subtype)

 # Filter on the specific subtype relevant to your use case.
 # The subtype values are defined by your Symphony deployment; log them first
 # to discover which ones are relevant before adding conditional logic.
 if subtype == "CONNECTION_REQUEST_ALERT":
 # Example: a federation connection lifecycle event.
 # event.parameters contains subtype-specific fields.
 logging.info("Connection request alert — parameters: %s", event.parameters)

 elif subtype is None:
 logging.warning("Received GENERICSYSTEMEVENT with no event_subtype — skipping")

 else:
 logging.debug("Unhandled GENERICSYSTEMEVENT subtype: %s", subtype)


logging.config.fileConfig(
 Path(__file__).parent.parent / "logging.conf", disable_existing_loggers=False
)


try:
 logging.info("Running datahose generic system event example...")
 asyncio.run(run())
except KeyboardInterrupt:
 logging.info("Ending datahose generic system event example")

4 changes: 3 additions & 1 deletion
symphony/bdk/core/service/datafeed/abstract_datafeed_loop.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,6 +57,7 @@ class RealTimeEvent(Enum):
 CONNECTIONACCEPTED = ("on_connection_accepted", "connection_accepted")
 SYMPHONYELEMENTSACTION = ("on_symphony_elements_action", "symphony_elements_action")
 MESSAGESUPPRESSED = ("on_message_suppressed", "message_suppressed")
 GENERICSYSTEMEVENT = ("on_generic_system_event", "generic_system_event")


def _set_context_var(current_task, event, listener):
Expand DownExpand Up@@ -202,7 +203,8 @@ async def _run_listener_method(listener: RealTimeEventListener, event: V4Event):
 listener_method_name, payload_field_name = RealTimeEvent[event.type].value
 except KeyError:
 logger.info("Received event with an unknown type: %s", event.type)
 return
 return # <-- GENERICSYSTEMEVENT hits this branch
 # GENERICSYSTEMEVENT is not in the enum, so every event is dropped.

 listener_method = getattr(listener, listener_method_name)
 event_field = getattr(event.payload, payload_field_name)
Expand Down

18 changes: 18 additions & 0 deletions
symphony/bdk/core/service/datafeed/real_time_event_listener.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
from symphony.bdk.gen.agent_model.v4_generic_system_event import V4GenericSystemEvent
from symphony.bdk.gen.agent_model.v4_connection_accepted import V4ConnectionAccepted
from symphony.bdk.gen.agent_model.v4_connection_requested import V4ConnectionRequested
from symphony.bdk.gen.agent_model.v4_event import V4Event
Expand DownExpand Up@@ -166,3 +167,20 @@ async def on_symphony_elements_action(
 :param initiator: Event initiator.
 :param event: Symphony Elements Action payload.
 """

 async def on_generic_system_event(
 self, initiator: V4Initiator, event: V4GenericSystemEvent
 ):
 """
 Called when a GENERICSYSTEMEVENT event is received.

 Generic system events are platform-level notifications emitted by Symphony's internal Maestro event bus.
 The ``event_subtype`` field on the payload identifies the specific event; ``parameters`` carries
 subtype-specific data.

 Bot developers should filter on ``event.event_subtype`` rather than relying solely on the outer
 ``GENERICSYSTEMEVENT`` type.

 :param initiator: Event initiator.
 :param event: Generic system event payload (``V4GenericSystemEvent``).
 """

17 changes: 17 additions & 0 deletions
tests/core/service/datafeed/abstract_datafeed_loop_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
# ruff: noqa
import asyncio
from unittest.mock import AsyncMock, call, patch
from symphony.bdk.gen.agent_model.v4_generic_system_event import V4GenericSystemEvent

import pytest

Expand DownExpand Up@@ -492,6 +493,22 @@ async def test_handle_symphony_element(df_loop, listener, initiator_userid):
 initiator_userid, payload.symphony_elements_action
 )

# This test verifies the full dispatch path: enum lookup → payload extraction → listener method called with correct
# arguments
@pytest.mark.asyncio
async def test_handle_generic_system_event(df_loop, listener, initiator_userid):
 payload = V4Payload(generic_system_event=V4GenericSystemEvent())
 event = V4Event(
 type=RealTimeEvent.GENERICSYSTEMEVENT.name,
 payload=payload,
 initiator=initiator_userid,
 )

 await create_and_await_tasks(df_loop, [event])

 listener.on_generic_system_event.assert_called_once_with(
 initiator_userid, payload.generic_system_event
 )

@pytest.mark.asyncio
async def test_handle_unknown_type(df_loop, listener, initiator_userid):
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat: Add GENERICSYSTEMEVENT support to RealTimeEvent enum and RealTimeEventListener#384

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Open

Alex-Nalin
wants to merge
2
commits into

base:main
Choose a base branch

from

 Open


feat: Add GENERICSYSTEMEVENT support to RealTimeEvent enum and RealTimeEventListener
#384
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
1f5f9d5

feat: Add GENERICSYSTEMEVENT support to RealTimeEvent enum and RealTi…


Alex-Nalin Mar 23, 2026
374571e

feat: Add GENERICSYSTEMEVENT support to RealTimeEvent enum and RealTi…


Alex-Nalin Mar 23, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


11 changes: 6 additions & 5 deletions
docsrc/markdown/datafeed.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -197,7 +197,8 @@ datahose:
 eventTypes: # mandatory field, events you want to receive
 - INSTANTMESSAGECREATED
 - ROOMCREATED
 - ROOMUPDATED 
 - ROOMUPDATED
 - GENERICSYSTEMEVENT

 retry: # optional
 maxAttempts: 6 # maximum number of retry attempts
Expand All@@ -206,10 +207,10 @@ datahose:
 maxIntervalMillis: 10000 # limit of the interval between two attempts
```

The minimal configuration for the datahose service is the `eventTypes` field. It should contain at least one value
chosen among [_Real Time Events_](https://docs.developers.symphony.com/building-bots-on-symphony/datafeed/real-time-events) 
list and that `MESSAGESENT`, `MESSAGESUPPRESSED` and `SYMPHONYELEMENTSACTION` values can be set only if the ceservice is
properly configured and running in your Symphony agent.
The minimal configuration for the datahose service is the `eventTypes` field. It should contain at least one value
chosen among [_Real Time Events_](...) list. Note that `MESSAGESENT`, `MESSAGESUPPRESSED`, `SYMPHONYELEMENTSACTION`
and `GENERICSYSTEMEVENT` values can be set only if the ceservice is properly configured and running in your
Symphony agent.

The `tag` field is optional and is used when creating and reusing datahose feeds. If you have several instances of the
same bot and want them to use the same datahose feed (so that events are spread over bot instances),
Expand Down

68 changes: 68 additions & 0 deletions
examples/datafeed/datahose_generic_system_event.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
import asyncio
import logging
import logging.config
from pathlib import Path

from symphony.bdk.core.config.loader import BdkConfigLoader
from symphony.bdk.core.service.datafeed.real_time_event_listener import RealTimeEventListener
from symphony.bdk.core.symphony_bdk import SymphonyBdk
from symphony.bdk.gen.agent_model.v4_generic_system_event import V4GenericSystemEvent
from symphony.bdk.gen.agent_model.v4_initiator import V4Initiator

# Required config.yaml datahose section:
#
# datahose:
# tag: my-bot-tag
# eventTypes:
# - GENERICSYSTEMEVENT


async def run():
 config = BdkConfigLoader.load_from_symphony_dir("config.yaml")

 async with SymphonyBdk(config) as bdk:
 datahose_loop = bdk.datahose()
 datahose_loop.subscribe(RealTimeEventListenerImpl())
 await datahose_loop.start()


class RealTimeEventListenerImpl(RealTimeEventListener):
 async def on_generic_system_event(self, initiator: V4Initiator, event: V4GenericSystemEvent):
 """Called for every GENERICSYSTEMEVENT received from the datahose.

 GENERICSYSTEMEVENT is a platform-level envelope emitted by Symphony's internal
 Maestro event bus. The ``event_subtype`` field identifies the specific event;
 ``parameters`` carries subtype-specific data whose structure varies per subtype.

 Always filter on ``event_subtype`` — do not act on every generic event blindly.
 """
 subtype = event.event_subtype

 # We do not recommend logging full events in production as it could expose sensitive data
 logging.debug("GenericSystemEvent received — subtype: %s", subtype)

 # Filter on the specific subtype relevant to your use case.
 # The subtype values are defined by your Symphony deployment; log them first
 # to discover which ones are relevant before adding conditional logic.
 if subtype == "CONNECTION_REQUEST_ALERT":
 # Example: a federation connection lifecycle event.
 # event.parameters contains subtype-specific fields.
 logging.info("Connection request alert — parameters: %s", event.parameters)

 elif subtype is None:
 logging.warning("Received GENERICSYSTEMEVENT with no event_subtype — skipping")

 else:
 logging.debug("Unhandled GENERICSYSTEMEVENT subtype: %s", subtype)


logging.config.fileConfig(
 Path(__file__).parent.parent / "logging.conf", disable_existing_loggers=False
)


try:
 logging.info("Running datahose generic system event example...")
 asyncio.run(run())
except KeyboardInterrupt:
 logging.info("Ending datahose generic system event example")

4 changes: 3 additions & 1 deletion
symphony/bdk/core/service/datafeed/abstract_datafeed_loop.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,6 +57,7 @@ class RealTimeEvent(Enum):
 CONNECTIONACCEPTED = ("on_connection_accepted", "connection_accepted")
 SYMPHONYELEMENTSACTION = ("on_symphony_elements_action", "symphony_elements_action")
 MESSAGESUPPRESSED = ("on_message_suppressed", "message_suppressed")
 GENERICSYSTEMEVENT = ("on_generic_system_event", "generic_system_event")


def _set_context_var(current_task, event, listener):
Expand DownExpand Up@@ -202,7 +203,8 @@ async def _run_listener_method(listener: RealTimeEventListener, event: V4Event):
 listener_method_name, payload_field_name = RealTimeEvent[event.type].value
 except KeyError:
 logger.info("Received event with an unknown type: %s", event.type)
 return
 return # <-- GENERICSYSTEMEVENT hits this branch
 # GENERICSYSTEMEVENT is not in the enum, so every event is dropped.

 listener_method = getattr(listener, listener_method_name)
 event_field = getattr(event.payload, payload_field_name)
Expand Down

18 changes: 18 additions & 0 deletions
symphony/bdk/core/service/datafeed/real_time_event_listener.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
from symphony.bdk.gen.agent_model.v4_generic_system_event import V4GenericSystemEvent
from symphony.bdk.gen.agent_model.v4_connection_accepted import V4ConnectionAccepted
from symphony.bdk.gen.agent_model.v4_connection_requested import V4ConnectionRequested
from symphony.bdk.gen.agent_model.v4_event import V4Event
Expand DownExpand Up@@ -166,3 +167,20 @@ async def on_symphony_elements_action(
 :param initiator: Event initiator.
 :param event: Symphony Elements Action payload.
 """

 async def on_generic_system_event(
 self, initiator: V4Initiator, event: V4GenericSystemEvent
 ):
 """
 Called when a GENERICSYSTEMEVENT event is received.

 Generic system events are platform-level notifications emitted by Symphony's internal Maestro event bus.
 The ``event_subtype`` field on the payload identifies the specific event; ``parameters`` carries
 subtype-specific data.

 Bot developers should filter on ``event.event_subtype`` rather than relying solely on the outer
 ``GENERICSYSTEMEVENT`` type.

 :param initiator: Event initiator.
 :param event: Generic system event payload (``V4GenericSystemEvent``).
 """

17 changes: 17 additions & 0 deletions
tests/core/service/datafeed/abstract_datafeed_loop_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
# ruff: noqa
import asyncio
from unittest.mock import AsyncMock, call, patch
from symphony.bdk.gen.agent_model.v4_generic_system_event import V4GenericSystemEvent

import pytest

Expand DownExpand Up@@ -492,6 +493,22 @@ async def test_handle_symphony_element(df_loop, listener, initiator_userid):
 initiator_userid, payload.symphony_elements_action
 )

# This test verifies the full dispatch path: enum lookup → payload extraction → listener method called with correct
# arguments
@pytest.mark.asyncio
async def test_handle_generic_system_event(df_loop, listener, initiator_userid):
 payload = V4Payload(generic_system_event=V4GenericSystemEvent())
 event = V4Event(
 type=RealTimeEvent.GENERICSYSTEMEVENT.name,
 payload=payload,
 initiator=initiator_userid,
 )

 await create_and_await_tasks(df_loop, [event])

 listener.on_generic_system_event.assert_called_once_with(
 initiator_userid, payload.generic_system_event
 )

@pytest.mark.asyncio
async def test_handle_unknown_type(df_loop, listener, initiator_userid):
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat: Add GENERICSYSTEMEVENT support to RealTimeEvent enum and RealTimeEventListener#384

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Open

Alex-Nalin
wants to merge
2
commits into

base:main
Choose a base branch

from

 Open


feat: Add GENERICSYSTEMEVENT support to RealTimeEvent enum and RealTimeEventListener
#384
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
1f5f9d5

feat: Add GENERICSYSTEMEVENT support to RealTimeEvent enum and RealTi…


Alex-Nalin Mar 23, 2026
374571e

feat: Add GENERICSYSTEMEVENT support to RealTimeEvent enum and RealTi…


Alex-Nalin Mar 23, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


11 changes: 6 additions & 5 deletions
docsrc/markdown/datafeed.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -197,7 +197,8 @@ datahose:
 eventTypes: # mandatory field, events you want to receive
 - INSTANTMESSAGECREATED
 - ROOMCREATED
 - ROOMUPDATED 
 - ROOMUPDATED
 - GENERICSYSTEMEVENT

 retry: # optional
 maxAttempts: 6 # maximum number of retry attempts
Expand All@@ -206,10 +207,10 @@ datahose:
 maxIntervalMillis: 10000 # limit of the interval between two attempts
```

The minimal configuration for the datahose service is the `eventTypes` field. It should contain at least one value
chosen among [_Real Time Events_](https://docs.developers.symphony.com/building-bots-on-symphony/datafeed/real-time-events) 
list and that `MESSAGESENT`, `MESSAGESUPPRESSED` and `SYMPHONYELEMENTSACTION` values can be set only if the ceservice is
properly configured and running in your Symphony agent.
The minimal configuration for the datahose service is the `eventTypes` field. It should contain at least one value
chosen among [_Real Time Events_](...) list. Note that `MESSAGESENT`, `MESSAGESUPPRESSED`, `SYMPHONYELEMENTSACTION`
and `GENERICSYSTEMEVENT` values can be set only if the ceservice is properly configured and running in your
Symphony agent.

The `tag` field is optional and is used when creating and reusing datahose feeds. If you have several instances of the
same bot and want them to use the same datahose feed (so that events are spread over bot instances),
Expand Down

68 changes: 68 additions & 0 deletions
examples/datafeed/datahose_generic_system_event.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
import asyncio
import logging
import logging.config
from pathlib import Path

from symphony.bdk.core.config.loader import BdkConfigLoader
from symphony.bdk.core.service.datafeed.real_time_event_listener import RealTimeEventListener
from symphony.bdk.core.symphony_bdk import SymphonyBdk
from symphony.bdk.gen.agent_model.v4_generic_system_event import V4GenericSystemEvent
from symphony.bdk.gen.agent_model.v4_initiator import V4Initiator

# Required config.yaml datahose section:
#
# datahose:
# tag: my-bot-tag
# eventTypes:
# - GENERICSYSTEMEVENT


async def run():
 config = BdkConfigLoader.load_from_symphony_dir("config.yaml")

 async with SymphonyBdk(config) as bdk:
 datahose_loop = bdk.datahose()
 datahose_loop.subscribe(RealTimeEventListenerImpl())
 await datahose_loop.start()


class RealTimeEventListenerImpl(RealTimeEventListener):
 async def on_generic_system_event(self, initiator: V4Initiator, event: V4GenericSystemEvent):
 """Called for every GENERICSYSTEMEVENT received from the datahose.

 GENERICSYSTEMEVENT is a platform-level envelope emitted by Symphony's internal
 Maestro event bus. The ``event_subtype`` field identifies the specific event;
 ``parameters`` carries subtype-specific data whose structure varies per subtype.

 Always filter on ``event_subtype`` — do not act on every generic event blindly.
 """
 subtype = event.event_subtype

 # We do not recommend logging full events in production as it could expose sensitive data
 logging.debug("GenericSystemEvent received — subtype: %s", subtype)

 # Filter on the specific subtype relevant to your use case.
 # The subtype values are defined by your Symphony deployment; log them first
 # to discover which ones are relevant before adding conditional logic.
 if subtype == "CONNECTION_REQUEST_ALERT":
 # Example: a federation connection lifecycle event.
 # event.parameters contains subtype-specific fields.
 logging.info("Connection request alert — parameters: %s", event.parameters)

 elif subtype is None:
 logging.warning("Received GENERICSYSTEMEVENT with no event_subtype — skipping")

 else:
 logging.debug("Unhandled GENERICSYSTEMEVENT subtype: %s", subtype)


logging.config.fileConfig(
 Path(__file__).parent.parent / "logging.conf", disable_existing_loggers=False
)


try:
 logging.info("Running datahose generic system event example...")
 asyncio.run(run())
except KeyboardInterrupt:
 logging.info("Ending datahose generic system event example")

4 changes: 3 additions & 1 deletion
symphony/bdk/core/service/datafeed/abstract_datafeed_loop.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,6 +57,7 @@ class RealTimeEvent(Enum):
 CONNECTIONACCEPTED = ("on_connection_accepted", "connection_accepted")
 SYMPHONYELEMENTSACTION = ("on_symphony_elements_action", "symphony_elements_action")
 MESSAGESUPPRESSED = ("on_message_suppressed", "message_suppressed")
 GENERICSYSTEMEVENT = ("on_generic_system_event", "generic_system_event")


def _set_context_var(current_task, event, listener):
Expand DownExpand Up@@ -202,7 +203,8 @@ async def _run_listener_method(listener: RealTimeEventListener, event: V4Event):
 listener_method_name, payload_field_name = RealTimeEvent[event.type].value
 except KeyError:
 logger.info("Received event with an unknown type: %s", event.type)
 return
 return # <-- GENERICSYSTEMEVENT hits this branch
 # GENERICSYSTEMEVENT is not in the enum, so every event is dropped.

 listener_method = getattr(listener, listener_method_name)
 event_field = getattr(event.payload, payload_field_name)
Expand Down

18 changes: 18 additions & 0 deletions
symphony/bdk/core/service/datafeed/real_time_event_listener.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
from symphony.bdk.gen.agent_model.v4_generic_system_event import V4GenericSystemEvent
from symphony.bdk.gen.agent_model.v4_connection_accepted import V4ConnectionAccepted
from symphony.bdk.gen.agent_model.v4_connection_requested import V4ConnectionRequested
from symphony.bdk.gen.agent_model.v4_event import V4Event
Expand DownExpand Up@@ -166,3 +167,20 @@ async def on_symphony_elements_action(
 :param initiator: Event initiator.
 :param event: Symphony Elements Action payload.
 """

 async def on_generic_system_event(
 self, initiator: V4Initiator, event: V4GenericSystemEvent
 ):
 """
 Called when a GENERICSYSTEMEVENT event is received.

 Generic system events are platform-level notifications emitted by Symphony's internal Maestro event bus.
 The ``event_subtype`` field on the payload identifies the specific event; ``parameters`` carries
 subtype-specific data.

 Bot developers should filter on ``event.event_subtype`` rather than relying solely on the outer
 ``GENERICSYSTEMEVENT`` type.

 :param initiator: Event initiator.
 :param event: Generic system event payload (``V4GenericSystemEvent``).
 """

17 changes: 17 additions & 0 deletions
tests/core/service/datafeed/abstract_datafeed_loop_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
# ruff: noqa
import asyncio
from unittest.mock import AsyncMock, call, patch
from symphony.bdk.gen.agent_model.v4_generic_system_event import V4GenericSystemEvent

import pytest

Expand DownExpand Up@@ -492,6 +493,22 @@ async def test_handle_symphony_element(df_loop, listener, initiator_userid):
 initiator_userid, payload.symphony_elements_action
 )

# This test verifies the full dispatch path: enum lookup → payload extraction → listener method called with correct
# arguments
@pytest.mark.asyncio
async def test_handle_generic_system_event(df_loop, listener, initiator_userid):
 payload = V4Payload(generic_system_event=V4GenericSystemEvent())
 event = V4Event(
 type=RealTimeEvent.GENERICSYSTEMEVENT.name,
 payload=payload,
 initiator=initiator_userid,
 )

 await create_and_await_tasks(df_loop, [event])

 listener.on_generic_system_event.assert_called_once_with(
 initiator_userid, payload.generic_system_event
 )

@pytest.mark.asyncio
async def test_handle_unknown_type(df_loop, listener, initiator_userid):
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
feat: Add GENERICSYSTEMEVENT support to RealTimeEvent enum and RealTimeEventListener#384

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Open

Alex-Nalin
wants to merge
2
commits into

base:main
Choose a base branch

from

 Open


feat: Add GENERICSYSTEMEVENT support to RealTimeEvent enum and RealTimeEventListener
#384
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
1f5f9d5

feat: Add GENERICSYSTEMEVENT support to RealTimeEvent enum and RealTi…


Alex-Nalin Mar 23, 2026
374571e

feat: Add GENERICSYSTEMEVENT support to RealTimeEvent enum and RealTi…


Alex-Nalin Mar 23, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


11 changes: 6 additions & 5 deletions
docsrc/markdown/datafeed.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -197,7 +197,8 @@ datahose:
 eventTypes: # mandatory field, events you want to receive
 - INSTANTMESSAGECREATED
 - ROOMCREATED
 - ROOMUPDATED 
 - ROOMUPDATED
 - GENERICSYSTEMEVENT

 retry: # optional
 maxAttempts: 6 # maximum number of retry attempts
Expand All@@ -206,10 +207,10 @@ datahose:
 maxIntervalMillis: 10000 # limit of the interval between two attempts
```

The minimal configuration for the datahose service is the `eventTypes` field. It should contain at least one value
chosen among [_Real Time Events_](https://docs.developers.symphony.com/building-bots-on-symphony/datafeed/real-time-events) 
list and that `MESSAGESENT`, `MESSAGESUPPRESSED` and `SYMPHONYELEMENTSACTION` values can be set only if the ceservice is
properly configured and running in your Symphony agent.
The minimal configuration for the datahose service is the `eventTypes` field. It should contain at least one value
chosen among [_Real Time Events_](...) list. Note that `MESSAGESENT`, `MESSAGESUPPRESSED`, `SYMPHONYELEMENTSACTION`
and `GENERICSYSTEMEVENT` values can be set only if the ceservice is properly configured and running in your
Symphony agent.

The `tag` field is optional and is used when creating and reusing datahose feeds. If you have several instances of the
same bot and want them to use the same datahose feed (so that events are spread over bot instances),
Expand Down

68 changes: 68 additions & 0 deletions
examples/datafeed/datahose_generic_system_event.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
import asyncio
import logging
import logging.config
from pathlib import Path

from symphony.bdk.core.config.loader import BdkConfigLoader
from symphony.bdk.core.service.datafeed.real_time_event_listener import RealTimeEventListener
from symphony.bdk.core.symphony_bdk import SymphonyBdk
from symphony.bdk.gen.agent_model.v4_generic_system_event import V4GenericSystemEvent
from symphony.bdk.gen.agent_model.v4_initiator import V4Initiator

# Required config.yaml datahose section:
#
# datahose:
# tag: my-bot-tag
# eventTypes:
# - GENERICSYSTEMEVENT


async def run():
 config = BdkConfigLoader.load_from_symphony_dir("config.yaml")

 async with SymphonyBdk(config) as bdk:
 datahose_loop = bdk.datahose()
 datahose_loop.subscribe(RealTimeEventListenerImpl())
 await datahose_loop.start()


class RealTimeEventListenerImpl(RealTimeEventListener):
 async def on_generic_system_event(self, initiator: V4Initiator, event: V4GenericSystemEvent):
 """Called for every GENERICSYSTEMEVENT received from the datahose.

 GENERICSYSTEMEVENT is a platform-level envelope emitted by Symphony's internal
 Maestro event bus. The ``event_subtype`` field identifies the specific event;
 ``parameters`` carries subtype-specific data whose structure varies per subtype.

 Always filter on ``event_subtype`` — do not act on every generic event blindly.
 """
 subtype = event.event_subtype

 # We do not recommend logging full events in production as it could expose sensitive data
 logging.debug("GenericSystemEvent received — subtype: %s", subtype)

 # Filter on the specific subtype relevant to your use case.
 # The subtype values are defined by your Symphony deployment; log them first
 # to discover which ones are relevant before adding conditional logic.
 if subtype == "CONNECTION_REQUEST_ALERT":
 # Example: a federation connection lifecycle event.
 # event.parameters contains subtype-specific fields.
 logging.info("Connection request alert — parameters: %s", event.parameters)

 elif subtype is None:
 logging.warning("Received GENERICSYSTEMEVENT with no event_subtype — skipping")

 else:
 logging.debug("Unhandled GENERICSYSTEMEVENT subtype: %s", subtype)


logging.config.fileConfig(
 Path(__file__).parent.parent / "logging.conf", disable_existing_loggers=False
)


try:
 logging.info("Running datahose generic system event example...")
 asyncio.run(run())
except KeyboardInterrupt:
 logging.info("Ending datahose generic system event example")

4 changes: 3 additions & 1 deletion
symphony/bdk/core/service/datafeed/abstract_datafeed_loop.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,6 +57,7 @@ class RealTimeEvent(Enum):
 CONNECTIONACCEPTED = ("on_connection_accepted", "connection_accepted")
 SYMPHONYELEMENTSACTION = ("on_symphony_elements_action", "symphony_elements_action")
 MESSAGESUPPRESSED = ("on_message_suppressed", "message_suppressed")
 GENERICSYSTEMEVENT = ("on_generic_system_event", "generic_system_event")


def _set_context_var(current_task, event, listener):
Expand DownExpand Up@@ -202,7 +203,8 @@ async def _run_listener_method(listener: RealTimeEventListener, event: V4Event):
 listener_method_name, payload_field_name = RealTimeEvent[event.type].value
 except KeyError:
 logger.info("Received event with an unknown type: %s", event.type)
 return
 return # <-- GENERICSYSTEMEVENT hits this branch
 # GENERICSYSTEMEVENT is not in the enum, so every event is dropped.

 listener_method = getattr(listener, listener_method_name)
 event_field = getattr(event.payload, payload_field_name)
Expand Down

18 changes: 18 additions & 0 deletions
symphony/bdk/core/service/datafeed/real_time_event_listener.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
from symphony.bdk.gen.agent_model.v4_generic_system_event import V4GenericSystemEvent
from symphony.bdk.gen.agent_model.v4_connection_accepted import V4ConnectionAccepted
from symphony.bdk.gen.agent_model.v4_connection_requested import V4ConnectionRequested
from symphony.bdk.gen.agent_model.v4_event import V4Event
Expand DownExpand Up@@ -166,3 +167,20 @@ async def on_symphony_elements_action(
 :param initiator: Event initiator.
 :param event: Symphony Elements Action payload.
 """

 async def on_generic_system_event(
 self, initiator: V4Initiator, event: V4GenericSystemEvent
 ):
 """
 Called when a GENERICSYSTEMEVENT event is received.

 Generic system events are platform-level notifications emitted by Symphony's internal Maestro event bus.
 The ``event_subtype`` field on the payload identifies the specific event; ``parameters`` carries
 subtype-specific data.

 Bot developers should filter on ``event.event_subtype`` rather than relying solely on the outer
 ``GENERICSYSTEMEVENT`` type.

 :param initiator: Event initiator.
 :param event: Generic system event payload (``V4GenericSystemEvent``).
 """

17 changes: 17 additions & 0 deletions
tests/core/service/datafeed/abstract_datafeed_loop_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
# ruff: noqa
import asyncio
from unittest.mock import AsyncMock, call, patch
from symphony.bdk.gen.agent_model.v4_generic_system_event import V4GenericSystemEvent

import pytest

Expand DownExpand Up@@ -492,6 +493,22 @@ async def test_handle_symphony_element(df_loop, listener, initiator_userid):
 initiator_userid, payload.symphony_elements_action
 )

# This test verifies the full dispatch path: enum lookup → payload extraction → listener method called with correct
# arguments
@pytest.mark.asyncio
async def test_handle_generic_system_event(df_loop, listener, initiator_userid):
 payload = V4Payload(generic_system_event=V4GenericSystemEvent())
 event = V4Event(
 type=RealTimeEvent.GENERICSYSTEMEVENT.name,
 payload=payload,
 initiator=initiator_userid,
 )

 await create_and_await_tasks(df_loop, [event])

 listener.on_generic_system_event.assert_called_once_with(
 initiator_userid, payload.generic_system_event
 )

@pytest.mark.asyncio
async def test_handle_unknown_type(df_loop, listener, initiator_userid):
Expand Down