[Client encryption]: Adds a new override through property bag to enable System.Text.Json streaming API

[adamnova]

Pull Request Template

#4678

Overview

Adds opt-in support for System.Text.Json streaming API in client-side encryption operations, providing improved performance and reduced memory usage for large encrypted documents.

Usage

Set via RequestOptions (Read/Write Operations)

var requestOptions = new ItemRequestOptions
{
    Properties = new Dictionary<string, object>
    {
        { "encryption-json-processor", JsonProcessor.Stream }
    }
};

// Read with streaming processor
var response = await encryptionContainer.ReadItemAsync<MyDoc>(
    id, partitionKey, requestOptions);

Listening to telemetry

OpenTelemetry SDK

OpenTelemetry SDK automatically captures activities from both sources:

using OpenTelemetry;
using OpenTelemetry.Trace;

var tracerProvider = Sdk.CreateTracerProviderBuilder()
    .AddSource("Microsoft.Azure.Cosmos.Encryption.Custom")
    .AddConsoleExporter()
    .Build();

// Use your encrypted container - all traces are automatically collected

Using ActivityListener

For custom processing without OpenTelemetry SDK, you can use ActivityListener:

using System.Diagnostics;

var listener = new ActivityListener
{
    ShouldListenTo = (activitySource) => 
        activitySource.Name == "Microsoft.Azure.Cosmos.Encryption.Custom"
    
    Sample = (ref ActivityCreationOptions<ActivityContext> _) => 
        ActivitySamplingResult.AllDataAndRecorded,
    
    ActivityStarted = activity =>
    {
        Console.WriteLine($"[START] {activity.Source.Name}: {activity.DisplayName}");
    },
    
    ActivityStopped = activity =>
    {
        Console.WriteLine($"[STOP]  {activity.Source.Name}: {activity.DisplayName} ({activity.Duration.TotalMilliseconds}ms)");
    }
};

ActivitySource.AddActivityListener(listener);

// Clean up when done
listener.Dispose();

Key Changes

• New Property Bag Key: "encryption-json-processor" in RequestOptions.Properties
• New Enum Value: JsonProcessor.Stream (available in .NET 8.0+)
• Backward Compatible: Defaults to JsonProcessor.Newtonsoft when not specified
• Algorithm Support: Only works with MdeAeadAes256CbcHmac256Randomized algorithm

[kirankumarkolli]

var requestOptions = new ItemRequestOptions
{
    Properties = new Dictionary<string, object>
    {
        { "encryption-json-processor", "JsonProcessor.Stream" }
    }
};

[kirankumarkolli]

/azp run

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).

[kirankumarkolli]

/azp run

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).