HACKATHON: Grafana Sharing Slack App

conf/defaults.ini

@@ -1844,3 +1844,8 @@ read_only_toggles =
 [public_dashboards]
 # Set to false to disable public dashboards
 enabled = true
+
+#################################### Slack integration #####################################
+[slack]
+token =
+signing_secret =

packages/grafana-data/src/types/featureToggles.gen.ts

@@ -180,4 +180,6 @@ export interface FeatureToggles {
   groupByVariable?: boolean;
   alertingUpgradeDryrunOnStart?: boolean;
   scopeFilters?: boolean;
+  slackSharePreview?: boolean;
+  slackUnfurling?: boolean;
 }

pkg/api/api.go

@@ -469,6 +469,7 @@ func (hs *HTTPServer) registerRoutes() {
 					dashboardPermissionRoute.Get("/", authorize(ac.EvalPermission(dashboards.ActionDashboardsPermissionsRead)), routing.Wrap(hs.GetDashboardPermissionList))
 					dashboardPermissionRoute.Post("/", authorize(ac.EvalPermission(dashboards.ActionDashboardsPermissionsWrite)), routing.Wrap(hs.UpdateDashboardPermissions))
 				})
+				dashUidRoute.Post("/preview", authorize(ac.EvalPermission(dashboards.ActionDashboardsRead)), routing.Wrap(hs.GeneratePreview))
 			})
 
 			dashboardRoute.Post("/calculate-diff", authorize(ac.EvalPermission(dashboards.ActionDashboardsWrite)), routing.Wrap(hs.CalculateDashboardDiff))
@@ -575,6 +576,7 @@ func (hs *HTTPServer) registerRoutes() {
 
 		// short urls
 		apiRoute.Post("/short-urls", routing.Wrap(hs.createShortURL))
+
 	}, reqSignedIn)
 
 	// admin api

pkg/api/dashboard.go

