[Algolia integration] the current project doesn't allow geolocation indexing

[giuunit]

Based on Algolia documentation, we should be able to add geolocation properties inside algolia using the format listed here:

https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#enabling-geo-search-by-adding-geolocation-data-to-records

We need a record with a "_geoloc" attribute that contains an object with lat/long properties.

The issue we have is that all the "hardcoded" properties are locked inside the SearchController.

I think it would be good to have a "before indexing" event for the Record object where we would be able to edit any property like non data properties after the hydration from the converters based on the Data dictionary.

[acoumb]

Hi @giuunit ,

Could you provide more details on what you would expect for this geolocation property? Are you referring to a new property of the Record that will be serialized as _geoloc (with lat/long parameters) or a means to extend the existing Data property of the record?

Thank you,
Adrian

[giuunit]

Here's the code I have so far:

using Newtonsoft.Json;

namespace Umbraco.Cms.Integrations.Search.Algolia.Models
{
    public class GeolocProperties
    {
        [JsonProperty("lat")]
        public double Latitude { get; set; }

        [JsonProperty("lng")]
        public double Longitude { get; set; }
    }
}

using Newtonsoft.Json;

namespace Umbraco.Cms.Integrations.Search.Algolia.Models
{
    public class Record
    {
        public Record()
        {
            Data = new Dictionary<string, object>();
            Geoloc = new List<GeolocProperties>();
        }

        public Record(Record record)
        {
            ContentTypeAlias = record.ContentTypeAlias;
            ObjectID = record.ObjectID;
            Id = record.Id;
            Name = record.Name;
            CreateDate = record.CreateDate;
            CreatorName = record.CreatorName;
            UpdateDate = record.UpdateDate;
            WriterName = record.WriterName;
            TemplateId = record.TemplateId;
            Level = record.Level;
            Path = record.Path;
            Url = record.Url;
            Data = record.Data;
            Geoloc = record.Geoloc;
        }

        public string ObjectID { get; set; }

        public int Id { get; set; }

        public string Name { get; set; }

        public string CreateDate { get; set; }

        /// <summary>
        /// Unix timestamp
        /// </summary>
        public long CreateDateTimestamp { get; set; }

        public string CreatorName { get; set; }

        public string UpdateDate { get; set; }

        /// <summary>
        /// Unix timestamp
        /// </summary>
        public long UpdateDateTimestamp { get; set; }

        public string WriterName { get; set; }

        public int TemplateId { get; set; }

        public int Level { get; set; }

        public List<string> Path { get; set; }

        public string ContentTypeAlias { get; set; }

        public string Url { get; set; }

        [JsonProperty("_geoloc")]
        public List<GeolocProperties> Geoloc { get; set; }

        public Dictionary<string, object> Data { get; set; }
    }
}

and then I was thinking maybe having an interface on top of ContentRecordBuilder to hijack the behavior when building a record, but then I noticed the AddCustomValues inside ContentRecordBuilder but I can't seem to make it work, is there a way to do it with this function ?

[giuunit]

Please ignore my last paragraph, I understood how to make the IRecordBuilder<> work. I just need the geoloc properties to be added to the Record object, I will send the PR shortly.

[acoumb]

Can't you use the Data property and add there?

[giuunit]

I am afraid it is not a possibility. Algolia requires a root level property named _geoloc to enable geo location features. My suggestion would be to extend the Record object inside the core repo (see my comments above) as it is part of the standard algolia API, and then projects using the plugin can use a IRecordBuilder to set the _geoloc property based on some data that was fetched earlier in the Data property object.

[acoumb]

Hi @giuunit ,

The updates have been released with versions 2.3.0 and 3.1.0.

To set the geolocation properties, you can add your own provider that implements IAlgoliaGeolocationProvider.

Thanks,
Adrian

[giuunit]

Wonderful thank you

[giuunit]

I am looking at the IAlgoliaGeolocationProvider interface and I noticed we do not have any parameters. If the data comes from the IContent or Record object, is there a way to know the object from inside the interface ? It is not a blocker for me as I have RecordBuilders ready, but I am wondering how to use this interface.

[acoumb]

Docs coming out soon, but you can get a preview here.

[acoumb]

I am preparing a patch release passing IContent to the provider method.