tests

Author: christothes

src/Custom/Chat/UpdateChatCompletionOptions..cs

@@ -2,32 +2,35 @@
 using System.ClientModel;
 using System.ClientModel.Primitives;
 using System.Collections.Generic;
+using System.ComponentModel;
+using System.Diagnostics.CodeAnalysis;
+using System.Text;
 using System.Text.Json;
 
 namespace OpenAI.Chat;
 
 public class UpdateChatCompletionOptions : JsonModel<UpdateChatCompletionOptions>
 {
-    private protected IDictionary<string, BinaryData> _additionalBinaryDataProperties;
+    [Experimental("SCME0001")]
+    private JsonPatch _patch;
 
-    public UpdateChatCompletionOptions() { }
+    public UpdateChatCompletionOptions() : this(null, default) { }
 
-    internal UpdateChatCompletionOptions(IDictionary<string, string> metadata, IDictionary<string, BinaryData> additionalBinaryDataProperties)
+#pragma warning disable SCME0001 // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
+    internal UpdateChatCompletionOptions(IDictionary<string, string> metadata, in JsonPatch patch)
     {
         // Plugin customization: ensure initialization of collections
         Metadata = metadata ?? new ChangeTrackingDictionary<string, string>();
-        _additionalBinaryDataProperties = additionalBinaryDataProperties;
+        _patch = patch;
     }
 
     public string CompletionId { get; set; }
 
     public IDictionary<string, string> Metadata { get; }
 
-    internal IDictionary<string, BinaryData> SerializedAdditionalRawData
-    {
-        get => _additionalBinaryDataProperties;
-        set => _additionalBinaryDataProperties = value;
-    }
+    [EditorBrowsable(EditorBrowsableState.Never)]
+    [Experimental("SCME0001")]
+    public ref JsonPatch Patch => ref _patch;
 
     protected override void WriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options)
     {
@@ -36,7 +39,8 @@ protected override void WriteCore(Utf8JsonWriter writer, ModelReaderWriterOption
         {
             throw new FormatException($"The model {nameof(UpdateChatCompletionOptions)} does not support writing '{format}' format.");
         }
-        if (_additionalBinaryDataProperties?.ContainsKey("metadata") != true)
+        writer.WriteStartObject();
+        if (Optional.IsCollectionDefined(Metadata) && !Patch.Contains("$.metadata"u8))
         {
             writer.WritePropertyName("metadata"u8);
             writer.WriteStartObject();
@@ -52,26 +56,9 @@ protected override void WriteCore(Utf8JsonWriter writer, ModelReaderWriterOption
             }
             writer.WriteEndObject();
         }
-        // Plugin customization: remove options.Format != "W" check
-        if (_additionalBinaryDataProperties != null)
-        {
-            foreach (var item in _additionalBinaryDataProperties)
-            {
-                if (ModelSerializationExtensions.IsSentinelValue(item.Value))
-                {
-                    continue;
-                }
-                writer.WritePropertyName(item.Key);
-#if NET6_0_OR_GREATER
-                    writer.WriteRawValue(item.Value);
-#else
-                using (JsonDocument document = JsonDocument.Parse(item.Value))
-                {
-                    JsonSerializer.Serialize(writer, document.RootElement);
-                }
-#endif
-            }
-        }
+        Patch.WriteTo(writer);
+        writer.WriteEndObject();
+#pragma warning restore SCME0001 // Type is for evaluation purposes only and is subject to change or removal in future updates.
     }
 
     protected override UpdateChatCompletionOptions CreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options)
@@ -85,17 +72,19 @@ protected virtual UpdateChatCompletionOptions JsonModelCreateCore(ref Utf8JsonRe
             throw new FormatException($"The model {nameof(UpdateChatCompletionOptions)} does not support reading '{format}' format.");
         }
         using JsonDocument document = JsonDocument.ParseValue(ref reader);
-        return DeserializeUpdateChatCompletionOptions(document.RootElement, options);
+        return DeserializeUpdateChatCompletionOptions(document.RootElement, null, options);
     }
 
-    internal static UpdateChatCompletionOptions DeserializeUpdateChatCompletionOptions(JsonElement element, ModelReaderWriterOptions options)
+    internal static UpdateChatCompletionOptions DeserializeUpdateChatCompletionOptions(JsonElement element, BinaryData data, ModelReaderWriterOptions options)
     {
         if (element.ValueKind == JsonValueKind.Null)
         {
             return null;
         }
         IDictionary<string, string> metadata = default;
-        IDictionary<string, BinaryData> additionalBinaryDataProperties = new ChangeTrackingDictionary<string, BinaryData>();
+#pragma warning disable SCME0001 // Type is for evaluation purposes only and is subject to change or removal in future updates.
+        JsonPatch patch = new JsonPatch(data is null ? ReadOnlyMemory<byte>.Empty : data.ToMemory());
+#pragma warning restore SCME0001 // Type is for evaluation purposes only and is subject to change or removal in future updates.
         foreach (var prop in element.EnumerateObject())
         {
             if (prop.NameEquals("metadata"u8))
@@ -115,10 +104,9 @@ internal static UpdateChatCompletionOptions DeserializeUpdateChatCompletionOptio
                 metadata = dictionary;
                 continue;
             }
-            // Plugin customization: remove options.Format != "W" check
-            additionalBinaryDataProperties.Add(prop.Name, BinaryData.FromString(prop.Value.GetRawText()));
+            patch.Set([.. "$."u8, .. Encoding.UTF8.GetBytes(prop.Name)], prop.Value.GetUtf8Bytes());
         }
