CSHARP-5305: Improve error message when custom LINQ extension method is executed client side. #1547
Conversation
…is executed client side.
| @@ -42,7 +42,7 @@ internal static HashSet<T> ToHashSet<T>(this IEnumerable<T> source) | |||
| /// <returns>Only meant to be used in Update specifications.</returns> | |||
| public static TSource AllElements<TSource>(this IEnumerable<TSource> source) | |||
| { | |||
| throw new NotSupportedException("This method is not functional. It is only usable in conjunction with MongoDB."); | |||
| throw new NotSupportedException($"{nameof(AllElements)} can only be used in LINQ queries executed server-side."); | |||
There was a problem hiding this comment.
Is this error message good enough or can you think of even better?
| @@ -862,7 +862,7 @@ public static IEnumerable<TResult> TopN<TSource, TKey, TResult>( | |||
| /// <returns>The filtered results.</returns> | |||
| public static IEnumerable<TSource> Where<TSource>(this IEnumerable<TSource> source, Func<TSource, bool> predicate, int limit) | |||
| { | |||
| throw new NotSupportedException("This method is not functional. It is only usable in conjunction with MongoDB."); | |||
| throw new NotSupportedException($"{nameof(Where)} can only be used in LINQ queries executed server-side."); | |||
There was a problem hiding this comment.
Can move relace by single helper method to throw:
private void ThrowNotSupportedException([CallerMemberName]string callerName = null)
{
throw new NotSupportedException($"{callerName} can only be used in LINQ queries executed server-side.");
}
So each method could be converted to simple expression body method:
public static IEnumerable<TSource> Where<TSource>(this IEnumerable<TSource> source, Func<TSource, bool> predicate, int limit)
=> ThrowNotSupportedException()
There was a problem hiding this comment.
I think losing "MongoDB" is a step backward as no other LINQ providers will be able to translate this.
There was a problem hiding this comment.
Good point. I will include "MongoDB" in the error message.
| { | ||
| public static Exception CreateNotSupportedException([CallerMemberName] string methodName = null) | ||
| { | ||
| throw new NotSupportedException($"{methodName} can only be used in MongoDB LINQ queries executed server-side."); |
There was a problem hiding this comment.
Should we return it instead of throwing?
There was a problem hiding this comment.
Good catch.
When I renamed this method from ThrowNotSupportedException to CreateNotSupportedException I missed changing this line!
| { | ||
| public static Exception CreateNotSupportedException([CallerMemberName] string methodName = null) | ||
| { | ||
| throw new NotSupportedException($"{methodName} can only be used in MongoDB LINQ queries executed server-side."); |
There was a problem hiding this comment.
Good catch.
When I renamed this method from ThrowNotSupportedException to CreateNotSupportedException I missed changing this line!
| @@ -32,7 +33,7 @@ public static class DateTimeExtensions | |||
| /// <returns>The resulting DateTime.</returns> | |||
| public static DateTime Add(this DateTime @this, long value, DateTimeUnit unit) | |||
| { | |||
| throw new InvalidOperationException("This DateTime.Add method is only intended to be used in LINQ queries."); | |||
| throw CustomLinqExtensionMethodHelper.CreateNotSupportedException(); | |||
There was a problem hiding this comment.
Is switching from throwing InvalidOperationException to throwing NotSupportedException a breaking change?
No description provided.