Use a CollectionBuilder to register FeedGenerators. Updated Backend implementation to obtain IProductFeedGeneratorService instances via this collection.

Ben White · Ben White · commit fbeafa5dfe32 · 2025-05-23T15:45:08.000+01:00
diff --git a/src/Umbraco.Commerce.ProductFeeds.Core/Features/FeedGenerators/Application/IProductFeedGeneratorFactory.cs b/src/Umbraco.Commerce.ProductFeeds.Core/Features/FeedGenerators/Application/IProductFeedGeneratorFactory.cs
@@ -4,6 +4,6 @@ namespace Umbraco.Commerce.ProductFeeds.Core.Features.FeedGenerators.Application
 {
     public interface IProductFeedGeneratorFactory
     {
-        IProductFeedGeneratorService GetGenerator(ProductFeedType feedType);
+        IProductFeedGeneratorService GetGenerator(string feedGeneratorId);
     }
 }
diff --git a/src/Umbraco.Commerce.ProductFeeds.Core/Features/FeedGenerators/Application/IProductFeedGeneratorService.cs b/src/Umbraco.Commerce.ProductFeeds.Core/Features/FeedGenerators/Application/IProductFeedGeneratorService.cs
@@ -5,6 +5,15 @@ namespace Umbraco.Commerce.ProductFeeds.Core.Features.FeedGenerators.Application
 {
     public interface IProductFeedGeneratorService
     {
+        /// <summary>
+        /// Returns the value extractor id. Must be unique.
+        /// </summary>
+        public string Id { get; }
+
+        /// <summary>
+        /// Returns a user friendly name of the value extractor.
+        /// </summary>
+        public string DisplayName { get; }
         Task<XmlDocument> GenerateFeedAsync(ProductFeedSettingReadModel feedSetting);
     }
 }
diff --git a/src/Umbraco.Commerce.ProductFeeds.Core/Features/FeedGenerators/Implementations/FeedGeneratorCollection.cs b/src/Umbraco.Commerce.ProductFeeds.Core/Features/FeedGenerators/Implementations/FeedGeneratorCollection.cs
@@ -0,0 +1,12 @@
+using Umbraco.Cms.Core.Composing;
+using Umbraco.Commerce.ProductFeeds.Core.Features.FeedGenerators.Application;
+
+namespace Umbraco.Commerce.ProductFeeds.Core.Features.FeedGenerators.Implementations
+{
+    public class FeedGeneratorCollection : BuilderCollectionBase<IProductFeedGeneratorService>
+    {
+        public FeedGeneratorCollection(Func<IEnumerable<IProductFeedGeneratorService>> items) : base(items)
+        {
+        }
+    }
+}
diff --git a/src/Umbraco.Commerce.ProductFeeds.Core/Features/FeedGenerators/Implementations/FeedGeneratorCollectionBuilder.cs b/src/Umbraco.Commerce.ProductFeeds.Core/Features/FeedGenerators/Implementations/FeedGeneratorCollectionBuilder.cs
@@ -0,0 +1,17 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+using Microsoft.Extensions.DependencyInjection;
+using Umbraco.Cms.Core.Composing;
+using Umbraco.Commerce.ProductFeeds.Core.Features.FeedGenerators.Application;
+
+namespace Umbraco.Commerce.ProductFeeds.Core.Features.FeedGenerators.Implementations
+{
+    public class FeedGeneratorCollectionBuilder : OrderedCollectionBuilderBase<FeedGeneratorCollectionBuilder, FeedGeneratorCollection, IProductFeedGeneratorService>
+    {
+        protected override FeedGeneratorCollectionBuilder This => this;
+        protected override ServiceLifetime CollectionLifetime => ServiceLifetime.Scoped;
+    }
+}
diff --git a/src/Umbraco.Commerce.ProductFeeds.Core/Features/FeedGenerators/Implementations/GoogleMerchantCenterFeedService.cs b/src/Umbraco.Commerce.ProductFeeds.Core/Features/FeedGenerators/Implementations/GoogleMerchantCenterFeedService.cs
@@ -36,6 +36,10 @@ public class GoogleMerchantCenterFeedService : IProductFeedGeneratorService
         private readonly ISingleValuePropertyExtractorFactory _singleValuePropertyExtractorFactory;
         private readonly IMultipleValuePropertyExtractorFactory _multipleValuePropertyExtractorFactory;
 
