public/grafana
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

ShortURL: Implement /goto with a sub-resource (#110972)

Browse Source
This commit is contained in:
Ryan McKinley
2025-09-15 16:56:20 +03:00
committed by GitHub
parent 2df39fc71a
commit a5bd313f5a
12 changed files with 319 additions and 98 deletions
Download Patch File Download Diff File Expand all files Collapse all files
pkg/api/short_url.go
+36 -31
View File
@@ -1,14 +1,15 @@
package api
import (
"encoding/json"
"fmt"
"net/http"
"time"
"k8s.io/apimachinery/pkg/api/errors"
v1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime/schema"
"k8s.io/client-go/dynamic"
"k8s.io/client-go/kubernetes"
"github.com/grafana/grafana/apps/shorturl/pkg/apis/shorturl/v1alpha1"
"github.com/grafana/grafana/pkg/api/dtos"
@@ -152,47 +153,51 @@ func (sk8s *shortURLK8sHandler) getKubernetesShortURLsHandler(c *contextmodel.Re
}
func (sk8s *shortURLK8sHandler) getKubernetesRedirectFromShortURL(c *contextmodel.ReqContext) {
client, ok := sk8s.getClient(c)
if !ok {
return
}
shortURLUID := web.Params(c.Req)[":uid"]
if !util.IsValidShortUID(shortURLUID) {
c.Logger.Warn("Invalid short URL UID format", "uid", shortURLUID)
uid := web.Params(c.Req)[":uid"]
if !util.IsValidShortUID(uid) {
c.Logger.Warn("Invalid short URL UID format", "uid", uid)
c.Redirect(sk8s.cfg.AppURL, http.StatusFound)
return
}
// Get Object
obj, err := client.Get(c.Req.Context(), shortURLUID, v1.GetOptions{})
client, err := kubernetes.NewForConfig(sk8s.clientConfigProvider.GetDirectRestConfig(c))
if err != nil {
sk8s.writeError(c, err)
c.JsonApiErr(500, "client", err)
return
}
// Modify status
status := obj.Object["status"].(map[string]interface{})
newTimestamp := time.Now().Unix()
status["lastSeenAt"] = newTimestamp
result := client.RESTClient().Get().
Prefix("apis", v1alpha1.APIGroup, v1alpha1.APIVersion).
Namespace(sk8s.namespacer(c.OrgID)).
Resource(v1alpha1.ShortURLKind().Plural()).
Name(uid).
SubResource("goto").
Param("redirect", "false"). // returns the URL and then we will do the redirect
Do(c.Req.Context())
// Try status subresource first (works in Mode 5), fallback to main resource (works in Mode 0)
out, err := client.Update(c.Req.Context(), obj, v1.UpdateOptions{}, "status")
if err != nil {
c.Logger.Debug("Status subresource update failed, trying main resource", "error", err)
// Fallback to main resource update (for Mode 0)
out, err = client.Update(c.Req.Context(), obj, v1.UpdateOptions{})
if err != nil {
c.Logger.Error("Both status and main resource updates failed", "error", err)
sk8s.writeError(c, err)
return
}
if err = result.Error(); err != nil {
c.JsonApiErr(500, "goto", err)
return
}
spec := out.Object["spec"].(map[string]any)
path := spec["path"].(string)
c.Logger.Debug("Redirecting short URL", "uid", shortURLUID, "path", path)
c.Redirect(setting.ToAbsUrl(path), http.StatusFound)
body, err := result.Raw()
if err != nil {
c.JsonApiErr(500, "body", err)
return
}
value := &v1alpha1.GetGoto{}
if err = json.Unmarshal(body, value); err != nil {
c.JsonApiErr(500, "unmarshal", err)
return
}
if value.Url == "" {
c.JsonApiErr(500, "invalid", fmt.Errorf("expected url"))
return
}
c.Resp.Header().Add("Location", value.Url)
c.Resp.WriteHeader(http.StatusFound)
}
func (sk8s *shortURLK8sHandler) createKubernetesShortURLsHandler(c *contextmodel.ReqContext) {
pkg/registry/apps/shorturl/register.go
+6 -8
View File
@@ -28,8 +28,8 @@ var (
type ShortURLAppInstaller struct {
appsdkapiserver.AppInstaller
cfg *setting.Cfg
service shorturls.Service
service shorturls.Service
namespacer request.NamespaceMapper
}
func RegisterAppInstaller(
@@ -37,12 +37,10 @@ func RegisterAppInstaller(
service shorturls.Service,
) (*ShortURLAppInstaller, error) {
installer := &ShortURLAppInstaller{
cfg: cfg,
service: service,
service: service,
namespacer: request.GetNamespaceMapper(cfg),
}
specificConfig := any(&shorturlapp.ShortURLConfig{
AppURL: cfg.AppURL,
})
specificConfig := any(&shorturlapp.ShortURLConfig{})
provider := simple.NewAppProvider(apis.LocalManifest(), specificConfig, shorturlapp.New)
appCfg := app.Config{
@@ -69,7 +67,7 @@ func (s *ShortURLAppInstaller) GetLegacyStorage(requested schema.GroupVersionRes
}
legacyStore := &legacyStorage{
service: s.service,
namespacer: request.GetNamespaceMapper(s.cfg),
namespacer: s.namespacer,
}
legacyStore.tableConverter = utils.NewTableConverter(
gvr.GroupResource(),
pkg/tests/apis/openapi_snapshots/shorturl.grafana.app-v1alpha1.json
+60
View File
@@ -865,6 +865,55 @@
}
]
},
"/apis/shorturl.grafana.app/v1alpha1/namespaces/{namespace}/shorturls/{name}/goto": {
"get": {
"tags": [
"ShortURL"
],
"description": "connect GET requests to goto of ShortURL",
"operationId": "getShortURLGoto",
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/com.github.grafana.grafana.apps.shorturl.pkg.apis.shorturl.v1alpha1.GetGoto"
}
}
}
}
},
"x-kubernetes-action": "connect",
"x-kubernetes-group-version-kind": {
"group": "shorturl.grafana.app",
"version": "v1alpha1",
"kind": "ResourceCallOptions"
}
},
"parameters": [
{
"name": "name",
"in": "path",
"description": "name of the ResourceCallOptions",
"required": true,
"schema": {
"type": "string",
"uniqueItems": true
}
},
{
"name": "namespace",
"in": "path",
"description": "object name and auth scope, such as for teams and projects",
"required": true,
"schema": {
"type": "string",
"uniqueItems": true
}
}
]
},
"/apis/shorturl.grafana.app/v1alpha1/namespaces/{namespace}/shorturls/{name}/status": {
"get": {
"tags": [
@@ -1158,6 +1207,17 @@
},
"components": {
"schemas": {
"com.github.grafana.grafana.apps.shorturl.pkg.apis.shorturl.v1alpha1.GetGoto": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string"
}
}
},
"com.github.grafana.grafana.apps.shorturl.pkg.apis.shorturl.v1alpha1.ShortURL": {
"type": "object",
"properties": {
pkg/tests/apis/shorturl/shorturl_test.go
+26 -48
View File
@@ -6,9 +6,7 @@ import (
"net/http"
"testing"
"github.com/grafana/grafana/pkg/services/shorturls"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
@@ -17,6 +15,8 @@ import (
"github.com/grafana/grafana/pkg/api/dtos"
grafanarest "github.com/grafana/grafana/pkg/apiserver/rest"
"github.com/grafana/grafana/pkg/services/apiserver/options"
"github.com/grafana/grafana/pkg/services/featuremgmt"
"github.com/grafana/grafana/pkg/services/shorturls"
"github.com/grafana/grafana/pkg/setting"
"github.com/grafana/grafana/pkg/tests/apis"
"github.com/grafana/grafana/pkg/tests/testinfra"
@@ -68,7 +68,7 @@ func TestIntegrationShortURL(t *testing.T) {
AppModeProduction: false, // required for unified storage
DisableAnonymous: true,
APIServerStorageType: options.StorageTypeUnified,
EnableFeatureToggles: []string{"kubernetesShortURLs"},
EnableFeatureToggles: []string{featuremgmt.FlagKubernetesShortURLs},
UnifiedStorageConfig: map[string]setting.UnifiedStorageConfig{
RESOURCEGROUP: {
DualWriterMode: grafanarest.Mode0,
@@ -78,60 +78,38 @@ func TestIntegrationShortURL(t *testing.T) {
doLegacyOnlyTests(t, helper)
})
t.Run("with dual write (unified storage, mode 1)", func(t *testing.T) {
mode := grafanarest.Mode1
helper := apis.NewK8sTestHelper(t, testinfra.GrafanaOpts{
AppModeProduction: false,
DisableAnonymous: true,
APIServerStorageType: options.StorageTypeUnified,
EnableFeatureToggles: []string{"kubernetesShortURLs"},
UnifiedStorageConfig: map[string]setting.UnifiedStorageConfig{
RESOURCEGROUP: {
DualWriterMode: mode,
for _, mode := range []grafanarest.DualWriterMode{
grafanarest.Mode1,
grafanarest.Mode2,
// grafanarest.Mode3, TODO: the /goto function needs to use an UpdateStatus client
// grafanarest.Mode4,
} {
t.Run(fmt.Sprintf("with dual write (unified storage, mode %d)", mode), func(t *testing.T) {
helper := apis.NewK8sTestHelper(t, testinfra.GrafanaOpts{
AppModeProduction: false,
DisableAnonymous: true,
APIServerStorageType: options.StorageTypeUnified,
EnableFeatureToggles: []string{
featuremgmt.FlagKubernetesShortURLs,
},
},
})
doDualWriteTests(t, helper, mode)
})
t.Run("with dual write (unified storage, mode 2)", func(t *testing.T) {
mode := grafanarest.Mode2
helper := apis.NewK8sTestHelper(t, testinfra.GrafanaOpts{
AppModeProduction: false,
DisableAnonymous: true,
APIServerStorageType: options.StorageTypeUnified,
EnableFeatureToggles: []string{"kubernetesShortURLs"},
UnifiedStorageConfig: map[string]setting.UnifiedStorageConfig{
RESOURCEGROUP: {
DualWriterMode: mode,
UnifiedStorageConfig: map[string]setting.UnifiedStorageConfig{
RESOURCEGROUP: {
DualWriterMode: mode,
},
},
},
})
doDualWriteTests(t, helper, mode)
})
doDualWriteTests(t, helper, mode)
})
t.Run("with dual write (unified storage, mode 3)", func(t *testing.T) {
mode := grafanarest.Mode3
helper := apis.NewK8sTestHelper(t, testinfra.GrafanaOpts{
AppModeProduction: false,
DisableAnonymous: true,
APIServerStorageType: options.StorageTypeUnified,
EnableFeatureToggles: []string{"kubernetesShortURLs"},
UnifiedStorageConfig: map[string]setting.UnifiedStorageConfig{
RESOURCEGROUP: {
DualWriterMode: mode,
},
},
})
doDualWriteTests(t, helper, mode)
})
}
t.Run("with dual write (unified storage, mode 5)", func(t *testing.T) {
helper := apis.NewK8sTestHelper(t, testinfra.GrafanaOpts{
AppModeProduction: false,
DisableAnonymous: true,
APIServerStorageType: options.StorageTypeUnified,
EnableFeatureToggles: []string{"kubernetesShortURLs"},
EnableFeatureToggles: []string{
featuremgmt.FlagKubernetesShortURLs,
},
UnifiedStorageConfig: map[string]setting.UnifiedStorageConfig{
RESOURCEGROUP: {
DualWriterMode: grafanarest.Mode5,