MM-19445 - Added version information to plugin diagnostics data

api4/plugin.go

@@ -347,12 +347,14 @@ func parseMarketplacePluginFilter(u *url.URL) (*model.MarketplacePluginFilter, e
 
 	filter := u.Query().Get("filter")
 	serverVersion := u.Query().Get("server_version")
+	localOnly := u.Query().Get("local_only") == "true"
 
 	return &model.MarketplacePluginFilter{
 		Page:          page,
 		PerPage:       perPage,
 		Filter:        filter,
 		ServerVersion: serverVersion,
+		LocalOnly:     localOnly,
 	}, nil
 }
 

api4/plugin_test.go

@@ -61,6 +61,10 @@ func TestPlugin(t *testing.T) {
 	CheckNoError(t, resp)
 	assert.Equal(t, "testplugin", manifest.Id)
 
+	ok, resp := th.SystemAdminClient.RemovePlugin(manifest.Id)
+	CheckNoError(t, resp)
+	require.True(t, ok)
+
 	t.Run("install plugin from URL with slow response time", func(t *testing.T) {
 		if testing.Short() {
 			t.Skip("skipping test to install plugin from a slow response server")
@@ -163,7 +167,7 @@ func TestPlugin(t *testing.T) {
 	assert.False(t, found)
 
 	// Successful activate
-	ok, resp := th.SystemAdminClient.EnablePlugin(manifest.Id)
+	ok, resp = th.SystemAdminClient.EnablePlugin(manifest.Id)
 	CheckNoError(t, resp)
 	assert.True(t, ok)
 
@@ -767,6 +771,163 @@ func TestSearchGetMarketplacePlugins(t *testing.T) {
 		plugins, resp = th.SystemAdminClient.GetMarketplacePlugins(&model.MarketplacePluginFilter{Filter: "NOFILTER"})
 		CheckNoError(t, resp)
 		require.Nil(t, plugins)
+
+		// cleanup
+		ok, resp := th.SystemAdminClient.RemovePlugin(newPluginV1.Manifest.Id)
+		CheckNoError(t, resp)
+		assert.True(t, ok)
+
+		ok, resp = th.SystemAdminClient.RemovePlugin(newPluginV2.Manifest.Id)
+		CheckNoError(t, resp)
+		assert.True(t, ok)
+	})
+}
+
+func TestGetLocalPluginInMarketplace(t *testing.T) {
+	th := Setup().InitBasic()
+	defer th.TearDown()
+
+	samplePlugins := []*model.MarketplacePlugin{
+		{
+			BaseMarketplacePlugin: &model.BaseMarketplacePlugin{
+				HomepageURL: "https://example.com/mattermost/mattermost-plugin-nps",
+				IconData:    "https://example.com/icon.svg",
+				DownloadURL: "www.github.com/example",
+				Manifest: &model.Manifest{
+					Id:               "testplugin_v2",
+					Name:             "testplugin_v2",
+					Description:      "dsgsdg_v2",
+					Version:          "1.2.2",
+					MinServerVersion: "",
+				},
+			},
+			InstalledVersion: "",
+		},
+	}
+
+	testServer := httptest.NewServer(http.HandlerFunc(func(res http.ResponseWriter, req *http.Request) {
+		res.WriteHeader(http.StatusOK)
+		json, err := json.Marshal([]*model.MarketplacePlugin{samplePlugins[0]})
+		require.NoError(t, err)
+		res.Write(json)
+	}))
+	defer testServer.Close()
+
+	th.App.UpdateConfig(func(cfg *model.Config) {
+		*cfg.PluginSettings.Enable = true
+		*cfg.PluginSettings.EnableMarketplace = true
+		*cfg.PluginSettings.MarketplaceUrl = testServer.URL
+	})
+
+	t.Run("Get plugins with EnableRemoteMarketplace enabled", func(t *testing.T) {
+
+		th.App.UpdateConfig(func(cfg *model.Config) {
+			*cfg.PluginSettings.EnableRemoteMarketplace = true
+		})
+
+		plugins, resp := th.SystemAdminClient.GetMarketplacePlugins(&model.MarketplacePluginFilter{})
+		CheckNoError(t, resp)
+
+		require.Len(t, plugins, len(samplePlugins))
+		require.Equal(t, samplePlugins, plugins)
+	})
+
+	t.Run("get remote and local plugins", func(t *testing.T) {
+
+		th.App.UpdateConfig(func(cfg *model.Config) {
+			*cfg.PluginSettings.EnableRemoteMarketplace = true
+			*cfg.PluginSettings.EnableUploads = true
+		})
+
+		// Upload one local plugin
+		path, _ := fileutils.FindDir("tests")
+		tarData, err := ioutil.ReadFile(filepath.Join(path, "testplugin.tar.gz"))
+		require.NoError(t, err)
+
+		manifest, resp := th.SystemAdminClient.UploadPlugin(bytes.NewReader(tarData))
+		CheckNoError(t, resp)
+
+		plugins, resp := th.SystemAdminClient.GetMarketplacePlugins(&model.MarketplacePluginFilter{})
+		CheckNoError(t, resp)
+
+		require.Len(t, plugins, 2)
+
+		ok, resp := th.SystemAdminClient.RemovePlugin(manifest.Id)
+		CheckNoError(t, resp)
+		assert.True(t, ok)
+	})
+
+	t.Run("EnableRemoteMarketplace disabled", func(t *testing.T) {
+
+		th.App.UpdateConfig(func(cfg *model.Config) {
+			*cfg.PluginSettings.EnableRemoteMarketplace = false
+			*cfg.PluginSettings.EnableUploads = true
+		})
+
+		// No marketplace plugins returned
+		plugins, resp := th.SystemAdminClient.GetMarketplacePlugins(&model.MarketplacePluginFilter{})
+		CheckNoError(t, resp)
+
+		require.Len(t, plugins, 0)
+
+		// Upload one local plugin
+		path, _ := fileutils.FindDir("tests")
+		tarData, err := ioutil.ReadFile(filepath.Join(path, "testplugin.tar.gz"))
+		require.NoError(t, err)
+
+		manifest, resp := th.SystemAdminClient.UploadPlugin(bytes.NewReader(tarData))
+		CheckNoError(t, resp)
+
+		newPlugin := &model.MarketplacePlugin{
+			BaseMarketplacePlugin: &model.BaseMarketplacePlugin{
+				Manifest: manifest,
+			},
+			InstalledVersion: manifest.Version,
+		}
+
+		plugins, resp = th.SystemAdminClient.GetMarketplacePlugins(&model.MarketplacePluginFilter{})
+		CheckNoError(t, resp)
+
+		// Only get the local plugins
+		require.Len(t, plugins, 1)
+		require.Equal(t, newPlugin, plugins[0])
+
+		ok, resp := th.SystemAdminClient.RemovePlugin(manifest.Id)
+		CheckNoError(t, resp)
+		assert.True(t, ok)
+	})
+
+	t.Run("local_only true", func(t *testing.T) {
+
+		th.App.UpdateConfig(func(cfg *model.Config) {
+			*cfg.PluginSettings.EnableRemoteMarketplace = true
+			*cfg.PluginSettings.EnableUploads = true
+		})
+
+		// Upload one local plugin
+		path, _ := fileutils.FindDir("tests")
+		tarData, err := ioutil.ReadFile(filepath.Join(path, "testplugin.tar.gz"))
+		require.NoError(t, err)
+
+		manifest, resp := th.SystemAdminClient.UploadPlugin(bytes.NewReader(tarData))
+		CheckNoError(t, resp)
+
+		newPlugin := &model.MarketplacePlugin{
+			BaseMarketplacePlugin: &model.BaseMarketplacePlugin{
+				Manifest: manifest,
+			},
+			InstalledVersion: manifest.Version,
+		}
+
+		plugins, resp := th.SystemAdminClient.GetMarketplacePlugins(&model.MarketplacePluginFilter{LocalOnly: true})
+		CheckNoError(t, resp)
+
+		require.Len(t, plugins, 1)
+		require.Equal(t, newPlugin, plugins[0])
+
+		ok, resp := th.SystemAdminClient.RemovePlugin(manifest.Id)
+		CheckNoError(t, resp)
+		assert.True(t, ok)
 	})
 }
 

app/diagnostics.go

@@ -100,12 +100,16 @@ func pluginSetting(pluginSettings *model.PluginSettings, plugin, key string, def
 	return defaultValue
 }
 
-func pluginActivated(pluginStates map[string]*model.PluginState, pluginId string) bool {
-	state, ok := pluginStates[pluginId]
+func pluginData(availablePluginsData map[string]interface{}, pluginId string) interface{} {
+	data, ok := availablePluginsData[pluginId]
 	if !ok {
-		return false
+		return map[string]interface{}{
+			"enabled": false,
+			"version": "",
+		}
 	}
-	return state.Enable
+
+	return data
 }
 
 func (a *App) trackActivity() {
@@ -591,24 +595,14 @@ func (a *App) trackConfig() {
 	})
 
 	a.SendDiagnostic(TRACK_CONFIG_PLUGIN, map[string]interface{}{
-		"enable_antivirus":              pluginActivated(cfg.PluginSettings.PluginStates, "antivirus"),
-		"enable_autolink":               pluginActivated(cfg.PluginSettings.PluginStates, "mattermost-autolink"),
-		"enable_aws_sns":                pluginActivated(cfg.PluginSettings.PluginStates, "com.mattermost.aws-sns"),
-		"enable_custom_user_attributes": pluginActivated(cfg.PluginSettings.PluginStates, "com.mattermost.custom-attributes"),
-		"enable_github":                 pluginActivated(cfg.PluginSettings.PluginStates, "github"),
-		"enable_gitlab":                 pluginActivated(cfg.PluginSettings.PluginStates, "com.github.manland.mattermost-plugin-gitlab"),
-		"enable_jenkins":                pluginActivated(cfg.PluginSettings.PluginStates, "jenkins"),
-		"enable_jira":                   pluginActivated(cfg.PluginSettings.PluginStates, "jira"),
-		"enable_nps":                    pluginActivated(cfg.PluginSettings.PluginStates, "com.mattermost.nps"),
-		"enable_nps_survey":             pluginSetting(&cfg.PluginSettings, "com.mattermost.nps", "enablesurvey", true),
-		"enable_welcome_bot":            pluginActivated(cfg.PluginSettings.PluginStates, "com.mattermost.welcomebot"),
-		"enable_zoom":                   pluginActivated(cfg.PluginSettings.PluginStates, "zoom"),
-		"enable":                        *cfg.PluginSettings.Enable,
-		"enable_uploads":                *cfg.PluginSettings.EnableUploads,
-		"allow_insecure_download_url":   *cfg.PluginSettings.AllowInsecureDownloadUrl,
-		"enable_health_check":           *cfg.PluginSettings.EnableHealthCheck,
-		"enable_marketplace":            *cfg.PluginSettings.EnableMarketplace,
-		"is_default_marketplace_url":    isDefault(*cfg.PluginSettings.MarketplaceUrl, model.PLUGIN_SETTINGS_DEFAULT_MARKETPLACE_URL),
+		"enable_nps_survey":           pluginSetting(&cfg.PluginSettings, "com.mattermost.nps", "enablesurvey", true),
+		"enable":                      *cfg.PluginSettings.Enable,
+		"enable_uploads":              *cfg.PluginSettings.EnableUploads,
+		"allow_insecure_download_url": *cfg.PluginSettings.AllowInsecureDownloadUrl,
+		"enable_health_check":         *cfg.PluginSettings.EnableHealthCheck,
+		"enable_marketplace":          *cfg.PluginSettings.EnableMarketplace,
+		"enable_remote_marketplace":   *cfg.PluginSettings.EnableRemoteMarketplace,
+		"is_default_marketplace_url":  isDefault(*cfg.PluginSettings.MarketplaceUrl, model.PLUGIN_SETTINGS_DEFAULT_MARKETPLACE_URL),
 	})
 
 	a.SendDiagnostic(TRACK_CONFIG_DATA_RETENTION, map[string]interface{}{
@@ -689,15 +683,19 @@ func (a *App) trackPlugins() {
 
 	pluginStates := a.Config().PluginSettings.PluginStates
 	plugins, _ := pluginsEnvironment.Available()
+	pluginTrackData := map[string]interface{}{}
 
 	if pluginStates != nil && plugins != nil {
 		for _, plugin := range plugins {
 			if plugin.Manifest == nil {
 				brokenManifestCount += 1
 				continue
 			}
+
+			enabled := false
 			if state, ok := pluginStates[plugin.Manifest.Id]; ok && state.Enable {
 				totalEnabledCount += 1
+				enabled = true
 				if plugin.Manifest.HasServer() {
 					backendEnabledCount += 1
 				}
@@ -716,6 +714,11 @@ func (a *App) trackPlugins() {
 			if plugin.Manifest.SettingsSchema != nil {
 				settingsCount += 1
 			}
+
+			pluginTrackData[plugin.Manifest.Id] = map[string]interface{}{
+				"enabled": enabled,
+				"version": plugin.Manifest.Version,
+			}
 		}
 	} else {
 		totalEnabledCount = -1  // -1 to indicate disabled or error
@@ -731,6 +734,16 @@ func (a *App) trackPlugins() {
 		"disabled_backend_plugins":      backendDisabledCount,
 		"plugins_with_settings":         settingsCount,
 		"plugins_with_broken_manifests": brokenManifestCount,
+		"enable_antivirus":              pluginData(pluginTrackData, "antivirus"),
+		"enable_autolink":               pluginData(pluginTrackData, "mattermost-autolink"),
+		"enable_aws_sns":                pluginData(pluginTrackData, "com.mattermost.aws-sns"),
+		"enable_custom_user_attributes": pluginData(pluginTrackData, "com.mattermost.custom-attributes"),
+		"enable_github":                 pluginData(pluginTrackData, "github"),
+		"enable_gitlab":                 pluginData(pluginTrackData, "com.github.manland.mattermost-plugin-gitlab"),
+		"enable_jenkins":                pluginData(pluginTrackData, "jenkins"),
+		"enable_jira":                   pluginData(pluginTrackData, "jira"),
+		"enable_nps":                    pluginData(pluginTrackData, "com.mattermost.nps"),
+		"enable_welcome_bot":            pluginData(pluginTrackData, "com.mattermost.welcomebot"),
 	})
 }
 

app/diagnostics_test.go

@@ -29,18 +29,29 @@ func TestPluginSetting(t *testing.T) {
 	assert.Equal(t, "asd", pluginSetting(settings, "test", "qwe", "asd"))
 }
 
-func TestPluginActivated(t *testing.T) {
-	states := map[string]*model.PluginState{
-		"foo": {
-			Enable: true,
-		},
-		"bar": {
-			Enable: false,
-		},
+func TestPluginData(t *testing.T) {
+
+	fooPluginData := map[string]interface{}{
+		"enabled": true,
+		"version": "1.2.0",
+	}
+	barPluginData := map[string]interface{}{
+		"enabled": false,
+		"version": "0.1.2",
 	}
-	assert.True(t, pluginActivated(states, "foo"))
-	assert.False(t, pluginActivated(states, "bar"))
-	assert.False(t, pluginActivated(states, "none"))
+	unavailablePluginData := map[string]interface{}{
+		"enabled": false,
+		"version": "",
+	}
+
+	pluginsData := map[string]interface{}{
+		"foo": fooPluginData,
+		"bar": barPluginData,
+	}
+
+	assert.Equal(t, fooPluginData, pluginData(pluginsData, "foo"))
+	assert.Equal(t, barPluginData, pluginData(pluginsData, "bar"))
+	assert.Equal(t, unavailablePluginData, pluginData(pluginsData, "none"))
 }
 
 func TestDiagnostics(t *testing.T) {