feat(NODE-6507): generate encryption configuration on mongoose connect #15320
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
baileympearson
commented
Mar 18, 2025
baileympearson
commented
Mar 18, 2025
baileympearson
commented
Mar 18, 2025
vkarpov15
requested changes
Mar 18, 2025
There was a problem hiding this comment.
I'd also like to see tests covering:
- Subdocuments
- Document arrays
- Maps
If you can do CSFLE with nested paths, you should be able to also do CSFLE with subdocuments, which are slightly different.
I believe I now have tests for all of these. Let me know if I'm still missing anything |
vkarpov15
reviewed
Mar 21, 2025
vkarpov15
reviewed
Mar 21, 2025
vkarpov15
reviewed
Mar 21, 2025
vkarpov15
reviewed
Apr 15, 2025
| } | ||
| } | ||
|
|
||
| function* allNestedPaths(schema) { |
There was a problem hiding this comment.
This is a neat use case for generators, but I think doing [...Object.keys(schema.paths), ...Object.keys(schema.singleNestedPaths)] would be more concise and more consistent with the rest of the codebase
vkarpov15
approved these changes
Apr 15, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR contains the meat and potatoes of the automatic CSFLE/QE integration into mongoose. With the changes included, users can now create encrypted schemas, instantiate models with them, insert and query using their model and have the resultant documents be encrypted and decrypted automatically.
This PR contains a lot of test changes. I tried to be as exhaustive to ensure as much coverage as possible, and because the schema format is unlikely to change (changing the format of encryptedFieldsMap or schemaMap would break a lot of drivers and applications). So ideally these tests are not a large maintenance burden.
Examples
See the integration tests in
encryption.test.tsfor an example of how the API works.