DGS-21268 Add support for full payload encryption #2011
Conversation
This file contains hidden or 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
|
🎉 All Contributor License Agreements have been signed. Ready to merge. |
There was a problem hiding this comment.
Pull Request Overview
This PR adds full payload encryption support by introducing a new payload-level executor, extending rule phases, and wiring encoding-phase rule execution into all sync/async serdes.
- Introduce
EncryptionExecutoralongside legacyFieldEncryptionExecutorto handle full payload encryption. - Add a new
RulePhase.ENCODINGandencoding_rulesinRuleSetfor payload-phase rules. - Update all sync and async JSON/Avro/Protobuf serializers/deserializers to run encoding-phase rules before serialization and after deserialization.
- Add end-to-end payload encryption tests (
test_*_payload_encryption) for JSON, Avro, and Protobuf in both sync and async contexts.
Reviewed Changes
Copilot reviewed 16 out of 16 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| tests/schema_registry/_sync/test_proto_serdes.py | Imported EncryptionExecutor, adjusted client references, added payload encryption test |
| tests/schema_registry/_sync/test_json_serdes.py | Imported EncryptionExecutor, adjusted client references, added payload encryption test |
| tests/schema_registry/_sync/test_avro_serdes.py | Imported EncryptionExecutor, adjusted client references, added payload encryption test |
| src/confluent_kafka/schema_registry/rules/encryption/*.py | Added EncryptionExecutor, renamed transform signatures, wrapped field executor |
| src/confluent_kafka/schema_registry/common/schema_registry_client.py | Added RulePhase.ENCODING and encoding_rules in RuleSet |
| src/confluent_kafka/schema_registry/_sync/serde.py | Added _execute_rules_with_phase and wired encoding-phase rules |
| src/confluent_kafka/schema_registry/_sync/{protobuf,json_schema,avro}.py | Hooked encoding-phase execution in serializers/deserializers |
| src/confluent_kafka/schema_registry/_async/serde.py | Mirrored sync serde changes for async |
| src/confluent_kafka/schema_registry/_async/{protobuf,json_schema,avro}.py | Mirrored sync serializers/deserializers changes for async |
Comments suppressed due to low confidence (2)
tests/schema_registry/_sync/test_json_serdes.py:998
- [nitpick] Rename the test function to test_json_payload_encryption for consistency with the other payload encryption test names.
def test_json_payloadencryption():
tests/schema_registry/_async/test_json_serdes.py:998
- [nitpick] Rename the async test function to test_json_payload_encryption for consistency with other payload encryption test names.
async def test_json_payloadencryption():
Analysis Details51 Issues
Coverage and Duplications
Project ID: confluent-kafka-python |
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.
What
Add support for full payload encryption
Checklist
References
JIRA:
Test & Review
Open questions / Follow-ups