mirror of
https://github.com/grafana/grafana.git
synced 2025-02-10 23:55:47 -06:00
5626461b3c
* define initial service and add to wire * update caching service interface * add skipQueryCache header handler and update metrics query function to use it * add caching service as a dependency to query service * working caching impl * propagate cache status to frontend in response * beginning of improvements suggested by Lean - separate caching logic from query logic. * more changes to simplify query function * Decided to revert renaming of function * Remove error status from cache request * add extra documentation * Move query caching duration metric to query package * add a little bit of documentation * wip: convert resource caching * Change return type of query service QueryData to a QueryDataResponse with Headers * update codeowners * change X-Cache value to const * use resource caching in endpoint handlers * write resource headers to response even if it's not a cache hit * fix panic caused by lack of nil check * update unit test * remove NONE header - shouldn't show up in OSS * Convert everything to use the plugin middleware * revert a few more things * clean up unused vars * start reverting resource caching, start to implement in plugin middleware * revert more, fix typo * Update caching interfaces - resource caching now has a separate cache method * continue wiring up new resource caching conventions - still in progress * add more safety to implementation * remove some unused objects * remove some code that I left in by accident * add some comments, fix codeowners, fix duplicate registration * fix source of panic in resource middleware * Update client decorator test to provide an empty response object * create tests for caching middleware * fix unit test * Update pkg/services/caching/service.go Co-authored-by: Arati R. <33031346+suntala@users.noreply.github.com> * improve error message in error log * quick docs update * Remove use of mockery. Update return signature to return an explicit hit/miss bool * create unit test for empty request context * rename caching metrics to make it clear they pertain to caching * Update pkg/services/pluginsintegration/clientmiddleware/caching_middleware.go Co-authored-by: Marcus Efraimsson <marcus.efraimsson@gmail.com> * Add clarifying comments to cache skip middleware func * Add comment pointing to the resource cache update call * fix unit tests (missing dependency) * try to fix mystery syntax error * fix a panic * Caching: Introduce feature toggle to caching service refactor (#66323) * introduce new feature toggle * hide calls to new service behind a feature flag * remove licensing flag from toggle (misunderstood what it was for) * fix unit tests * rerun toggle gen --------- Co-authored-by: Arati R. <33031346+suntala@users.noreply.github.com> Co-authored-by: Marcus Efraimsson <marcus.efraimsson@gmail.com>
61 lines
2.7 KiB
Go
61 lines
2.7 KiB
Go
package caching
|
|
|
|
import (
|
|
"context"
|
|
|
|
"github.com/grafana/grafana-plugin-sdk-go/backend"
|
|
)
|
|
|
|
const (
|
|
XCacheHeader = "X-Cache"
|
|
StatusHit = "HIT"
|
|
StatusMiss = "MISS"
|
|
StatusBypass = "BYPASS"
|
|
StatusError = "ERROR"
|
|
StatusDisabled = "DISABLED"
|
|
)
|
|
|
|
type CacheQueryResponseFn func(context.Context, *backend.QueryDataResponse)
|
|
|
|
type CachedQueryDataResponse struct {
|
|
// The cached data response associated with a query, or nil if no cached data is found
|
|
Response *backend.QueryDataResponse
|
|
// A function that should be used to cache a QueryDataResponse for a given query.
|
|
// It can be set to nil by the method implementation (if there is an error, for example), so it should be checked before being called.
|
|
UpdateCacheFn CacheQueryResponseFn
|
|
}
|
|
|
|
func ProvideCachingService() *OSSCachingService {
|
|
return &OSSCachingService{}
|
|
}
|
|
|
|
type CachingService interface {
|
|
// HandleQueryRequest uses a QueryDataRequest to check the cache for any existing results for that query.
|
|
// If none are found, it should return false and a CachedQueryDataResponse with an UpdateCacheFn which can be used to update the results cache after the fact.
|
|
// This function may populate any response headers (accessible through the context) with the cache status using the X-Cache header.
|
|
HandleQueryRequest(context.Context, *backend.QueryDataRequest) (bool, CachedQueryDataResponse)
|
|
// HandleResourceRequest uses a CallResourceRequest to check the cache for any existing results for that request. If none are found, it should return false.
|
|
// This function may populate any response headers (accessible through the context) with the cache status using the X-Cache header.
|
|
HandleResourceRequest(context.Context, *backend.CallResourceRequest) (bool, *backend.CallResourceResponse)
|
|
// CacheResourceResponse is used to cache resource responses for a resource request.
|
|
// Because plugins can send multiple responses asyncronously, the implementation should be able to handle multiple calls to this function for one request.
|
|
CacheResourceResponse(context.Context, *backend.CallResourceRequest, *backend.CallResourceResponse)
|
|
}
|
|
|
|
// Implementation of interface - does nothing
|
|
type OSSCachingService struct {
|
|
}
|
|
|
|
func (s *OSSCachingService) HandleQueryRequest(ctx context.Context, req *backend.QueryDataRequest) (bool, CachedQueryDataResponse) {
|
|
return false, CachedQueryDataResponse{}
|
|
}
|
|
|
|
func (s *OSSCachingService) HandleResourceRequest(ctx context.Context, req *backend.CallResourceRequest) (bool, *backend.CallResourceResponse) {
|
|
return false, nil
|
|
}
|
|
|
|
func (s *OSSCachingService) CacheResourceResponse(ctx context.Context, req *backend.CallResourceRequest, resp *backend.CallResourceResponse) {
|
|
}
|
|
|
|
var _ CachingService = &OSSCachingService{}
|