From 580b546862860ca389305d0d4614471095ec67fe Mon Sep 17 00:00:00 2001 From: Jesse Hallam Date: Wed, 3 Oct 2018 13:13:19 -0400 Subject: MM-12193: remove auto unmarshalling (#9519) * MM-12193: remove auto configuration unmarshalling Since plugin hook events are called concurrently, there's no way for the plugin framework to coordinate safe access to the automatically unmarshalled configuration fields. Remove this functionality, and update documentation to illustrate a safe way to do this. * better Fprint example * fix unit tests * log when OnConfigurationChange fails through OnActivate * clarify lifecycle when OnConfigurationChange returns an error * call SetAPI even if OnConfigurationChange not implemented --- app/plugin_api_test.go | 40 ++++++++++++++++++++++++++++++++-------- 1 file changed, 32 insertions(+), 8 deletions(-) (limited to 'app') diff --git a/app/plugin_api_test.go b/app/plugin_api_test.go index 618805bb6..12701e87e 100644 --- a/app/plugin_api_test.go +++ b/app/plugin_api_test.go @@ -76,16 +76,28 @@ func TestPluginAPILoadPluginConfiguration(t *testing.T) { "fmt" ) - type MyPlugin struct { - plugin.MattermostPlugin - + type configuration struct { MyStringSetting string MyIntSetting int MyBoolSetting bool } + type MyPlugin struct { + plugin.MattermostPlugin + + configuration configuration + } + + func (p *MyPlugin) OnConfigurationChange() error { + if err := p.API.LoadPluginConfiguration(&p.configuration); err != nil { + return err + } + + return nil + } + func (p *MyPlugin) MessageWillBePosted(c *plugin.Context, post *model.Post) (*model.Post, string) { - return nil, fmt.Sprintf("%v%v%v", p.MyStringSetting, p.MyIntSetting, p.MyBoolSetting) + return nil, fmt.Sprintf("%v%v%v", p.configuration.MyStringSetting, p.configuration.MyIntSetting, p.configuration.MyBoolSetting) } func main() { @@ -135,16 +147,28 @@ func TestPluginAPILoadPluginConfigurationDefaults(t *testing.T) { "fmt" ) - type MyPlugin struct { - plugin.MattermostPlugin - + type configuration struct { MyStringSetting string MyIntSetting int MyBoolSetting bool } + type MyPlugin struct { + plugin.MattermostPlugin + + configuration configuration + } + + func (p *MyPlugin) OnConfigurationChange() error { + if err := p.API.LoadPluginConfiguration(&p.configuration); err != nil { + return err + } + + return nil + } + func (p *MyPlugin) MessageWillBePosted(c *plugin.Context, post *model.Post) (*model.Post, string) { - return nil, fmt.Sprintf("%v%v%v", p.MyStringSetting, p.MyIntSetting, p.MyBoolSetting) + return nil, fmt.Sprintf("%v%v%v", p.configuration.MyStringSetting, p.configuration.MyIntSetting, p.configuration.MyBoolSetting) } func main() { -- cgit v1.2.3-1-g7c22