Plugin Support by michael-pisman · Pull Request #92 · csed-ucm/psephos

michael-pisman · 2025-07-30T06:34:45Z

This pull request introduces several updates across the codebase, focusing on modularizing the application, improving dependency management, refining data models, and enhancing plugin functionality. The changes also include significant refactoring to improve maintainability and functionality.

Modularization and Dependency Management:

Updated main.py and pyproject.toml to use entry_points instead of app as the CLI entry point, reflecting the modularization of the application ([[1]](https://github.com/csed-ucm/psephos/pull/92/files#diff-b10564ab7d2c520cdd0243874879fb0a782862c3c902ab535faabe57d5a505e1L3-R7), [[2]](https://github.com/csed-ucm/psephos/pull/92/files#diff-50c86b7ed8ac2cf95bd48334961bf0530cdc77b5a56f852c5c61b89d735fd711L27-R27)).
Removed CLI-related logic from src/unipoll_api/app.py, streamlining the application startup process and delegating CLI responsibilities to entry_points ([src/unipoll_api/app.pyL59-L126](https://github.com/csed-ucm/psephos/pull/92/files#diff-d498ad8817523664d8c158e356bd7c79087ee7be4b0d35758dcecb331012375fL59-L126)).

Plugin System Enhancements:

Introduced a plugins decorator in src/unipoll_api/actions/__init__.py to enable plugin execution for action methods, and applied it to the get_workspace function in workspace.py ([[1]](https://github.com/csed-ucm/psephos/pull/92/files#diff-94bf0c9ed022246f7ac94ef5192608c679ae8c51161310c33c7bf4a16fcb6bfeL1-R21), [[2]](https://github.com/csed-ucm/psephos/pull/92/files#diff-2ae799ba28a7096726004d259e3d70ae98a4badc2f712c10e8bc394fcc517e01R49-R60)).
Added a default plugin (test_plugin) to the configuration in src/unipoll_api/config.py ([src/unipoll_api/config.pyR31-R32](https://github.com/csed-ucm/psephos/pull/92/files#diff-b89132392cb2a691d4d2a106efb1df8a3d918e59555c079f395566c38a78457aR31-R32)).

Data Model Refinements:

Refactored the Member document in src/unipoll_api/documents.py to replace BackLink relationships with Link for workspace, improving model clarity and consistency ([src/unipoll_api/documents.pyL210-R212](https://github.com/csed-ucm/psephos/pull/92/files#diff-9436de0bdd228d52bac6a9e652a53b49bf48b90044ffd098203ef31595faaf42L210-R212)).
Updated the add_member method in the Workspace document to align with the new Link structure for workspace ([src/unipoll_api/documents.pyL99-R99](https://github.com/csed-ucm/psephos/pull/92/files#diff-9436de0bdd228d52bac6a9e652a53b49bf48b90044ffd098203ef31595faaf42L99-R99)).

Dependency Refactoring:

Replaced the get_member function with a new get_member_by_account function in src/unipoll_api/dependencies.py, ensuring more precise member retrieval based on account and resource context ([[1]](https://github.com/csed-ucm/psephos/pull/92/files#diff-bfce4882dc04f49a73a81580802630710122d01e4c8c35b2580c7a5bcf73a3eaL34-R45), [[2]](https://github.com/csed-ucm/psephos/pull/92/files#diff-bfce4882dc04f49a73a81580802630710122d01e4c8c35b2580c7a5bcf73a3eaL49-R60)).
Updated all references to get_member across multiple action files (group.py, members.py, policy.py) to use get_member_by_account ([[1]](https://github.com/csed-ucm/psephos/pull/92/files#diff-dafacf886695f5ded37150101af1be3e3eaefe9562182fb92003050ac4d9ea41L11-R11), [[2]](https://github.com/csed-ucm/psephos/pull/92/files#diff-dafacf886695f5ded37150101af1be3e3eaefe9562182fb92003050ac4d9ea41L51-R51), [[3]](https://github.com/csed-ucm/psephos/pull/92/files#diff-d53c5c2dd44af5a48bb2401dc5cd4339279706c5d712c5dc27271647b8604f1aL49-R54), [[4]](https://github.com/csed-ucm/psephos/pull/92/files#diff-9e60a6e9ce651c9515e17c600e91c2a210f0bd19c4ea0f0cb1b56e7a96ac5341L20-R20)).

Code Cleanup and Miscellaneous:

Removed unused imports and commented-out code in src/unipoll_api/app.py and src/unipoll_api/__init__.py, improving code readability ([[1]](https://github.com/csed-ucm/psephos/pull/92/files#diff-d498ad8817523664d8c158e356bd7c79087ee7be4b0d35758dcecb331012375fL1-L14), [[2]](https://github.com/csed-ucm/psephos/pull/92/files#diff-6b16c30dc7a5820015dfcb9d6034906ddfdbde4bf5bbc6a652f91fb243da2efaR1-R3)).
Added a new get_member function in src/unipoll_api/actions/members.py to fetch detailed member information, enhancing functionality ([src/unipoll_api/actions/members.pyR71-R91](https://github.com/csed-ucm/psephos/pull/92/files#diff-d53c5c2dd44af5a48bb2401dc5cd4339279706c5d712c5dc27271647b8604f1aR71-R91)).

These changes collectively improve the application's modularity, maintainability, and extensibility while laying the groundwork for future enhancements.

Added v1 prefix, fixed member related tests

This reverts commit b743302

Changed get_openapi function to exclude the default api version in the openapi schema

Repalace backlinks with links, changed workspace reference in Member class

This class provides add_field method, however it does not fully work

…t_workspace

Moved entry points and related functions from app.py to entry_points.py

Repeated app import was causing module to re-initialize

Created PluginManager class and turned all functions into methods, improved package discovery

Copilot

Pull Request Overview

This pull request introduces API versioning by adding /v1/ prefix to all API endpoints, along with plugin system enhancements and modularization improvements. The changes ensure backward compatibility while preparing for future API evolution.

Updates all test endpoints to use /v1/ prefix for API versioning
Introduces plugin system with decorator support for action methods
Refactors CLI entry points and dependency management for better modularity

Reviewed Changes

Copilot reviewed 39 out of 39 changed files in this pull request and generated 12 comments.

Show a summary per file

File	Description
tests/test_v1/*.py	Updated API endpoints to include `/v1/` prefix for versioning
src/unipoll_api/routes/v2/*.py	Import path updates for action interfaces
src/unipoll_api/routes/v1/*.py	Updated imports and endpoint structure for v1 API
src/unipoll_api/actions/*.py	Added plugin system and refactored dependency imports
src/unipoll_api/*.py	CLI refactoring, configuration updates, and modularization
pyproject.toml	Updated CLI entry point reference

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

src/unipoll_api/schemas/workspace.py

+# class UpdatableModel(BaseModel):
+
+#     @classmethod
+#     def add_field(cls, field_name, field_type, default=None):
+#         cls.model_fields[field_name] = Field(default=default, title=field_name)
+#         cls.model_fields[field_name].default = default
+#         cls.model_fields[field_name].annotation = field_type
+#         return cls
+
+


Remove commented-out code block (lines 6-14) as it appears to be unused and reduces code readability.

Suggested change

# class UpdatableModel(BaseModel):

# @classmethod

# def add_field(cls, field_name, field_type, default=None):

# cls.model_fields[field_name] = Field(default=default, title=field_name)

# cls.model_fields[field_name].default = default

# cls.model_fields[field_name].annotation = field_type

# return cls

# (No replacement lines; the block is removed entirely.)

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

src/unipoll_api/schemas/member.py

+            # raise ValueError('Either Workspace or Groups must be specified.')
+            from unipoll_api.exceptions.resource import APIException


Remove commented-out code on line 47 as it's been replaced with the APIException implementation on lines 48-49.

Suggested change

# raise ValueError('Either Workspace or Groups must be specified.')

from unipoll_api.exceptions.resource import APIException

from unipoll_api.exceptions.resource import APIException

raise APIException(422, "Either Workspace or Group must be specified")

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

src/unipoll_api/routes/v1/account.py


 # Delete user account by id


Remove the empty lines and orphaned comment on lines 49-50 as they don't correspond to any actual code change.

Suggested change

# Delete user account by id

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

src/unipoll_api/routes/v2/authentications.py

+
+

Remove unnecessary empty lines (lines 69-70 and 89-90) that don't add value to code structure.

Suggested change

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

src/unipoll_api/plugin_manager.py

@@ -0,0 +1,59 @@
+from functools import lru_cache, cache
+import importlib, pkgutil
+# from timer_plugin import TimerPlugin


Remove commented-out import on line 3 as it's not being used.

Suggested change

# from timer_plugin import TimerPlugin

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

src/unipoll_api/actions/workspace.py

+# from unipoll_api.dependencies import get_member_by_account




Remove commented-out import on line 9 as it's not being used.

Suggested change

# from unipoll_api.dependencies import get_member_by_account

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

src/unipoll_api/actions/workspace.py

+    # BUG: Deleting workspace also deletes account
+    # TODO: Find a way to keep the account 
+    # from beanie import DeleteRules
+    # await Workspace.delete(workspace, link_rule=DeleteRules.DELETE_LINKS)
+
+    # await Workspace.delete(workspace)
+
+    # if await workspace.get(workspace.id):
+    #     raise WorkspaceExceptions.ErrorWhileDeleting(workspace.id)
+
+    # await Policy.find({"parent_resource": workspace_ref}).delete()
+    # mems = await Member.find(Member.workspace.id == workspace.id, fetch_links=True).delete()
+


Remove or address the large block of commented-out code (lines 110-131) as it clutters the implementation. Consider creating a proper TODO item or issue if this represents future work.

Suggested change

# BUG: Deleting workspace also deletes account

# TODO: Find a way to keep the account

# from beanie import DeleteRules

# await Workspace.delete(workspace, link_rule=DeleteRules.DELETE_LINKS)

# await Workspace.delete(workspace)

# if await workspace.get(workspace.id):

# raise WorkspaceExceptions.ErrorWhileDeleting(workspace.id)

# await Policy.find({"parent_resource": workspace_ref}).delete()

# mems = await Member.find(Member.workspace.id == workspace.id, fetch_links=True).delete()

# TODO: Implement proper workspace deletion logic, ensuring related entities (e.g., members, policies) are handled correctly.

# Address the issue where deleting a workspace also deletes the account. Track this work in ISSUE-1234.

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

src/unipoll_api/documents.py

+    # workspace: BackLink[Workspace] = Field(original_field="members")
+    workspace: Link[Workspace]
+    # groups: list[BackLink[Group]] = Field(original_field="members")


Remove commented-out field definitions on lines 210 and 212 as they've been replaced with the new Link structure.

Suggested change

# workspace: BackLink[Workspace] = Field(original_field="members")

workspace: Link[Workspace]

# groups: list[BackLink[Group]] = Field(original_field="members")

workspace: Link[Workspace]

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

src/unipoll_api/__init__.py

@@ -1,5 +1,6 @@
+# FIXME: Remove all the imports


Address the FIXME comment by either removing the unused imports or removing the comment if the imports are still needed.

Suggested change

# FIXME: Remove all the imports

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

tests/test_v1/test_2_workspaces.py

+# Attempt to remove a non existing workspace
 async def test_delete_non_existing_workspace(client_test: AsyncClient):
    print("\n")
    colored_dbg.test_info("Testing deletion of non existing workspace")


Correct the comment grammar: 'non existing' should be 'non-existing' or 'nonexistent'.

Suggested change

# Attempt to remove a non existing workspace

async def test_delete_non_existing_workspace(client_test: AsyncClient):

print("\n")

colored_dbg.test_info("Testing deletion of non existing workspace")

# Attempt to remove a nonexistent workspace

async def test_delete_non_existing_workspace(client_test: AsyncClient):

print("\n")

colored_dbg.test_info("Testing deletion of nonexistent workspace")

michael-pisman added 30 commits November 10, 2023 23:21

refactor: renamed get_member function to get_member_by_account

df26239

fix: remove_group_member function

12977e5

test: Update API endpoint paths for account related tests

096d587

Added v1 prefix, fixed member related tests

feat: Update API versioning to include version number in the title

6f86d6e

refactor: Update Account schema naming

220c005

refactor: Deleted account and authentication from v2 router

b743302

style: Comments

dea0b72

style: Renamed poll to polls

e1fe2c5

style: Renamed

27b56b3

style: Renamed

8329567

revert: Deleted account and authentication from v2 router

24471ac

This reverts commit b743302

style: Deleted extra new lines

4462eb0

refactor: Update route imports

ce1cb08

refactor: Updated get_openapi entrypoint

ed923a9

Changed get_openapi function to exclude the default api version in the openapi schema

refactor: Update active_user ContextVar type

1249205

fix: Fix workspace deletion bug and optimize deletion process

1490e39

refactor: Add API versions constant

1901198

feat: Add version argument to get-openapi command

2982bad

feat: Update get_openapi function to support multiple versions

0694103

feat: Added action to get member info

714d7a3

feat: Added get member endpoint

3e378e8

fix: Fix validation error in AddMembersRequest schema

68b7ea8

refactor: Changed member document

43cf320

Repalace backlinks with links, changed workspace reference in Member class

refactor: Moved import statements for actions to __interface__.py

dcf4ef8

feat: Created a test plugin

363fa4d

feat: Add plugin functionality to the app

1295d13

feat: Add UpdatableModel class (not working)

af05bfc

This class provides add_field method, however it does not fully work

feat: Add action wrapper for plugin integration

4448e0d

refactor: Added plugin initialization

d4fb116

refactor: Refactor import statements and added plugins wrapper for ge…

923d244

…t_workspace

michael-pisman added 5 commits November 28, 2023 22:12

refactor: Moved timer plugin outside of the project

a599ac5

refactor: Moved entry points to a separate file

fad4d23

Moved entry points and related functions from app.py to entry_points.py

fix: Removed app import

aa10f84

Repeated app import was causing module to re-initialize

feat: Added plugins field to app config

56ec913

refactor: Replaced plugin functions with PluginManger

2e6744c

Created PluginManager class and turned all functions into methods, improved package discovery

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

Copilot AI reviewed Jul 30, 2025

View reviewed changes

Merge branch 'main' into plugins

424b7d8

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

michael-pisman deleted the plugins branch July 30, 2025 06:37

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Plugin Support#92

Plugin Support#92
michael-pisman merged 36 commits intomainfrom
plugins

michael-pisman commented Jul 30, 2025

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!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

		# raise ValueError('Either Workspace or Groups must be specified.')
		from unipoll_api.exceptions.resource import APIException

		# from unipoll_api.dependencies import get_member_by_account

Conversation

michael-pisman commented Jul 30, 2025

Modularization and Dependency Management:

Plugin System Enhancements:

Data Model Refinements:

Dependency Refactoring:

Code Cleanup and Miscellaneous:

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!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant