Plugin System / Plugin Management - Githubissues

gentics / mesh

Gentics Mesh - The open source headless CMS for developers

https://getmesh.io

Apache License 2.0

572 stars 115 forks source link

Plugin System / Plugin Management #202

Closed Jotschi closed 6 years ago

Jotschi commented 6 years ago

We need a plugin system which allows us to extend the basic features of mesh with additional ones.

Open

[x] Documentation
[x] Manifest Handling
[x] Static resource handling
[x] Configuration handling
[x] Routing context enhancement
[x] Provide admin client to plugin
[x] Provide client for requesting user to plugin
[x] ~~Provide storage location for plugins~~
[x] Handle startup deployment of existing plugins
[x] Add REST paging support for /api/v1/admin/plugins
[x] Add segment name to manifest
[x] Validate segment name (e.g. no spaces)
[x] Update deploymentId handling to conform to mesh UUID's
[x] Prevent multiple deployments of the same plugin
[x] Add shutdown handling - Plugins need to be unloaded.
[x] Add GraphQL types for plugins

Sub Tasks

[x] Plugin Manager - #322
[x] Plugin Format - #323
[x] Plugin API - #324
[x] Plugin Example

Questions

How should the user be able to select plugins?
How can plugins be obtained / installed? Will they be downloaded? Is there a folder for plugins?
What format has a plugin? How are plugins build?
How do we provide a basic API to implement a plugin?
What can a plugin do? What should a plugin not be allowed to do?
If we apply restrictions - how do we enforce them?

Usecases

GIS Plugin to add a new endpoint which accepts GIS encoded urls
Google Sitemap plugin
Enhanced navigation plugin
Like / Comment plugin

Possible requirements

Custom data storage area (graph)
Access to the mesh graph, ES
Store and retrieve files → Could be problematic in clustered environments
Serve static resources
Add custom endpoints
Deploy / undeploy during runtime
Update check/mechanism?
Technologies

http://stackoverflow.com/questions/465099/best-way-to-build-a-plugin-system-with-java

Name	Pro	Cons
Vert.x Module System		No sandboxing
OSGi	Sandboxing
JPF		Last updated 2004
JSPF		Unfinished

Custom Implementation

Compare with other systems

Typo3
Wordpress
...

Jotschi commented 6 years ago

Released with 0.19.0