Merge pull request #217 from umbraco/feature/v14/algolia-geolocation

acoumb · web-flow · commit 23b897eeabb4 · 2024-09-19T12:46:08.000+03:00
Add geolocation extensibility for Algolia
diff --git a/src/Umbraco.Cms.Integrations.Search.Algolia/AlgoliaComposer.cs b/src/Umbraco.Cms.Integrations.Search.Algolia/AlgoliaComposer.cs
@@ -36,6 +36,8 @@ public void Compose(IUmbracoBuilder builder)
 
             builder.Services.AddScoped<IAlgoliaSearchPropertyIndexValueFactory, AlgoliaSearchPropertyIndexValueFactory>();
 
+            builder.Services.AddSingleton<IAlgoliaGeolocationProvider, AlgoliaNullGeolocationProvider>();
+
             builder.AddAlgoliaConverters();
 
             // Generate Swagger documentation for Algolia Search API
diff --git a/src/Umbraco.Cms.Integrations.Search.Algolia/Api/Management/Controllers/BuildIndexController.cs b/src/Umbraco.Cms.Integrations.Search.Algolia/Api/Management/Controllers/BuildIndexController.cs
@@ -27,6 +27,7 @@ public class BuildIndexController : SearchControllerBase
     private readonly IPublishedUrlProvider _urlProvider;
     private readonly IAlgoliaSearchPropertyIndexValueFactory _algoliaSearchPropertyIndexValueFactory;
     private readonly IRecordBuilderFactory _recordBuilderFactory;
+    private readonly IAlgoliaGeolocationProvider _algoliaGeolocationProvider;
 
     public BuildIndexController(
         IAlgoliaIndexDefinitionStorage<AlgoliaIndex> indexStorage,
@@ -37,7 +38,8 @@ public BuildIndexController(
         IUserService userService,
         IPublishedUrlProvider urlProvider,
         IAlgoliaSearchPropertyIndexValueFactory algoliaSearchPropertyIndexValueFactory,
-        IRecordBuilderFactory recordBuilderFactory)
+        IRecordBuilderFactory recordBuilderFactory,
+        IAlgoliaGeolocationProvider algoliaGeolocationProvider)
     {
         _indexStorage = indexStorage;
         _umbracoContextFactory = umbracoContextFactory;
@@ -48,6 +50,7 @@ public BuildIndexController(
         _urlProvider = urlProvider;
         _algoliaSearchPropertyIndexValueFactory = algoliaSearchPropertyIndexValueFactory;
         _recordBuilderFactory = recordBuilderFactory;
+        _algoliaGeolocationProvider = algoliaGeolocationProvider;
     }
 
     [HttpPost("index/build")]
@@ -82,7 +85,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/Builders/ContentRecordBuilder.cs b/src/Umbraco.Cms.Integrations.Search.Algolia/Builders/ContentRecordBuilder.cs
@@ -23,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;
 
@@ -37,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)
@@ -63,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/Handlers/AlgoliaContentCacheRefresherHandler.cs b/src/Umbraco.Cms.Integrations.Search.Algolia/Handlers/AlgoliaContentCacheRefresherHandler.cs
@@ -40,6 +40,8 @@ public class AlgoliaContentCacheRefresherHandler : INotificationAsyncHandler<Con
 
         private readonly IUmbracoContextFactory _umbracoContextFactory;
 
+        private readonly IAlgoliaGeolocationProvider _algoliaGeolocationProvider;
+
         public AlgoliaContentCacheRefresherHandler(
             IServerRoleAccessor serverRoleAccessor,
             ILogger<AlgoliaContentCacheRefresherHandler> logger,
@@ -50,7 +52,8 @@ public AlgoliaContentCacheRefresherHandler(
             IPublishedUrlProvider urlProvider,
             IAlgoliaSearchPropertyIndexValueFactory algoliaSearchPropertyIndexValueFactory, 
             IRecordBuilderFactory recordBuilderFactory,
-            IUmbracoContextFactory umbracoContextFactory)
+            IUmbracoContextFactory umbracoContextFactory,
+            IAlgoliaGeolocationProvider algoliaGeolocationProvider)
         {
             _serverRoleAccessor = serverRoleAccessor;
             _contentService = contentService;
@@ -62,6 +65,7 @@ public AlgoliaContentCacheRefresherHandler(
             _algoliaSearchPropertyIndexValueFactory = algoliaSearchPropertyIndexValueFactory;
             _recordBuilderFactory = recordBuilderFactory;
             _umbracoContextFactory = umbracoContextFactory;
+            _algoliaGeolocationProvider = algoliaGeolocationProvider;
         }
 
         public async Task HandleAsync(ContentCacheRefresherNotification notification, CancellationToken cancellationToken)
@@ -108,7 +112,13 @@ protected async Task RebuildIndex(IEnumerable<IContent> entities)
                             .FirstOrDefault(p => p.Alias == entity.ContentType.Alias);
                         if (indexConfiguration == null || indexConfiguration.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
@@ -0,0 +1,13 @@
+﻿using Newtonsoft.Json;
+
+namespace Umbraco.Cms.Integrations.Search.Algolia.Models
+{
+    public class GeolocationEntity
+    {
+        [JsonProperty("lat")]
+        public double Latitude { get; set; }
+
+        [JsonProperty("lng")]
+        public double Longitude { get; set; }
+    }
+}
diff --git a/src/Umbraco.Cms.Integrations.Search.Algolia/Models/Record.cs b/src/Umbraco.Cms.Integrations.Search.Algolia/Models/Record.cs
@@ -1,10 +1,13 @@
-﻿namespace Umbraco.Cms.Integrations.Search.Algolia.Models
+﻿using Newtonsoft.Json;
+
+namespace Umbraco.Cms.Integrations.Search.Algolia.Models
 {
     public class Record
     {
         public Record()
         {
             Data = new Dictionary<string, object>();
+            GeolocationData = new List<GeolocationEntity>();
         }
 
         public Record(Record record)
@@ -22,6 +25,7 @@ public Record(Record record)
             Path = record.Path;
             Url = record.Url;
             Data = record.Data;
+            GeolocationData = record.GeolocationData;
         }
 
         public string ObjectID { get; set; }
@@ -58,6 +62,9 @@ public Record(Record record)
 
         public string Url { get; set; }
 
+        [JsonProperty("_geoloc")]
+        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>3.0.1</Version>
+		<Version>3.1.0</Version>
 		<Authors>Umbraco HQ</Authors>
 		<Company>Umbraco</Company>
 		<PackageTags>Umbraco;Umbraco-Marketplace</PackageTags>

Original file line number	Diff line number	Diff line change
`@@ -1,10 +1,13 @@`
`1`		`-namespace Umbraco.Cms.Integrations.Search.Algolia.Models`
	`1`	`+using Newtonsoft.Json;`
	`2`	`+`
	`3`	`+namespace Umbraco.Cms.Integrations.Search.Algolia.Models`
`2`	`4`	`{`
`3`	`5`	`public class Record`
`4`	`6`	`{`
`5`	`7`	`public Record()`
`6`	`8`	`{`
`7`	`9`	`Data = new Dictionary<string, object>();`
	`10`	`+ GeolocationData = new List<GeolocationEntity>();`
`8`	`11`	`}`
`9`	`12`
`10`	`13`	`public Record(Record record)`
`@@ -22,6 +25,7 @@ public Record(Record record)`
`22`	`25`	`Path = record.Path;`
`23`	`26`	`Url = record.Url;`
`24`	`27`	`Data = record.Data;`
	`28`	`+ GeolocationData = record.GeolocationData;`
`25`	`29`	`}`
`26`	`30`
`27`	`31`	`public string ObjectID { get; set; }`
`@@ -58,6 +62,9 @@ public Record(Record record)`
`58`	`62`
`59`	`63`	`public string Url { get; set; }`
`60`	`64`
	`65`	`+ [JsonProperty("_geoloc")]`
	`66`	`+ public List<GeolocationEntity> GeolocationData { get; set; }`
	`67`	`+`
`61`	`68`	`public Dictionary<string, object> Data { get; set; }`
`62`	`69`	`}`
`63`	`70`	`}`
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`