Chore: Annotation store interface (#114100)

* annotation legacy store with api server, read only

* annotations are not addressable by ID for read operations

* add ownership for an app

* typo, of course

* fix go workspace

* update workspace

* copy annotation app in dockerfile

* experimenting with store interface

* finalising interfaces

* add tags as custom handler

* implement tags handler

* add missing config file

* mute linter

* update generated files

* update workspace

apps/annotation/pkg/apis/annotation/v0alpha1/gettags_response_body_types_gen.go

@@ -0,0 +1,26 @@
+// Code generated - EDITING IS FUTILE. DO NOT EDIT.
+
+package v0alpha1
+
+// +k8s:openapi-gen=true
+type GetTagsBody struct {
+	Tags []V0alpha1GetTagsBodyTags `json:"tags"`
+}
+
+// NewGetTagsBody creates a new GetTagsBody object.
+func NewGetTagsBody() *GetTagsBody {
+	return &GetTagsBody{
+		Tags: []V0alpha1GetTagsBodyTags{},
+	}
+}
+
+// +k8s:openapi-gen=true
+type V0alpha1GetTagsBodyTags struct {
+	Tag   string  `json:"tag"`
+	Count float64 `json:"count"`
+}
+
+// NewV0alpha1GetTagsBodyTags creates a new V0alpha1GetTagsBodyTags object.
+func NewV0alpha1GetTagsBodyTags() *V0alpha1GetTagsBodyTags {
+	return &V0alpha1GetTagsBodyTags{}
+}

apps/annotation/pkg/apis/annotation/v0alpha1/gettags_response_object_types_gen.go

@@ -0,0 +1,37 @@
+// Code generated - EDITING IS FUTILE. DO NOT EDIT.
+
+package v0alpha1
+
+import (
+	"github.com/grafana/grafana-app-sdk/resource"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/apimachinery/pkg/runtime"
+)
+
+// +k8s:openapi-gen=true
+type GetTags struct {
+	metav1.TypeMeta `json:",inline"`
+	GetTagsBody     `json:",inline"`
+}
+
+func NewGetTags() *GetTags {
+	return &GetTags{}
+}
+
+func (t *GetTagsBody) DeepCopyInto(dst *GetTagsBody) {
+	_ = resource.CopyObjectInto(dst, t)
+}
+
+func (o *GetTags) DeepCopyObject() runtime.Object {
+	dst := NewGetTags()
+	o.DeepCopyInto(dst)
+	return dst
+}
+
+func (o *GetTags) DeepCopyInto(dst *GetTags) {
+	dst.TypeMeta.APIVersion = o.TypeMeta.APIVersion
+	dst.TypeMeta.Kind = o.TypeMeta.Kind
+	o.GetTagsBody.DeepCopyInto(&dst.GetTagsBody)
+}
+
+var _ runtime.Object = NewGetTags()

apps/annotation/pkg/apis/annotation_manifest.go

@@ -43,9 +43,60 @@ var appManifestData = app.ManifestData{
 				},
 			},
 			Routes: app.ManifestVersionRoutes{
-				Namespaced: map[string]spec3.PathProps{},
-				Cluster:    map[string]spec3.PathProps{},
-				Schemas:    map[string]spec.Schema{},
+				Namespaced: map[string]spec3.PathProps{
+					"/tags": {
+						Get: &spec3.Operation{
+							OperationProps: spec3.OperationProps{
+
+								OperationId: "getTags",
+
+								Responses: &spec3.Responses{
+									ResponsesProps: spec3.ResponsesProps{
+										Default: &spec3.Response{
+											ResponseProps: spec3.ResponseProps{
+												Description: "Default OK response",
+												Content: map[string]*spec3.MediaType{
+													"application/json": {
+														MediaTypeProps: spec3.MediaTypeProps{
+															Schema: &spec.Schema{
+																SchemaProps: spec.SchemaProps{
+																	Type: []string{"object"},
+																	Properties: map[string]spec.Schema{
+																		"apiVersion": {
+																			SchemaProps: spec.SchemaProps{
+																				Type:        []string{"string"},
+																				Description: "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
+																			},
+																		},
+																		"kind": {
+																			SchemaProps: spec.SchemaProps{
+																				Type:        []string{"string"},
+																				Description: "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
+																			},
+																		},
+																		"tags": {
+																			SchemaProps: spec.SchemaProps{
+																				Type: []string{"array"},
+																			},
+																		},
+																	},
+																	Required: []string{
+																		"tags",
+																		"apiVersion",
+																		"kind",
+																	},
+																}},
+														}},
+												},
+											},
+										},
+									}},
+							},
+						},
+					},
+				},
+				Cluster: map[string]spec3.PathProps{},
+				Schemas: map[string]spec.Schema{},
 			},
 		},
 	},
@@ -70,7 +121,9 @@ func ManifestGoTypeAssociator(kind, version string) (goType resource.Kind, exist
 	return goType, exists
 }
 
-var customRouteToGoResponseType = map[string]any{}
+var customRouteToGoResponseType = map[string]any{
+	"v0alpha1||<namespace>/tags|GET": v0alpha1.GetTags{},
+}
 
 // ManifestCustomRouteResponsesAssociator returns the associated response go type for a given kind, version, custom route path, and method, if one exists.
 // kind may be empty for custom routes which are not kind subroutes. Leading slashes are removed from subroute paths.

apps/annotation/pkg/app/app.go

@@ -30,6 +30,23 @@ func New(cfg app.Config) (app.App, error) {
 		},
 	}
 
+	// Add custom route handlers if a TagHandler is provided in SpecificConfig.
+	// The handler is created/owned by the registry layer and passed in via
+	// SpecificConfig to avoid the apps package depending on the registry.
+	if cfg.SpecificConfig != nil {
+		if annotationConfig, ok := cfg.SpecificConfig.(*AnnotationConfig); ok && annotationConfig.TagHandler != nil {
+			simpleConfig.VersionedCustomRoutes = map[string]simple.AppVersionRouteHandlers{
+				"v0alpha1": {
+					{
+						Namespaced: true,
+						Path:       "tags",
+						Method:     "GET",
+					}: annotationConfig.TagHandler,
+				},
+			}
+		}
+	}
+
 	a, err := simple.NewApp(simpleConfig)
 	if err != nil {
 		return nil, err

apps/annotation/pkg/app/config.go

@@ -0,0 +1,16 @@
+package app
+
+import (
+	"context"
+
+	"github.com/grafana/grafana-app-sdk/app"
+)
+
+// AnnotationConfig is the app-specific config for the annotation app. The
+// registry can pass a TagHandler implementation here to wire the /tags
+// resource route into the app without importing registry types.
+type AnnotationConfig struct {
+	// TagHandler is the handler function for the GET /tags custom route.
+	// The function signature matches app.CustomRouteHandler from the app-sdk.
+	TagHandler func(ctx context.Context, writer app.CustomRouteResponseWriter, request *app.CustomRouteRequest) error
+}