-        return new UpdateChatCompletionOptions(metadata, additionalBinaryDataProperties);
+        return new UpdateChatCompletionOptions(metadata, patch);
     }
 
     public static implicit operator BinaryContent(UpdateChatCompletionOptions options)

tests/Chat/ChatStoreTests.cs

@@ -68,7 +68,7 @@ public async Task GetChatCompletionsWithPagination()
             completionIds.Add(completion.Id);
         }
 
-        await Task.Delay(s_delayInMilliseconds); // Wait for completions to be stored
+        await DelayIfNotInPlaybackAsync(s_delayInMilliseconds); // Wait for completions to be stored
 
         // Test pagination with limit
         ChatCompletionCollectionOptions paginationOptions = new()
@@ -125,20 +125,20 @@ public async Task GetChatCompletionsWithPagination_PM()
             completionIds.Add(completion.Id);
         }
 
-        await Task.Delay(s_delayInMilliseconds); // Wait for completions to be stored
+        await DelayIfNotInPlaybackAsync(s_delayInMilliseconds); // Wait for completions to be stored
 
         // Test pagination with limit
         ChatCompletionCollectionOptions paginationOptions = new()
         {
-            PageSizeLimit = 2
+            PageSizeLimit = 2,
         };
 
         int totalCount = 0;
         string lastId = null;
 
-        // await foreach (var fetchedCompletion in client.GetChatCompletionsAsync(after: null, limit: 2, order: null, metadata: null))
         var getOptions = GetChatCompletionsOptions.Create(client);
         getOptions.Limit = 2;
+        getOptions.Model = "gpt-4o-mini-2024-07-18";
         ChatCompletionList result;
         do
         {
@@ -150,11 +150,9 @@ public async Task GetChatCompletionsWithPagination_PM()
                 lastId = fetchedCompletion.Id;
                 Assert.That(fetchedCompletion.Id, Is.Not.Null.And.Not.Empty);
                 Assert.That(fetchedCompletion.Choices[0].Message.Content, Is.Not.Null);
-
-                if (totalCount >= 2) break; // Stop after getting 2 items
             }
 
-        } while (result.HasMore);
+        } while (result.HasMore && totalCount < 2);
 
 
         Assert.That(totalCount, Is.EqualTo(2));
@@ -193,7 +191,7 @@ public async Task GetChatCompletionsWithPagination_PMwRequestOptions()
             completionIds.Add(completion.Id);
         }
 
-        await Task.Delay(s_delayInMilliseconds); // Wait for completions to be stored
+        await DelayIfNotInPlaybackAsync(s_delayInMilliseconds); // Wait for completions to be stored
 
         // Test pagination with limit
         ChatCompletionCollectionOptions paginationOptions = new()
@@ -205,6 +203,7 @@ public async Task GetChatCompletionsWithPagination_PMwRequestOptions()
         string lastId = null;
         var getOptions = GetChatCompletionsOptions.Create(client);
         getOptions.Limit = 2;
+        getOptions.Model = "gpt-4o-mini-2024-07-18";
 
         AsyncCollectionResult foo = client.GetChatCompletionsAsync(getOptions, requestOptions: new RequestOptions());
 
@@ -258,7 +257,7 @@ public async Task GetChatCompletionsWithAfterIdPagination()
             completionIds.Add(completion.Id);
         }
 
-        await Task.Delay(s_delayInMilliseconds); // Wait for completions to be stored
+        await DelayIfNotInPlaybackAsync(s_delayInMilliseconds); // Wait for completions to be stored
 
         // Get first completion to use as afterId
         string afterId = null;
@@ -317,10 +316,10 @@ public async Task GetChatCompletionsWithOrderFiltering()
                 createOptions);
 
             completionIds.Add(completion.Id);
-            await Task.Delay(1000); // Ensure different timestamps
+            await DelayIfNotInPlaybackAsync(1000); // Ensure different timestamps
         }
 
-        await Task.Delay(s_delayInMilliseconds); // Wait for completions to be stored
+        await DelayIfNotInPlaybackAsync(s_delayInMilliseconds); // Wait for completions to be stored
 
         // Test ascending order
         ChatCompletionCollectionOptions ascOptions = new()
@@ -403,7 +402,7 @@ public async Task GetChatCompletionsWithMetadataFiltering()
             options2);
         completionIds.Add(otherCompletion.Id);
 
