feat(external plugins): worked on supporting external plugins better

69daede5 · Torkel Ödegaard · 65a7fa32 · 69daede5 · 69daede5 · 69daede5
Commit 69daede5 authored Nov 19, 2015 by Torkel Ödegaard
13 changed files
--- a/pkg/api/externalplugin.go
+++ b/pkg/api/externalplugin.go
@@ -2,14 +2,15 @@ package api
 import (
 	"encoding/json"
+	"net/http"
+	"net/http/httputil"
+	"net/url"
 	"github.com/Unknwon/macaron"
 	"github.com/grafana/grafana/pkg/log"
 	"github.com/grafana/grafana/pkg/middleware"
 	"github.com/grafana/grafana/pkg/plugins"
 	"github.com/grafana/grafana/pkg/util"
-	"net/http"
-	"net/http/httputil"
-	"net/url"
 )
 func InitExternalPluginRoutes(r *macaron.Macaron) {
@@ -31,10 +32,10 @@ func InitExternalPluginRoutes(r *macaron.Macaron) {
 		}
 	*/
 	for _, plugin := range plugins.ExternalPlugins {
-		log.Info("adding routes for external plugin")
+		log.Info("Plugin: Adding proxy routes for backend plugin")
-		for _, route := range plugin.Settings.Routes {
+		for _, route := range plugin.Routes {
-			log.Info("adding route %s /plugins%s", route.Method, route.Path)
+			log.Info("Plugin: Adding route %s /api/plugin-proxy/%s", route.Method, route.Path)
-			r.Route(util.JoinUrlFragments("/plugins/", route.Path), route.Method, ExternalPlugin(route.Url))
+			r.Route(util.JoinUrlFragments("/api/plugin-proxy/", route.Path), route.Method, ExternalPlugin(route.Url))
 		}
 	}
 }

--- a/pkg/api/index.go
+++ b/pkg/api/index.go
@@ -57,16 +57,15 @@ func setIndexViewData(c *middleware.Context) error {
 	externalPluginCss := make([]string, 0)
 	externalPluginMenu := make([]*plugins.ExternalPluginMenuItem, 0)
 	for _, plugin := range plugins.ExternalPlugins {
-		for _, js := range plugin.Settings.Js {
+		for _, js := range plugin.Js {
-			externalPluginJs = append(externalPluginJs, js.Src)
+			externalPluginJs = append(externalPluginJs, js.Module)
 		}
-		for _, css := range plugin.Settings.Css {
+		for _, css := range plugin.Css {
 			externalPluginCss = append(externalPluginCss, css.Href)
 		}
-		for _, item := range plugin.Settings.MenuItems {
+		for _, item := range plugin.MenuItems {
 			externalPluginMenu = append(externalPluginMenu, item)
 		}
 	}
 	c.Data["ExternalPluginJs"] = externalPluginJs
 	c.Data["ExternalPluginCss"] = externalPluginCss

--- a/pkg/cmd/web.go
+++ b/pkg/cmd/web.go
@@ -29,6 +29,12 @@ func newMacaron() *macaron.Macaron {
 		m.Use(middleware.Gziper())
 	}
+	for _, route := range plugins.StaticRoutes {
+		pluginRoute := path.Join("/public/plugins/", route.Url)
+		log.Info("Plugin: Adding static route %s -> %s", pluginRoute, route.Path)
+		mapStatic(m, route.Path, "", pluginRoute)
+	}
 	mapStatic(m, setting.StaticRootPath, "", "public")
 	mapStatic(m, setting.StaticRootPath, "app", "app")
 	mapStatic(m, setting.StaticRootPath, "css", "css")
@@ -36,11 +42,6 @@ func newMacaron() *macaron.Macaron {
 	mapStatic(m, setting.StaticRootPath, "fonts", "fonts")
 	mapStatic(m, setting.StaticRootPath, "robots.txt", "robots.txt")
-	for _, route := range plugins.StaticRoutes {
-		log.Info("Adding plugin static route %s -> %s", route.Url, route.Path)
-		mapStatic(m, route.Path, "", route.Url)
-	}
 	m.Use(macaron.Renderer(macaron.RenderOptions{
 		Directory:  path.Join(setting.StaticRootPath, "views"),
 		IndentJSON: macaron.Env != macaron.PROD,

--- a/pkg/plugins/models.go
+++ b/pkg/plugins/models.go
@@ -16,22 +16,21 @@ type DataSourcePlugin struct {
 }
 type StaticRootConfig struct {
-	Url        string `json:"url"`
+	Url  string `json:"url"`
-	Path       string `json:"path"`
+	Path string `json:"path"`
-	PluginRoot string `json:"-"`
 }
 type ExternalPluginRoute struct {
 	Path            string          `json:"path"`
 	Method          string          `json:"method"`
-	ReqSignedIn     bool            `json:"req_signed_in"`
+	ReqSignedIn     bool            `json:"reqSignedIn"`
-	ReqGrafanaAdmin bool            `json:"req_grafana_admin"`
+	ReqGrafanaAdmin bool            `json:"reqGrafanaAdmin"`
-	ReqRole         models.RoleType `json:"req_role"`
+	ReqRole         models.RoleType `json:"reqRole"`
 	Url             string          `json:"url"`
 }
 type ExternalPluginJs struct {
-	Src string `json:"src"`
+	Module string `json:"module"`
 }
 type ExternalPluginMenuItem struct {
@@ -44,14 +43,10 @@ type ExternalPluginCss struct {
 	Href string `json:"href"`
 }
-type ExternalPluginSettings struct {
-	Routes    []*ExternalPluginRoute    `json:"routes"`
-	Js        []*ExternalPluginJs       `json:"js"`
-	Css       []*ExternalPluginCss      `json:"css"`
-	MenuItems []*ExternalPluginMenuItem `json:"menu_items"`
-}
 type ExternalPlugin struct {
-	PluginType string                 `json:"pluginType"`
+	Routes           []*ExternalPluginRoute    `json:"routes"`
-	Settings   ExternalPluginSettings `json:"settings"`
+	Js               []*ExternalPluginJs       `json:"js"`
+	Css              []*ExternalPluginCss      `json:"css"`
+	MenuItems        []*ExternalPluginMenuItem `json:"menuItems"`
+	StaticRootConfig *StaticRootConfig         `json:"staticRoot"`
 }
--- a/pkg/plugins/plugins.go
+++ b/pkg/plugins/plugins.go
@@ -38,7 +38,7 @@ func checkExternalPluginPaths() error {
 		if strings.HasPrefix(section.Name(), "plugin.") {
 			path := section.Key("path").String()
 			if path != "" {
-				log.Info("Plugin: scaning specific dir %s", path)
+				log.Info("Plugin: Scaning dir %s", path)
 				scan(path)
 			}
 		}
@@ -81,6 +81,13 @@ func (scanner *PluginScanner) walker(currentPath string, f os.FileInfo, err erro
 	return nil
 }
+func addStaticRoot(staticRootConfig *StaticRootConfig, currentDir string) {
+	if staticRootConfig != nil {
+		staticRootConfig.Path = path.Join(currentDir, staticRootConfig.Path)
+		StaticRoutes = append(StaticRoutes, staticRootConfig)
+	}
+}
 func (scanner *PluginScanner) loadPluginJson(pluginJsonFilePath string) error {
 	currentDir := filepath.Dir(pluginJsonFilePath)
 	reader, err := os.Open(pluginJsonFilePath)
@@ -114,20 +121,17 @@ func (scanner *PluginScanner) loadPluginJson(pluginJsonFilePath string) error {
 		}
 		DataSources[p.Type] = p
+		addStaticRoot(p.StaticRootConfig, currentDir)
-		if p.StaticRootConfig != nil {
-			p.StaticRootConfig.Path = path.Join(currentDir, p.StaticRootConfig.Path)
-			StaticRoutes = append(StaticRoutes, p.StaticRootConfig)
-		}
 	}
-	if pluginType == "externalPlugin" {
+	if pluginType == "external" {
 		p := ExternalPlugin{}
 		reader.Seek(0, 0)
 		if err := jsonParser.Decode(&p); err != nil {
 			return err
 		}
 		ExternalPlugins = append(ExternalPlugins, p)
+		addStaticRoot(p.StaticRootConfig, currentDir)
 	}
 	return nil

--- a/public/app/app.js
+++ b/public/app/app.js
@@ -68,9 +68,13 @@ function (angular, $, _, appLevelRequire) {
    app.useModule(angular.module(module_name, []));
  });
-  var preBootRequires = [
+  var preBootRequires = ['app/features/all'];
-    'app/features/all',
+  var pluginModules = window.grafanaBootData.pluginModules || [];
-  ];
+  // add plugin modules
+  for (var i = 0; i < pluginModules.length; i++) {
+    preBootRequires.push(pluginModules[i]);
+  }
  app.boot = function() {
    require(preBootRequires, function () {

--- a/public/app/core/controllers/sidemenu_ctrl.js
+++ b/public/app/core/controllers/sidemenu_ctrl.js
@@ -29,8 +29,8 @@ function (angular, _, $, coreModule, config) {
        });
      }
-      if (_.isArray(window.externalPlugins.MainLinks)) {
+      if (_.isArray(window.externalPlugins.mainLinks)) {
-        _.forEach(window.externalPlugins.MainLinks, function(item) {
+        _.forEach(window.externalPlugins.mainLinks, function(item) {
          if (!item.adminOnly || contextSrv.hasRole('Admin')) {
            $scope.mainLinks.push({
              text: item.text,

--- a/public/app/core/routes/all.js
+++ b/public/app/core/routes/all.js
@@ -10,7 +10,7 @@ define([
    $locationProvider.html5Mode(true);
    var loadOrgBundle = new BundleLoader.BundleLoader('app/features/org/all');
-    console.log("adding grafana routes");
    $routeProvider
      .when('/', {
        templateUrl: 'app/partials/dashboard.html',

--- a/public/app/core/settings.js
+++ b/public/app/core/settings.js
@@ -16,7 +16,6 @@ function (_) {
        'dashlist':   { path: 'app/panels/dashlist',   name: 'Dashboard list' },
      },
      new_panel_title: 'Panel Title',
-      plugins: {},
      playlist_timespan: "1m",
      unsaved_changes_warning: true,
      appSubUrl: ""

--- a/public/app/plugins/externalPlugins/example/_plugin.json
+++ b/public/app/plugins/externalPlugins/example/_plugin.json
@@ -37,11 +37,6 @@
        "adminOnly": false,
      }
    ]
-  },
+  }
-  "staticRoot": {
-    "url": "_plugins/test_ds",
-    "path": "public"
-  },
 }
--- a/public/app/require_config.js
+++ b/public/app/require_config.js
@@ -3,8 +3,6 @@ require.config({
  baseUrl: 'public',
  paths: {
-    '_plugins':               '../_plugins',
    'lodash-src':             'vendor/lodash',
    lodash:                   'app/core/lodash_extended',

--- a/public/test/test-main.js
+++ b/public/test/test-main.js
@@ -95,6 +95,8 @@ function file2moduleName(filePath) {
    .replace(/\.\w*$/, '');
 }
+window.grafanaBootData = {};
 require([
  'lodash',
  'angular',

--- a/public/views/index.html
+++ b/public/views/index.html
@@ -13,8 +13,9 @@
 		[[else]]
 		  <link rel="stylesheet" href="[[.AppSubUrl]]/css/grafana.dark.min.css">
 		[[end]]
 		[[ range $css := .ExternalPluginCss ]]
-		<link rel="stylesheet" href="[[$.AppSubUrl]]/plugins[[ $css ]]">
+			<link rel="stylesheet" href="[[$.AppSubUrl]]/[[ $css ]]">
 		[[ end ]]
    <link rel="icon" type="image/png" href="[[.AppSubUrl]]/img/fav32.png">
@@ -53,19 +54,18 @@
 		window.grafanaBootData = {
 			user:[[.User]],
 			settings: [[.Settings]],
+			pluginModules: [[.ExternalPluginJs]],
 		};
 		window.externalPlugins =  {
-			MainLinks: [[.ExternalPluginMenu]]
+			mainLinks: [[.ExternalPluginMenu]]
 		};
    require(['app/app'], function (app) {
    	app.boot();
    })
 	</script>
-	[[ range $js := .ExternalPluginJs]]
-	<script src="[[$.AppSubUrl]]/plugins[[ $js ]]"></script>
-	[[ end ]]
 	[[if .GoogleAnalyticsId]]
 		<script>
 		(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){