mirror of
https://github.com/mattermost/mattermost.git
synced 2026-02-03 20:40:00 -05:00
2230fb6f5f
* ProfileImageBytes for EnsureBotOptions * leverage plugintest.NewAPI * fix linting * add UpdateUserRoles to plugin api * MM-57018: support reattaching plugins Expose a local-only API for reattaching plugins: instead of the server starting and managing the process itself, allow the plugin to be launched externally (eg within a unit test) and reattach to an existing server instance to provide the unit test with a fully functional RPC API, sidestepping the need for mocking the plugin API in most cases. In the future, this may become the basis for running plugins in a sidecar container. Fixes: https://mattermost.atlassian.net/browse/MM-57018 * drop unused supervisor.pid * factor out checkMinServerVersion * factor out startPluginServer * restore missing setPluginState on successful reattach * avoid passing around a stale registeredPlugin * inline initializePluginImplementation * have IsValid return an error * explicitly close rpcClient In the case of reattached plugins, the Unix socket won't necessarily disappear leaving the muxBrokers blocked indefinitely. And `Kill()` doesn't do anything if there's no process being managed. * explicitly detachPlugin * emphasize gRPC not being supported --------- Co-authored-by: Mattermost Build <build@mattermost.com>
106 lines
2.7 KiB
Go
106 lines
2.7 KiB
Go
// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
|
|
// See LICENSE.txt for license information.
|
|
|
|
package plugin
|
|
|
|
import (
|
|
"context"
|
|
|
|
"github.com/hashicorp/go-plugin"
|
|
)
|
|
|
|
const (
|
|
InternalKeyPrefix = "mmi_"
|
|
BotUserKey = InternalKeyPrefix + "botid"
|
|
)
|
|
|
|
// WithTestContext provides a context typically used to terminate a plugin from a unit test.
|
|
func WithTestContext(ctx context.Context) func(*plugin.ServeConfig) error {
|
|
return func(config *plugin.ServeConfig) error {
|
|
if config.Test == nil {
|
|
config.Test = &plugin.ServeTestConfig{}
|
|
}
|
|
|
|
config.Test.Context = ctx
|
|
|
|
return nil
|
|
}
|
|
}
|
|
|
|
// WithTestReattachConfigCh configures the channel to receive the ReattachConfig used to reattach
|
|
// an externally launched plugin instance with the Mattermost server.
|
|
func WithTestReattachConfigCh(reattachConfigCh chan<- *plugin.ReattachConfig) func(*plugin.ServeConfig) error {
|
|
return func(config *plugin.ServeConfig) error {
|
|
if config.Test == nil {
|
|
config.Test = &plugin.ServeTestConfig{}
|
|
}
|
|
|
|
config.Test.ReattachConfigCh = reattachConfigCh
|
|
|
|
return nil
|
|
}
|
|
}
|
|
|
|
// WithTestCloseCh provides a channel that signals when the plugin exits.
|
|
func WithTestCloseCh(closeCh chan<- struct{}) func(*plugin.ServeConfig) error {
|
|
return func(config *plugin.ServeConfig) error {
|
|
if config.Test == nil {
|
|
config.Test = &plugin.ServeTestConfig{}
|
|
}
|
|
|
|
config.Test.CloseCh = closeCh
|
|
|
|
return nil
|
|
}
|
|
}
|
|
|
|
// Starts the serving of a Mattermost plugin over net/rpc. gRPC is not supported.
|
|
//
|
|
// Call this when your plugin is ready to start. Options allow configuring plugins for testing
|
|
// scenarios.
|
|
func ClientMain(pluginImplementation any, opts ...func(config *plugin.ServeConfig) error) {
|
|
impl, ok := pluginImplementation.(interface {
|
|
SetAPI(api API)
|
|
SetDriver(driver Driver)
|
|
})
|
|
if !ok {
|
|
panic("Plugin implementation given must embed plugin.MattermostPlugin")
|
|
}
|
|
impl.SetAPI(nil)
|
|
impl.SetDriver(nil)
|
|
|
|
pluginMap := map[string]plugin.Plugin{
|
|
"hooks": &hooksPlugin{hooks: pluginImplementation},
|
|
}
|
|
|
|
serveConfig := &plugin.ServeConfig{
|
|
HandshakeConfig: handshake,
|
|
Plugins: pluginMap,
|
|
}
|
|
|
|
for _, opt := range opts {
|
|
err := opt(serveConfig)
|
|
if err != nil {
|
|
panic("failed to start serving plugin: " + err.Error())
|
|
}
|
|
}
|
|
|
|
plugin.Serve(serveConfig)
|
|
}
|
|
|
|
type MattermostPlugin struct {
|
|
// API exposes the plugin api, and becomes available just prior to the OnActive hook.
|
|
API API
|
|
Driver Driver
|
|
}
|
|
|
|
// SetAPI persists the given API interface to the plugin. It is invoked just prior to the
|
|
// OnActivate hook, exposing the API for use by the plugin.
|
|
func (p *MattermostPlugin) SetAPI(api API) {
|
|
p.API = api
|
|
}
|
|
|
|
// SetDriver sets the RPC client implementation to talk with the server.
|
|
func (p *MattermostPlugin) SetDriver(driver Driver) {
|
|
p.Driver = driver
|
|
}
|