Client Encryption: Adds Client Encryption APIs to GA SDK (#3035)

To GA the client-encryption feature, we would need to remove the PREVIEW hooks from the SDK so that we can take the first step toward taking a dependency on the stable SDK version. Original PR: #2662
Azure · Mar 10, 2022 · e9aa0dd · e9aa0dd
1 parent a8c56d6
commit e9aa0dd
Show file tree

Hide file tree

Showing 19 changed files with 634 additions and 764 deletions.
diff --git a/Microsoft.Azure.Cosmos/src/CosmosClient.cs b/Microsoft.Azure.Cosmos/src/CosmosClient.cs
@@ -461,12 +461,7 @@ internal CosmosClient(
         /// a custom container that modifies the response. For example the client encryption
         /// uses this to decrypt responses before returning to the caller.
         /// </remarks>
-#if PREVIEW
-        public
-#else
-        internal
-#endif
-        virtual CosmosResponseFactory ResponseFactory => this.ClientContext.ResponseFactory;
+        public virtual CosmosResponseFactory ResponseFactory => this.ClientContext.ResponseFactory;
 
         /// <summary>
         /// Gets the endpoint Uri for the Azure Cosmos DB service.

diff --git a/Microsoft.Azure.Cosmos/src/Fluent/Settings/ClientEncryptionPolicyDefinition.cs b/Microsoft.Azure.Cosmos/src/Fluent/Settings/ClientEncryptionPolicyDefinition.cs
@@ -5,18 +5,12 @@
 namespace Microsoft.Azure.Cosmos.Fluent
 {
     using System;
-    using System.Collections.Generic;
     using System.Collections.ObjectModel;
 
     /// <summary>
     /// <see cref="ClientEncryptionPolicy"/> fluent definition.
     /// </summary>
-#if PREVIEW
-    public 
-#else
-    internal
-#endif
-        sealed class ClientEncryptionPolicyDefinition
+    public sealed class ClientEncryptionPolicyDefinition
     {
         private readonly Collection<ClientEncryptionIncludedPath> clientEncryptionIncludedPaths = new Collection<ClientEncryptionIncludedPath>();
         private readonly ContainerBuilder parent;

diff --git a/Microsoft.Azure.Cosmos/src/Fluent/Settings/ContainerBuilder.cs b/Microsoft.Azure.Cosmos/src/Fluent/Settings/ContainerBuilder.cs
@@ -91,12 +91,7 @@ ChangeFeedPolicyDefinition WithChangeFeedPolicy(TimeSpan retention)
         /// Defines the ClientEncryptionPolicy for Azure Cosmos container
         /// </summary>
         /// <returns>An instance of <see cref="ClientEncryptionPolicyDefinition"/>.</returns>
-#if PREVIEW
-        public 
-#else
-        internal
-#endif
-            ClientEncryptionPolicyDefinition WithClientEncryptionPolicy()
+        public ClientEncryptionPolicyDefinition WithClientEncryptionPolicy()
         {
             return new ClientEncryptionPolicyDefinition(
                 this,

diff --git a/Microsoft.Azure.Cosmos/src/Handler/ResponseMessage.cs b/Microsoft.Azure.Cosmos/src/Handler/ResponseMessage.cs
@@ -20,9 +20,7 @@ namespace Microsoft.Azure.Cosmos
     /// </summary>
     public class ResponseMessage : IDisposable
     {
-#if PREVIEW
         private CosmosDiagnostics diagnostics = null;
-#endif
 
         /// <summary>
         /// Create a <see cref="ResponseMessage"/>
@@ -149,21 +147,14 @@ public virtual Stream Content
         /// </summary>
         public virtual RequestMessage RequestMessage { get; internal set; }
 
-#if PREVIEW
         /// <summary>
-        /// Gets the cosmos diagnostic information for the current request to Azure Cosmos DB service
+        /// Gets or sets the cosmos diagnostic information for the current request to Azure Cosmos DB service
         /// </summary>
         public virtual CosmosDiagnostics Diagnostics
         {
             get => this.diagnostics ?? new CosmosTraceDiagnostics(this.Trace ?? NoOpTrace.Singleton);
             set => this.diagnostics = value ?? throw new ArgumentNullException(nameof(this.Diagnostics));
         }
-#else
-        /// <summary>
-        /// Gets the cosmos diagnostic information for the current request to Azure Cosmos DB service
-        /// </summary>
-        public virtual CosmosDiagnostics Diagnostics => new CosmosTraceDiagnostics(this.Trace ?? NoOpTrace.Singleton);
-#endif
 
         internal ITrace Trace { get; set; }
 

diff --git a/Microsoft.Azure.Cosmos/src/RequestOptions/RequestOptions.cs b/Microsoft.Azure.Cosmos/src/RequestOptions/RequestOptions.cs
@@ -36,15 +36,10 @@ public class RequestOptions
         /// </summary>
         public IReadOnlyDictionary<string, object> Properties { get; set; }
 
-#if PREVIEW
         /// <summary>
         /// Gets or sets a delegate which injects/appends a custom header in the request.
         /// </summary>
-        public 
-#else
-        internal        
-#endif
-        Action<Headers> AddRequestHeaders { get; set; }
+        public Action<Headers> AddRequestHeaders { get; set; }
 
         /// <summary>
         /// Gets or sets the boolean to use effective partition key routing in the cosmos db request.
@@ -93,16 +88,11 @@ internal virtual void PopulateRequestOptions(RequestMessage request)
             this.AddRequestHeaders?.Invoke(request.Headers);
         }
 
-#if PREVIEW
         /// <summary>
         /// Clone RequestOptions.
         /// </summary>
         /// <returns> cloned RequestOptions. </returns>
-        public
-#else
-        internal
-#endif
-        RequestOptions ShallowCopy()
+        public RequestOptions ShallowCopy()
         {
             return this.MemberwiseClone() as RequestOptions;
         }

diff --git a/Microsoft.Azure.Cosmos/src/Resource/ClientEncryptionKey/ClientEncryptionKey.cs b/Microsoft.Azure.Cosmos/src/Resource/ClientEncryptionKey/ClientEncryptionKey.cs
@@ -12,12 +12,7 @@ namespace Microsoft.Azure.Cosmos
     /// See <see cref="Database"/> for operations to create and enumerate client encryption keys.
     /// See https://aka.ms/CosmosClientEncryption for more information on client-side encryption support in Azure Cosmos DB.
     /// </summary>
-#if PREVIEW
-    public
-#else
-    internal
-#endif
-        abstract class ClientEncryptionKey
+    public abstract class ClientEncryptionKey
     {
         /// <summary>
         /// The unique identifier of the client encryption key.

diff --git a/Microsoft.Azure.Cosmos/src/Resource/ClientEncryptionKey/ClientEncryptionKeyProperties.cs b/Microsoft.Azure.Cosmos/src/Resource/ClientEncryptionKey/ClientEncryptionKeyProperties.cs
@@ -14,12 +14,7 @@ namespace Microsoft.Azure.Cosmos
     /// <summary> 
     /// Details of an encryption key for use with the Azure Cosmos DB service.
     /// </summary>
-#if PREVIEW
-    public
-#else
-    internal
-#endif
-        class ClientEncryptionKeyProperties : IEquatable<ClientEncryptionKeyProperties>
+    public class ClientEncryptionKeyProperties : IEquatable<ClientEncryptionKeyProperties>
     {
         /// <summary>
         /// Initializes a new instance of <see cref="ClientEncryptionKeyProperties"/>.

diff --git a/Microsoft.Azure.Cosmos/src/Resource/ClientEncryptionKey/ClientEncryptionKeyResponse.cs b/Microsoft.Azure.Cosmos/src/Resource/ClientEncryptionKey/ClientEncryptionKeyResponse.cs
@@ -9,12 +9,7 @@ namespace Microsoft.Azure.Cosmos
     /// <summary>
     /// Response from the Cosmos DB service for a <see cref="Cosmos.ClientEncryptionKey"/> related request.
     /// </summary>
-#if PREVIEW
-    public
-#else
-    internal
-#endif
-        class ClientEncryptionKeyResponse : Response<ClientEncryptionKeyProperties>
+    public class ClientEncryptionKeyResponse : Response<ClientEncryptionKeyProperties>
     {
         /// <summary>
         /// Creates a client encryption key response as a no-op for mock testing.

diff --git a/Microsoft.Azure.Cosmos/src/Resource/ClientEncryptionKey/EncryptionKeyWrapMetadata.cs b/Microsoft.Azure.Cosmos/src/Resource/ClientEncryptionKey/EncryptionKeyWrapMetadata.cs
@@ -13,12 +13,7 @@ namespace Microsoft.Azure.Cosmos
     /// Metadata that can be used to wrap/unwrap a Data Encryption Key using a Customer Managed Key.
     /// See https://aka.ms/CosmosClientEncryption for more information on client-side encryption support in Azure Cosmos DB.
     /// </summary>
-#if PREVIEW
-    public
-#else
-    internal
-#endif
-         class EncryptionKeyWrapMetadata : IEquatable<EncryptionKeyWrapMetadata>
+    public class EncryptionKeyWrapMetadata : IEquatable<EncryptionKeyWrapMetadata>
     {
         // For JSON deserialize
         private EncryptionKeyWrapMetadata()

diff --git a/Microsoft.Azure.Cosmos/src/Resource/CosmosResponseFactory.cs b/Microsoft.Azure.Cosmos/src/Resource/CosmosResponseFactory.cs
@@ -11,12 +11,7 @@ namespace Microsoft.Azure.Cosmos
     /// to the corresponding type response using the
     /// CosmosClient serializer
     /// </summary>
-#if PREVIEW
-    public
-#else
-    internal
-#endif
-    abstract class CosmosResponseFactory
+    public abstract class CosmosResponseFactory
     {
         /// <summary>
         /// Creates a FeedResponse from a response message

diff --git a/Microsoft.Azure.Cosmos/src/Resource/Database/Database.cs b/Microsoft.Azure.Cosmos/src/Resource/Database/Database.cs
@@ -980,7 +980,6 @@ public abstract ContainerBuilder DefineContainer(
             string name,
             string partitionKeyPath);
 
-#if PREVIEW
         /// <summary>
         /// Returns a reference to a client encryption key object.
         /// This method is not meant to be invoked directly. Please see https://aka.ms/CosmosClientEncryption in order to use client-side encryption.
@@ -1022,6 +1021,5 @@ public abstract Task<ClientEncryptionKeyResponse> CreateClientEncryptionKeyAsync
             ClientEncryptionKeyProperties clientEncryptionKeyProperties,
             RequestOptions requestOptions = null,
             CancellationToken cancellationToken = default);
-#endif
     }
 }
diff --git a/Microsoft.Azure.Cosmos/src/Resource/Database/DatabaseCore.cs b/Microsoft.Azure.Cosmos/src/Resource/Database/DatabaseCore.cs
@@ -684,12 +684,7 @@ public override ContainerBuilder DefineContainer(
             return new ContainerBuilder(this, name, partitionKeyPath);
         }
 
-#if PREVIEW
-        public override
-#else
-        internal virtual
-#endif
-            ClientEncryptionKey GetClientEncryptionKey(string id)
+        public override ClientEncryptionKey GetClientEncryptionKey(string id)
         {
             if (string.IsNullOrEmpty(id))
             {
@@ -702,15 +697,10 @@ ClientEncryptionKey GetClientEncryptionKey(string id)
                     id);
         }
 
-#if PREVIEW
-        public override
-#else
-        internal virtual
-#endif
-            FeedIterator<ClientEncryptionKeyProperties> GetClientEncryptionKeyQueryIterator(
-                QueryDefinition queryDefinition,
-                string continuationToken = null,
-                QueryRequestOptions requestOptions = null)
+        public override FeedIterator<ClientEncryptionKeyProperties> GetClientEncryptionKeyQueryIterator(
+            QueryDefinition queryDefinition,
+            string continuationToken = null,
+            QueryRequestOptions requestOptions = null)
         {
             if (!(this.GetClientEncryptionKeyQueryStreamIterator(
                     queryDefinition: queryDefinition,
@@ -743,12 +733,7 @@ private FeedIterator GetClientEncryptionKeyQueryStreamIterator(
                 options: requestOptions);
         }
 
-#if PREVIEW
-        public
-#else
-        internal virtual
-#endif
-            async Task<ClientEncryptionKeyResponse> CreateClientEncryptionKeyAsync(
+        public async Task<ClientEncryptionKeyResponse> CreateClientEncryptionKeyAsync(
                 ITrace trace,
                 ClientEncryptionKeyProperties clientEncryptionKeyProperties,
                 RequestOptions requestOptions = null,

diff --git a/Microsoft.Azure.Cosmos/src/Resource/Database/DatabaseInlineCore.cs b/Microsoft.Azure.Cosmos/src/Resource/Database/DatabaseInlineCore.cs
@@ -305,38 +305,23 @@ public override Task<UserResponse> UpsertUserAsync(
                 (trace) => base.UpsertUserAsync(id, requestOptions, trace, cancellationToken));
         }
 
-#if PREVIEW
-        public
-#else
-        internal
-#endif
-            override ClientEncryptionKey GetClientEncryptionKey(string id)
+        public override ClientEncryptionKey GetClientEncryptionKey(string id)
         {
             return base.GetClientEncryptionKey(id);
         }
 
-#if PREVIEW
-        public
-#else
-        internal
-#endif
-            override FeedIterator<ClientEncryptionKeyProperties> GetClientEncryptionKeyQueryIterator(
-                QueryDefinition queryDefinition,
-                string continuationToken = null,
-                QueryRequestOptions requestOptions = null)  
+        public override FeedIterator<ClientEncryptionKeyProperties> GetClientEncryptionKeyQueryIterator(
+            QueryDefinition queryDefinition,
+            string continuationToken = null,
+            QueryRequestOptions requestOptions = null)  
         {
             return base.GetClientEncryptionKeyQueryIterator(queryDefinition, continuationToken, requestOptions);
         }
 
-#if PREVIEW
-        public override
-#else
-        internal
-#endif
-            Task<ClientEncryptionKeyResponse> CreateClientEncryptionKeyAsync(
-                ClientEncryptionKeyProperties clientEncryptionKeyProperties,
-                RequestOptions requestOptions = null,
-                CancellationToken cancellationToken = default)
+        public override Task<ClientEncryptionKeyResponse> CreateClientEncryptionKeyAsync(
+            ClientEncryptionKeyProperties clientEncryptionKeyProperties,
+            RequestOptions requestOptions = null,
+            CancellationToken cancellationToken = default)
         {
             return this.ClientContext.OperationHelperAsync(
                 nameof(CreateClientEncryptionKeyAsync),

diff --git a/Microsoft.Azure.Cosmos/src/Resource/Settings/ClientEncryptionIncludedPath.cs b/Microsoft.Azure.Cosmos/src/Resource/Settings/ClientEncryptionIncludedPath.cs
@@ -11,12 +11,7 @@ namespace Microsoft.Azure.Cosmos
     /// <summary>
     /// Path that needs encryption and the associated settings within <see cref="ClientEncryptionPolicy"/>.
     /// </summary>
-#if PREVIEW
-    public 
-#else
-    internal
-#endif
-        sealed class ClientEncryptionIncludedPath
+    public sealed class ClientEncryptionIncludedPath
     {
         /// <summary>
         /// Gets or sets the path to be encrypted. Must be a top level path, eg. /salary

diff --git a/Microsoft.Azure.Cosmos/src/Resource/Settings/ClientEncryptionPolicy.cs b/Microsoft.Azure.Cosmos/src/Resource/Settings/ClientEncryptionPolicy.cs
@@ -14,12 +14,7 @@ namespace Microsoft.Azure.Cosmos
     /// <summary>
     /// Client encryption policy.
     /// </summary>
-#if PREVIEW
-    public 
-#else
-    internal
-#endif
-        sealed class ClientEncryptionPolicy
+    public sealed class ClientEncryptionPolicy
     {
         /// <summary>
         /// Initializes a new instance of the <see cref="ClientEncryptionPolicy"/> class.

diff --git a/Microsoft.Azure.Cosmos/src/Resource/Settings/ContainerProperties.cs b/Microsoft.Azure.Cosmos/src/Resource/Settings/ContainerProperties.cs
@@ -246,7 +246,7 @@ public UniqueKeyPolicy UniqueKeyPolicy
         public DateTime? LastModified { get; private set; }
 
         /// <summary>
-        /// Gets the client encryption policy information for storing items in a container from the Azure Cosmos service.
+        /// Gets or sets the client encryption policy information for storing items in a container from the Azure Cosmos service.
         /// </summary>
         /// <value>
         /// It is an optional property.
@@ -258,12 +258,7 @@ public UniqueKeyPolicy UniqueKeyPolicy
         /// </para>
         /// </remarks>
         [JsonIgnore]
-#if PREVIEW
-        public
-#else
-        internal
-#endif
-            ClientEncryptionPolicy ClientEncryptionPolicy
+        public ClientEncryptionPolicy ClientEncryptionPolicy
         {
             get => this.clientEncryptionPolicyInternal;