Prefer throw helper for missing settings

stevejgordon · stevejgordon · commit b92934e64984 · 2023-03-06T09:33:46.000Z
diff --git a/src/Elastic.Clients.Elasticsearch/Api/BulkRequest.cs b/src/Elastic.Clients.Elasticsearch/Api/BulkRequest.cs
@@ -34,11 +34,14 @@ public void Serialize(Stream stream, IElasticsearchClientSettings settings, Seri
 		foreach (var op in Operations)
 		{
 			if (op is not IStreamSerializable serializable)
-				throw new InvalidOperationException("");
+			{
+				ThrowHelper.ThrowInvalidOperationForBulkWhenNotIStreamSerializable();
+				return;
+			}
 
 			op.PrepareIndex(index);
 
-			serializable.Serialize(stream, settings, formatting);
+			serializable.Serialize(stream, settings, SerializationFormatting.None);
 			stream.WriteByte((byte)'\n');
 		}
 	}
@@ -53,11 +56,14 @@ public async Task SerializeAsync(Stream stream, IElasticsearchClientSettings set
 		foreach (var op in Operations)
 		{
 			if (op is not IStreamSerializable serializable)
-				throw new InvalidOperationException("");
+			{
+				ThrowHelper.ThrowInvalidOperationForBulkWhenNotIStreamSerializable();
+				return;
+			}
 
 			op.PrepareIndex(index);
 
-			await serializable.SerializeAsync(stream, settings, formatting).ConfigureAwait(false);
+			await serializable.SerializeAsync(stream, settings, SerializationFormatting.None).ConfigureAwait(false);
 			stream.WriteByte((byte)'\n');
 		}
 	}
@@ -200,11 +206,14 @@ public void Serialize(Stream stream, IElasticsearchClientSettings settings, Seri
 		foreach (var op in _operations)
 		{
 			if (op is not IStreamSerializable serializable)
-				throw new InvalidOperationException("");
+			{
+				ThrowHelper.ThrowInvalidOperationForBulkWhenNotIStreamSerializable();
+				return;
+			}
 
 			op.PrepareIndex(index);
 
-			serializable.Serialize(stream, settings, formatting);
+			serializable.Serialize(stream, settings, SerializationFormatting.None);
 			stream.WriteByte((byte)'\n');
 		}
 	}
@@ -219,11 +228,14 @@ public async Task SerializeAsync(Stream stream, IElasticsearchClientSettings set
 		foreach (var op in _operations)
 		{
 			if (op is not IStreamSerializable serializable)
-				throw new InvalidOperationException("");
+			{
+				ThrowHelper.ThrowInvalidOperationForBulkWhenNotIStreamSerializable();
+				return;
+			}
 
 			op.PrepareIndex(index);
 
-			await serializable.SerializeAsync(stream, settings, formatting).ConfigureAwait(false);
+			await serializable.SerializeAsync(stream, settings, SerializationFormatting.None).ConfigureAwait(false);
 			stream.WriteByte((byte)'\n');
 		}
 	}
diff --git a/src/Elastic.Clients.Elasticsearch/Core/Exceptions/ThrowHelper.cs b/src/Elastic.Clients.Elasticsearch/Core/Exceptions/ThrowHelper.cs
@@ -15,7 +15,7 @@ internal static class ThrowHelper
 
 	[MethodImpl(MethodImplOptions.NoInlining)]
 	internal static void ThrowUnknownTaggedUnionVariantJsonException(string variantTag, Type interfaceType) =>
-		throw new JsonException($"Encounted an unsupported variant tag '{variantTag}' on '{SimplifiedFullName(interfaceType)}', which could not be deserialised.");
+		throw new JsonException($"Encountered an unsupported variant tag '{variantTag}' on '{SimplifiedFullName(interfaceType)}', which could not be deserialized.");
 
 	[MethodImpl(MethodImplOptions.NoInlining)]
 	internal static void ThrowInvalidOperationException(string message) =>
@@ -25,4 +25,10 @@ internal static void ThrowInvalidOperationException(string message) =>
 #pragma warning disable IDE0057 // Use range operator
 	private static string SimplifiedFullName(Type type) => type.FullName.Substring(30);
 #pragma warning restore IDE0057 // Use range operator
+
+	[MethodImpl(MethodImplOptions.NoInlining)]
+	internal static void ThrowJsonExceptionForMissingSettings() => throw new JsonException("Unable to retrieve client settings for JsonSerializerOptions.");
+
+	[MethodImpl(MethodImplOptions.NoInlining)]
+	internal static void ThrowInvalidOperationForBulkWhenNotIStreamSerializable() => throw new InvalidOperationException("Operation must implement IStreamSerializable.");
 }
diff --git a/src/Elastic.Clients.Elasticsearch/Core/Fields/FieldValue.cs b/src/Elastic.Clients.Elasticsearch/Core/Fields/FieldValue.cs
@@ -374,7 +374,7 @@ public override void Write(Utf8JsonWriter writer, FieldValue value, JsonSerializ
 		else if (value.TryGetComposite(out var objectValue))
 		{
 			if (!options.TryGetClientSettings(out var settings))
-				throw new JsonException("Unable to retrieve ElasticsearchClientSettings in order to access source serializer.");
+				ThrowHelper.ThrowJsonExceptionForMissingSettings();
 
 			SourceSerialization.Serialize(objectValue, objectValue.GetType(), writer, settings);
 		}
diff --git a/src/Elastic.Clients.Elasticsearch/Types/Core/Bulk/BulkOperationsCollection.cs b/src/Elastic.Clients.Elasticsearch/Types/Core/Bulk/BulkOperationsCollection.cs
@@ -235,9 +235,12 @@ public void Serialize(Stream stream, IElasticsearchClientSettings settings, Seri
 		foreach (var op in this)
 		{
 			if (op is not IStreamSerializable serializable)
-				throw new InvalidOperationException("");
+			{
+				ThrowHelper.ThrowInvalidOperationForBulkWhenNotIStreamSerializable();
+				return;
+			}
 
-			serializable.Serialize(stream, settings, formatting);
+			serializable.Serialize(stream, settings, SerializationFormatting.None);
 			stream.WriteByte((byte)'\n');
 		}
 	}
@@ -247,9 +250,12 @@ public async Task SerializeAsync(Stream stream, IElasticsearchClientSettings set
 		foreach (var op in this)
 		{
 			if (op is not IStreamSerializable serializable)
-				throw new InvalidOperationException("");
+			{
+				ThrowHelper.ThrowInvalidOperationForBulkWhenNotIStreamSerializable();
+				return;
+			}
 
-			await serializable.SerializeAsync(stream, settings, formatting).ConfigureAwait(false);
+			await serializable.SerializeAsync(stream, settings, SerializationFormatting.None).ConfigureAwait(false);
 			stream.WriteByte((byte)'\n');
 		}
 	}
diff --git a/src/Elastic.Clients.Elasticsearch/Types/Mapping/Properties.cs b/src/Elastic.Clients.Elasticsearch/Types/Mapping/Properties.cs
@@ -27,7 +27,7 @@ internal sealed class PropertiesConverter : JsonConverter<Properties>
 	public override Properties? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
 	{
 		if (!options.TryGetClientSettings(out var settings))
-			throw new JsonException("Unable to retrive client settings during properties deserialization.");
+			ThrowHelper.ThrowJsonExceptionForMissingSettings();
 
 		if (reader.TokenType != JsonTokenType.StartObject)
 			throw new JsonException("Expected start object token.");
@@ -51,7 +51,7 @@ internal sealed class PropertiesConverter : JsonConverter<Properties>
 	public override void Write(Utf8JsonWriter writer, Properties value, JsonSerializerOptions options)
 	{
 		if (!options.TryGetClientSettings(out var settings))
-			throw new JsonException("Unable to retrive client settings during properties serialization.");
+			ThrowHelper.ThrowJsonExceptionForMissingSettings();
 
 		if (value is null)
 		{
diff --git a/src/Elastic.Clients.Elasticsearch/Types/SortOptions.cs b/src/Elastic.Clients.Elasticsearch/Types/SortOptions.cs
@@ -73,7 +73,7 @@ public override SortOptions Read(ref Utf8JsonReader reader, Type typeToConvert,
 	public override void Write(Utf8JsonWriter writer, SortOptions value, JsonSerializerOptions options)
 	{
 		if (!options.TryGetClientSettings(out var settings))
-			throw new JsonException("Unable to retrieve IElasticsearchClientSettings.");
+			ThrowHelper.ThrowJsonExceptionForMissingSettings();
 
 		string? fieldName = null;
 

Original file line number	Diff line number	Diff line change
`@@ -34,11 +34,14 @@ public void Serialize(Stream stream, IElasticsearchClientSettings settings, Seri`
`34`	`34`	`foreach (var op in Operations)`
`35`	`35`	`{`
`36`	`36`	`if (op is not IStreamSerializable serializable)`
`37`		`- throw new InvalidOperationException("");`
	`37`	`+ {`
	`38`	`+ ThrowHelper.ThrowInvalidOperationForBulkWhenNotIStreamSerializable();`
	`39`	`+ return;`
	`40`	`+ }`
`38`	`41`
`39`	`42`	`op.PrepareIndex(index);`
`40`	`43`
`41`		`- serializable.Serialize(stream, settings, formatting);`
	`44`	`+ serializable.Serialize(stream, settings, SerializationFormatting.None);`
`42`	`45`	`stream.WriteByte((byte)'\n');`
`43`	`46`	`}`
`44`	`47`	`}`
`@@ -53,11 +56,14 @@ public async Task SerializeAsync(Stream stream, IElasticsearchClientSettings set`
`53`	`56`	`foreach (var op in Operations)`
`54`	`57`	`{`
`55`	`58`	`if (op is not IStreamSerializable serializable)`
`56`		`- throw new InvalidOperationException("");`
	`59`	`+ {`
	`60`	`+ ThrowHelper.ThrowInvalidOperationForBulkWhenNotIStreamSerializable();`
	`61`	`+ return;`
	`62`	`+ }`
`57`	`63`
`58`	`64`	`op.PrepareIndex(index);`
`59`	`65`
`60`		`- await serializable.SerializeAsync(stream, settings, formatting).ConfigureAwait(false);`
	`66`	`+ await serializable.SerializeAsync(stream, settings, SerializationFormatting.None).ConfigureAwait(false);`
`61`	`67`	`stream.WriteByte((byte)'\n');`
`62`	`68`	`}`
`63`	`69`	`}`
`@@ -200,11 +206,14 @@ public void Serialize(Stream stream, IElasticsearchClientSettings settings, Seri`
`200`	`206`	`foreach (var op in _operations)`
`201`	`207`	`{`
`202`	`208`	`if (op is not IStreamSerializable serializable)`
`203`		`- throw new InvalidOperationException("");`
	`209`	`+ {`
	`210`	`+ ThrowHelper.ThrowInvalidOperationForBulkWhenNotIStreamSerializable();`
	`211`	`+ return;`
	`212`	`+ }`
`204`	`213`
`205`	`214`	`op.PrepareIndex(index);`
`206`	`215`
`207`		`- serializable.Serialize(stream, settings, formatting);`
	`216`	`+ serializable.Serialize(stream, settings, SerializationFormatting.None);`
`208`	`217`	`stream.WriteByte((byte)'\n');`
`209`	`218`	`}`
`210`	`219`	`}`
`@@ -219,11 +228,14 @@ public async Task SerializeAsync(Stream stream, IElasticsearchClientSettings set`
`219`	`228`	`foreach (var op in _operations)`
`220`	`229`	`{`
`221`	`230`	`if (op is not IStreamSerializable serializable)`
`222`		`- throw new InvalidOperationException("");`
	`231`	`+ {`
	`232`	`+ ThrowHelper.ThrowInvalidOperationForBulkWhenNotIStreamSerializable();`
	`233`	`+ return;`
	`234`	`+ }`
`223`	`235`
`224`	`236`	`op.PrepareIndex(index);`
`225`	`237`
`226`		`- await serializable.SerializeAsync(stream, settings, formatting).ConfigureAwait(false);`
	`238`	`+ await serializable.SerializeAsync(stream, settings, SerializationFormatting.None).ConfigureAwait(false);`
`227`	`239`	`stream.WriteByte((byte)'\n');`
`228`	`240`	`}`
`229`	`241`	`}`
Original file line number	Diff line number	Diff line change
`@@ -374,7 +374,7 @@ public override void Write(Utf8JsonWriter writer, FieldValue value, JsonSerializ`
`374`	`374`	`else if (value.TryGetComposite(out var objectValue))`
`375`	`375`	`{`
`376`	`376`	`if (!options.TryGetClientSettings(out var settings))`
`377`		`- throw new JsonException("Unable to retrieve ElasticsearchClientSettings in order to access source serializer.");`
	`377`	`+ ThrowHelper.ThrowJsonExceptionForMissingSettings();`
`378`	`378`
`379`	`379`	`SourceSerialization.Serialize(objectValue, objectValue.GetType(), writer, settings);`
`380`	`380`	`}`
Original file line number	Diff line number	Diff line change
`@@ -235,9 +235,12 @@ public void Serialize(Stream stream, IElasticsearchClientSettings settings, Seri`
`235`	`235`	`foreach (var op in this)`
`236`	`236`	`{`
`237`	`237`	`if (op is not IStreamSerializable serializable)`
`238`		`- throw new InvalidOperationException("");`
	`238`	`+ {`
	`239`	`+ ThrowHelper.ThrowInvalidOperationForBulkWhenNotIStreamSerializable();`
	`240`	`+ return;`
	`241`	`+ }`
`239`	`242`
`240`		`- serializable.Serialize(stream, settings, formatting);`
	`243`	`+ serializable.Serialize(stream, settings, SerializationFormatting.None);`
`241`	`244`	`stream.WriteByte((byte)'\n');`
`242`	`245`	`}`
`243`	`246`	`}`
`@@ -247,9 +250,12 @@ public async Task SerializeAsync(Stream stream, IElasticsearchClientSettings set`
`247`	`250`	`foreach (var op in this)`
`248`	`251`	`{`
`249`	`252`	`if (op is not IStreamSerializable serializable)`
`250`		`- throw new InvalidOperationException("");`
	`253`	`+ {`
	`254`	`+ ThrowHelper.ThrowInvalidOperationForBulkWhenNotIStreamSerializable();`
	`255`	`+ return;`
	`256`	`+ }`
`251`	`257`
`252`		`- await serializable.SerializeAsync(stream, settings, formatting).ConfigureAwait(false);`
	`258`	`+ await serializable.SerializeAsync(stream, settings, SerializationFormatting.None).ConfigureAwait(false);`
`253`	`259`	`stream.WriteByte((byte)'\n');`
`254`	`260`	`}`
`255`	`261`	`}`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ internal sealed class PropertiesConverter : JsonConverter<Properties>`
`27`	`27`	`public override Properties? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)`
`28`	`28`	`{`
`29`	`29`	`if (!options.TryGetClientSettings(out var settings))`
`30`		`- throw new JsonException("Unable to retrive client settings during properties deserialization.");`
	`30`	`+ ThrowHelper.ThrowJsonExceptionForMissingSettings();`
`31`	`31`
`32`	`32`	`if (reader.TokenType != JsonTokenType.StartObject)`
`33`	`33`	`throw new JsonException("Expected start object token.");`
`@@ -51,7 +51,7 @@ internal sealed class PropertiesConverter : JsonConverter<Properties>`
`51`	`51`	`public override void Write(Utf8JsonWriter writer, Properties value, JsonSerializerOptions options)`
`52`	`52`	`{`
`53`	`53`	`if (!options.TryGetClientSettings(out var settings))`
`54`		`- throw new JsonException("Unable to retrive client settings during properties serialization.");`
	`54`	`+ ThrowHelper.ThrowJsonExceptionForMissingSettings();`
`55`	`55`
`56`	`56`	`if (value is null)`
`57`	`57`	`{`
Original file line number	Diff line number	Diff line change
`@@ -73,7 +73,7 @@ public override SortOptions Read(ref Utf8JsonReader reader, Type typeToConvert,`
`73`	`73`	`public override void Write(Utf8JsonWriter writer, SortOptions value, JsonSerializerOptions options)`
`74`	`74`	`{`
`75`	`75`	`if (!options.TryGetClientSettings(out var settings))`
`76`		`- throw new JsonException("Unable to retrieve IElasticsearchClientSettings.");`
	`76`	`+ ThrowHelper.ThrowJsonExceptionForMissingSettings();`
`77`	`77`
`78`	`78`	`string? fieldName = null;`
`79`	`79`