+        public string Id => "GoogleMerchantCenter";
+
+        public string DisplayName => "Google Merchant Center Feed";
+
         public GoogleMerchantCenterFeedService(
             ILogger<GoogleMerchantCenterFeedService> logger,
             ICurrencyService currencyService,
diff --git a/src/Umbraco.Commerce.ProductFeeds.Core/Features/FeedGenerators/Implementations/ProductFeedGeneratorFactory.cs b/src/Umbraco.Commerce.ProductFeeds.Core/Features/FeedGenerators/Implementations/ProductFeedGeneratorFactory.cs
@@ -1,29 +1,26 @@
 using Microsoft.Extensions.DependencyInjection;
 using Umbraco.Commerce.ProductFeeds.Core.Features.FeedGenerators.Application;
-using Umbraco.Commerce.ProductFeeds.Core.Features.FeedSettings.Application;
 
 namespace Umbraco.Commerce.ProductFeeds.Core.Features.FeedGenerators.Implementations
 {
     public class ProductFeedGeneratorFactory : IProductFeedGeneratorFactory
     {
-        private readonly IServiceProvider _serviceProvider;
+        private readonly FeedGeneratorCollection _feedGenerators;
 
-        public ProductFeedGeneratorFactory(IServiceProvider serviceProvider)
+        public ProductFeedGeneratorFactory(FeedGeneratorCollection feedGenerators)
         {
-            _serviceProvider = serviceProvider;
+            _feedGenerators = feedGenerators;
         }
 
-        public IProductFeedGeneratorService GetGenerator(ProductFeedType feedType)
+        public IProductFeedGeneratorService GetGenerator(string feedGeneratorId)
         {
-            switch (feedType)
-            {
-                case ProductFeedType.GoogleMerchantCenter:
-                    return _serviceProvider.GetRequiredService<GoogleMerchantCenterFeedService>();
+            IProductFeedGeneratorService? feedGenerator = _feedGenerators.FirstOrDefault(p => p.Id == feedGeneratorId);
 
-                default:
-                    throw new InvalidOperationException($"Invalid feed type: {feedType}");
+            if (feedGenerator == null)
+            {
+                throw new InvalidOperationException($"Invalid feed id: {feedGeneratorId}");
             }
-
+            return feedGenerator;
         }
     }
 }
diff --git a/src/Umbraco.Commerce.ProductFeeds.Core/Features/FeedSettings/Application/ProductFeedSettingReadModel.cs b/src/Umbraco.Commerce.ProductFeeds.Core/Features/FeedSettings/Application/ProductFeedSettingReadModel.cs
@@ -7,9 +7,7 @@ public class ProductFeedSettingReadModel
     {
         public Guid Id { get; set; }
 
-        public ProductFeedType FeedType { get; set; }
-
-        public string FeedTypeName => FeedType.GetDescription();
+        public required string FeedGeneratorId { get; set; }
 
         public required string FeedName { get; set; }
 
diff --git a/src/Umbraco.Commerce.ProductFeeds.Core/Features/FeedSettings/Application/ProductFeedSettingWriteModel.cs b/src/Umbraco.Commerce.ProductFeeds.Core/Features/FeedSettings/Application/ProductFeedSettingWriteModel.cs
@@ -1,3 +1,5 @@
+using System.Runtime.Serialization;
+
 namespace Umbraco.Commerce.ProductFeeds.Core.Features.FeedSettings.Application
 {
     public class ProductFeedSettingWriteModel
@@ -6,7 +8,7 @@ public class ProductFeedSettingWriteModel
 
         public required string FeedRelativePath { get; set; }
 
-        public ProductFeedType? FeedType { get; set; }
+        public required string FeedGeneratorId { get; set; }
 
         public required string FeedName { get; set; }
 
diff --git a/src/Umbraco.Commerce.ProductFeeds.Core/Features/FeedSettings/Application/ProductFeedSettingWriteModelValidator.cs b/src/Umbraco.Commerce.ProductFeeds.Core/Features/FeedSettings/Application/ProductFeedSettingWriteModelValidator.cs
@@ -11,7 +11,7 @@ public ProductFeedSettingWriteModelValidator()
             RuleFor(x => x.FeedName).NotEmpty().WithName("Feed Name");
             RuleFor(x => x.FeedRelativePath).NotEmpty().WithName("Feed Relative Path");
             RuleFor(x => x.FeedDescription).MaximumLength(MaximumStringLength).WithName("Feed Description");
-            RuleFor(x => x.FeedType).NotEmpty().WithName("Feed Type");
+            RuleFor(x => x.FeedGeneratorId).NotEmpty().WithName("Feed Generator Id");
             RuleFor(x => x.StoreId).NotEmpty().WithName("Umbraco Commerce Store");
             RuleFor(x => x.ProductRootId).NotEmpty().WithName("Product Root");
             RuleFor(x => x.ProductDocumentTypeIds).NotEmpty().WithName("Product Document Types");
diff --git a/src/Umbraco.Commerce.ProductFeeds.Core/Features/FeedSettings/Application/ProductFeedType.cs b/src/Umbraco.Commerce.ProductFeeds.Core/Features/FeedSettings/Application/ProductFeedType.cs
diff --git a/src/Umbraco.Commerce.ProductFeeds.Infrastructure/DtoMappings/InfrastructureMappingProfile.cs b/src/Umbraco.Commerce.ProductFeeds.Infrastructure/DtoMappings/InfrastructureMappingProfile.cs
@@ -11,11 +11,13 @@ public InfrastructureMappingProfile()
         {
             CreateMap<ProductFeedSettingWriteModel, UmbracoCommerceProductFeedSetting>()
                 .ForSourceMember(src => src.PropertyNameMappings, opt => opt.DoNotValidate())
+                .ForMember(dest => dest.FeedType, opt => opt.MapFrom((src, dest) => src.FeedGeneratorId)) // TODO: Rename FeedType to FeedGeneratorId or similar
                 .ForMember(dest => dest.ProductPropertyNameMappings, opt => opt.MapFrom((src, dest) => JsonSerializer.Serialize(src.PropertyNameMappings)))
                 .ForMember(dest => dest.ProductChildVariantTypeIds, opt => opt.MapFrom((src, dest) => string.Join(';', src.ProductChildVariantTypeIds)))
                 .ForMember(dest => dest.ProductDocumentTypeIds, opt => opt.MapFrom((src, dest) => string.Join(';', src.ProductDocumentTypeIds)));
 
             CreateMap<UmbracoCommerceProductFeedSetting, ProductFeedSettingReadModel>()
+                .ForMember(dest => dest.FeedGeneratorId, opt => opt.MapFrom((src, dest) => src.FeedType)) // TODO: Rename FeedType to FeedGeneratorId or similar
                 .ForMember(dest => dest.PropertyNameMappings, opt => opt.MapFrom((src, dest) => JsonSerializer.Deserialize<ICollection<PropertyAndNodeMapItem>>(src.ProductPropertyNameMappings)))
                 .ForMember(dest => dest.ProductChildVariantTypeIds, opt => opt.MapFrom((src, dest) => !string.IsNullOrEmpty(src.ProductChildVariantTypeIds) ? src.ProductChildVariantTypeIds?.Split(';') : []))
                 .ForMember(dest => dest.ProductDocumentTypeIds, opt => opt.MapFrom((src, dest) => !string.IsNullOrEmpty(src.ProductDocumentTypeIds) ? src.ProductDocumentTypeIds.Split(';') : []));
diff --git a/src/Umbraco.Commerce.ProductFeeds.Infrastructure/Implementations/ProductFeedSettingsService.cs b/src/Umbraco.Commerce.ProductFeeds.Infrastructure/Implementations/ProductFeedSettingsService.cs
@@ -4,6 +4,7 @@
 using Microsoft.Extensions.Logging;
 using Umbraco.Cms.Infrastructure.Scoping;
 using Umbraco.Cms.Web.Common;
+using Umbraco.Commerce.ProductFeeds.Core.Features.FeedGenerators.Implementations;
 using Umbraco.Commerce.ProductFeeds.Core.Features.FeedSettings.Application;
 using Umbraco.Commerce.ProductFeeds.Infrastructure.DbModels;
 
@@ -15,17 +16,20 @@ internal class ProductFeedSettingsService : IProductFeedSettingsService
         private readonly IMapper _mapper;
         private readonly ILogger<ProductFeedSettingsService> _logger;
         private readonly UmbracoHelper _umbracoHelper;
+        private readonly FeedGeneratorCollection _feedGenerators;
 
         public ProductFeedSettingsService(
             IScopeProvider scopeProvider,
             IMapper mapper,
             ILogger<ProductFeedSettingsService> logger,
-            UmbracoHelper umbracoHelper)
+            UmbracoHelper umbracoHelper,
+            FeedGeneratorCollection feedGenerators)
         {
             _scopeProvider = scopeProvider;
             _mapper = mapper;
             _logger = logger;
             _umbracoHelper = umbracoHelper;
+            _feedGenerators = feedGenerators;
         }
 
         /// <inheritdoc/>
@@ -53,7 +57,7 @@ from umbracoCommerceProductFeedSetting
                     return null;
                 }
 
-                if (!Enum.TryParse(feedSetting.FeedType, true, out ProductFeedType feedType))
+                if(_feedGenerators.Where(p=>p.Id == feedSetting.FeedType).Any() == false)
                 {
                     throw new InvalidOperationException($"Unknown feed type: '{feedSetting.FeedType}'.");
                 }
diff --git a/src/Umbraco.Commerce.ProductFeeds.Startup/Initializations/IUmbracoCommerceBuilderExtensions.cs b/src/Umbraco.Commerce.ProductFeeds.Startup/Initializations/IUmbracoCommerceBuilderExtensions.cs
@@ -42,6 +42,8 @@ public static IUmbracoCommerceBuilder AddCommerceProductFeeds(this IUmbracoComme
 
         public static MultipleValuePropertyExtractorCollectionBuilder MultipleValuePropertyExtractors(this IUmbracoCommerceBuilder builder) => builder.WithUmbracoBuilder().WithCollectionBuilder<MultipleValuePropertyExtractorCollectionBuilder>();
 
+        public static FeedGeneratorCollectionBuilder FeedGenerators(this IUmbracoCommerceBuilder builder) => builder.WithUmbracoBuilder().WithCollectionBuilder<FeedGeneratorCollectionBuilder>();
+
         private static IUmbracoCommerceBuilder AddDbMigrations(this IUmbracoCommerceBuilder builder)
         {
             builder.WithUmbracoBuilder().AddNotificationHandler<UmbracoApplicationStartingNotification, RunDbMigrations>();
@@ -58,11 +60,13 @@ private static void AddServices(this IUmbracoCommerceBuilder builder)
         {
             IServiceCollection services = builder.Services;
             services.AddScoped<IProductFeedGeneratorFactory, ProductFeedGeneratorFactory>();
-            services.AddScoped<GoogleMerchantCenterFeedService>();
 
             services.AddScoped<IProductFeedSettingsService, ProductFeedSettingsService>();
             services.AddScoped<IProductQueryService, ProductQueryService>();
 
+            builder.FeedGenerators()
+                .Append<GoogleMerchantCenterFeedService>();
+
             builder.SingleValuePropertyExtractors()
                 .Append<DefaultSingleValuePropertyExtractor>()
                 .Append<DefaultGoogleAvailabilityValueExtractor>()
diff --git a/src/Umbraco.Commerce.ProductFeeds.Web/Apis/Backoffice/Controllers/ProductFeedSettingController.cs b/src/Umbraco.Commerce.ProductFeeds.Web/Apis/Backoffice/Controllers/ProductFeedSettingController.cs
@@ -15,6 +15,7 @@
 using Umbraco.Commerce.Cms.Authorization;
 using Umbraco.Commerce.Extensions;
 using Umbraco.Commerce.ProductFeeds.Core.Common.Constants;
+using Umbraco.Commerce.ProductFeeds.Core.Features.FeedGenerators.Implementations;
 using Umbraco.Commerce.ProductFeeds.Core.Features.FeedSettings.Application;
 using Umbraco.Commerce.ProductFeeds.Core.Features.PropertyValueExtractors.Implementations;
 using Umbraco.Commerce.ProductFeeds.Web.Apis.Backoffice;
@@ -33,17 +34,20 @@ public class ProductFeedSettingController : ManagementApiControllerBase
         private readonly IContentTypeService _contentTypeService;
         private readonly SingleValuePropertyExtractorCollection _singleValuePropertyExtractors;
         private readonly MultipleValuePropertyExtractorCollection _multipleValuePropertyExtractors;
+        private readonly FeedGeneratorCollection _feedGenerators;
 
         public ProductFeedSettingController(
             IProductFeedSettingsService feedConfigService,
             IContentTypeService contentTypeService,
             SingleValuePropertyExtractorCollection singleValuePropertyExtractors,
-            MultipleValuePropertyExtractorCollection multipleValuePropertyExtractors)
+            MultipleValuePropertyExtractorCollection multipleValuePropertyExtractors,
+            FeedGeneratorCollection feedGenerators)
         {
             _feedSettingsService = feedConfigService;
             _contentTypeService = contentTypeService;
             _singleValuePropertyExtractors = singleValuePropertyExtractors;
             _multipleValuePropertyExtractors = multipleValuePropertyExtractors;
+            _feedGenerators = feedGenerators;
         }
 
         [HttpPost("save")]
@@ -126,14 +130,7 @@ public IActionResult GetDocumentTypes()
         [HttpGet("feedtypes")]
         public ActionResult<IEnumerable<LookupReadModel>> GetFeedTypes()
         {
-            return Ok(new LookupReadModel[]
-            {
-                new LookupReadModel
-                {
-                    Value = ProductFeedType.GoogleMerchantCenter.ToString(),
-                    Label = ProductFeedType.GoogleMerchantCenter.GetDescription(),
-                },
-            });
+            return Ok(_feedGenerators.Select(x => new LookupReadModel { Value = x.Id, Label = x.DisplayName }));
         }
 
         [Route("[action]")]
diff --git a/src/Umbraco.Commerce.ProductFeeds.Web/Apis/Publics/ProductFeedController.cs b/src/Umbraco.Commerce.ProductFeeds.Web/Apis/Publics/ProductFeedController.cs
@@ -29,7 +29,7 @@ public async Task<IActionResult> Xml(string path)
                 return NotFound("Unknown feed type.");
             }
 
-            IProductFeedGeneratorService feedGenerator = _feedGeneratorFactory.GetGenerator(feedSettings.FeedType);
+            IProductFeedGeneratorService feedGenerator = _feedGeneratorFactory.GetGenerator(feedSettings.FeedGeneratorId);
             XmlDocument feed = await feedGenerator.GenerateFeedAsync(feedSettings);
 
             var result = new XmlActionResult(feed) { Formatting = Formatting.Indented };

Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,6 @@ namespace Umbraco.Commerce.ProductFeeds.Core.Features.FeedGenerators.Application`
`4`	`4`	`{`
`5`	`5`	`public interface IProductFeedGeneratorFactory`
`6`	`6`	`{`
`7`		`- IProductFeedGeneratorService GetGenerator(ProductFeedType feedType);`
	`7`	`+ IProductFeedGeneratorService GetGenerator(string feedGeneratorId);`
`8`	`8`	`}`
`9`	`9`	`}`
Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,15 @@ namespace Umbraco.Commerce.ProductFeeds.Core.Features.FeedGenerators.Application`
`5`	`5`	`{`
`6`	`6`	`public interface IProductFeedGeneratorService`
`7`	`7`	`{`
	`8`	`+ /// <summary>`
	`9`	`+ /// Returns the value extractor id. Must be unique.`
	`10`	`+ /// </summary>`
	`11`	`+ public string Id { get; }`
	`12`	`+`
	`13`	`+ /// <summary>`
	`14`	`+ /// Returns a user friendly name of the value extractor.`
	`15`	`+ /// </summary>`
	`16`	`+ public string DisplayName { get; }`
`8`	`17`	`Task<XmlDocument> GenerateFeedAsync(ProductFeedSettingReadModel feedSetting);`
`9`	`18`	`}`
`10`	`19`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,29 +1,26 @@`
`1`	`1`	`using Microsoft.Extensions.DependencyInjection;`
`2`	`2`	`using Umbraco.Commerce.ProductFeeds.Core.Features.FeedGenerators.Application;`
`3`		`-using Umbraco.Commerce.ProductFeeds.Core.Features.FeedSettings.Application;`
`4`	`3`
`5`	`4`	`namespace Umbraco.Commerce.ProductFeeds.Core.Features.FeedGenerators.Implementations`
`6`	`5`	`{`
`7`	`6`	`public class ProductFeedGeneratorFactory : IProductFeedGeneratorFactory`
`8`	`7`	`{`
`9`		`- private readonly IServiceProvider _serviceProvider;`
	`8`	`+ private readonly FeedGeneratorCollection _feedGenerators;`
`10`	`9`
`11`		`- public ProductFeedGeneratorFactory(IServiceProvider serviceProvider)`
	`10`	`+ public ProductFeedGeneratorFactory(FeedGeneratorCollection feedGenerators)`
`12`	`11`	`{`
`13`		`- _serviceProvider = serviceProvider;`
	`12`	`+ _feedGenerators = feedGenerators;`
`14`	`13`	`}`
`15`	`14`
`16`		`- public IProductFeedGeneratorService GetGenerator(ProductFeedType feedType)`
	`15`	`+ public IProductFeedGeneratorService GetGenerator(string feedGeneratorId)`
`17`	`16`	`{`
`18`		`- switch (feedType)`
`19`		`- {`
`20`		`- case ProductFeedType.GoogleMerchantCenter:`
`21`		`- return _serviceProvider.GetRequiredService<GoogleMerchantCenterFeedService>();`
	`17`	`+ IProductFeedGeneratorService? feedGenerator = _feedGenerators.FirstOrDefault(p => p.Id == feedGeneratorId);`
`22`	`18`
`23`		`- default:`
`24`		`- throw new InvalidOperationException($"Invalid feed type: {feedType}");`
	`19`	`+ if (feedGenerator == null)`
	`20`	`+ {`
	`21`	`+ throw new InvalidOperationException($"Invalid feed id: {feedGeneratorId}");`
`25`	`22`	`}`
`26`		`-`
	`23`	`+ return feedGenerator;`
`27`	`24`	`}`
`28`	`25`	`}`
`29`	`26`	`}`
Original file line number	Diff line number	Diff line change
`@@ -7,9 +7,7 @@ public class ProductFeedSettingReadModel`
`7`	`7`	`{`
`8`	`8`	`public Guid Id { get; set; }`
`9`	`9`
`10`		`- public ProductFeedType FeedType { get; set; }`
`11`		`-`
`12`		`- public string FeedTypeName => FeedType.GetDescription();`
	`10`	`+ public required string FeedGeneratorId { get; set; }`
`13`	`11`
`14`	`12`	`public required string FeedName { get; set; }`
`15`	`13`