From 97a8282ba213886247c7d03398737124c838b2df Mon Sep 17 00:00:00 2001
From: Mariell Hoversholm <mariell.hoversholm@grafana.com>
Date: Mon, 17 Feb 2025 15:14:01 +0100
Subject: [PATCH] Provisioning: Refactor history to its own interface (#100735)

* Provisioning: Refactor history to its own interface

* refactor: use VersionedRepository
---
 pkg/registry/apis/provisioning/history.go              | 10 +++++++++-
 pkg/registry/apis/provisioning/repository/github.go    |  6 +++++-
 pkg/registry/apis/provisioning/repository/local.go     |  9 ---------
 .../apis/provisioning/repository/repository.go         |  5 ++---
 4 files changed, 16 insertions(+), 14 deletions(-)

diff --git a/pkg/registry/apis/provisioning/history.go b/pkg/registry/apis/provisioning/history.go
index 7406a1ecb67..0e362d6e5de 100644
--- a/pkg/registry/apis/provisioning/history.go
+++ b/pkg/registry/apis/provisioning/history.go
@@ -6,11 +6,13 @@ import (
 	"net/http"
 	"strings"
 
+	"k8s.io/apimachinery/pkg/api/errors"
 	"k8s.io/apimachinery/pkg/runtime"
 	"k8s.io/apiserver/pkg/registry/rest"
 
 	"github.com/grafana/grafana-app-sdk/logging"
 	provisioning "github.com/grafana/grafana/pkg/apis/provisioning/v0alpha1"
+	"github.com/grafana/grafana/pkg/registry/apis/provisioning/repository"
 )
 
 type historySubresource struct {
@@ -58,6 +60,12 @@ func (h *historySubresource) Connect(ctx context.Context, name string, opts runt
 	}
 
 	return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		versioned, ok := repo.(repository.VersionedRepository)
+		if !ok {
+			responder.Error(errors.NewBadRequest("this repository does not support history"))
+			return
+		}
+
 		query := r.URL.Query()
 		ref := query.Get("ref")
 
@@ -71,7 +79,7 @@ func (h *historySubresource) Connect(ctx context.Context, name string, opts runt
 		logger := logger.With("ref", ref, "path", filePath)
 		ctx := logging.Context(r.Context(), logger)
 
-		commits, err := repo.History(ctx, filePath, ref)
+		commits, err := versioned.History(ctx, filePath, ref)
 		if err != nil {
 			logger.Debug("failed to get history", "error", err)
 			responder.Error(err)
diff --git a/pkg/registry/apis/provisioning/repository/github.go b/pkg/registry/apis/provisioning/repository/github.go
index 3b777aa46ed..a726850987d 100644
--- a/pkg/registry/apis/provisioning/repository/github.go
+++ b/pkg/registry/apis/provisioning/repository/github.go
@@ -37,7 +37,11 @@ type githubRepository struct {
 	repo  string
 }
 
-var _ Repository = (*githubRepository)(nil)
+var (
+	_ Repository          = (*githubRepository)(nil)
+	_ RepositoryHooks     = (*githubRepository)(nil)
+	_ VersionedRepository = (*githubRepository)(nil)
+)
 
 func NewGitHub(
 	ctx context.Context,
diff --git a/pkg/registry/apis/provisioning/repository/local.go b/pkg/registry/apis/provisioning/repository/local.go
index 7228eafb2a7..c5632bb3795 100644
--- a/pkg/registry/apis/provisioning/repository/local.go
+++ b/pkg/registry/apis/provisioning/repository/local.go
@@ -383,12 +383,3 @@ func (r *localRepository) Delete(ctx context.Context, path string, ref string, c
 
 	return os.Remove(path)
 }
-
-func (r *localRepository) History(ctx context.Context, path string, ref string) ([]provisioning.HistoryItem, error) {
-	return nil, &apierrors.StatusError{
-		ErrStatus: metav1.Status{
-			Message: "history is not yet implemented",
-			Code:    http.StatusNotImplemented,
-		},
-	}
-}
diff --git a/pkg/registry/apis/provisioning/repository/repository.go b/pkg/registry/apis/provisioning/repository/repository.go
index 040bcf5080a..85c146bf00d 100644
--- a/pkg/registry/apis/provisioning/repository/repository.go
+++ b/pkg/registry/apis/provisioning/repository/repository.go
@@ -85,9 +85,6 @@ type Repository interface {
 
 	// Delete a file in the remote repository
 	Delete(ctx context.Context, path, ref, message string) error
-
-	// History of changes for a path
-	History(ctx context.Context, path, ref string) ([]provisioning.HistoryItem, error)
 }
 
 // Hooks called after the repository has been created, updated or deleted
@@ -124,6 +121,8 @@ type VersionedFileChange struct {
 // this inferface may be extended to make the the original Repository interface
 // more agnostic to the underlying storage system
 type VersionedRepository interface {
+	// History of changes for a path
+	History(ctx context.Context, path, ref string) ([]provisioning.HistoryItem, error)
 	LatestRef(ctx context.Context) (string, error)
 	CompareFiles(ctx context.Context, base, ref string) ([]VersionedFileChange, error)
 }