Plugins: Add autoEnabled plugin JSON field to auto enable App plugins and add configuration link to menu by default #31354

torkelo · 2021-02-19T13:54:39Z

App plugins no longer get a "Plugin Config" menu option added automatically
If you navigate to the plugin via the Plugins list it will default to the config page (if it's an app and export a config ctrl)
An app plugin that wants the Plugin Config to remain in the main menu can add it as an entry in the plugin.json (includes) like any plugin page
New option plugin.json autoEnable option that makes the plugin be enabled by default (making plugins be auto-enabled requires a bit more changes so we can disable any plugin). Can wait for v8

dprokop · 2021-02-19T13:56:37Z

pkg/plugins/app_plugin.go

@@ -15,7 +15,8 @@ import (

 type AppPlugin struct {
 	FrontendPluginBase
-	Routes []*AppPluginRoute `json:"routes"`
+	Routes   []*AppPluginRoute `json:"routes"`
+	NoConfig bool              `json: "noConfig"`


Maybe noConfigPage or noConfigPageInNav instead? noConfig feels very generic.

yea had the same thought

dprokop

LGTM

wbrowne

We should add an entry for the new field in docs/sources/developers/plugins/plugin.schema.json.

Also just to confirm, we should still be able to visit the config page from the plugins list view? Does this change only remove it from the sidebar nav?

torkelo · 2021-02-19T16:53:32Z

Oh i think this might need another change to auto enable the plugin , or maybe that exists already need to check

natellium · 2021-02-22T15:42:08Z

@torkelo should we add this to the plugins platform project and set the milestone to 7.5?

torkelo · 2021-02-22T15:45:17Z

@natellium yes

wbrowne · 2021-02-22T15:58:32Z

pkg/plugins/queries.go

@@ -64,7 +64,10 @@ func GetEnabledPlugins(orgId int64) (*EnabledPlugins, error) {
 	}

 	for pluginId, app := range Apps {
-		if b, ok := pluginSettingMap[pluginId]; ok {
+		if app.AutoEnabled {


This won't actually enable apps though correct? Or at least, it won't set the plugin data - It will just pin it in the nav, so maybe AutoPinned/AutoPinnedToNav is a better name?

it will once I figured out how, at least that is the plan, but was harder than I expected

wbrowne · 2021-02-22T15:59:41Z

docs/sources/developers/plugins/plugin.schema.json

@@ -122,6 +122,14 @@
    "hiddenQueries": {
      "type": "boolean"
    },
+    "noConfigPage": {
+      "type": "boolean",
+      "description": "For app plugins that have no config page"


A little bit confused by this - Does this mean that the app can't be configured at all?

just means they don't have a default config page

ryantxu · 2021-02-22T16:19:00Z

Ugg -- for v8, can the sidebar menu be defined programatically? Why do we need it in plugin.json?

Ideally we can remove all the sidemenu options from plugin.json

torkelo · 2021-02-22T16:31:12Z

@ryantxu I do not think the top level navigation items should require loading async external plugins during frontend rendering, that I think should be declaratively defined in the plugin.json along with user role permission restrictions .

Otherwise the sidemenu will require some loading state and things plopping in after some plugin loading phase? feels bad

torkelo · 2021-02-24T18:05:26Z

@ryantxu I changed this a bit, so it's a bit more of a breaking change but I think it's ok.

App plugins no longer get a "Plugin Config" menu option added automatically
If you navigate to the plugin via the Plugins list it will default to the config page (if it's an app and export a config ctrl)
An app plugin that wants the Plugin Config to remain in the main menu can add it as an entry in the plugin.json (includes) like any plugin page
New option plugin.json autoEnable option that makes the plugin be enabled by default (making plugins be auto-enabled requires a bit more changes so we can disable any plugin). Can wait for v8

what do you think?

ryantxu

This is much better! although we should still be open to more breaking changes in 8.

mikhail-vl · 2021-03-11T19:58:44Z

@torkelo @ryantxu I understand that autoEnabled feature will be fully implemented for v8. In 7.5-beta1 panels are auto-imported and application enabled, but dashboards are missing. Is it going to be fixed in v8, should I open an issue?

torkelo · 2021-03-11T20:13:27Z

Open an issue

AppPlugins: Options to disable showing config page in nav

3fdce41

torkelo requested a review from a team as a code owner February 19, 2021 13:54

torkelo requested review from wbrowne and ying-jeanne and removed request for a team February 19, 2021 13:54

dprokop reviewed Feb 19, 2021

View reviewed changes

rename

f3adfc1

dprokop approved these changes Feb 19, 2021

View reviewed changes

wbrowne requested changes Feb 19, 2021

View reviewed changes

dprokop mentioned this pull request Feb 22, 2021

Epic: enhancements in Grafana App API #31381

Closed

7 tasks

torkelo added 2 commits February 22, 2021 14:10

Added autoEnabled

9bd88a7

updated

a432e03

torkelo requested a review from marcusolsson as a code owner February 22, 2021 15:28

torkelo requested review from a team, peterholmberg and natellium and removed request for a team February 22, 2021 15:28

torkelo added this to the 7.5.0 milestone Feb 22, 2021

wbrowne reviewed Feb 22, 2021

View reviewed changes

Things are working sort of

6888acc

Simplify

dd1cf04

Merge remote-tracking branch 'origin/master' into app-plugins-config

a313e24

ryantxu approved these changes Feb 24, 2021

View reviewed changes

torkelo added the area/grafana/ui Issues that belong to components in the @grafana/ui library label Feb 25, 2021

torkelo changed the title ~~AppPlugins: Options to disable showing config page in nav~~ AppPlugins: Change to plugin menu, do not add Plugin Config to menu by default, and a new option to auto enable app plugins Feb 25, 2021

torkelo merged commit 584886f into master Feb 25, 2021

torkelo deleted the app-plugins-config branch February 25, 2021 09:00

wbrowne added the add to changelog label Mar 3, 2021

wbrowne changed the title ~~AppPlugins: Change to plugin menu, do not add Plugin Config to menu by default, and a new option to auto enable app plugins~~ Plugins: Add autoEnabled plugin JSON field to auto enable App plugins and add configuration link to menu by default Mar 3, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Plugins: Add autoEnabled plugin JSON field to auto enable App plugins and add configuration link to menu by default #31354

Plugins: Add autoEnabled plugin JSON field to auto enable App plugins and add configuration link to menu by default #31354

torkelo commented Feb 19, 2021 •

edited

Loading

dprokop Feb 19, 2021

torkelo Feb 19, 2021

dprokop left a comment

wbrowne left a comment

torkelo commented Feb 19, 2021

natellium commented Feb 22, 2021

torkelo commented Feb 22, 2021

wbrowne Feb 22, 2021

torkelo Feb 22, 2021

wbrowne Feb 22, 2021

torkelo Feb 22, 2021 •

edited

Loading

ryantxu commented Feb 22, 2021

torkelo commented Feb 22, 2021

torkelo commented Feb 24, 2021 •

edited

Loading

ryantxu left a comment

mikhail-vl commented Mar 11, 2021 •

edited

Loading

torkelo commented Mar 11, 2021

Plugins: Add autoEnabled plugin JSON field to auto enable App plugins and add configuration link to menu by default #31354

Plugins: Add autoEnabled plugin JSON field to auto enable App plugins and add configuration link to menu by default #31354

Conversation

torkelo commented Feb 19, 2021 • edited Loading

dprokop Feb 19, 2021

Choose a reason for hiding this comment

torkelo Feb 19, 2021

Choose a reason for hiding this comment

dprokop left a comment

Choose a reason for hiding this comment

wbrowne left a comment

Choose a reason for hiding this comment

torkelo commented Feb 19, 2021

natellium commented Feb 22, 2021

torkelo commented Feb 22, 2021

wbrowne Feb 22, 2021

Choose a reason for hiding this comment

torkelo Feb 22, 2021

Choose a reason for hiding this comment

wbrowne Feb 22, 2021

Choose a reason for hiding this comment

torkelo Feb 22, 2021 • edited Loading

Choose a reason for hiding this comment

ryantxu commented Feb 22, 2021

torkelo commented Feb 22, 2021

torkelo commented Feb 24, 2021 • edited Loading

ryantxu left a comment

Choose a reason for hiding this comment

mikhail-vl commented Mar 11, 2021 • edited Loading

torkelo commented Mar 11, 2021

torkelo commented Feb 19, 2021 •

edited

Loading

torkelo Feb 22, 2021 •

edited

Loading

torkelo commented Feb 24, 2021 •

edited

Loading

mikhail-vl commented Mar 11, 2021 •

edited

Loading