CSHARP-5505: Add $geoNear stage aggregation builders #1621

adelinowona · 2025-02-22T02:46:20Z

No description provided.

damieng · 2025-02-22T08:53:00Z

src/MongoDB.Driver/GeoNearOptions.cs

+        /// <summary>
+        /// Gets or sets the distance field. Required if querying a time-series collection.
+        /// </summary>
+        public string DistanceField { get; set; }


We should make a note this is optional here given that we don't use the nullable reference annotations in our API.

Is DistanceField actually optional? The server documentation doesn't say that.

Using a string here is also not completely safe.

This name MUST match the corresponding element name (usually the same as the property name unless configured differently) in the TNewResult POCO.

Is DistanceField actually optional? The server documentation doesn't say that.

In server 8.1, it'll be optional for non-timeseries collections but for time-series collections it's still required. I mentioned the time-series restriction in the property summary to guide users appropriately. If users accidentally omit the property when working with a time-series collection, they'll receive a detailed error message from the server explaining the issue so I don't think there should be too much concern for us here.

Using a string here is also not completely safe.

This name MUST match the corresponding element name (usually the same as the property name unless configured differently) in the TNewResult POCO.

Thanks for flagging this! I missed the fact that the element name isn't necessarily the same as the property name. We can address this by changing the type of the DistanceField option to FieldDefinition<TDocument> so that during the serialization process, the appropriate element name will be used if it's different from the property name. However, this means the type of the document passed into GeoNearOptions in the GeoNear methods should be the TOutput instead of TInput. @rstam lmk what you think about this?

src/MongoDB.Driver/GeoNearOptions.cs

src/MongoDB.Driver/PipelineStageDefinitionBuilder.cs

tests/MongoDB.Driver.Tests/AggregateGeoNearTests.cs

src/MongoDB.Driver/PipelineStageDefinitionBuilder.cs

src/MongoDB.Driver/GeoNearOptions.cs

src/MongoDB.Driver/PipelineStageDefinitionBuilder.cs

src/MongoDB.Driver/AggregateFluent.cs

src/MongoDB.Driver/AggregateFluentBase.cs

src/MongoDB.Driver/IAggregateFluent.cs

src/MongoDB.Driver/PipelineDefinitionBuilder.cs

src/MongoDB.Driver/PipelineStageDefinitionBuilder.cs

rstam

Looks good! Some small changes requested.

rstam · 2025-03-05T02:12:17Z

src/MongoDB.Driver/GeoNearOptions.cs

+    /// <summary>
+    /// Represents options for the $geoNear stage.
+    /// </summary>
+    public record GeoNearOptions<TDocument>


If we are going with record we should also make this class immutable.

rstam · 2025-03-13T18:27:12Z

src/MongoDB.Driver/GeoNearOptions.cs

+        /// <summary>
+        /// Gets or sets the distance field. Required if querying a time-series collection.
+        /// </summary>
+        public string DistanceField { get; set; }


Is DistanceField actually optional? The server documentation doesn't say that.

rstam · 2025-03-13T18:28:31Z

src/MongoDB.Driver/GeoNearOptions.cs

+        /// <summary>
+        /// Gets or sets the distance field. Required if querying a time-series collection.
+        /// </summary>
+        public string DistanceField { get; set; }


Using a string here is also not completely safe.

This name MUST match the corresponding element name (usually the same as the property name unless configured differently) in the TNewResult POCO.

rstam · 2025-03-13T18:29:05Z

src/MongoDB.Driver/IAggregateFluent.cs

