Rename SourceSerialization helper

stevejgordon · stevejgordon · commit 3258e9913f95 · 2023-03-06T09:32:47.000Z
diff --git a/src/Elastic.Clients.Elasticsearch/Api/CreateRequest.cs b/src/Elastic.Clients.Elasticsearch/Api/CreateRequest.cs
@@ -19,5 +19,5 @@ public CreateRequest(TDocument documentWithId, IndexName index = null, Id id = n
 		: this(index ?? typeof(TDocument), id ?? Id.From(documentWithId)) =>
 			Document = documentWithId;
 
-	public void WriteJson(Utf8JsonWriter writer, Serializer sourceSerializer) => SourceSerialisation.Serialize(Document, writer, sourceSerializer);
+	public void WriteJson(Utf8JsonWriter writer, Serializer sourceSerializer) => SourceSerialization.Serialize(Document, writer, sourceSerializer);
 }
diff --git a/src/Elastic.Clients.Elasticsearch/Api/IndexRequest.cs b/src/Elastic.Clients.Elasticsearch/Api/IndexRequest.cs
@@ -24,7 +24,7 @@ public IndexRequest() : this(typeof(TDocument)) { }
 
 	[JsonIgnore] private Id? Id => RouteValues.Get<Id>("id");
 
-	void ICustomJsonWriter.WriteJson(Utf8JsonWriter writer, Serializer sourceSerializer) => SourceSerialisation.Serialize(Document, writer, sourceSerializer);
+	void ICustomJsonWriter.WriteJson(Utf8JsonWriter writer, Serializer sourceSerializer) => SourceSerialization.Serialize(Document, writer, sourceSerializer);
 
 	internal static HttpMethod GetHttpMethod(IndexRequest<TDocument> request) =>
 		request.Id?.StringOrLongValue != null || request.RouteValues.ContainsId ? HttpMethod.PUT : HttpMethod.POST;
@@ -40,7 +40,7 @@ public IndexRequestDescriptor<TDocument> Document(TDocument document)
 
 	internal Id _id;
 
-	public void WriteJson(Utf8JsonWriter writer, Serializer sourceSerializer) => SourceSerialisation.Serialize(DocumentValue, writer, sourceSerializer);
+	public void WriteJson(Utf8JsonWriter writer, Serializer sourceSerializer) => SourceSerialization.Serialize(DocumentValue, writer, sourceSerializer);
 
 	protected override HttpMethod? DynamicHttpMethod => _id is not null || RouteValues.ContainsId ? HttpMethod.PUT : HttpMethod.POST;
 }
