[CLIENT-2383] Fix bug where Query.where() and client.index_cdt_create() do not accept a list of contexts #550

DomPeliniAerospike · 2024-01-08T16:50:53Z

This approach does not change the helper function get_cdt_ctx() which currently only accepts an optional Python dictionary. We're avoiding changes to get_cdt_ctx() since it is used in many places in cdt_list_operate.c and cdt_map_operate.c. In the future we will refactor cdt_{list,map}_operate.c to make it easier to refactor these type of helper functions

Extra changes:

CLIENT-3652 Fix query.where() not accepting None as ctx argument
Fix bug where index_cdt_create() raises a blank AerospikeError exception when receiving an invalid ctx parameter
Remove unused raise_exception_old() declaration
Fixed TestBaseClass.major_ver and TestBaseClass.minor_ver not being initialized for test files that use TestBaseClass.get_new_connection() and not the as_connection fixture to initialize the Python client

Known issues

There's some missing code coverage in index_cdt_create() because ctx is a required parameter (non-NULL) and will always be passed to get_cdt_ctx in a Python dictionary. So when get_cdt_ctx succeeds, ctx_in_use will always be true.

Manual testing

Code coverage looks ok
Valgrind shows no memory leaks or errors related to these changes
Build artifacts passes
Massif memory usage looks ok
Repro script passes with this PR. See jira ticket

CLIENT-2383 Added support for context lists in Client.index_cdt_create() and Client.Query.where() Fixed the check for TestBaseClass.version not working corerctly upon initialization

codecov-commenter · 2024-01-08T17:13:14Z

Codecov Report

❌ Patch coverage is 70.96774% with 9 lines in your changes missing coverage. Please review.
✅ Project coverage is 83.31%. Comparing base (b658400) to head (ffdbd22).
⚠️ Report is 3 commits behind head on dev.

Files with missing lines	Patch %	Lines
src/main/client/sec_index.c	61.53%	5 Missing ⚠️
src/main/query/where.c	77.77%	4 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##              dev     #550      +/-   ##
==========================================
+ Coverage   83.30%   83.31%   +0.01%     
==========================================
  Files          99       99              
  Lines       14402    14422      +20     
==========================================
+ Hits        11997    12016      +19     
- Misses       2405     2406       +1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

juliannguyen4

query.where() is missing a test case.

juliannguyen4 · 2024-01-10T23:45:02Z

src/main/conversions.c

                      PyObject *op_dict, bool *ctx_in_use,
                      as_static_pool *static_pool, int serializer_type)
 {
-    PyObject *py_ctx = PyDict_GetItemString(op_dict, CTX_KEY);


I think it might be better to modify Client.index_cdt_create() and Query.where() directly, instead of this helper function. Many other functions use this helper function, so this change might introduce a bug somewhere else in the client.

You are right. I added these changes in the newest commit

test/new_tests/test_query.py

Added Documentation Added test cases for ctx dictionary legacy support

Ran precommit lint

Fixed memory leak in get_cdt_ctx

Fixed misuse of Py_Decref

* [CLIENT-3793] Remove macOS 13 support (#846) * Auto-bump version to 18.1.0rc3.dev1 [skip ci] * [CLIENT-3106] Remove dead code in conversions.c (#817) - record_to_resultpyobject() was a helper function for client.batch_get_ops(), which is now removed. - record_to_pyobject_cnvt_list_to_map() and as_list_of_map_to_py_tuple_list(): these were helper functions that were used before Python client version 2.1.3 to return the result of certain map operations. They are no longer used starting from Python client 2.1.3 and higher, so it is safe to remove - bin_strict_type_checking() isn't used anywhere. But it would be good to consolidate the bin checking code into one place, since it is currently spread out all over the codebase - as_batch_read_results_to_pyobject() was used by get_many() which has been removed - batch_read_records_to_pyobject() was used by select_many() which has been removed Extra Changes Merge do_*_to_pyobject() methods into their calling methods, since they have the same function signature * Auto-bump version to 18.1.0rc3.dev2 [skip ci] --------- Co-authored-by: Julian Nguyen <109386615+juliannguyen4@users.noreply.github.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

…client-python into CLIENT-2383

…longer take in a dictionary to match documentation...

…rieving it from a dictionary entry

…arameter

…eaking changes to the api

… as ctx argument

…then index_cdt_create should not raise an exception with its own as_error because it may be initialized to AEROSPIKE_OK

… and reduce repetition

… passed

justinlee-aerospike

Code looks fine. Can you please add negative tests around parse errors in context?

juliannguyen4 · 2026-01-15T16:58:16Z

Both query.where and client.index_cdt_create() have test cases where an invalid type object is passed to the ctx parameter

test_neg_cdtindex_with_invalid_ctx -- None and a non-list object are both rejected since index_cdt_create's ctx parameter is required
test_query_with_invalid_list_cdt_ctx_dict -- None is acceptable for query.where()'s ctx parameter because it is optional. There's currently enough test cases that pass in a valid ctx or omit passing anything to the ctx parameter in query.where()

juliannguyen4 · 2026-01-16T16:44:15Z

Bump

justinlee-aerospike

changes look good

Justin already approved and I worked on the requested changes

CLIENT-2383

4057529

CLIENT-2383 Added support for context lists in Client.index_cdt_create() and Client.Query.where() Fixed the check for TestBaseClass.version not working corerctly upon initialization

juliannguyen4 previously requested changes Jan 10, 2024

View reviewed changes

DomPeliniAerospike added 3 commits February 5, 2024 09:37

Moved logic from conversions.c to individual functions

1c7d6c8

Added Documentation Added test cases for ctx dictionary legacy support

Fixed compiler warning

0afea08

Ran precommit lint

2f83de6

Ran precommit lint

DomPeliniAerospike changed the title ~~CLIENT-2383~~ CLIENT-2383 - Context arguments must accept a context list Feb 5, 2024

DomPeliniAerospike requested a review from juliannguyen4 February 5, 2024 21:44

DomPeliniAerospike changed the base branch from stage to dev November 14, 2025 14:12

DomPeliniAerospike and others added 14 commits November 14, 2025 07:26

Merge branch 'dev' into CLIENT-2383

ca5e460

Fixed compile issue

8475d8e

Update sec_index.c

9be3325

Fixed linting issue

a6cd67b

Fixed doc build error

1d76db0

Added test coverage

dc2df7b

Fixed memory leak in get_cdt_ctx

Update where.c

1012a31

Fixed linting issue

c1bd2fb

Fixed misuse of Py_Decref

Update test_query.py

7fd63be

Update test_query.py

e58d71a

Merge branch 'CLIENT-2383' of https://github.com/aerospike/aerospike-…

ccf0c3f

…client-python into CLIENT-2383

Merge remote-tracking branch 'origin/dev' into CLIENT-2383

957d1dc

Merge remote-tracking branch 'origin/dev' into CLIENT-2383

01bb57f

juliannguyen4 changed the title ~~CLIENT-2383 - Context arguments must accept a context list~~ CLIENT-2383 - Fix bug where Query.where(), client.index_cdt_create() and other operations do not accept a list of contexts Jan 2, 2026

juliannguyen4 changed the title ~~CLIENT-2383 - Fix bug where Query.where(), client.index_cdt_create() and other operations do not accept a list of contexts~~ CLIENT-2383 - Fix bug where Query.where() and client.index_cdt_create() do not accept a list of contexts Jan 2, 2026

juliannguyen4 added 5 commits January 13, 2026 09:54

Merge remote-tracking branch 'origin/dev' into CLIENT-2383

ee34980

Add error handling

1b2c9cd

Just make breaking change where index_cdt_create's ctx parameter can …

271e721

…longer take in a dictionary to match documentation...

get_cdt_ctx() already checks if python ctx is a list or not after ret…

4511081

…rieving it from a dictionary entry

Cleanup and add error handling

e9ee8dd

juliannguyen4 added 8 commits January 13, 2026 10:51

We are no longer allowing the old behavior of passing a dict to ctx p…

adc81ca

…arameter

dont need to test exception messages since those aren't considered br…

98b055f

…eaking changes to the api

Remove since we no longer allow query.where() to take in a dictionary…

7e63922

… as ctx argument

rm unused var from context manager

cb019b6

Fix test regressions. If createIndexWithDataAndCollectionType fails, …

a235322

…then index_cdt_create should not raise an exception with its own as_error because it may be initialized to AEROSPIKE_OK

Not a helper

e6719db

fix dup var declaration

c53c5b2

fix regression

5440425

juliannguyen4 removed their request for review January 13, 2026 23:09

juliannguyen4 added 8 commits January 13, 2026 15:20

Just combine cleanup steps into one codepath to improve code coverage…

c80f523

… and reduce repetition

Error message not set here. Was test coverage missing before?

1bc07cd

Fix potentially freeing uninitialized cdt_ctx

286c943

Add test case to cover invalid ctx

d55f776

improve comment

e41ce66

This should slightly improve performance when invalid input types are…

f41dc11

… passed

Forgot to add test case where None passed as ctx arg

6fc83a5

fix test...

1dc3c60

juliannguyen4 requested a review from justinlee-aerospike January 14, 2026 21:33

juliannguyen4 changed the title ~~[CLIENT-2383] Fix bug where Query.where() and client.index_cdt_create() do not accept a list of contexts~~ [CLIENT-2383] Fix bug where Query.where() and client.index_cdt_create() do not accept a list of contexts or None Jan 14, 2026

juliannguyen4 changed the title ~~[CLIENT-2383] Fix bug where Query.where() and client.index_cdt_create() do not accept a list of contexts or None~~ [CLIENT-2383] Fix bug where Query.where() and client.index_cdt_create() do not accept a list of contexts Jan 14, 2026

justinlee-aerospike requested changes Jan 14, 2026

View reviewed changes

juliannguyen4 added 2 commits January 14, 2026 18:25

Add test case where we explicitly pass in None to query.where

ed7ba8a

clean up dead code.

ffdbd22

juliannguyen4 requested a review from justinlee-aerospike January 15, 2026 16:58

justinlee-aerospike approved these changes Jan 16, 2026

View reviewed changes

juliannguyen4 merged commit 2d5c83f into dev Jan 16, 2026
186 of 187 checks passed

juliannguyen4 deleted the CLIENT-2383 branch January 16, 2026 17:44

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[CLIENT-2383] Fix bug where Query.where() and client.index_cdt_create() do not accept a list of contexts #550

[CLIENT-2383] Fix bug where Query.where() and client.index_cdt_create() do not accept a list of contexts #550

Uh oh!

DomPeliniAerospike commented Jan 8, 2024 •

edited by atlassian bot

Loading

Uh oh!

codecov-commenter commented Jan 8, 2024 •

edited

Loading

Uh oh!

juliannguyen4 left a comment

Uh oh!

juliannguyen4 Jan 10, 2024

Uh oh!

DomPeliniAerospike Feb 5, 2024

Uh oh!

Uh oh!

justinlee-aerospike left a comment

Uh oh!

juliannguyen4 commented Jan 15, 2026 •

edited

Loading

Uh oh!

juliannguyen4 commented Jan 16, 2026

Uh oh!

justinlee-aerospike left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

[CLIENT-2383] Fix bug where Query.where() and client.index_cdt_create() do not accept a list of contexts #550

[CLIENT-2383] Fix bug where Query.where() and client.index_cdt_create() do not accept a list of contexts #550

Uh oh!

Conversation

DomPeliniAerospike commented Jan 8, 2024 • edited by atlassian bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Manual testing

Uh oh!

codecov-commenter commented Jan 8, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

juliannguyen4 left a comment

Choose a reason for hiding this comment

Uh oh!

juliannguyen4 Jan 10, 2024

Choose a reason for hiding this comment

Uh oh!

DomPeliniAerospike Feb 5, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

justinlee-aerospike left a comment

Choose a reason for hiding this comment

Uh oh!

juliannguyen4 commented Jan 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

juliannguyen4 commented Jan 16, 2026

Uh oh!

justinlee-aerospike left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

DomPeliniAerospike commented Jan 8, 2024 •

edited by atlassian bot

Loading

codecov-commenter commented Jan 8, 2024 •

edited

Loading

juliannguyen4 commented Jan 15, 2026 •

edited

Loading