Skip to content
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.

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

[Plugin|Doc] Enhance Plugin-Core Interaction Protocol #288

Open
Tracked by #210
StardustSeemsInk opened this issue Oct 24, 2024 · 1 comment
Open
Tracked by #210

[Plugin|Doc] Enhance Plugin-Core Interaction Protocol #288

StardustSeemsInk opened this issue Oct 24, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request tracking This issue is tracking by another issue

Comments

@StardustSeemsInk
Copy link
Member

🪦 Is your feature request related to a problem? Please describe.

The current interaction protocol between plugins and the KitX core does not provide a standardized way for plugins to expose their callable functions. This limitation makes it difficult for the KitX core and the plugins to dynamically discover and utilize the available functionalities.

🪧 Describe the solution you'd like

I would like to see the development of an enhanced plugin-core interaction protocol that includes a mechanism for plugins to explicitly expose a list of their callable functions. This would allow the core system and other plugins to easily identify and invoke these functions as needed.

🧾 Describe alternatives you've considered

One alternative we’ve considered is a manual registration process where plugin developers would have to update a central registry with their function list. However, this approach is error-prone and not scalable.
Another alternative is to use reflection to automatically detect functions, but this could lead to security and performance issues.
And most importantly, we shoud develop a doc that discribe the protocol

📎 Additional context

  • The protocol should be easy to implement for plugin developers.

  • It should ensure that only authorized functions are exposed to prevent security vulnerabilities.

This feature would significantly improve the interoperability and extensibility of our system, making it easier for developers to create powerful and integrated plugin solutions. Documentation and developer guidelines should be updated to reflect these changes, and a set of best practices for exposing functions should be established.

(This issue is created with the assistance of an LLM.)

@StardustSeemsInk StardustSeemsInk added enhancement New feature or request help wanted Extra attention is needed documentation Improvements or additions to documentation and removed help wanted Extra attention is needed labels Oct 24, 2024
Copy link

Tracked by #210 .

@github-actions github-actions bot added the tracking This issue is tracking by another issue label Oct 24, 2024
@Dynesshely Dynesshely moved this to Constructive in KitX Project Todo-Lists Oct 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request tracking This issue is tracking by another issue
Projects
Status: Constructive
Development

No branches or pull requests

1 participant