Event log by michael-pisman · Pull Request #95 · csed-ucm/psephos

michael-pisman · 2025-07-30T06:52:48Z

This pull request introduces significant new features and enhancements to the unipoll_api project, including WebSocket and event streaming functionality, Redis integration for notifications, and improved workspace and group management. Key updates include the addition of new WebSocket actions, Redis-based push notifications, event logging for resources, and new endpoints for event streams.

New Features and Integrations:

WebSocket Actions:
- Added websocket.py with WebSocket-related actions for managing workspaces and groups, including CRUD operations for resources, members, and policies. (src/unipoll_api/actions/websocket.py)
- Imported WebsocketActions into __init__.py to expose WebSocket functionality. (src/unipoll_api/actions/__init__.py)
Redis Integration:
- Introduced Redis for push notifications with methods to publish messages and listen to channels. (src/unipoll_api/redis.py)
- Added Redis configuration fields (redis_host, redis_port) to application settings. (src/unipoll_api/config.py)
Event Logging and Streaming:
- Added an Event document for time-series event logging. (src/unipoll_api/documents.py)
- Implemented event logging in workspace updates, including notifications for members. (src/unipoll_api/actions/workspace.py)
- Created new endpoints for subscribing to resource events and pushing notifications. (src/unipoll_api/routes/streams.py)

Enhancements to Existing Components:

Workspace and Group Management:
- Enhanced workspace-related actions to include event logging and notifications. (src/unipoll_api/actions/workspace.py)
- Updated dependencies to support WebSocket authentication and token validation. (src/unipoll_api/dependencies.py)
Error Handling:
- Added WebSocket-specific exceptions for better error reporting. (src/unipoll_api/exceptions/websocket.py)

Configuration and Dependencies:

Dependencies:
- Added sse-starlette for server-sent events. (pyproject.toml)
Startup Improvements:
- Introduced application start time for tracking resource updates. (src/unipoll_api/app.py)

These changes collectively enhance the API's real-time capabilities and improve resource management while introducing robust event logging and notification systems.

Event document represents time series for storing various events

Added list of linked events to Resource model and created log_event() method to record new events into the database

Created to functions to publish and listen to the messages from redis

…ng purposes

Changed get_updates function to use ResourceID instead of Resource object, removed event_generator

operation_id is not set inside router module

There is no point in storing events inside of the Resource

Copilot

Pull Request Overview

This PR implements an event logging system with real-time notifications for workspace operations. The changes introduce WebSocket connections for real-time communication, MongoDB time-series collections for event storage, and Redis pub/sub for push notifications.

Key changes:

Added WebSocket support with action parsing and real-time messaging capabilities
Implemented event logging system using MongoDB time-series collections
Added Redis integration for real-time push notifications and Server-Sent Events (SSE)

Reviewed Changes

Copilot reviewed 18 out of 19 changed files in this pull request and generated 13 comments.

Show a summary per file

File	Description
src/unipoll_api/websocket_manager.py	Enhanced WebSocket manager with JSON messaging and action parsing functionality
src/unipoll_api/utils/events.py	New event utilities for getting updates, streaming events, and notifying members
src/unipoll_api/schemas/websocket.py	New WebSocket message schema for action-based communication
src/unipoll_api/routes/websocket.py	Updated WebSocket route with authentication and message parsing
src/unipoll_api/routes/streams.py	New streaming endpoints for event logs and Redis notifications
src/unipoll_api/routes/init.py	Added streams router to main application
src/unipoll_api/redis.py	New Redis client for pub/sub messaging
src/unipoll_api/mongo_db.py	Added Event document to database initialization
src/unipoll_api/exceptions/websocket.py	New WebSocket-specific exception classes
src/unipoll_api/exceptions/init.py	Exported WebSocket exceptions
src/unipoll_api/documents.py	Added Event document with time-series configuration
src/unipoll_api/dependencies.py	Updated WebSocket authentication dependency
src/unipoll_api/config.py	Added Redis configuration settings
src/unipoll_api/app.py	Added application start time tracking
src/unipoll_api/actions/workspace.py	Added event logging to workspace updates
src/unipoll_api/actions/websocket.py	New WebSocket action handlers for various operations
src/unipoll_api/actions/init.py	Exported WebSocket actions
pyproject.toml	Added sse-starlette dependency

Comments suppressed due to low confidence (1)

Copilot · 2025-07-30T06:55:35Z

src/unipoll_api/websocket_manager.py

+    filtered_args = {}
+    for key, required in args.items():
+        value = data.get(key)
+        if required and not value:


This condition will incorrectly reject valid falsy values like 0, False, or empty strings that might be legitimate arguments. Consider using value is None instead.

Suggested change

if required and not value:

if required and value is None:

Copilot · 2025-07-30T06:55:36Z

src/unipoll_api/websocket_manager.py

+    response: BaseModel = await action(**args)
+    if not response:
+        response = {"status": "success"}
+    return response.model_dump(exclude_none=True)


When response is a dictionary (line 55), calling .model_dump() will fail since dictionaries don't have this method. The function should handle both BaseModel instances and dictionaries consistently.

Suggested change

return response.model_dump(exclude_none=True)

if isinstance(response, BaseModel):

return response.model_dump(exclude_none=True)

return response

Copilot · 2025-07-30T06:55:36Z

src/unipoll_api/utils/events.py

+    try:
+        timestamp = datetime.now()
+        for member in resource.members:
+            # print(member)


Commented-out debug print statement should be removed from production code.

Suggested change

# print(member)

Copilot · 2025-07-30T06:55:36Z

src/unipoll_api/routes/streams.py

+            time = datetime.fromisoformat(since)
+        return await get_updates(resource_id, time)
+    except Exception as e:
+        print(e)


Using print() for error handling is not appropriate for production code. Consider using proper logging or raising appropriate exceptions.

Copilot · 2025-07-30T06:55:36Z

src/unipoll_api/routes/streams.py

+        print(e)
+
+


Using print() for error handling is not appropriate for production code. Consider using proper logging or raising appropriate exceptions.

Suggested change

print(e)

logger.error(f"Error in generate_event: {e}")

raise HTTPException(status_code=500, detail="Internal Server Error")

Copilot · 2025-07-30T06:55:38Z

src/unipoll_api/redis.py

+        print("Connection error:", e)
+    except Exception as e:
+        print("An unexpected error occurred:", e)


Using print() for error handling is not appropriate for production code. Consider using proper logging.

Suggested change

print("Connection error:", e)

except Exception as e:

print("An unexpected error occurred:", e)

logger.error("Connection error: %s", e)

except Exception as e:

logger.error("An unexpected error occurred: %s", e)

Copilot · 2025-07-30T06:55:38Z

src/unipoll_api/redis.py

+        print("Connection error:", e)
+    except Exception as e:
+        print("An unexpected error occurred:", e)


Using print() for error handling is not appropriate for production code. Consider using proper logging.

Suggested change

print("Connection error:", e)

except Exception as e:

print("An unexpected error occurred:", e)

logger.error("Connection error: %s", e)

except Exception as e:

logger.error("An unexpected error occurred: %s", e)

Copilot · 2025-07-30T06:55:38Z

src/unipoll_api/redis.py

+                    if user_id == message.get("recipient_id"):
+                        yield {"data": json.dumps(message)}
+    except redis.exceptions.ConnectionError as e:
+        print("Connection error:", e)


Using print() for error handling is not appropriate for production code. Consider using proper logging.

Suggested change

print("Connection error:", e)

logger.error("Connection error: %s", e)

Copilot · 2025-07-30T06:55:39Z

src/unipoll_api/documents.py

+    # @after_event(Insert)
+    # def 


Incomplete commented code should be removed or properly implemented.

Suggested change

# @after_event(Insert)

# def

@after_event(Insert)

async def after_insert(self):

Debug(f"Event inserted with ID: {self.id}")

Copilot · 2025-07-30T06:55:39Z

src/unipoll_api/utils/events.py

+                    "message": message}
+            await publish_message(data)
+    except Exception as e:
+        print(e)


Using print() for error handling is not appropriate for production code. Consider using proper logging or raising appropriate exceptions.

Suggested change

print(e)

Debug.error(f"An error occurred in notify_members: {e}")

raise

michael-pisman added 22 commits November 8, 2023 23:37

feat: Created Event document

fd52836

Event document represents time series for storing various events

feat: Added event list and log_event to Resource

71ef74d

Added list of linked events to Resource model and created log_event() method to record new events into the database

feat: Add event and timeseries generators

03470e3

feat: Add new routes for event logging and subscription

cf726a3

feat: Add start time to application

d5cede1

refactor: Add deque data structure for events in Resource class

a031842

feat: Add Event document model to mongo_db.py

9d4c0a8

feat: Add Redis configuration options to Settings class

2609e10

feat: Added pubsub Redis functionality

63bb57c

Created to functions to publish and listen to the messages from redis

feat: Added endpoints to test Redis pubsub

5834056

refactor: Refactor event logging and subscription endpoints for testi…

ead43ae

…ng purposes

refactor: Refactor events

ca491e2

Changed get_updates function to use ResourceID instead of Resource object, removed event_generator

refactor: Removed unnecessary code in app.py

3966d8c

operation_id is not set inside router module

refactor: Removed events fielf from the Resource

b1aeefd

There is no point in storing events inside of the Resource

feat: Add function to notify all members of a resource

c23fd2f

refactor: Add message parameter and timestamp to redis_push endpoint

4f4dc0d

refactor: Refactor log_event method in Resource class

02ec499

style: Changed publish_message parameter name

4592d49

feat: Add event logging and member notification to workspace update

a1448ab

Merge branch 'api_v2' into even_log

4e6c154

refactor: Update Redis subscribe endpoint route

7290cab

fix: Fix JSON serialization in listen_to_channel function

2c07b3c

Copilot AI review requested due to automatic review settings July 30, 2025 06:52

Merge branch 'main' into even_log

e555500

michael-pisman merged commit 376f06d into main Jul 30, 2025
1 check failed

michael-pisman deleted the even_log branch July 30, 2025 06:55

Copilot AI reviewed Jul 30, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Event log#95

Event log#95
michael-pisman merged 23 commits intomainfrom
even_log

michael-pisman commented Jul 30, 2025 •

edited

Loading

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Jul 30, 2025

Uh oh!

Copilot AI Jul 30, 2025

Uh oh!

Copilot AI Jul 30, 2025

Uh oh!

Copilot AI Jul 30, 2025

Uh oh!

Copilot AI Jul 30, 2025

Uh oh!

Copilot AI Jul 30, 2025

Uh oh!

Copilot AI Jul 30, 2025

Uh oh!

Copilot AI Jul 30, 2025

Uh oh!

Copilot AI Jul 30, 2025

Uh oh!

Copilot AI Jul 30, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

	print(e)
	logger.error(f"Error in generate_event: {e}")
	raise HTTPException(status_code=500, detail="Internal Server Error")

	print("Connection error:", e)
	logger.error("Connection error: %s", e)

	print(e)
	Debug.error(f"An error occurred in notify_members: {e}")
	raise

Conversation

michael-pisman commented Jul 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

New Features and Integrations:

Enhancements to Existing Components:

Configuration and Dependencies:

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Jul 30, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 30, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 30, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 30, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 30, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 30, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 30, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 30, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 30, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 30, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

michael-pisman commented Jul 30, 2025 •

edited

Loading