Skip to content

Agent Zero AI framework

refactor: add websocket wildcard event support and improve cache clearing

frdel651deac6f72b
diff --git a/extensions/webui/ws_sync_push/clear_cache.js b/extensions/webui/ws_sync_push/clear_cache.js
new file mode 100644
index 000000000..8ee5491f8
--- /dev/null
+++ b/extensions/webui/ws_sync_push/clear_cache.js
@@ -0,0 +1,21 @@
+import { clear, clear_all } from "/js/cache.js";
+
+export default async function clearCache(eventType, envelope) {
+ try {
+ // clear frontend cache areas when backend caches are cleared via API
+ if (eventType == "clear_cache") {
+ const areas = envelope?.data?.areas || [];
+ console.log("Clearing caches", areas);
+ if (areas.length > 0) {
+ for (const area of areas) {
+ clear(area);
+ }
+ } else {
+ // clear all caches
+ clear_all();
+ }
+ }
+ } catch (e) {
+ console.error(e);
+ }
+}
diff --git a/helpers/plugins.py b/helpers/plugins.py
index d17de63d5..089ed2c82 100644
--- a/helpers/plugins.py
+++ b/helpers/plugins.py
@@ -14,7 +14,6 @@ from typing import (
TYPE_CHECKING,
TypedDict,
)
-from helpers.settings import get_default_value
from regex import W
@@ -133,17 +132,17 @@ def register_watchdogs():
relevant_patterns = ["**/extensions/**/*", TOGGLE_FILE_PATTERN, HOOKS_SCRIPT]
# combine relevant patterns with base path
- def expand_patterns(base_path:str):
+ def expand_patterns(base_path: str):
result = []
for pattern in relevant_patterns:
- result.append(base_path+pattern)
+ result.append(base_path + pattern)
return result
# add watchdogs for plugin roots
watchdog.add_watchdog(
id="plugins_roots",
roots=get_plugin_roots(),
- patterns = [*expand_patterns("*/")],
+ patterns=[*expand_patterns("*/")],
handler=on_plugin_change,
)
@@ -180,9 +179,17 @@ def after_plugin_change(plugin_names: list[str] | None = None):
def clear_plugin_cache():
- cache.clear("*(plugins)*")
- cache.clear("*(extensions)*")
- cache.clear("*(api)*")
+ areas = ["*(plugins)*", "*(extensions)*", "*(api)*"]
+ for area in areas:
+ cache.clear(area)
+ from helpers.websocket_manager import send_data
+
+ DeferredTask().start_task(
+ send_data,
+ endpoint_name="/state_sync",
+ event_name="clear_cache",
+ data={"areas": areas},
+ )
def get_plugin_roots(plugin_name: str = "") -> List[str]:
@@ -362,18 +369,17 @@ def delete_plugin(plugin_name: str):
raise ValueError("Only custom plugins can be deleted")
# delete additional plugin folders
- assets = find_plugin_assets("",plugin_name=plugin_name)
+ assets = find_plugin_assets("", plugin_name=plugin_name)
for asset in assets:
files.delete_dir(asset["path"])
-
send_frontend_reload_notification(
[plugin_name]
) # send before deletion to properly check the extensions, second notification will be skipped automatically
-
+
# delete main plugin folder
files.delete_dir(plugin_dir)
-
+
after_plugin_change([plugin_name])
@@ -855,12 +861,16 @@ def call_plugin_hook(
return default
if asyncio.iscoroutinefunction(hook):
- return asyncio.run(extract_tools.safe_call(hook, *args, default=default, **kwargs))
+ return asyncio.run(
+ extract_tools.safe_call(hook, *args, default=default, **kwargs)
+ )
return extract_tools.safe_call(hook, *args, default=default, **kwargs)
def _apply_defaults_from_env(plugin_name: str, config: dict[str, Any]):
+ from helpers.settings import get_default_value
+
def _apply(prefix: list[str], value: dict[str, Any]):
for key, child in value.items():
env_name = "__".join([plugin_name, *prefix, key])
diff --git a/helpers/websocket_manager.py b/helpers/websocket_manager.py
index cf5f46b27..1b6fc39bf 100644
--- a/helpers/websocket_manager.py
+++ b/helpers/websocket_manager.py
@@ -19,12 +19,36 @@ from helpers.state_monitor import _ws_debug_enabled
BUFFER_MAX_SIZE = 100
BUFFER_TTL = timedelta(hours=1)
+_shared_websocket_manager: WebSocketManager | None = None
def _utcnow() -> datetime:
return datetime.now(timezone.utc)
+def set_shared_websocket_manager(manager: "WebSocketManager") -> None:
+ global _shared_websocket_manager
+ _shared_websocket_manager = manager
+
+
+def get_shared_websocket_manager() -> "WebSocketManager":
+ manager = _shared_websocket_manager
+ if manager is None:
+ raise RuntimeError("Shared WebSocketManager has not been initialized")
+ return manager
+
+
+async def send_data(
+ endpoint_name: str,
+ event_name: str,
+ data: dict[str, Any],
+ connection_id: str | None = None,
+) -> None:
+ manager = get_shared_websocket_manager()
+ print(f"Sending data to {endpoint_name}/{event_name} with data {data}")
+ await manager.send_data(endpoint_name, event_name, data, connection_id)
+
+
@dataclass
class BufferedEvent:
event_type: str
@@ -979,6 +1003,18 @@ class WebSocketManager:
}
)
+ async def send_data(
+ self,
+ endpoint_name: str,
+ event_name: str,
+ data: dict[str, Any],
+ connection_id: str | None = None,
+ ) -> None:
+ if connection_id is not None:
+ await self.emit_to(endpoint_name, connection_id, event_name, data)
+ return
+ await self.broadcast(endpoint_name, event_name, data)
+
async def broadcast(
self,
namespace: str,
diff --git a/run_ui.py b/run_ui.py
index 2a7bc84e2..4681ae2d2 100644
--- a/run_ui.py
+++ b/run_ui.py
@@ -24,7 +24,7 @@ from socketio import ASGIApp, packet
from starlette.applications import Starlette
from starlette.routing import Mount
from uvicorn.middleware.wsgi import WSGIMiddleware
-from helpers.websocket_manager import WebSocketManager
+from helpers.websocket_manager import WebSocketManager, set_shared_websocket_manager
from helpers.websocket_namespace_discovery import discover_websocket_namespaces
from flask import send_file
@@ -74,6 +74,7 @@ socketio_server = socketio.AsyncServer(
)
websocket_manager = WebSocketManager(socketio_server, lock)
+set_shared_websocket_manager(websocket_manager)
_settings = settings_helper.get_settings()
settings_helper.set_runtime_settings_snapshot(_settings)
websocket_manager.set_server_restart_broadcast(
diff --git a/webui/components/sync/sync-store.js b/webui/components/sync/sync-store.js
index 59cac0088..14a13355f 100644
--- a/webui/components/sync/sync-store.js
+++ b/webui/components/sync/sync-store.js
@@ -4,6 +4,7 @@ import { invalidateCsrfToken } from "/js/api.js";
import { applySnapshot, buildStateRequestPayload } from "/index.js";
import { store as chatTopStore } from "/components/chat/top-section/chat-top-store.js";
import { store as notificationStore } from "/components/notifications/notification-store.js";
+import * as Extensions from "/js/extensions.js"
const stateSocket = getNamespacedClient("/state_sync");
@@ -314,6 +315,12 @@ const model = {
});
debug("[syncStore] subscribed to server_restart");
+ // handle all requests with extensions
+ await stateSocket.on("*", (eventType, envelope) => {
+ console.log(`[syncStore] *${eventType} received`);
+ this.handleEvent(eventType, envelope)
+ });
+
await this.sendStateRequest({ forceFull: true });
} catch (error) {
console.error("[syncStore] init failed:", error);
@@ -322,6 +329,10 @@ const model = {
}
},
+ async handleEvent(eventType, envelope){
+ await Extensions.callJsExtensions("ws_sync_push", eventType, envelope);
+ },
+
async sendStateRequest(options = {}) {
const { forceFull = false } = options || {};
const payload = buildStateRequestPayload({ forceFull });
diff --git a/webui/js/websocket.js b/webui/js/websocket.js
index b65ceaebf..6cc877b39 100644
--- a/webui/js/websocket.js
+++ b/webui/js/websocket.js
@@ -115,6 +115,15 @@ function normalizeNamespace(value) {
return trimmed.startsWith("/") ? trimmed : `/${trimmed}`;
}
+function hasWildcardPattern(value) {
+ return typeof value === "string" && value.includes("*");
+}
+
+function compileEventPattern(value) {
+ const escaped = value.replace(/[|\\{}()[\]^$+?.]/g, "\\$&");
+ return new RegExp(`^${escaped.replaceAll("*", ".*")}$`);
+}
+
/**
* Generate a correlation identifier using UUIDv4 semantics.
*
@@ -487,9 +496,18 @@ class WebSocketClient {
await this.connect();
if (!this.subscriptions.has(eventType)) {
- const handler = (payload) => {
+ const isWildcard = hasWildcardPattern(eventType);
+ const eventPattern = isWildcard ? compileEventPattern(eventType) : null;
+ const handler = (...args) => {
const entry = this.subscriptions.get(eventType);
if (!entry) return;
+ const currentIsWildcard = Boolean(entry.eventPattern);
+ const payload = isWildcard ? args[1] : args[0];
+ const incomingEventType = isWildcard ? args[0] : eventType;
+ if (currentIsWildcard) {
+ if (typeof incomingEventType !== "string") return;
+ if (!entry.eventPattern.test(incomingEventType)) return;
+ }
let envelope;
try {
envelope = validateServerEnvelope(payload);
@@ -501,6 +519,10 @@ class WebSocketClient {
entry.callbacks.forEach((cb) => {
try {
+ if (currentIsWildcard) {
+ cb(incomingEventType, envelope);
+ return;
+ }
cb(envelope);
} catch (error) {
console.error("WebSocket callback error:", error);
@@ -509,11 +531,16 @@ class WebSocketClient {
};
this.subscriptions.set(eventType, {
+ eventPattern,
handler,
callbacks: new Set(),
});
- this.socket.on(eventType, handler);
+ if (isWildcard) {
+ this.socket.onAny(handler);
+ } else {
+ this.socket.on(eventType, handler);
+ }
}
const entry = this.subscriptions.get(eventType);
@@ -532,7 +559,11 @@ class WebSocketClient {
if (entry.callbacks.size === 0) {
if (this.socket) {
- this.socket.off(eventType, entry.handler);
+ if (entry.eventPattern) {
+ this.socket.offAny(entry.handler);
+ } else {
+ this.socket.off(eventType, entry.handler);
+ }
}
this.subscriptions.delete(eventType);
}