diff --git a/src/Elastic.Clients.Elasticsearch/Client/ElasticsearchClient.cs b/src/Elastic.Clients.Elasticsearch/Client/ElasticsearchClient.cs
@@ -76,8 +76,10 @@ internal ElasticsearchClient(HttpTransport<IElasticsearchClientSettings> transpo
 
 	public IElasticsearchClientSettings ElasticsearchClientSettings => _transport.Settings;
 	public Inferrer Infer => _transport.Settings.Inferrer;
+
 	public Serializer RequestResponseSerializer => _transport.Settings.RequestResponseSerializer;
 	public Serializer SourceSerializer => _transport.Settings.SourceSerializer;
+
 	public HttpTransport Transport => _transport;
 
 	private ProductCheckStatus _productCheckStatus;
diff --git a/src/Elastic.Clients.Elasticsearch/Core/Fields/FieldValue.cs b/src/Elastic.Clients.Elasticsearch/Core/Fields/FieldValue.cs
@@ -376,7 +376,7 @@ public override void Write(Utf8JsonWriter writer, FieldValue value, JsonSerializ
 			if (!options.TryGetClientSettings(out var settings))
 				throw new JsonException("Unable to retrieve ElasticsearchClientSettings in order to access source serializer.");
 
-			SourceSerialisation.Serialize(objectValue, objectValue.GetType(), writer, settings);
+			SourceSerialization.Serialize(objectValue, objectValue.GetType(), writer, settings);
 		}
 
 		else if (value.Kind == FieldValue.ValueKind.Null)
diff --git a/src/Elastic.Clients.Elasticsearch/Serialization/IStreamSerializable.cs b/src/Elastic.Clients.Elasticsearch/Serialization/IStreamSerializable.cs
@@ -9,7 +9,7 @@
 namespace Elastic.Clients.Elasticsearch.Serialization;
 
 /// <summary>
-/// Used to mark types which expect to directly serialise into a stream. This supports non-json compliant output such as NDJSON.
+/// Used to mark types which expect to directly serialize into a stream. This supports non-json compliant output such as NDJSON.
 /// </summary>
 internal interface IStreamSerializable
 {
diff --git a/src/Elastic.Clients.Elasticsearch/Serialization/SourceConverter.cs b/src/Elastic.Clients.Elasticsearch/Serialization/SourceConverter.cs
@@ -16,8 +16,8 @@ internal sealed class SourceConverter<T> : JsonConverter<SourceMarker<T>>
 
 	public override SourceMarker<T>? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => new()
 	{
-		Source = SourceSerialisation.Deserialize<T>(ref reader, _settings)
+		Source = SourceSerialization.Deserialize<T>(ref reader, _settings)
 	};
 
-	public override void Write(Utf8JsonWriter writer, SourceMarker<T> value, JsonSerializerOptions options) => SourceSerialisation.Serialize<T>(value.Source, writer, _settings);
+	public override void Write(Utf8JsonWriter writer, SourceMarker<T> value, JsonSerializerOptions options) => SourceSerialization.Serialize<T>(value.Source, writer, _settings);
 }
diff --git a/src/Elastic.Clients.Elasticsearch/Serialization/SourceSerialization.cs b/src/Elastic.Clients.Elasticsearch/Serialization/SourceSerialization.cs
@@ -5,15 +5,14 @@
 using System;
 using System.IO;
 using System.Text.Json;
-using System.Text.Json.Serialization;
 using Elastic.Transport;
 
 namespace Elastic.Clients.Elasticsearch.Serialization;
 
 /// <summary>
-/// May be used by requests that need to serialise only part of their source rather than the request object itself.
+/// May be used by requests that need to serialize only part of their source rather than the request object itself.
 /// </summary>
-internal static class SourceSerialisation
+internal static class SourceSerialization
 {
 	public static void SerializeParams<T>(T toSerialize, Utf8JsonWriter writer, IElasticsearchClientSettings settings)
 	{
@@ -49,7 +48,7 @@ public static void Serialize<T>(T toSerialize, Utf8JsonWriter writer, Serializer
 	{
 		if (sourceSerializer is DefaultSourceSerializer defaultSerializer)
 		{
-			// When the serializer is our own, which uses STJ we can avoid unneccesary allocations and serialise straight into the writer
+			// When the serializer is our own, which uses STJ we can avoid unnecessary allocations and serialize straight into the writer
 			// In most cases this is not the case as it's wrapped in the DiagnosticsSerializerProxy
 			// Ideally, we'd short-circuit here if we know there are no listeners or avoid wrapping the default source serializer.
 			JsonSerializer.Serialize(writer, toSerialize, defaultSerializer.Options);
@@ -75,7 +74,7 @@ public static void Serialize(object toSerialize, Type type, Utf8JsonWriter write
 	{
 		if (sourceSerializer is DefaultSourceSerializer defaultSerializer)
 		{
-			// When the serializer is our own, which uses STJ we can avoid unneccesary allocations and serialise straight into the writer
+			// When the serializer is our own, which uses STJ we can avoid unnecessary allocations and serialize straight into the writer
 			// In most cases this is not the case as it's wrapped in the DiagnosticsSerializerProxy
 			// Ideally, we'd short-circuit here if we know there are no listeners or avoid wrapping the default source serializer.
 			JsonSerializer.Serialize(writer, toSerialize, type, defaultSerializer.Options);
@@ -103,7 +102,7 @@ public static T Deserialize<T>(ref Utf8JsonReader reader, IElasticsearchClientSe
 
 		if (sourceSerializer is DefaultSourceSerializer defaultSerializer)
 		{
-			// When the serializer is our own which uses STJ we can avoid unneccesary allocations and serialise straight into the writer
+			// When the serializer is our own which uses STJ we can avoid unnecessary allocations and serialize straight into the writer
 			return JsonSerializer.Deserialize<T>(ref reader, defaultSerializer.Options);
 		}
 		else
diff --git a/src/Elastic.Clients.Elasticsearch/Types/Core/Bulk/BulkUpdateBody.cs b/src/Elastic.Clients.Elasticsearch/Types/Core/Bulk/BulkUpdateBody.cs
@@ -57,7 +57,7 @@ protected override void SerializeProperties(Utf8JsonWriter writer, JsonSerialize
 		if (PartialUpdate is not null)
 		{
 			writer.WritePropertyName("doc");
-			SourceSerialisation.Serialize(PartialUpdate, writer, settings.SourceSerializer);
+			SourceSerialization.Serialize(PartialUpdate, writer, settings.SourceSerializer);
 		}
 
 		if (Script is not null)
@@ -81,7 +81,7 @@ protected override void SerializeProperties(Utf8JsonWriter writer, JsonSerialize
 		if (Upsert is not null)
 		{
 			writer.WritePropertyName("upsert");
-			SourceSerialisation.Serialize(Upsert, writer, settings.SourceSerializer);
+			SourceSerialization.Serialize(Upsert, writer, settings.SourceSerializer);
 		}
 
 		if (Source is not null)
diff --git a/src/Elastic.Clients.Elasticsearch/Types/Core/Bulk/BulkUpdateOperationDescriptor.cs b/src/Elastic.Clients.Elasticsearch/Types/Core/Bulk/BulkUpdateOperationDescriptor.cs
@@ -155,7 +155,7 @@ private void WriteBody(IElasticsearchClientSettings settings, Utf8JsonWriter wri
 		if (_document is not null)
 		{
 			writer.WritePropertyName("doc");
-			SourceSerialisation.Serialize(_document, writer, settings.SourceSerializer);
+			SourceSerialization.Serialize(_document, writer, settings.SourceSerializer);
 		}
 
 		if (_scriptedUpsert.HasValue)
@@ -173,7 +173,7 @@ private void WriteBody(IElasticsearchClientSettings settings, Utf8JsonWriter wri
 		if (_upsert is not null)
 		{
 			writer.WritePropertyName("upsert");
-			SourceSerialisation.Serialize(_upsert, writer, settings.SourceSerializer);
+			SourceSerialization.Serialize(_upsert, writer, settings.SourceSerializer);
 		}
 
 		if (_source is not null)
diff --git a/src/Elastic.Clients.Elasticsearch/Types/Core/Bulk/PartialBulkUpdateBody.cs b/src/Elastic.Clients.Elasticsearch/Types/Core/Bulk/PartialBulkUpdateBody.cs
@@ -24,7 +24,7 @@ protected override void SerializeProperties(Utf8JsonWriter writer, JsonSerialize
 		if (PartialUpdate is not null)
 		{
 			writer.WritePropertyName("doc");
-			SourceSerialisation.Serialize(PartialUpdate, writer, settings.SourceSerializer);
+			SourceSerialization.Serialize(PartialUpdate, writer, settings.SourceSerializer);
 		}
 	}
 }
diff --git a/src/Elastic.Clients.Elasticsearch/Types/Core/Bulk/ScriptedBulkUpdateBody.cs b/src/Elastic.Clients.Elasticsearch/Types/Core/Bulk/ScriptedBulkUpdateBody.cs
@@ -36,7 +36,7 @@ protected override void SerializeProperties(Utf8JsonWriter writer, JsonSerialize
 		if (Upsert is not null)
 		{
 			writer.WritePropertyName("upsert");
-			SourceSerialisation.Serialize(Upsert, writer, settings.SourceSerializer);
+			SourceSerialization.Serialize(Upsert, writer, settings.SourceSerializer);
 		}
 	}
 }
diff --git a/src/Elastic.Clients.Elasticsearch/Types/Scripting/InlineScript.cs b/src/Elastic.Clients.Elasticsearch/Types/Scripting/InlineScript.cs
@@ -40,7 +40,7 @@ void ISelfTwoWaySerializable.Serialize(Utf8JsonWriter writer, JsonSerializerOpti
 		if (Params is not null)
 		{
 			writer.WritePropertyName("params");
-			SourceSerialisation.SerializeParams(Params, writer, settings);
+			SourceSerialization.SerializeParams(Params, writer, settings);
 		}
 
 		writer.WriteEndObject();
@@ -89,7 +89,7 @@ void ISelfTwoWaySerializable.Deserialize(ref Utf8JsonReader reader, JsonSerializ
 
 				if (reader.ValueTextEquals("params"))
 				{
-					var value = SourceSerialisation.DeserializeParams<Dictionary<string, object>>(ref reader, settings);
+					var value = SourceSerialization.DeserializeParams<Dictionary<string, object>>(ref reader, settings);
 					if (value is not null)
 					{
 						Params = value;

Original file line number	Diff line number	Diff line change
`@@ -19,5 +19,5 @@ public CreateRequest(TDocument documentWithId, IndexName index = null, Id id = n`
`19`	`19`	`: this(index ?? typeof(TDocument), id ?? Id.From(documentWithId)) =>`
`20`	`20`	`Document = documentWithId;`
`21`	`21`
`22`		`- public void WriteJson(Utf8JsonWriter writer, Serializer sourceSerializer) => SourceSerialisation.Serialize(Document, writer, sourceSerializer);`
	`22`	`+ public void WriteJson(Utf8JsonWriter writer, Serializer sourceSerializer) => SourceSerialization.Serialize(Document, writer, sourceSerializer);`
`23`	`23`	`}`
Original file line number	Diff line number	Diff line change
`@@ -376,7 +376,7 @@ public override void Write(Utf8JsonWriter writer, FieldValue value, JsonSerializ`
`376`	`376`	`if (!options.TryGetClientSettings(out var settings))`
`377`	`377`	`throw new JsonException("Unable to retrieve ElasticsearchClientSettings in order to access source serializer.");`
`378`	`378`
`379`		`- SourceSerialisation.Serialize(objectValue, objectValue.GetType(), writer, settings);`
	`379`	`+ SourceSerialization.Serialize(objectValue, objectValue.GetType(), writer, settings);`
`380`	`380`	`}`
`381`	`381`
`382`	`382`	`else if (value.Kind == FieldValue.ValueKind.Null)`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@`
`9`	`9`	`namespace Elastic.Clients.Elasticsearch.Serialization;`
`10`	`10`
`11`	`11`	`/// <summary>`
`12`		`-/// Used to mark types which expect to directly serialise into a stream. This supports non-json compliant output such as NDJSON.`
	`12`	`+/// Used to mark types which expect to directly serialize into a stream. This supports non-json compliant output such as NDJSON.`
`13`	`13`	`/// </summary>`
`14`	`14`	`internal interface IStreamSerializable`
`15`	`15`	`{`
Original file line number	Diff line number	Diff line change
`@@ -16,8 +16,8 @@ internal sealed class SourceConverter<T> : JsonConverter<SourceMarker<T>>`
`16`	`16`
`17`	`17`	`public override SourceMarker<T>? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => new()`
`18`	`18`	`{`
`19`		`- Source = SourceSerialisation.Deserialize<T>(ref reader, _settings)`
	`19`	`+ Source = SourceSerialization.Deserialize<T>(ref reader, _settings)`
`20`	`20`	`};`
`21`	`21`
`22`		`- public override void Write(Utf8JsonWriter writer, SourceMarker<T> value, JsonSerializerOptions options) => SourceSerialisation.Serialize<T>(value.Source, writer, _settings);`
	`22`	`+ public override void Write(Utf8JsonWriter writer, SourceMarker<T> value, JsonSerializerOptions options) => SourceSerialization.Serialize<T>(value.Source, writer, _settings);`
`23`	`23`	`}`
Original file line number	Diff line number	Diff line change
`@@ -5,15 +5,14 @@`
`5`	`5`	`using System;`
`6`	`6`	`using System.IO;`
`7`	`7`	`using System.Text.Json;`
`8`		`-using System.Text.Json.Serialization;`
`9`	`8`	`using Elastic.Transport;`
`10`	`9`
`11`	`10`	`namespace Elastic.Clients.Elasticsearch.Serialization;`
`12`	`11`
`13`	`12`	`/// <summary>`
`14`		`-/// May be used by requests that need to serialise only part of their source rather than the request object itself.`
	`13`	`+/// May be used by requests that need to serialize only part of their source rather than the request object itself.`
`15`	`14`	`/// </summary>`
`16`		`-internal static class SourceSerialisation`
	`15`	`+internal static class SourceSerialization`
`17`	`16`	`{`
`18`	`17`	`public static void SerializeParams<T>(T toSerialize, Utf8JsonWriter writer, IElasticsearchClientSettings settings)`
`19`	`18`	`{`
`@@ -49,7 +48,7 @@ public static void Serialize<T>(T toSerialize, Utf8JsonWriter writer, Serializer`
`49`	`48`	`{`
`50`	`49`	`if (sourceSerializer is DefaultSourceSerializer defaultSerializer)`
`51`	`50`	`{`
`52`		`- // When the serializer is our own, which uses STJ we can avoid unneccesary allocations and serialise straight into the writer`
	`51`	`+ // When the serializer is our own, which uses STJ we can avoid unnecessary allocations and serialize straight into the writer`
`53`	`52`	`// In most cases this is not the case as it's wrapped in the DiagnosticsSerializerProxy`
`54`	`53`	`// Ideally, we'd short-circuit here if we know there are no listeners or avoid wrapping the default source serializer.`
`55`	`54`	`JsonSerializer.Serialize(writer, toSerialize, defaultSerializer.Options);`
`@@ -75,7 +74,7 @@ public static void Serialize(object toSerialize, Type type, Utf8JsonWriter write`
`75`	`74`	`{`
`76`	`75`	`if (sourceSerializer is DefaultSourceSerializer defaultSerializer)`
`77`	`76`	`{`
`78`		`- // When the serializer is our own, which uses STJ we can avoid unneccesary allocations and serialise straight into the writer`
	`77`	`+ // When the serializer is our own, which uses STJ we can avoid unnecessary allocations and serialize straight into the writer`
`79`	`78`	`// In most cases this is not the case as it's wrapped in the DiagnosticsSerializerProxy`
`80`	`79`	`// Ideally, we'd short-circuit here if we know there are no listeners or avoid wrapping the default source serializer.`
`81`	`80`	`JsonSerializer.Serialize(writer, toSerialize, type, defaultSerializer.Options);`
`@@ -103,7 +102,7 @@ public static T Deserialize<T>(ref Utf8JsonReader reader, IElasticsearchClientSe`
`103`	`102`
`104`	`103`	`if (sourceSerializer is DefaultSourceSerializer defaultSerializer)`
`105`	`104`	`{`
`106`		`- // When the serializer is our own which uses STJ we can avoid unneccesary allocations and serialise straight into the writer`
	`105`	`+ // When the serializer is our own which uses STJ we can avoid unnecessary allocations and serialize straight into the writer`
`107`	`106`	`return JsonSerializer.Deserialize<T>(ref reader, defaultSerializer.Options);`
`108`	`107`	`}`
`109`	`108`	`else`
Original file line number	Diff line number	Diff line change
`@@ -57,7 +57,7 @@ protected override void SerializeProperties(Utf8JsonWriter writer, JsonSerialize`
`57`	`57`	`if (PartialUpdate is not null)`
`58`	`58`	`{`
`59`	`59`	`writer.WritePropertyName("doc");`
`60`		`- SourceSerialisation.Serialize(PartialUpdate, writer, settings.SourceSerializer);`
	`60`	`+ SourceSerialization.Serialize(PartialUpdate, writer, settings.SourceSerializer);`
`61`	`61`	`}`
`62`	`62`
`63`	`63`	`if (Script is not null)`
`@@ -81,7 +81,7 @@ protected override void SerializeProperties(Utf8JsonWriter writer, JsonSerialize`
`81`	`81`	`if (Upsert is not null)`
`82`	`82`	`{`
`83`	`83`	`writer.WritePropertyName("upsert");`
`84`		`- SourceSerialisation.Serialize(Upsert, writer, settings.SourceSerializer);`
	`84`	`+ SourceSerialization.Serialize(Upsert, writer, settings.SourceSerializer);`
`85`	`85`	`}`
`86`	`86`
`87`	`87`	`if (Source is not null)`
Original file line number	Diff line number	Diff line change
`@@ -155,7 +155,7 @@ private void WriteBody(IElasticsearchClientSettings settings, Utf8JsonWriter wri`
`155`	`155`	`if (_document is not null)`
`156`	`156`	`{`
`157`	`157`	`writer.WritePropertyName("doc");`
`158`		`- SourceSerialisation.Serialize(_document, writer, settings.SourceSerializer);`
	`158`	`+ SourceSerialization.Serialize(_document, writer, settings.SourceSerializer);`
`159`	`159`	`}`
`160`	`160`
`161`	`161`	`if (_scriptedUpsert.HasValue)`
`@@ -173,7 +173,7 @@ private void WriteBody(IElasticsearchClientSettings settings, Utf8JsonWriter wri`
`173`	`173`	`if (_upsert is not null)`
`174`	`174`	`{`
`175`	`175`	`writer.WritePropertyName("upsert");`
`176`		`- SourceSerialisation.Serialize(_upsert, writer, settings.SourceSerializer);`
	`176`	`+ SourceSerialization.Serialize(_upsert, writer, settings.SourceSerializer);`
`177`	`177`	`}`
`178`	`178`
`179`	`179`	`if (_source is not null)`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ protected override void SerializeProperties(Utf8JsonWriter writer, JsonSerialize`
`24`	`24`	`if (PartialUpdate is not null)`
`25`	`25`	`{`
`26`	`26`	`writer.WritePropertyName("doc");`
`27`		`- SourceSerialisation.Serialize(PartialUpdate, writer, settings.SourceSerializer);`
	`27`	`+ SourceSerialization.Serialize(PartialUpdate, writer, settings.SourceSerializer);`
`28`	`28`	`}`
`29`	`29`	`}`
`30`	`30`	`}`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ protected override void SerializeProperties(Utf8JsonWriter writer, JsonSerialize`
`36`	`36`	`if (Upsert is not null)`
`37`	`37`	`{`
`38`	`38`	`writer.WritePropertyName("upsert");`
`39`		`- SourceSerialisation.Serialize(Upsert, writer, settings.SourceSerializer);`
	`39`	`+ SourceSerialization.Serialize(Upsert, writer, settings.SourceSerializer);`
`40`	`40`	`}`
`41`	`41`	`}`
`42`	`42`	`}`
Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ void ISelfTwoWaySerializable.Serialize(Utf8JsonWriter writer, JsonSerializerOpti`
`40`	`40`	`if (Params is not null)`
`41`	`41`	`{`
`42`	`42`	`writer.WritePropertyName("params");`
`43`		`- SourceSerialisation.SerializeParams(Params, writer, settings);`
	`43`	`+ SourceSerialization.SerializeParams(Params, writer, settings);`
`44`	`44`	`}`
`45`	`45`
`46`	`46`	`writer.WriteEndObject();`
`@@ -89,7 +89,7 @@ void ISelfTwoWaySerializable.Deserialize(ref Utf8JsonReader reader, JsonSerializ`
`89`	`89`
`90`	`90`	`if (reader.ValueTextEquals("params"))`
`91`	`91`	`{`
`92`		`- var value = SourceSerialisation.DeserializeParams<Dictionary<string, object>>(ref reader, settings);`
	`92`	`+ var value = SourceSerialization.DeserializeParams<Dictionary<string, object>>(ref reader, settings);`
`93`	`93`	`if (value is not null)`
`94`	`94`	`{`
`95`	`95`	`Params = value;`