Modern Docker Management, Designed for Everyone
Go composecontainer-managementcontainersdockerdocker-composedocker-managementgoself-hostedsveltekittypescriptweb-ui
feat: support icon_url in remote template registries (#4350)
Kyle Mendella78fc139f6ce
diff --git a/backend/internal/template/model.go b/backend/internal/template/model.goindex a210b6bb1..7aec38139 100644--- a/backend/internal/template/model.go+++ b/backend/internal/template/model.go@@ -33,6 +33,7 @@ type ComposeTemplateMetadata struct {EnvURL *string `json:"envUrl,omitempty"`DocumentationURL *string `json:"documentationUrl,omitempty"`IconURL *string `json:"iconUrl,omitempty"`+ RegistryIconURL *string `json:"registryIconUrl,omitempty"`}func (TemplateRegistry) TableName() string { return "template_registries" }diff --git a/backend/internal/template/service.go b/backend/internal/template/service.goindex 14e402470..0e82ebca5 100644--- a/backend/internal/template/service.go+++ b/backend/internal/template/service.go@@ -1,6 +1,7 @@package templateimport (+ "cmp""context""encoding/json/v2""errors"@@ -61,9 +62,8 @@ type TemplateService struct {}const (- remoteCacheDuration = 5 * time.Minute- fsSyncInterval = 1 * time.Minute- remoteIconResolveLimit = 4+ remoteCacheDuration = 5 * time.Minute+ fsSyncInterval = 1 * time.MinuteremoteIDPrefix = "remote")@@ -727,7 +727,6 @@ func (s *TemplateService) fetchRegistryTemplatesInternal(ctx context.Context, refor _, remoteTemplate := range regDTO.Templates {templates = append(templates, s.convertRemoteToLocal(remoteTemplate, reg))}- s.enrichRemoteTemplateIcons(ctx, templates)lm := resp.Header.Get("Last-Modified")newMeta := ®istryFetchMeta{@@ -780,6 +779,8 @@ func (s *TemplateService) convertRemoteToLocal(remote tmpl.RemoteTemplate, regisRemoteURL: mo.EmptyableToOption(strings.TrimSpace(remote.ComposeURL)).ToPointer(),EnvURL: mo.EmptyableToOption(strings.TrimSpace(remote.EnvURL)).ToPointer(),DocumentationURL: mo.EmptyableToOption(strings.TrimSpace(remote.DocumentationURL)).ToPointer(),+ IconURL: mo.EmptyableToOption(strings.TrimSpace(remote.IconURL)).ToPointer(),+ RegistryIconURL: mo.EmptyableToOption(strings.TrimSpace(remote.IconURL)).ToPointer(),},}}@@ -821,34 +822,6 @@ func (s *TemplateService) fetchRemoteTemplateFiles(ctx context.Context, templatereturn composeContent, envContent, nil}-func (s *TemplateService) enrichRemoteTemplateIcons(ctx context.Context, templates []ComposeTemplate) {- if len(templates) == 0 {- return- }-- group, groupCtx := errgroup.WithContext(ctx)- group.SetLimit(remoteIconResolveLimit)-- for i := range templates {- idx := i- group.Go(func() (workerErr error) {- defer utils.RecoverToError(&workerErr, "template worker")-- composeContent, envContent, err := s.fetchRemoteTemplateFiles(groupCtx, &templates[idx])- if err != nil {- slog.WarnContext(groupCtx, "failed to fetch remote template content for icon extraction", "templateId", templates[idx].ID, "error", err)- setTemplateIconURL(&templates[idx], nil)- return nil- }-- setTemplateIconURL(&templates[idx], projects.ResolveTemplateIconURL(groupCtx, composeContent, envContent))- return nil- })- }-- _ = group.Wait()-}-func (s *TemplateService) fetchURL(ctx context.Context, url string) (string, error) {body, err := s.doGET(ctx, url)if err != nil {@@ -1010,6 +983,7 @@ func cloneTemplateMetadata(meta *ComposeTemplateMetadata) *ComposeTemplateMetadaEnvURL: mo.EmptyableToOption(strings.TrimSpace(mo.PointerToOption(meta.EnvURL).OrEmpty())).ToPointer(),DocumentationURL: mo.EmptyableToOption(strings.TrimSpace(mo.PointerToOption(meta.DocumentationURL).OrEmpty())).ToPointer(),IconURL: mo.EmptyableToOption(strings.TrimSpace(mo.PointerToOption(meta.IconURL).OrEmpty())).ToPointer(),+ RegistryIconURL: mo.EmptyableToOption(strings.TrimSpace(mo.PointerToOption(meta.RegistryIconURL).OrEmpty())).ToPointer(),}}@@ -1158,7 +1132,8 @@ func setTemplateIconURL(template *ComposeTemplate, iconURL *string) {template.Metadata = &ComposeTemplateMetadata{}}- template.Metadata.IconURL = iconURL+ // Downloaded templates fall back to their registry icon.+ template.Metadata.IconURL = cmp.Or(iconURL, template.Metadata.RegistryIconURL)if template.Metadata.Version == nil &&template.Metadata.Author == nil &&len(template.Metadata.Tags) == 0 &&@@ -1188,10 +1163,9 @@ func (s *TemplateService) GetTemplateContentWithParsedData(ctx context.Context,if composeTemplate.EnvContent != nil {envContent = *composeTemplate.EnvContent}+ setTemplateIconURL(composeTemplate, projects.ResolveTemplateIconURL(ctx, composeContent, envContent))}- setTemplateIconURL(composeTemplate, projects.ResolveTemplateIconURL(ctx, composeContent, envContent))-var outTemplate tmpl.Templateif mapErr := mapping.MapStruct(composeTemplate, &outTemplate); mapErr != nil {return nil, fmt.Errorf("failed to map template: %w", mapErr)diff --git a/backend/internal/template/service_test.go b/backend/internal/template/service_test.goindex 70a3f74aa..60de58db9 100644--- a/backend/internal/template/service_test.go+++ b/backend/internal/template/service_test.go@@ -76,8 +76,7 @@ func makePublicTestClient(t *testing.T, server *httptest.Server) (*http.Client,func TestFetchRegistryTemplates_ReusesCachedIconsOnNotModified(t *testing.T) {var composeHits atomic.Int32- var okComposeURL string- var badComposeURL string+ var composeURL stringserver := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {switch r.URL.Path {@@ -97,37 +96,36 @@ func TestFetchRegistryTemplates_ReusesCachedIconsOnNotModified(t *testing.T) {{"id": "good","name": "Good Template",- "description": "Has a compose icon",+ "description": "Has a registry icon","version": "1.0.0","author": "Arcane",- "compose_url": "` + okComposeURL + `",+ "compose_url": "` + composeURL + `","env_url": "","documentation_url": "",+ "icon_url": "https://cdn.example/good.png","tags": ["demo"]},{- "id": "bad",- "name": "Broken Template",- "description": "Compose fetch fails",+ "id": "plain",+ "name": "Plain Template",+ "description": "Only has a compose icon","version": "1.0.0","author": "Arcane",- "compose_url": "` + badComposeURL + `",+ "compose_url": "` + composeURL + `","env_url": "","documentation_url": "","tags": ["demo"]}]}`))- case "/ok.yml":+ case "/compose.yml":composeHits.Add(1)_, _ = w.Write([]byte(`x-arcane:- icon: https://cdn.example/good.png+ icon: https://cdn.example/compose.pngservices:app:image: nginx:alpine`))- case "/missing.yml":- http.NotFound(w, r)default:http.NotFound(w, r)}@@ -136,8 +134,7 @@ services:client, lookupIP, baseURL := makePublicTestClient(t, server)registryURL := baseURL + "/registry.json"- okComposeURL = baseURL + "/ok.yml"- badComposeURL = baseURL + "/missing.yml"+ composeURL = baseURL + "/compose.yml"service := &TemplateService{httpClient: client,@@ -158,7 +155,6 @@ services:require.NotNil(t, templates[0].Metadata.IconURL)require.Equal(t, "https://cdn.example/good.png", *templates[0].Metadata.IconURL)require.Nil(t, templates[1].Metadata.IconURL)- require.EqualValues(t, 1, composeHits.Load())cachedTemplates, err := service.fetchRegistryTemplatesInternal(t.Context(), registry, service.remoteGeneration.Load())require.NoError(t, err)@@ -166,7 +162,7 @@ services:require.NotNil(t, cachedTemplates[0].Metadata)require.NotNil(t, cachedTemplates[0].Metadata.IconURL)require.Equal(t, "https://cdn.example/good.png", *cachedTemplates[0].Metadata.IconURL)- require.EqualValues(t, 1, composeHits.Load())+ require.Zero(t, composeHits.Load())}func TestDownloadTemplate_PreservesIconURL(t *testing.T) {@@ -176,14 +172,12 @@ func TestDownloadTemplate_PreservesIconURL(t *testing.T) {server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {switch r.URL.Path {case "/compose.yaml":- _, _ = w.Write([]byte(`x-arcane:- icon: https://cdn.example/download.png-services:+ _, _ = w.Write([]byte(`services:app:image: nginx:alpine`))case "/template.env":- _, _ = w.Write([]byte("DOWNLOAD_ICON=https://cdn.example/download.png\n"))+ _, _ = w.Write([]byte("APP_PORT=8080\n"))default:http.NotFound(w, r)}@@ -211,9 +205,10 @@ services:IsCustom: false,RegistryID: mo.EmptyableToOption(strings.TrimSpace("reg-1")).ToPointer(),Metadata: &ComposeTemplateMetadata{- RemoteURL: mo.EmptyableToOption(strings.TrimSpace(baseURL + "/compose.yaml")).ToPointer(),- EnvURL: mo.EmptyableToOption(strings.TrimSpace(baseURL + "/template.env")).ToPointer(),- IconURL: mo.EmptyableToOption(strings.TrimSpace("https://cdn.example/download.png")).ToPointer(),+ RemoteURL: mo.EmptyableToOption(strings.TrimSpace(baseURL + "/compose.yaml")).ToPointer(),+ EnvURL: mo.EmptyableToOption(strings.TrimSpace(baseURL + "/template.env")).ToPointer(),+ IconURL: mo.EmptyableToOption(strings.TrimSpace("https://cdn.example/download.png")).ToPointer(),+ RegistryIconURL: mo.EmptyableToOption(strings.TrimSpace("https://cdn.example/download.png")).ToPointer(),},}@@ -230,6 +225,25 @@ services:require.NotNil(t, stored.Metadata)require.NotNil(t, stored.Metadata.IconURL)require.Equal(t, "https://cdn.example/download.png", *stored.Metadata.IconURL)++ // Filesystem sync and parsed content must not clear the registry icon.+ content, err := service.GetTemplateContentWithParsedData(t.Context(), downloaded.ID)+ require.NoError(t, err)+ require.NotNil(t, content.Template.Metadata)+ require.NotNil(t, content.Template.Metadata.IconURL)+ require.Equal(t, "https://cdn.example/download.png", *content.Template.Metadata.IconURL)++ // A compose icon wins, and removing it restores the registry icon.+ for _, tc := range []struct{ compose, icon string }{+ {"x-arcane:\n icon: https://cdn.example/compose.png\nservices:\n app:\n image: nginx:alpine\n", "https://cdn.example/compose.png"},+ {"services:\n app:\n image: nginx:alpine\n", "https://cdn.example/download.png"},+ } {+ require.NoError(t, service.UpdateTemplate(t.Context(), downloaded.ID, &ComposeTemplate{Name: stored.Name, Description: stored.Description, Content: tc.compose}))+ require.NoError(t, service.db.WithContext(t.Context()).First(&stored, "id = ?", downloaded.ID).Error)+ require.NotNil(t, stored.Metadata)+ require.NotNil(t, stored.Metadata.IconURL)+ require.Equal(t, tc.icon, *stored.Metadata.IconURL)+ }}func TestGetAllTemplatesPaginated_FiltersByType(t *testing.T) {diff --git a/backend/resources/migrations/postgres/093_add_template_registry_icon_url.sql b/backend/resources/migrations/postgres/093_add_template_registry_icon_url.sqlnew file mode 100644index 000000000..111b94f0c--- /dev/null+++ b/backend/resources/migrations/postgres/093_add_template_registry_icon_url.sql@@ -0,0 +1,5 @@+-- +goose Up+ALTER TABLE compose_templates ADD COLUMN IF NOT EXISTS meta_registry_icon_url TEXT;++-- +goose Down+ALTER TABLE compose_templates DROP COLUMN IF EXISTS meta_registry_icon_url;diff --git a/backend/resources/migrations/sqlite/093_add_template_registry_icon_url.sql b/backend/resources/migrations/sqlite/093_add_template_registry_icon_url.sqlnew file mode 100644index 000000000..6e60585f8--- /dev/null+++ b/backend/resources/migrations/sqlite/093_add_template_registry_icon_url.sql@@ -0,0 +1,5 @@+-- +goose Up+ALTER TABLE compose_templates ADD COLUMN meta_registry_icon_url TEXT;++-- +goose Down+ALTER TABLE compose_templates DROP COLUMN meta_registry_icon_url;diff --git a/types/meta/template_meta.go b/types/meta/template_meta.goindex 0f004fee4..f2c172ae0 100644--- a/types/meta/template_meta.go+++ b/types/meta/template_meta.go@@ -32,7 +32,7 @@ type TemplateMeta struct {// Required: falseDocumentationURL *string `json:"documentationUrl,omitempty"`- // IconURL is the URL to the template icon extracted from x-arcane metadata.+ // IconURL is the URL to the template icon, from the registry's icon_url for remote templates or x-arcane metadata for local ones.//// Required: falseIconURL *string `json:"iconUrl,omitempty"`diff --git a/types/template/template.go b/types/template/template.goindex ca1f542ac..cb3c716b8 100644--- a/types/template/template.go+++ b/types/template/template.go@@ -52,6 +52,11 @@ type RemoteTemplate struct {// Required: trueDocumentationURL string `json:"documentation_url"`+ // IconURL is the URL to the template icon.+ //+ // Required: false+ IconURL string `json:"icon_url,omitempty"`+// Tags is a list of tags associated with the template.//// Required: true