From 17f211c393772f30922bac595592e3fe60c2ef25 Mon Sep 17 00:00:00 2001 From: Jesse Hallam Date: Fri, 13 Jul 2018 10:29:50 -0400 Subject: MM-11292: clean up plugins GoDoc (#9109) * clean up plugins GoDoc: - eliminate plugin.NewBlankContext() as unnecessary - export ValidIdRegex as a string vs. the less readable var - add/update various documentation strings - hide everything by default, except where used by client plugins or the mattermost-server. The exception to this rule are the `*(Args|Returns)` structs which must be public for go-plugin, but are now prefixed with `Z_` with a warning not to use. - include a top-level example to get plugin authors started This is not a breaking change for existing plugins compiled against plugins-v2. * remove commented out ServeHTTPResponseWriter * update examples to match developer docs * add missing plugin/doc.go license header --- app/plugin_commands.go | 2 +- app/plugin_install.go | 2 +- app/plugin_requests.go | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) (limited to 'app') diff --git a/app/plugin_commands.go b/app/plugin_commands.go index 060defc86..daa92ce5a 100644 --- a/app/plugin_commands.go +++ b/app/plugin_commands.go @@ -105,7 +105,7 @@ func (a *App) ExecutePluginCommand(args *model.CommandArgs) (*model.Command, *mo if err != nil { return pc.Command, nil, model.NewAppError("ExecutePluginCommand", "model.plugin_command.error.app_error", nil, "err="+err.Error(), http.StatusInternalServerError) } - response, appErr := pluginHooks.ExecuteCommand(plugin.NewBlankContext(), args) + response, appErr := pluginHooks.ExecuteCommand(&plugin.Context{}, args) return pc.Command, response, appErr } } diff --git a/app/plugin_install.go b/app/plugin_install.go index e49f6f83e..f96c75f06 100644 --- a/app/plugin_install.go +++ b/app/plugin_install.go @@ -52,7 +52,7 @@ func (a *App) installPlugin(pluginFile io.Reader) (*model.Manifest, *model.AppEr } if !plugin.IsValidId(manifest.Id) { - return nil, model.NewAppError("installPlugin", "app.plugin.invalid_id.app_error", map[string]interface{}{"Min": plugin.MinIdLength, "Max": plugin.MaxIdLength, "Regex": plugin.ValidId.String()}, "", http.StatusBadRequest) + return nil, model.NewAppError("installPlugin", "app.plugin.invalid_id.app_error", map[string]interface{}{"Min": plugin.MinIdLength, "Max": plugin.MaxIdLength, "Regex": plugin.ValidIdRegex}, "", http.StatusBadRequest) } bundles, err := a.Plugins.Available() diff --git a/app/plugin_requests.go b/app/plugin_requests.go index 10ef758b4..1c5a73e8c 100644 --- a/app/plugin_requests.go +++ b/app/plugin_requests.go @@ -72,5 +72,5 @@ func (a *App) servePluginRequest(w http.ResponseWriter, r *http.Request, handler r.URL.RawQuery = newQuery.Encode() r.URL.Path = strings.TrimPrefix(r.URL.Path, "/plugins/"+params["plugin_id"]) - handler(plugin.NewBlankContext(), w, r) + handler(&plugin.Context{}, w, r) } -- cgit v1.2.3-1-g7c22