Redesign backend plugin architecture - Githubissues

zowe / zlux

The top-level superproject for zLUX. zLUX includes the Zowe Desktop framework in addition to several built-in apps and an example server implementation.

Eclipse Public License 2.0

39 stars 42 forks source link

Redesign backend plugin architecture #906

Open 1000TurquoisePogs opened 2 years ago

1000TurquoisePogs commented 2 years ago

https://github.com/zowe/db-browser-db2 was supposed to be a plugin to db-browser, but it doesnt appear to be able to be removed, because it is added as an import statement https://github.com/zowe/db-browser/blob/master/pluginDefinition.json#L30 in a read-only file, so adding or removing any 'plugin' would be impossible for a user.

Rather, it would be better if db-browser had its own backend which would be very simple:

Define an API for DB operations that would be delegated to plugins that can handle it
Have a trivial implementation builtin that just returns with 'no handlers found' to any query
Scan for handlers within the workspace directory on startup
On any operation, if a handler matches the type (ex "db2") asked for in the operation (ex "query") then send back the handler's response rather than the generic failure

This would be very similar to what we do in the terminal proxy. See:

Load handlers at startup from workspace directory: https://github.com/zowe/zlux-server-framework/blob/1ddf6d7a1d43781594ebb5064da9ded69c2471ab/plugins/terminal-proxy/lib/terminalProxy.js#L797
Delegate to a handler if one is found https://github.com/zowe/zlux-server-framework/blob/1ddf6d7a1d43781594ebb5064da9ded69c2471ab/plugins/terminal-proxy/lib/terminalProxy.js#L272

github-actions[bot] commented 1 year ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs, but can be reopened if needed. Thank you for your contributions.