Merge pull request #216 from umbraco/feature/algolia-geoloc-support

acoumb · web-flow · commit 4d8da8098582 · 2024-09-19T12:46:21.000+03:00
Add Algolia geolocation service
diff --git a/src/Umbraco.Cms.Integrations.Search.Algolia/AlgoliaComposer.cs b/src/Umbraco.Cms.Integrations.Search.Algolia/AlgoliaComposer.cs
@@ -37,6 +37,8 @@ public void Compose(IUmbracoBuilder builder)
 
             builder.Services.AddScoped<IAlgoliaSearchPropertyIndexValueFactory, AlgoliaSearchPropertyIndexValueFactory>();
 
+            builder.Services.AddSingleton<IAlgoliaGeolocationProvider, AlgoliaNullGeolocationProvider>();
+
             builder.AddAlgoliaConverters();
         }
 
diff --git a/src/Umbraco.Cms.Integrations.Search.Algolia/Builders/ContentRecordBuilder.cs b/src/Umbraco.Cms.Integrations.Search.Algolia/Builders/ContentRecordBuilder.cs
@@ -3,7 +3,6 @@
 using Umbraco.Cms.Core.Routing;
 using Umbraco.Cms.Core.Services;
 using Umbraco.Cms.Core.Web;
-using Umbraco.Cms.Integrations.Search.Algolia.Extensions;
 using Umbraco.Cms.Integrations.Search.Algolia.Models;
 using Umbraco.Cms.Integrations.Search.Algolia.Services;
 using Umbraco.Extensions;
@@ -24,10 +23,15 @@ public class ContentRecordBuilder
 
         private readonly IUmbracoContextFactory _umbracoContextFactory;
 
-        public ContentRecordBuilder(IUserService userService, IPublishedUrlProvider urlProvider, 
+        private readonly IAlgoliaGeolocationProvider _algoliaGeolocationProvider;
+
+        public ContentRecordBuilder(
+            IUserService userService, 
+            IPublishedUrlProvider urlProvider, 
             IAlgoliaSearchPropertyIndexValueFactory algoliaSearchPropertyIndexValueFactory, 
             IRecordBuilderFactory recordBuilderFactory,
-            IUmbracoContextFactory umbracoContextFactory)
+            IUmbracoContextFactory umbracoContextFactory,
+            IAlgoliaGeolocationProvider algoliaGeolocationProvider)
         {
             _userService = userService;
 
@@ -38,6 +42,8 @@ public ContentRecordBuilder(IUserService userService, IPublishedUrlProvider urlP
             _recordBuilderFactory = recordBuilderFactory;
 
             _umbracoContextFactory = umbracoContextFactory;
+
+            _algoliaGeolocationProvider = algoliaGeolocationProvider;
         }
 
         public ContentRecordBuilder BuildFromContent(IContent content, Func<IProperty, bool> filter = null)
@@ -64,6 +70,7 @@ public ContentRecordBuilder BuildFromContent(IContent content, Func<IProperty, b
             _record.Path = content.Path.Split(',').ToList();
             _record.ContentTypeAlias = content.ContentType.Alias;
             _record.Url = _urlProvider.GetUrl(content.Id);
+            _record.GeolocationData = _algoliaGeolocationProvider.GetGeolocationAsync().ConfigureAwait(false).GetAwaiter().GetResult();
             _record.Data = new();
 
             if (content.PublishedCultures.Count() > 0)
diff --git a/src/Umbraco.Cms.Integrations.Search.Algolia/Controllers/SearchController.cs b/src/Umbraco.Cms.Integrations.Search.Algolia/Controllers/SearchController.cs
@@ -37,6 +37,8 @@ public class SearchController : UmbracoAuthorizedApiController
 
         private readonly IAlgoliaSearchPropertyIndexValueFactory _algoliaSearchPropertyIndexValueFactory;
 
+        private readonly IAlgoliaGeolocationProvider _algoliaGeolocationProvider;
+
         private readonly IUmbracoContextFactory _umbracoContextFactory;
 
         private readonly ILogger<SearchController> _logger;
@@ -53,7 +55,8 @@ public SearchController(
             IAlgoliaSearchPropertyIndexValueFactory algoliaSearchPropertyIndexValueFactory,
             IUmbracoContextFactory umbracoContextFactory, 
             ILogger<SearchController> logger, 
-            IRecordBuilderFactory recordBuilderFactory)
+            IRecordBuilderFactory recordBuilderFactory,
+            IAlgoliaGeolocationProvider algoliaGeolocationProvider)
         {
             _indexService = indexService;
             
@@ -74,6 +77,8 @@ public SearchController(
             _logger = logger;
 
             _recordBuilderFactory = recordBuilderFactory;
+
+            _algoliaGeolocationProvider = algoliaGeolocationProvider;
         }
 
         [HttpGet]
@@ -136,7 +141,13 @@ public async Task<IActionResult> BuildIndex([FromBody] IndexConfiguration indexC
 
                     foreach (var contentItem in contentItems.Where(p => !p.Trashed))
                     {
-                        var record = new ContentRecordBuilder(_userService, _urlProvider, _algoliaSearchPropertyIndexValueFactory, _recordBuilderFactory, _umbracoContextFactory)
+                        var record = new ContentRecordBuilder(
+                                _userService, 
+                                _urlProvider, 
+                                _algoliaSearchPropertyIndexValueFactory, 
+                                _recordBuilderFactory, 
+                                _umbracoContextFactory,
+                                _algoliaGeolocationProvider)
                             .BuildFromContent(contentItem, (p) => contentDataItem.Properties.Any(q => q.Alias == p.Alias))
                             .Build();
 
diff --git a/src/Umbraco.Cms.Integrations.Search.Algolia/Handlers/AlgoliaContentCacheRefresherHandler.cs b/src/Umbraco.Cms.Integrations.Search.Algolia/Handlers/AlgoliaContentCacheRefresherHandler.cs
@@ -35,6 +35,8 @@ public class AlgoliaContentCacheRefresherHandler : INotificationAsyncHandler<Con
 
         private readonly IAlgoliaSearchPropertyIndexValueFactory _algoliaSearchPropertyIndexValueFactory;
 
+        private readonly IAlgoliaGeolocationProvider _algoliaGeolocationProvider;
+
         private readonly IRecordBuilderFactory _recordBuilderFactory;
 
         private readonly IUmbracoContextFactory _umbracoContextFactory;
@@ -48,6 +50,7 @@ public AlgoliaContentCacheRefresherHandler(
             IUserService userService,
             IPublishedUrlProvider urlProvider,
             IAlgoliaSearchPropertyIndexValueFactory algoliaSearchPropertyIndexValueFactory, 
+            IAlgoliaGeolocationProvider algoliaGeolocationProvider,
             IRecordBuilderFactory recordBuilderFactory,
             IUmbracoContextFactory umbracoContextFactory)
         {
@@ -59,6 +62,7 @@ public AlgoliaContentCacheRefresherHandler(
             _userService = userService;
             _urlProvider = urlProvider;
             _algoliaSearchPropertyIndexValueFactory = algoliaSearchPropertyIndexValueFactory;
+            _algoliaGeolocationProvider = algoliaGeolocationProvider;
             _recordBuilderFactory = recordBuilderFactory;
             _umbracoContextFactory = umbracoContextFactory;
         }
@@ -107,7 +111,13 @@ protected async Task RebuildIndex(IEnumerable<IContent> entities)
                             .FirstOrDefault(p => p.ContentType.Alias == entity.ContentType.Alias);
                         if (indexConfiguration == null || indexConfiguration.ContentType.Alias != entity.ContentType.Alias) continue;
 
-                        var record = new ContentRecordBuilder(_userService, _urlProvider, _algoliaSearchPropertyIndexValueFactory, _recordBuilderFactory, _umbracoContextFactory)
+                        var record = new ContentRecordBuilder(
+                                _userService, 
+                                _urlProvider, 
+                                _algoliaSearchPropertyIndexValueFactory, 
+                                _recordBuilderFactory, 
+                                _umbracoContextFactory,
+                                _algoliaGeolocationProvider)
                            .BuildFromContent(entity, (p) => indexConfiguration.Properties.Any(q => q.Alias == p.Alias))
                            .Build();
 
diff --git a/src/Umbraco.Cms.Integrations.Search.Algolia/Models/GeolocationEntity.cs b/src/Umbraco.Cms.Integrations.Search.Algolia/Models/GeolocationEntity.cs
@@ -2,7 +2,7 @@
 
 namespace Umbraco.Cms.Integrations.Search.Algolia.Models
 {
-    public class GeolocProperties
+    public class GeolocationEntity
     {
         [JsonProperty("lat")]
         public double Latitude { get; set; }
diff --git a/src/Umbraco.Cms.Integrations.Search.Algolia/Models/Record.cs b/src/Umbraco.Cms.Integrations.Search.Algolia/Models/Record.cs
@@ -7,7 +7,7 @@ public class Record
         public Record()
         {
             Data = new Dictionary<string, object>();
-            Geoloc = new List<GeolocProperties>();
+            GeolocationData = new List<GeolocationEntity>();
         }
 
         public Record(Record record)
@@ -25,7 +25,7 @@ public Record(Record record)
             Path = record.Path;
             Url = record.Url;
             Data = record.Data;
-            Geoloc = record.Geoloc;
+            GeolocationData = record.GeolocationData;
         }
 
         public string ObjectID { get; set; }
@@ -63,7 +63,7 @@ public Record(Record record)
         public string Url { get; set; }
 
         [JsonProperty("_geoloc")]
-        public List<GeolocProperties> Geoloc { get; set; }
+        public List<GeolocationEntity> GeolocationData { get; set; }
 
         public Dictionary<string, object> Data { get; set; }
     }
diff --git a/src/Umbraco.Cms.Integrations.Search.Algolia/Services/AlgoliaIndexService.cs b/src/Umbraco.Cms.Integrations.Search.Algolia/Services/AlgoliaIndexService.cs
@@ -11,10 +11,12 @@ namespace Umbraco.Cms.Integrations.Search.Algolia.Services
     public class AlgoliaIndexService : IAlgoliaIndexService
     {
         private readonly AlgoliaSettings _settings;
+        private readonly IAlgoliaGeolocationProvider _algoliaGeolocationProvider;
 
-        public AlgoliaIndexService(IOptions<AlgoliaSettings> options)
+        public AlgoliaIndexService(IOptions<AlgoliaSettings> options, IAlgoliaGeolocationProvider algoliaGeolocationProvider)
         {
             _settings = options.Value;
+            _algoliaGeolocationProvider = algoliaGeolocationProvider;
         }
 
         public async Task<Result> PushData(string name, List<Record> payload = null)
@@ -30,6 +32,7 @@ await index.SaveObjectsAsync(payload != null
                     : new List<Record> {
                         new Record {
                             ObjectID = Guid.NewGuid().ToString(),
+                            GeolocationData = await _algoliaGeolocationProvider.GetGeolocationAsync(),
                             Data = new Dictionary<string, object>()}
                     }, autoGenerateObjectId: false);
 
diff --git a/src/Umbraco.Cms.Integrations.Search.Algolia/Services/AlgoliaNullGeolocationProvider.cs b/src/Umbraco.Cms.Integrations.Search.Algolia/Services/AlgoliaNullGeolocationProvider.cs
@@ -0,0 +1,9 @@
+﻿using Umbraco.Cms.Integrations.Search.Algolia.Models;
+
+namespace Umbraco.Cms.Integrations.Search.Algolia.Services
+{
+    public class AlgoliaNullGeolocationProvider : IAlgoliaGeolocationProvider
+    {
+        public async Task<List<GeolocationEntity>> GetGeolocationAsync() => null;
+    }
+}
diff --git a/src/Umbraco.Cms.Integrations.Search.Algolia/Services/IAlgoliaGeolocationProvider.cs b/src/Umbraco.Cms.Integrations.Search.Algolia/Services/IAlgoliaGeolocationProvider.cs
@@ -0,0 +1,9 @@
+﻿using Umbraco.Cms.Integrations.Search.Algolia.Models;
+
+namespace Umbraco.Cms.Integrations.Search.Algolia.Services
+{
+    public interface IAlgoliaGeolocationProvider
+    {
+        Task<List<GeolocationEntity>> GetGeolocationAsync();
+    }
+}
diff --git a/src/Umbraco.Cms.Integrations.Search.Algolia/Umbraco.Cms.Integrations.Search.Algolia.csproj b/src/Umbraco.Cms.Integrations.Search.Algolia/Umbraco.Cms.Integrations.Search.Algolia.csproj
@@ -13,7 +13,7 @@
 		<PackageIconUrl></PackageIconUrl>
 		<PackageProjectUrl>https://github.com/umbraco/Umbraco.Cms.Integrations/tree/main/src/Umbraco.Cms.Integrations.Search.Algolia</PackageProjectUrl>
 		<RepositoryUrl>https://github.com/umbraco/Umbraco.Cms.Integrations</RepositoryUrl>
-		<Version>2.2.2</Version>
+		<Version>2.3.0</Version>
 		<Authors>Umbraco HQ</Authors>
 		<Company>Umbraco</Company>
 		<PackageTags>Umbraco;Umbraco-Marketplace</PackageTags>

Original file line number	Diff line number	Diff line change
`@@ -37,6 +37,8 @@ public void Compose(IUmbracoBuilder builder)`
`37`	`37`
`38`	`38`	`builder.Services.AddScoped<IAlgoliaSearchPropertyIndexValueFactory, AlgoliaSearchPropertyIndexValueFactory>();`
`39`	`39`
	`40`	`+ builder.Services.AddSingleton<IAlgoliaGeolocationProvider, AlgoliaNullGeolocationProvider>();`
	`41`	`+`
`40`	`42`	`builder.AddAlgoliaConverters();`
`41`	`43`	`}`
`42`	`44`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`
`3`	`3`	`namespace Umbraco.Cms.Integrations.Search.Algolia.Models`
`4`	`4`	`{`
`5`		`- public class GeolocProperties`
	`5`	`+ public class GeolocationEntity`
`6`	`6`	`{`
`7`	`7`	`[JsonProperty("lat")]`
`8`	`8`	`public double Latitude { get; set; }`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@ public class Record`
`7`	`7`	`public Record()`
`8`	`8`	`{`
`9`	`9`	`Data = new Dictionary<string, object>();`
`10`		`- Geoloc = new List<GeolocProperties>();`
	`10`	`+ GeolocationData = new List<GeolocationEntity>();`
`11`	`11`	`}`
`12`	`12`
`13`	`13`	`public Record(Record record)`
`@@ -25,7 +25,7 @@ public Record(Record record)`
`25`	`25`	`Path = record.Path;`
`26`	`26`	`Url = record.Url;`
`27`	`27`	`Data = record.Data;`
`28`		`- Geoloc = record.Geoloc;`
	`28`	`+ GeolocationData = record.GeolocationData;`
`29`	`29`	`}`
`30`	`30`
`31`	`31`	`public string ObjectID { get; set; }`
`@@ -63,7 +63,7 @@ public Record(Record record)`
`63`	`63`	`public string Url { get; set; }`
`64`	`64`
`65`	`65`	`[JsonProperty("_geoloc")]`
`66`		`- public List<GeolocProperties> Geoloc { get; set; }`
	`66`	`+ public List<GeolocationEntity> GeolocationData { get; set; }`
`67`	`67`
`68`	`68`	`public Dictionary<string, object> Data { get; set; }`
`69`	`69`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,10 +11,12 @@ namespace Umbraco.Cms.Integrations.Search.Algolia.Services`
`11`	`11`	`public class AlgoliaIndexService : IAlgoliaIndexService`
`12`	`12`	`{`
`13`	`13`	`private readonly AlgoliaSettings _settings;`
	`14`	`+ private readonly IAlgoliaGeolocationProvider _algoliaGeolocationProvider;`
`14`	`15`
`15`		`- public AlgoliaIndexService(IOptions<AlgoliaSettings> options)`
	`16`	`+ public AlgoliaIndexService(IOptions<AlgoliaSettings> options, IAlgoliaGeolocationProvider algoliaGeolocationProvider)`
`16`	`17`	`{`
`17`	`18`	`_settings = options.Value;`
	`19`	`+ _algoliaGeolocationProvider = algoliaGeolocationProvider;`
`18`	`20`	`}`
`19`	`21`
`20`	`22`	`public async Task<Result> PushData(string name, List<Record> payload = null)`
`@@ -30,6 +32,7 @@ await index.SaveObjectsAsync(payload != null`
`30`	`32`	`: new List<Record> {`
`31`	`33`	`new Record {`
`32`	`34`	`ObjectID = Guid.NewGuid().ToString(),`
	`35`	`+ GeolocationData = await _algoliaGeolocationProvider.GetGeolocationAsync(),`
`33`	`36`	`Data = new Dictionary<string, object>()}`
`34`	`37`	`}, autoGenerateObjectId: false);`
`35`	`38`