Kyle BrandtandTodd Treece
c3d7dbc258
Return the SQL schema for all DS queries in request (to provide information to AI / Autocomplete for SQL expressions). All DS queries are treated as if they were inputs to SQL expressions in terms of conversion, regardless if they are selected in a query or not. Requires feature toggle queryService = true Endpoint is apis/query.grafana.app/v0alpha1/namespaces/default/sqlschemas --------- Co-authored-by: Todd Treece <360020+toddtreece@users.noreply.github.com>
79 lines
4.8 KiB
Go
79 lines
4.8 KiB
Go
package publicdashboards
|
|
|
|
import (
|
|
"context"
|
|
|
|
"github.com/grafana/grafana-plugin-sdk-go/backend"
|
|
"github.com/grafana/grafana/pkg/api/dtos"
|
|
"github.com/grafana/grafana/pkg/apimachinery/identity"
|
|
"github.com/grafana/grafana/pkg/expr"
|
|
contextmodel "github.com/grafana/grafana/pkg/services/contexthandler/model"
|
|
"github.com/grafana/grafana/pkg/services/dashboards"
|
|
. "github.com/grafana/grafana/pkg/services/publicdashboards/models"
|
|
"github.com/grafana/grafana/pkg/services/user"
|
|
)
|
|
|
|
// These are the api contracts. The API should match the underlying service and store
|
|
|
|
//go:generate go run ./commands/generate_datasources/main.go
|
|
//go:generate mockery --name Service --structname FakePublicDashboardService --inpackage --filename public_dashboard_service_mock.go
|
|
type Service interface {
|
|
GetPublicDashboardForView(ctx context.Context, accessToken string) (*dtos.DashboardFullWithMeta, error)
|
|
FindPublicDashboardAndDashboardByAccessToken(ctx context.Context, accessToken string) (*PublicDashboard, *dashboards.Dashboard, error)
|
|
FindEnabledPublicDashboardAndDashboardByAccessToken(ctx context.Context, accessToken string) (*PublicDashboard, *dashboards.Dashboard, error)
|
|
FindByAccessToken(ctx context.Context, accessToken string) (*PublicDashboard, error)
|
|
FindByDashboardUid(ctx context.Context, orgId int64, dashboardUid string) (*PublicDashboard, error)
|
|
FindAnnotations(ctx context.Context, reqDTO AnnotationsQueryDTO, accessToken string) ([]AnnotationEvent, error)
|
|
FindDashboard(ctx context.Context, orgId int64, dashboardUid string) (*dashboards.Dashboard, error)
|
|
FindAllWithPagination(ctx context.Context, query *PublicDashboardListQuery) (*PublicDashboardListResponseWithPagination, error)
|
|
Find(ctx context.Context, uid string) (*PublicDashboard, error)
|
|
Create(ctx context.Context, u *user.SignedInUser, dto *SavePublicDashboardDTO) (*PublicDashboard, error)
|
|
Update(ctx context.Context, u *user.SignedInUser, dto *SavePublicDashboardDTO) (*PublicDashboard, error)
|
|
Delete(ctx context.Context, uid string, dashboardUid string) error
|
|
|
|
GetMetricRequest(ctx context.Context, dashboard *dashboards.Dashboard, publicDashboard *PublicDashboard, panelId int64, reqDTO PublicDashboardQueryDTO) (dtos.MetricRequest, error)
|
|
GetQueryDataResponse(ctx context.Context, skipDSCache bool, reqDTO PublicDashboardQueryDTO, panelId int64, accessToken string) (*backend.QueryDataResponse, error)
|
|
GetOrgIdByAccessToken(ctx context.Context, accessToken string) (int64, error)
|
|
NewPublicDashboardAccessToken(ctx context.Context) (string, error)
|
|
NewPublicDashboardUid(ctx context.Context) (string, error)
|
|
|
|
ExistsEnabledByAccessToken(ctx context.Context, accessToken string) (bool, error)
|
|
ExistsEnabledByDashboardUid(ctx context.Context, dashboardUid string) (bool, error)
|
|
|
|
GetSQLSchemas(ctx context.Context, user identity.Requester, reqDTO dtos.MetricRequest) (expr.SQLSchemas, error)
|
|
}
|
|
|
|
// ServiceWrapper these methods have different behavior between OSS and Enterprise. The latter would call the OSS service first
|
|
//
|
|
//go:generate mockery --name ServiceWrapper --structname FakePublicDashboardServiceWrapper --inpackage --filename public_dashboard_service_wrapper_mock.go
|
|
type ServiceWrapper interface {
|
|
FindByDashboardUid(ctx context.Context, orgId int64, dashboardUid string) (*PublicDashboard, error)
|
|
Delete(ctx context.Context, uid string) error
|
|
DeleteByDashboardUIDs(ctx context.Context, orgId int64, dashboardUIDs []string) error
|
|
}
|
|
|
|
//go:generate mockery --name Store --structname FakePublicDashboardStore --inpackage --filename public_dashboard_store_mock.go
|
|
type Store interface {
|
|
Find(ctx context.Context, uid string) (*PublicDashboard, error)
|
|
FindByAccessToken(ctx context.Context, accessToken string) (*PublicDashboard, error)
|
|
FindByDashboardUid(ctx context.Context, orgId int64, dashboardUid string) (*PublicDashboard, error)
|
|
FindAll(ctx context.Context, query *PublicDashboardListQuery) (*PublicDashboardListResponseWithPagination, error)
|
|
Create(ctx context.Context, cmd SavePublicDashboardCommand) (int64, error)
|
|
Update(ctx context.Context, cmd SavePublicDashboardCommand) (int64, error)
|
|
Delete(ctx context.Context, uid string) (int64, error)
|
|
DeleteByDashboardUIDs(ctx context.Context, orgId int64, dashboardUIDs []string) error
|
|
|
|
GetOrgIdByAccessToken(ctx context.Context, accessToken string) (int64, error)
|
|
ExistsEnabledByAccessToken(ctx context.Context, accessToken string) (bool, error)
|
|
ExistsEnabledByDashboardUid(ctx context.Context, dashboardUid string) (bool, error)
|
|
GetMetrics(ctx context.Context) (*Metrics, error)
|
|
}
|
|
|
|
//go:generate mockery --name Middleware --structname FakePublicDashboardMiddleware --inpackage --filename public_dashboard_middleware_mock.go
|
|
type Middleware interface {
|
|
HandleApi(c *contextmodel.ReqContext)
|
|
HandleView(c *contextmodel.ReqContext)
|
|
HandleAccessView(c *contextmodel.ReqContext)
|
|
HandleConfirmAccessView(c *contextmodel.ReqContext)
|
|
}
|