@@ -5,11 +5,16 @@ import (
 	"encoding/json"
 	"errors"
 	"fmt"
+	"github.com/grafana/grafana/pkg/models"
+	"github.com/grafana/grafana/pkg/services/dashboardimage"
+	"github.com/grafana/grafana/pkg/services/rendering"
 	"net/http"
+	"net/url"
 	"os"
 	"path/filepath"
 	"strconv"
 	"strings"
+	"time"
 
 	"github.com/grafana/grafana/pkg/api/apierrors"
 	"github.com/grafana/grafana/pkg/api/dtos"
@@ -1030,6 +1035,67 @@ func (hs *HTTPServer) GetDashboardUIDs(c *contextmodel.ReqContext) {
 	c.JSON(http.StatusOK, uids)
 }
 
+func (hs *HTTPServer) GeneratePreview(c *contextmodel.ReqContext) response.Response {
+	var previewRequest PreviewRequest
+	if err := web.Bind(c.Req, &previewRequest); err != nil {
+		return response.Error(http.StatusBadRequest, "error parsing body", err)
+	}
+	previewUrl, err := url.Parse(previewRequest.ResourcePath)
+	if err != nil {
+		return response.Error(http.StatusInternalServerError, "error parsing resource path", err)
+	}
+	q := previewUrl.Query()
+	panelId, _ := strconv.ParseInt(q.Get("viewPanel"), 10, 64)
+
+	hs.log.Info("Generating preview", "resourcePath", previewRequest.ResourcePath)
+
+	dq := dashboards.GetDashboardQuery{OrgID: c.SignedInUser.GetOrgID(), UID: web.Params(c.Req)[":uid"]}
+	dashboard, err := hs.DashboardService.GetDashboard(c.Req.Context(), &dq)
+	if err != nil {
+		return response.Error(http.StatusBadRequest, "Retrieving dashboard failed", err)
+	}
+
+	opts := dashboardimage.ScreenshotOptions{
+		AuthOptions: rendering.AuthOpts{
+			OrgID:   c.SignedInUser.GetOrgID(),
+			UserID:  c.SignedInUser.UserID,
+			OrgRole: c.SignedInUser.OrgRole,
+		},
+		OrgID:         c.SignedInUser.GetOrgID(),
+		DashboardUID:  dashboard.UID,
+		DashboardSlug: dashboard.Slug,
+		PanelID:       panelId,
+		From:          q.Get("from"),
+		To:            q.Get("to"),
+		Width:         1600,
+		Height:        800,
+		Theme:         models.ThemeDark,
+		Timeout:       time.Duration(60) * time.Second,
+	}
+
+	previewURL, err := hs.dashboardImageService.TakeScreenshotAndUpload(c.Req.Context(), opts)
+	if err != nil {
+		return response.Error(http.StatusInternalServerError, "Rendering failed", err)
+	}
+
+	return response.JSON(http.StatusOK, &PreviewResponse{
+		PreviewURL: previewURL,
+	})
+}
+
+func (hs *HTTPServer) getImageURL(imageName string) string {
+	grafanaURL := hs.getGrafanaURL()
+	return fmt.Sprintf("%s%s/%s", grafanaURL, "public/img/attachments", imageName)
+}
+
+type PreviewRequest struct {
+	ResourcePath string `json:"resourcePath"`
+}
+
+type PreviewResponse struct {
+	PreviewURL string `json:"previewUrl"`
+}
+
 // swagger:parameters restoreDashboardVersionByID
 type RestoreDashboardVersionByIDParams struct {
 	// in:body

pkg/api/dtos/slack.go

@@ -0,0 +1,17 @@
+package dtos
+
+type SlackChannel struct {
+	Id   string `json:"id"`
+	Name string `json:"name"`
+}
+type SlackChannels struct {
+	Channels []SlackChannel `json:"channels"`
+}
+
+type ShareRequest struct {
+	ChannelIds      []string `json:"channelIds"`
+	ImagePreviewUrl string   `json:"imagePreviewUrl"`
+	ResourcePath    string   `json:"resourcePath"`
+	Title           string   `json:"title"`
+	Message         string   `json:"message,omitempty"`
+}

pkg/api/http_server.go

@@ -11,6 +11,8 @@ import (
 	"encoding/pem"
 	"errors"
 	"fmt"
+	"github.com/grafana/grafana/pkg/services/dashboardimage"
+	slackApi "github.com/grafana/grafana/pkg/services/slack/api"
 	"math/big"
 	"net"
 	"net/http"
@@ -200,23 +202,25 @@ type HTTPServer struct {
 	kvStore                      kvstore.KVStore
 	pluginsCDNService            *pluginscdn.Service
 
-	userService          user.Service
-	tempUserService      tempUser.Service
-	loginAttemptService  loginAttempt.Service
-	orgService           org.Service
-	teamService          team.Service
-	accesscontrolService accesscontrol.Service
-	annotationsRepo      annotations.Repository
-	tagService           tag.Service
-	oauthTokenService    oauthtoken.OAuthTokenService
-	statsService         stats.Service
-	authnService         authn.Service
-	starApi              *starApi.API
-	promRegister         prometheus.Registerer
-	promGatherer         prometheus.Gatherer
-	clientConfigProvider grafanaapiserver.DirectRestConfigProvider
-	namespacer           request.NamespaceMapper
-	anonService          anonymous.Service
+	userService           user.Service
+	tempUserService       tempUser.Service
+	loginAttemptService   loginAttempt.Service
+	orgService            org.Service
+	teamService           team.Service
+	accesscontrolService  accesscontrol.Service
+	annotationsRepo       annotations.Repository
+	tagService            tag.Service
+	oauthTokenService     oauthtoken.OAuthTokenService
+	statsService          stats.Service
+	authnService          authn.Service
+	starApi               *starApi.API
+	promRegister          prometheus.Registerer
+	promGatherer          prometheus.Gatherer
+	clientConfigProvider  grafanaapiserver.DirectRestConfigProvider
+	namespacer            request.NamespaceMapper
+	anonService           anonymous.Service
+	slackApi              *slackApi.Api
+	dashboardImageService dashboardimage.Service
 }
 
 type ServerOptions struct {
@@ -259,6 +263,8 @@ func ProvideHTTPServer(opts ServerOptions, cfg *setting.Cfg, routeRegister routi
 	annotationRepo annotations.Repository, tagService tag.Service, searchv2HTTPService searchV2.SearchHTTPService, oauthTokenService oauthtoken.OAuthTokenService,
 	statsService stats.Service, authnService authn.Service, pluginsCDNService *pluginscdn.Service, promGatherer prometheus.Gatherer,
 	starApi *starApi.API, promRegister prometheus.Registerer, clientConfigProvider grafanaapiserver.DirectRestConfigProvider, anonService anonymous.Service,
+	slackApi *slackApi.Api,
+	dashboardImageService dashboardimage.Service,
 ) (*HTTPServer, error) {
 	web.Env = cfg.Env
 	m := web.New()
@@ -361,6 +367,8 @@ func ProvideHTTPServer(opts ServerOptions, cfg *setting.Cfg, routeRegister routi
 		clientConfigProvider:         clientConfigProvider,
 		namespacer:                   request.GetNamespaceMapper(cfg),
 		anonService:                  anonService,
+		slackApi:                     slackApi,
+		dashboardImageService:        dashboardImageService,
 	}
 	if hs.Listener != nil {
 		hs.log.Debug("Using provided listener")
@@ -803,6 +811,34 @@ func (hs *HTTPServer) mapStatic(m *web.Mux, rootDir string, dir string, prefix s
 	))
 }
 
+// TODO: Duplicated from the rendering service - maybe we can do this in another way to not duplicate this
+func (hs *HTTPServer) getGrafanaURL() string {
+	if hs.Cfg.RendererCallbackUrl != "" {
+		return hs.Cfg.RendererCallbackUrl
+	}
+
+	protocol := hs.Cfg.Protocol
+	switch protocol {
+	case setting.HTTPScheme:
+		protocol = "http"
+	case setting.HTTP2Scheme, setting.HTTPSScheme:
+		protocol = "https"
+	default:
+		// TODO: Handle other schemes?
+	}
+
+	subPath := ""
+	if hs.Cfg.ServeFromSubPath {
+		subPath = hs.Cfg.AppSubURL
+	}
+
+	domain := "localhost"
+	if hs.Cfg.HTTPAddr != "0.0.0.0" {
+		domain = hs.Cfg.HTTPAddr
+	}
+	return fmt.Sprintf("%s://%s:%s%s/", protocol, domain, hs.Cfg.HTTPPort, subPath)
+}
+
 func (hs *HTTPServer) metricsEndpointBasicAuthEnabled() bool {
 	return hs.Cfg.MetricsEndpointBasicAuthUsername != "" && hs.Cfg.MetricsEndpointBasicAuthPassword != ""
 }

pkg/server/wire.go

@@ -8,8 +8,9 @@ package server
 
 import (
 	"github.com/google/wire"
-
 	sdkhttpclient "github.com/grafana/grafana-plugin-sdk-go/backend/httpclient"
+	"github.com/grafana/grafana/pkg/services/dashboardimage"
+	"github.com/grafana/grafana/pkg/services/screenshot"
 
 	"github.com/grafana/grafana/pkg/api"
 	"github.com/grafana/grafana/pkg/api/avatar"
@@ -53,6 +54,7 @@ import (
 	"github.com/grafana/grafana/pkg/services/cloudmigration/cloudmigrationimpl"
 	"github.com/grafana/grafana/pkg/services/contexthandler"
 	"github.com/grafana/grafana/pkg/services/correlations"
+	dashboardImageService "github.com/grafana/grafana/pkg/services/dashboardimage/service"
 	"github.com/grafana/grafana/pkg/services/dashboardimport"
 	dashboardimportservice "github.com/grafana/grafana/pkg/services/dashboardimport/service"
 	dashboardstore "github.com/grafana/grafana/pkg/services/dashboards/database"
@@ -128,6 +130,9 @@ import (
 	"github.com/grafana/grafana/pkg/services/shorturls/shorturlimpl"
 	"github.com/grafana/grafana/pkg/services/signingkeys"
 	"github.com/grafana/grafana/pkg/services/signingkeys/signingkeysimpl"
+	"github.com/grafana/grafana/pkg/services/slack"
+	slackApi "github.com/grafana/grafana/pkg/services/slack/api"
+	slackService "github.com/grafana/grafana/pkg/services/slack/service"
 	"github.com/grafana/grafana/pkg/services/sqlstore"
 	"github.com/grafana/grafana/pkg/services/sqlstore/sqlutil"
 	"github.com/grafana/grafana/pkg/services/ssosettings"
@@ -183,6 +188,7 @@ var wireBasicSet = wire.NewSet(
 	alerting.ProvideAlertEngine,
 	wire.Bind(new(alerting.UsageStatsQuerier), new(*alerting.AlertEngine)),
 	New,
+	screenshot.NewHeadlessScreenshotService,
 	api.ProvideHTTPServer,
 	query.ProvideService,
 	wire.Bind(new(query.Service), new(*query.ServiceImpl)),
@@ -375,6 +381,7 @@ var wireBasicSet = wire.NewSet(
 	anonstore.ProvideAnonDBStore,
 	wire.Bind(new(anonstore.AnonStore), new(*anonstore.AnonDBStore)),
 	loggermw.Provide,
+	slackApi.ProvideApi,
 	signingkeysimpl.ProvideEmbeddedSigningKeysService,
 	wire.Bind(new(signingkeys.Service), new(*signingkeysimpl.Service)),
 	ssoSettingsImpl.ProvideService,
@@ -385,6 +392,10 @@ var wireBasicSet = wire.NewSet(
 	// Kubernetes API server
 	grafanaapiserver.WireSet,
 	apiregistry.WireSet,
+	dashboardImageService.ProvideService,
+	wire.Bind(new(dashboardimage.Service), new(*dashboardImageService.DashboardImageService)),
+	slackService.ProvideService,
+	wire.Bind(new(slack.Service), new(*slackService.SlackService)),
 )
 
 var wireSet = wire.NewSet(

pkg/services/dashboardimage/dashboardimage.go

@@ -0,0 +1,7 @@
+package dashboardimage
+
+import "context"
+
+type Service interface {
+	TakeScreenshotAndUpload(ctx context.Context, opts ScreenshotOptions) (string, error)
+}

pkg/services/dashboardimage/models.go

@@ -0,0 +1,23 @@
+package dashboardimage
+
+import (
+	"github.com/grafana/grafana/pkg/models"
+	"github.com/grafana/grafana/pkg/services/rendering"
+	"time"
+)
+
+type ScreenshotOptions struct {
+	AuthOptions   rendering.AuthOpts
+	OrgID         int64
+	DashboardUID  string
+	DashboardSlug string
+
+	// PanelID must be 0 or null if the screenshot is for the whole dashboard
+	PanelID int64
+	From    string
+	To      string
+	Width   int
+	Height  int
+	Theme   models.Theme
+	Timeout time.Duration
+}