CSHARP-4255: Fix bug and some tests. #993

DmitryLukyanov · 2022-12-15T19:00:40Z

No description provided.

DmitryLukyanov · 2022-12-15T19:02:50Z

src/MongoDB.Driver/Encryption/ClientEncryption.cs

        /// <param name="createCollectionOptions">The create collection options.</param>
        /// <param name="kmsProvider">The kms provider.</param>
        /// <param name="dataKeyOptions">The datakey options.</param>
        /// <param name="cancellationToken">The cancellation token.</param>
        /// <remarks>
        /// if EncryptionFields contains a keyId with a null value, a data key will be automatically generated and assigned to keyId value.
        /// </remarks>
-        public void CreateEncryptedCollection<TCollection>(CollectionNamespace collectionNamespace, CreateCollectionOptions createCollectionOptions, string kmsProvider, DataKeyOptions dataKeyOptions, CancellationToken cancellationToken = default)
+        public void CreateEncryptedCollection(IMongoDatabase database, string collectionName, CreateCollectionOptions createCollectionOptions, string kmsProvider, DataKeyOptions dataKeyOptions, CancellationToken cancellationToken = default)


spec API is described here

BorisDog · 2023-01-12T23:12:07Z

src/MongoDB.Driver/Encryption/ClientEncryption.cs

@@ -82,59 +82,59 @@ public ClientEncryption(ClientEncryptionOptions clientEncryptionOptions)
        /// <summary>
        /// Create encrypted collection.
        /// </summary>
-        /// <param name="collectionNamespace">The collection namespace.</param>
+        /// <param name="database">The database.</param>
+        /// <param name="collectionName">The collectionName.</param>


the collection name

BorisDog · 2023-01-12T23:12:20Z

src/MongoDB.Driver/Encryption/ClientEncryption.cs

        }

        /// <summary>
        /// Create encrypted collection.
        /// </summary>
-        /// <param name="collectionNamespace">The collection namespace.</param>
+        /// <param name="database">The database.</param>
+        /// <param name="collectionName">The collectionName.</param>


the collection name

tests/MongoDB.Bson.TestHelpers/BsonValueEquivalencyComparer.cs

BorisDog · 2023-01-12T23:33:56Z

tests/MongoDB.Driver.Tests/Encryption/ClientEncryptionTests.cs

+            void AssertInvalidOperationException(Exception ex, string message) => ex.Should().BeOfType<InvalidOperationException>().Which.Message.Should().Be(message);
+        }
+
+        private class EncryptedFieldsComparer : IEqualityComparer<BsonDocument>


nit: sealed.

BorisDog · 2023-01-12T23:36:36Z

tests/MongoDB.Driver.Tests/Encryption/ClientEncryptionTests.cs

+                    bDocument["keyId"] = aDocument["keyId"];
+                }
+            });
+            public int GetHashCode(BsonDocument obj) => obj.GetHashCode();


blank line.

BorisDog · 2023-01-12T23:41:50Z

tests/MongoDB.Driver.Tests/Encryption/ClientEncryptionTests.cs

+                if (BsonDocument.TryParse(expectedResult, out var encryptedFields))
+                {
+                    var createCollectionOptions = new CreateCollectionOptions() { EncryptedFields = encryptedFieldsStr != null ? BsonDocument.Parse(encryptedFieldsStr) : null };
+                    subject.CreateEncryptedCollection(database, collectionName: collectionName, createCollectionOptions, kmsProvider: kmsProvider, dataKeyOptions);


I think it's better to omit trivial parameter naming like:
collectionName: collectionName, and kmsProvider: kmsProvider. Here and elsewhere.

BorisDog · 2023-01-16T19:51:37Z

src/MongoDB.Driver/Encryption/MongoEncryptionCreateCollectionException.cs

+        public override void GetObjectData(SerializationInfo info, StreamingContext context)
+        {
+            base.GetObjectData(info, context);
+            info.AddValue("_encryptedFields", _encryptedFields);


Is nameof applicable here?

BorisDog · 2023-01-16T19:55:09Z

src/MongoDB.Driver/Encryption/ClientEncryption.cs

+            }
+            catch (Exception ex)
+            {
+                throw new MongoEncryptionCreateCollectionException(ex, encryptedFields);


Returning operation data, which is unrelated to exception, within exception is a bit unusual, but I am fine with this here.
@JamesKovacs this is follow up for our slack discussion, please double check that you are ok with this as well.

Discussed with Dima via Slack. While from an API perspective it feels odd to return successfully-created keys in the exception, I don't see another reasonable way to avoid phantom encryption keys. While we could modify CreateCollectionOptions as we generate dataKeys, it violates the principle of least surprise to modify one's input parameters unexpectedly. I think this is the best option given the available trade-offs.

src/MongoDB.Driver/Encryption/CreateEncryptedCollectionResult.cs

src/MongoDB.Driver/Encryption/MongoEncryptionCreateCollectionException.cs

BorisDog · 2023-01-16T19:56:51Z

tests/MongoDB.Driver.Tests/Encryption/ClientEncryptionTests.cs

+                    var createCollectionOptions = new CreateCollectionOptions() { EncryptedFields = encryptedFieldsStr != null ? BsonDocument.Parse(encryptedFieldsStr) : null };
+                    AssertInvalidOperationException(Record.Exception(() => subject.CreateEncryptedCollection(database, collectionName, createCollectionOptions, kmsProvider, dataKeyOptions)), expectedResult);
+
+                    createCollectionOptions = new CreateCollectionOptions() { EncryptedFields = encryptedFieldsStr != null ? BsonDocument.Parse(encryptedFieldsStr) : null };


No need to recreate CreateCollectionOptions everywhere now.

BorisDog · 2023-01-16T19:57:27Z

tests/MongoDB.Driver.Tests/Encryption/ClientEncryptionTests.cs

+                    effectiveEncryptedFields.EncryptedFields.WithComparer(new EncryptedFieldsComparer()).Should().Be(encryptedFields.DeepClone());
+
+                    createCollectionOptions = new CreateCollectionOptions() { EncryptedFields = encryptedFieldsStr != null ? BsonDocument.Parse(encryptedFieldsStr) : null };
+                    effectiveEncryptedFields = await subject.CreateEncryptedCollectionAsync(database, collectionName, createCollectionOptions, kmsProvider, dataKeyOptions);


createCollectionResult instead of effectiveEncryptedFields?

BorisDog

minor comments

BorisDog · 2023-01-16T20:49:32Z

tests/MongoDB.Driver.Tests/Encryption/ClientEncryptionTests.cs

+                var exception = Record.Exception(() => subject.CreateEncryptedCollection(database, collectionName, createCollectionOptions, kmsProvider, dataKeyOptions));
+                AssertResults(exception, createCollectionOptions);
+
+                createCollectionOptions = new CreateCollectionOptions() { EncryptedFields = BsonDocument.Parse(encryptedFieldsStr) };


No need to recreate createCollectionOptions.

missed, done

BorisDog · 2023-01-16T20:52:46Z

src/MongoDB.Driver/CreateCollectionOptions.cs

+
+        internal override CreateCollectionOptions Clone()
+        {
+            var clone = new CreateCollectionOptions<TDocument>();


nit: you could use initialization syntax.
var = new CreateCollectionOptions() { x= y ... }

BorisDog

LGTM.

CSHARP-4255: Fix bug and some tests.

Verified

This commit was signed with the committer’s verified signature.

AArnott Andrew Arnott

GPG key ID: F33A420C60ED9C6F

Verified
Learn about vigilant mode

ca108c1

DmitryLukyanov requested review from BorisDog and JamesKovacs December 15, 2022 19:07

DmitryLukyanov commented Dec 15, 2022

View reviewed changes

JamesKovacs removed their request for review December 15, 2022 23:26

BorisDog reviewed Jan 13, 2023

View reviewed changes

DmitryLukyanov added 2 commits January 16, 2023 18:36

Code review.

28cf23d

Add test.

4029fd3

DmitryLukyanov requested a review from BorisDog January 16, 2023 14:51

BorisDog requested changes Jan 16, 2023

View reviewed changes

Code review.

308349b

DmitryLukyanov requested a review from BorisDog January 16, 2023 20:23

BorisDog requested changes Jan 16, 2023

View reviewed changes

Code review.

e7b9fc1

DmitryLukyanov requested a review from BorisDog January 16, 2023 21:07

BorisDog approved these changes Jan 16, 2023

View reviewed changes

Fixing tests.

1e78cdb

DmitryLukyanov merged commit 0bb42fa into mongodb:master Jan 17, 2023

dnickless pushed a commit to dnickless/mongo-csharp-driver that referenced this pull request Aug 24, 2023

CSHARP-4255: Fix bug and some tests. (mongodb#993)

8194c28

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

CSHARP-4255: Fix bug and some tests. #993

CSHARP-4255: Fix bug and some tests. #993

DmitryLukyanov commented Dec 15, 2022

DmitryLukyanov Dec 15, 2022

BorisDog Jan 12, 2023

DmitryLukyanov Jan 16, 2023

BorisDog Jan 12, 2023

DmitryLukyanov Jan 16, 2023

BorisDog Jan 12, 2023

DmitryLukyanov Jan 16, 2023

BorisDog Jan 12, 2023

DmitryLukyanov Jan 16, 2023

BorisDog Jan 12, 2023

DmitryLukyanov Jan 16, 2023

BorisDog Jan 16, 2023

DmitryLukyanov Jan 16, 2023

BorisDog Jan 16, 2023

JamesKovacs Jan 16, 2023

BorisDog Jan 16, 2023

DmitryLukyanov Jan 16, 2023

BorisDog Jan 16, 2023

DmitryLukyanov Jan 16, 2023

BorisDog left a comment

BorisDog Jan 16, 2023

DmitryLukyanov Jan 16, 2023

BorisDog Jan 16, 2023

DmitryLukyanov Jan 16, 2023

BorisDog left a comment

CSHARP-4255: Fix bug and some tests. #993

CSHARP-4255: Fix bug and some tests. #993

Conversation

DmitryLukyanov commented Dec 15, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

BorisDog left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

BorisDog left a comment

Choose a reason for hiding this comment