+        /// <param name="options">The options.</param>
+        /// <returns>The fluent aggregate interface.</returns>
+        IAggregateFluent<TNewResult> GeoNear<TCoordinates, TNewResult>(
+            TCoordinates[] near,


Use double[] instead of TCoordinates[].

rstam · 2025-03-13T18:29:16Z

src/MongoDB.Driver/IAggregateFluent.cs

+        /// <param name="near">The point for which to find the closest documents.</param>
+        /// <param name="options">The options.</param>
+        /// <returns>The fluent aggregate interface.</returns>
+        IAggregateFluent<TNewResult> GeoNear<TNewResult>(


We discussed in Slack that this overload could be dropped.

@BorisDog Just to loop you in on the decision here. Users can provide a "legacy coordinates pair" as either an array or a bsondocument. The server docs mention that using an array is preferred so Robert and I agreed we could just provide the GeoNear overload using an array and drop the bsondocument overload. Lmk if you agree with this as well

rstam · 2025-03-13T18:31:00Z

src/MongoDB.Driver/PipelineDefinitionBuilder.cs

+        /// <returns>A new pipeline with an additional stage.</returns>
+        public static PipelineDefinition<TInput, TOutput> GeoNear<TInput, TIntermediate, TCoordinates, TOutput>(
+            this PipelineDefinition<TInput, TIntermediate> pipeline,
+            TCoordinates[] near,


Use double[] instead of TCoordinates[].

rstam · 2025-03-13T18:31:10Z

src/MongoDB.Driver/PipelineDefinitionBuilder.cs

+        /// <param name="near">The point for which to find the closest documents.</param>
+        /// <param name="options">The options.</param>
+        /// <returns>A new pipeline with an additional stage.</returns>
+        public static PipelineDefinition<TInput, TOutput> GeoNear<TInput, TIntermediate, TOutput>(


This overload can be dropped.

rstam · 2025-03-13T18:32:07Z

src/MongoDB.Driver/PipelineStageDefinitionBuilder.cs

+        /// <returns>The stage.</returns>
+        internal static PipelineStageDefinition<TInput, TOutput> GeoNear<TInput, TPoint, TOutput>(
+            TPoint near,
+            GeoNearOptions<TInput> options = null)


Consider adding a comment like:

// where TPoint is either a GeoJsonPoint or a legacy coordinate array

rstam · 2025-03-13T18:32:37Z

src/MongoDB.Driver/PipelineStageDefinitionBuilder.cs

+        /// <param name="options">The options.</param>
+        /// <returns>The stage.</returns>
+        public static PipelineStageDefinition<TInput, TOutput> GeoNear<TInput, TCoordinates, TOutput>(
+            TCoordinates[] near,


Use double[] instead of TCoordinates[]

rstam · 2025-03-13T18:32:46Z

src/MongoDB.Driver/PipelineStageDefinitionBuilder.cs

+        /// <param name="near">The point for which to find the closest documents.</param>
+        /// <param name="options">The options.</param>
+        /// <returns>The stage.</returns>
+        public static PipelineStageDefinition<TInput, TOutput> GeoNear<TInput, TOutput>(


This overload can be dropped.

BorisDog · 2025-03-21T17:26:07Z

src/MongoDB.Driver/IAggregateFluent.cs

+        /// <param name="near">The point for which to find the closest documents.</param>
+        /// <param name="options">The options.</param>
+        /// <returns>The fluent aggregate interface.</returns>
+        IAggregateFluent<TNewResult> GeoNear<TNewResult>(


BorisDog · 2025-03-21T17:30:35Z

src/MongoDB.Driver/PipelineStageDefinitionBuilder.cs

+                        { "near", pointSerializer.ToBsonValue(near)},
+                        { "distanceField", options?.DistanceField, options?.DistanceField != null },
+                        { "maxDistance", () => options?.MaxDistance.Value, options?.MaxDistance != null },
+                        { "minDistance", () => options?.MinDistance.Value, options?.MinDistance != null },


I think in case of nullable the value still can be provided directly, and avoid delegate creation.
{ "maxDistance", options?.MaxDistance, options?.MaxDistance != null }

Could you double check that please?

BorisDog · 2025-03-21T17:32:58Z

src/MongoDB.Driver/PipelineStageDefinitionBuilder.cs

+                    };
+
+                    var outputSerializer = args.SerializerRegistry.GetSerializer<TOutput>();
+                    return new RenderedPipelineStageDefinition<TOutput>(operatorName, new BsonDocument(operatorName, geoNearOptions), outputSerializer);


var outputSerializer = args.GetSerializer<TOutput>(); might safe serializer lookup.

CSHARP-5505: Add $geoNear stage aggregation builders

e202381

adelinowona requested a review from a team as a code owner February 22, 2025 02:46

adelinowona requested review from JamesKovacs, rstam and BorisDog and removed request for a team and JamesKovacs February 22, 2025 02:46

remove misc usings statement

e665118

damieng requested changes Feb 22, 2025

View reviewed changes

BorisDog reviewed Feb 24, 2025

View reviewed changes

src/MongoDB.Driver/GeoNearOptions.cs Outdated Show resolved Hide resolved

src/MongoDB.Driver/GeoNearOptions.cs Outdated Show resolved Hide resolved

src/MongoDB.Driver/PipelineStageDefinitionBuilder.cs Outdated Show resolved Hide resolved

PR comments

f101152

adelinowona requested a review from sanych-sun February 25, 2025 17:28

rstam requested changes Feb 28, 2025

View reviewed changes

address pr comments

77606ef

adelinowona requested review from rstam, damieng and BorisDog March 4, 2025 16:56

adelinowona added 2 commits March 4, 2025 11:57

use record

c84c06f

fix null error

5985760

rstam requested changes Mar 13, 2025

View reviewed changes

BorisDog requested changes Mar 21, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

CSHARP-5505: Add $geoNear stage aggregation builders #1621

CSHARP-5505: Add $geoNear stage aggregation builders #1621

adelinowona commented Feb 22, 2025

damieng Feb 22, 2025

rstam Mar 13, 2025

rstam Mar 13, 2025

adelinowona Mar 19, 2025

adelinowona Mar 19, 2025

rstam left a comment

rstam Mar 5, 2025

rstam Mar 13, 2025

rstam Mar 13, 2025

rstam Mar 13, 2025

rstam Mar 13, 2025

adelinowona Mar 19, 2025

BorisDog Mar 21, 2025

rstam Mar 13, 2025

rstam Mar 13, 2025

rstam Mar 13, 2025

rstam Mar 13, 2025

rstam Mar 13, 2025

BorisDog Mar 21, 2025

BorisDog Mar 21, 2025

BorisDog Mar 21, 2025

CSHARP-5505: Add $geoNear stage aggregation builders #1621

Are you sure you want to change the base?

CSHARP-5505: Add $geoNear stage aggregation builders #1621

Conversation

adelinowona commented Feb 22, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rstam left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment