forked from apache/cassandra-python-driver
-
Notifications
You must be signed in to change notification settings - Fork 49
Optimize column_encryption_policy checks in recv_results_rows #583
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
Copilot
wants to merge
11
commits into
master
Choose a base branch
from
copilot/optimize-column-encryption-checks
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from 2 commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
89ac019
Initial plan
Copilot 2fc623a
Optimize column_encryption_policy checks in recv_results_rows
Copilot b192ca5
Add detailed comments explaining the optimization benefits
Copilot 12eac38
Simplify optimization - only define decode_row differently
Copilot 89a3211
Restore decode_val function for readability and remove unused import
Copilot 8e82b03
Check column_encryption_policy once per result message
Copilot 92a5963
Only create col_descs when needed
Copilot 8910184
Reuse decode_val function in exception handler
Copilot f516180
Remove duplicate try-except blocks (DRY principle)
Copilot 8cda794
Sort imports alphabetically in test file
Copilot e9e4459
Refactor decode_val to use if/else instead of ternary operators
Copilot File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,152 @@ | ||
| # Copyright DataStax, Inc. | ||
mykaul marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
| import unittest | ||
| from unittest.mock import Mock, MagicMock | ||
github-code-quality[bot] marked this conversation as resolved.
Fixed
Show fixed
Hide fixed
|
||
| import io | ||
|
|
||
| from cassandra import ProtocolVersion | ||
| from cassandra.protocol import ResultMessage, RESULT_KIND_ROWS | ||
| from cassandra.cqltypes import Int32Type, UTF8Type | ||
mykaul marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| from cassandra.policies import ColDesc | ||
| from cassandra.marshal import int32_pack | ||
|
|
||
|
|
||
| class DecodeOptimizationTest(unittest.TestCase): | ||
| """ | ||
| Tests to verify the optimization of column_encryption_policy checks | ||
| in recv_results_rows. The optimization should avoid checking the policy | ||
| for every value and instead check once per recv_results_rows call. | ||
| """ | ||
|
|
||
| def _create_mock_result_metadata(self): | ||
| """Create mock result metadata for testing""" | ||
| return [ | ||
| ('keyspace1', 'table1', 'col1', Int32Type), | ||
| ('keyspace1', 'table1', 'col2', UTF8Type), | ||
| ] | ||
|
|
||
| def _create_mock_result_message(self): | ||
| """Create a mock result message with data""" | ||
| msg = ResultMessage(kind=RESULT_KIND_ROWS) | ||
| msg.column_metadata = self._create_mock_result_metadata() | ||
| msg.recv_results_metadata = Mock() | ||
| msg.recv_row = Mock(side_effect=[ | ||
| [int32_pack(42), b'hello'], | ||
| [int32_pack(100), b'world'], | ||
| ]) | ||
| return msg | ||
|
|
||
| def _create_mock_stream(self): | ||
| """Create a mock stream for reading rows""" | ||
| # Pack rowcount (2 rows) | ||
| data = int32_pack(2) | ||
| return io.BytesIO(data) | ||
|
|
||
| def test_decode_without_encryption_policy(self): | ||
| """ | ||
| Test that decoding works correctly without column encryption policy. | ||
| This should use the optimized simple path. | ||
| """ | ||
| msg = self._create_mock_result_message() | ||
| f = self._create_mock_stream() | ||
|
|
||
| msg.recv_results_rows(f, ProtocolVersion.V4, {}, None, None) | ||
|
|
||
| # Verify results | ||
| self.assertEqual(len(msg.parsed_rows), 2) | ||
| self.assertEqual(msg.parsed_rows[0][0], 42) | ||
| self.assertEqual(msg.parsed_rows[0][1], 'hello') | ||
| self.assertEqual(msg.parsed_rows[1][0], 100) | ||
| self.assertEqual(msg.parsed_rows[1][1], 'world') | ||
|
|
||
| def test_decode_with_encryption_policy_no_encrypted_columns(self): | ||
| """ | ||
| Test that decoding works with encryption policy when no columns are encrypted. | ||
| """ | ||
| msg = self._create_mock_result_message() | ||
| f = self._create_mock_stream() | ||
|
|
||
| # Create mock encryption policy that has no encrypted columns | ||
| mock_policy = Mock() | ||
| mock_policy.contains_column = Mock(return_value=False) | ||
|
|
||
| msg.recv_results_rows(f, ProtocolVersion.V4, {}, None, mock_policy) | ||
|
|
||
| # Verify results | ||
| self.assertEqual(len(msg.parsed_rows), 2) | ||
| self.assertEqual(msg.parsed_rows[0][0], 42) | ||
| self.assertEqual(msg.parsed_rows[0][1], 'hello') | ||
|
|
||
| # Verify contains_column was called only once per column (optimization check) | ||
| # Should be called 2 times total (once per column, not per value per row) | ||
| self.assertEqual(mock_policy.contains_column.call_count, 2) | ||
|
|
||
| def test_decode_with_encryption_policy_with_encrypted_column(self): | ||
| """ | ||
| Test that decoding works with encryption policy when one column is encrypted. | ||
| """ | ||
| msg = self._create_mock_result_message() | ||
| f = self._create_mock_stream() | ||
|
|
||
| # Create mock encryption policy where first column is encrypted | ||
| mock_policy = Mock() | ||
| def contains_column_side_effect(col_desc): | ||
| return col_desc.col == 'col1' | ||
| mock_policy.contains_column = Mock(side_effect=contains_column_side_effect) | ||
| mock_policy.column_type = Mock(return_value=Int32Type) | ||
| mock_policy.decrypt = Mock(side_effect=lambda col_desc, val: val) | ||
|
|
||
| msg.recv_results_rows(f, ProtocolVersion.V4, {}, None, mock_policy) | ||
|
|
||
| # Verify results | ||
| self.assertEqual(len(msg.parsed_rows), 2) | ||
| self.assertEqual(msg.parsed_rows[0][0], 42) | ||
| self.assertEqual(msg.parsed_rows[0][1], 'hello') | ||
|
|
||
| # Verify contains_column was called only once per column (optimization) | ||
| self.assertEqual(mock_policy.contains_column.call_count, 2) | ||
|
|
||
| # Verify decrypt was called for each encrypted value (2 rows * 1 encrypted column) | ||
| self.assertEqual(mock_policy.decrypt.call_count, 2) | ||
|
|
||
| def test_optimization_efficiency(self): | ||
| """ | ||
| Verify that the optimization reduces the number of policy checks. | ||
| With the old code, contains_column would be called for every value. | ||
| With the new code, it's called once per column. | ||
| """ | ||
| msg = self._create_mock_result_message() | ||
|
|
||
| # Create more rows to make the optimization more apparent | ||
| msg.recv_row = Mock(side_effect=[ | ||
| [int32_pack(i), f'text{i}'.encode()] for i in range(100) | ||
| ]) | ||
|
|
||
| # Create mock stream with 100 rows | ||
| f = io.BytesIO(int32_pack(100)) | ||
|
|
||
| mock_policy = Mock() | ||
| mock_policy.contains_column = Mock(return_value=False) | ||
|
|
||
| msg.recv_results_rows(f, ProtocolVersion.V4, {}, None, mock_policy) | ||
|
|
||
| # With optimization: contains_column called once per column = 2 calls | ||
| # Without optimization: would be called per value = 100 rows * 2 columns = 200 calls | ||
| self.assertEqual(mock_policy.contains_column.call_count, 2, | ||
| "Optimization failed: contains_column should be called once per column, not per value") | ||
|
|
||
|
|
||
| if __name__ == '__main__': | ||
| unittest.main() | ||
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.
Uh oh!
There was an error while loading. Please reload this page.