-        await Task.Delay(s_delayInMilliseconds); // Wait for completions to be stored
+        await DelayIfNotInPlaybackAsync(s_delayInMilliseconds); // Wait for completions to be stored
 
         // Filter by specific metadata
         ChatCompletionCollectionOptions filterOptions = new()
@@ -451,7 +450,7 @@ public async Task GetChatCompletionsWithModelFiltering()
             ["Model filter test: Say 'Hello'"],
             createOptions);
 
-        await Task.Delay(s_delayInMilliseconds); // Wait for completions to be stored
+        await DelayIfNotInPlaybackAsync(s_delayInMilliseconds); // Wait for completions to be stored
 
         // Filter by the model used by the test client
         ChatCompletionCollectionOptions filterOptions = new()
@@ -494,7 +493,7 @@ public async Task GetChatCompletionsWithEmptyOptions()
             ["Empty options test: Say 'Hello'"],
             createOptions);
 
-        await Task.Delay(s_delayInMilliseconds); // Wait for completions to be stored
+        await DelayIfNotInPlaybackAsync(s_delayInMilliseconds); // Wait for completions to be stored
 
         // Test with default/empty options
         int count = 0;
@@ -538,7 +537,7 @@ public async Task GetChatCompletionsWithCombinedFilters()
             ["Combined filters test: Say 'Combined test'"],
             createOptions);
 
-        await Task.Delay(s_delayInMilliseconds); // Wait for completions to be stored
+        await DelayIfNotInPlaybackAsync(s_delayInMilliseconds); // Wait for completions to be stored
 
         // Test with combined filters
         ChatCompletionCollectionOptions combinedOptions = new()
@@ -595,7 +594,7 @@ await TestHelpers.RetryWithExponentialBackoffAsync(async () =>
             Assert.That(deletionResult.Deleted, Is.True);
         });
 
-        await Task.Delay(s_delayInMilliseconds);
+        await DelayIfNotInPlaybackAsync(s_delayInMilliseconds);
 
         Assert.ThrowsAsync<ClientResultException>(async () =>
         {
@@ -661,7 +660,7 @@ public async Task UpdateChatCompletionWorks_PM()
             [new UserChatMessage("Say `this is a test`.")],
             initialOptions);
 
-        await Task.Delay(s_delayInMilliseconds); // Wait for completions to be stored
+        await DelayIfNotInPlaybackAsync(s_delayInMilliseconds); // Wait for completions to be stored
 
         var updateOptions = new UpdateChatCompletionOptions()
         {
@@ -672,15 +671,15 @@ [new UserChatMessage("Say `this is a test`.")],
 
         ChatCompletionResult updated = await client.UpdateChatCompletionAsync(updateOptions);
 
-        await Task.Delay(s_delayInMilliseconds); // Wait for completions to be updated
+        await DelayIfNotInPlaybackAsync(s_delayInMilliseconds); // Wait for completions to be updated
 
         Assert.That(updated, Is.Not.Null);
         Assert.That(updated.Id, Is.EqualTo(chatCompletion.Id));
 
         ChatCompletionDeletionResult deletionResult = await client.DeleteChatCompletionAsync(chatCompletion.Id);
         Assert.That(deletionResult.Deleted, Is.True);
 
-        await Task.Delay(s_delayInMilliseconds); // Wait for completions to be deleted
+        await DelayIfNotInPlaybackAsync(s_delayInMilliseconds); // Wait for completions to be deleted
 
         Assert.ThrowsAsync<ClientResultException>(async () =>
         {
@@ -704,7 +703,7 @@ public async Task GetChatCompletionsValidatesCollectionEnumeration()
             ["Enumeration test: Say 'Test enumeration'"],
             createOptions);
 
-        await Task.Delay(5000); // Wait for completion to be stored
+        await DelayIfNotInPlaybackAsync(5000); // Wait for completion to be stored
 
         // Test that we can enumerate multiple times
         ChatCompletionCollectionOptions collectionOptions = new()
@@ -758,7 +757,7 @@ public async Task GetChatCompletionsHandlesLargeLimits()
             ["Large limit test: Say 'Testing large limits'"],
             createOptions);
 
-        await Task.Delay(s_delayInMilliseconds); // Wait for completions to be stored
+        await DelayIfNotInPlaybackAsync(s_delayInMilliseconds); // Wait for completions to be stored
 
         // Test with a large page size limit
         ChatCompletionCollectionOptions largeOptions = new()
@@ -799,7 +798,7 @@ public async Task GetChatCompletionsWithMinimalLimits()
             ["Minimal limit test: Say 'Testing minimal limits'"],
             createOptions);
 
-        await Task.Delay(s_delayInMilliseconds); // Wait for completions to be stored
+        await DelayIfNotInPlaybackAsync(s_delayInMilliseconds); // Wait for completions to be stored
 
         // Test with minimal page size
         ChatCompletionCollectionOptions minimalOptions = new()