From 580b546862860ca389305d0d4614471095ec67fe Mon Sep 17 00:00:00 2001
From: Jesse Hallam <jesse.hallam@gmail.com>
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
---
 plugin/client.go | 22 ----------------------
 1 file changed, 22 deletions(-)

(limited to 'plugin/client.go')

diff --git a/plugin/client.go b/plugin/client.go
index 457a16cf4..63cedfbce 100644
--- a/plugin/client.go
+++ b/plugin/client.go
@@ -13,12 +13,10 @@ import (
 func ClientMain(pluginImplementation interface{}) {
 	if impl, ok := pluginImplementation.(interface {
 		SetAPI(api API)
-		SetSelfRef(ref interface{})
 	}); !ok {
 		panic("Plugin implementation given must embed plugin.MattermostPlugin")
 	} else {
 		impl.SetAPI(nil)
-		impl.SetSelfRef(pluginImplementation)
 	}
 
 	pluginMap := map[string]plugin.Plugin{
@@ -34,8 +32,6 @@ func ClientMain(pluginImplementation interface{}) {
 type MattermostPlugin struct {
 	// API exposes the plugin api, and becomes available just prior to the OnActive hook.
 	API API
-
-	selfRef interface{} // This is so we can unmarshal into our parent
 }
 
 // SetAPI persists the given API interface to the plugin. It is invoked just prior to the
@@ -43,21 +39,3 @@ type MattermostPlugin struct {
 func (p *MattermostPlugin) SetAPI(api API) {
 	p.API = api
 }
-
-// SetSelfRef is called by ClientMain to maintain a pointer to the plugin interface originally
-// registered. This allows for the default implementation of OnConfigurationChange.
-func (p *MattermostPlugin) SetSelfRef(ref interface{}) {
-	p.selfRef = ref
-}
-
-// OnConfigurationChange provides a default implementation of this hook event that unmarshals the
-// plugin configuration directly onto the plugin struct.
-//
-// Feel free to implement your own version of OnConfigurationChange if you need more advanced
-// configuration handling.
-func (p *MattermostPlugin) OnConfigurationChange() error {
-	if p.selfRef != nil {
-		return p.API.LoadPluginConfiguration(p.selfRef)
-	}
-	return nil
-}
-- 
cgit v1.2.3-1-g7c22