Summary

Add support for extended subquery comparison in compare_queries().

Review Request #13402 — Created Nov. 6, 2023 and submitted Nov. 14, 2023, 3:59 p.m.

Information

Owner

chipx86

Repository

Djblets

Branch

release-3.x

Bugs

Depends On

~~13401~~, ~~13396~~

Blocks

13404

Reviewers

Groups

djblets

People

Description

This reworks query comparison in compare_queries() and
assertQueries() to track and compare nested subqueries. Queries now
support a subqueries field, which follows the same format of the main
expected queries list, and this can be nested as deeply as required for
the queries being executed.

Any subquery inside of a where filter (via Subquery() or Exists())
will be transformed into a Q(__SubqueryType__subquery__=index) query,
since this allows for direct comparison and equates to an index within
the nested query comparison list.

The recent support for inner_query has been removed in favor of this
new support. Support is opt-in currently for assertQueries(), to
maintain backwards-compatibility, but will be enabled by default in
Djblets 5.

The normalization and formatting support has been enhanced to support
subqueries and F-expressions, and to display the way the code would be
written in Python with Q(...), F(...), etc. This makes it far easier
to compare and update queries.

Testing Done

Unit tests pass.

Tested this with in-progress code in Review Board.

Commits

Summary	ID
Add support for extended subquery comparison in compare_queries(). This reworks query comparison in `compare_queries()` and `assertQueries()` to track and compare nested subqueries. Queries now support a `subqueries` field, which follows the same format of the main expected queries list, and this can be nested as deeply as required for the queries being executed. Any subquery inside of a `where` filter (via `Subquery()` or `Exists()`) will be transformed into a `Q(__SubqueryType__subquery__=index)` query, since this allows for direct comparison and equates to an index within the nested query comparison list. The recent support for `inner_query` has been removed in favor of this new support. Support is opt-in currently for `assertQueries()`, to maintain backwards-compatibility, but will be enabled by default in Djblets 5. The normalization and formatting support has been enhanced to support subqueries and F-expressions, and to display the way the code would be written in Python with `Q(...)`, `F(...)`, etc. This makes it far easier to compare and update queries.	57ba205b1bf983de9b02ec504d56d0edebe9c182

Summary

Add support for extended subquery comparison in compare_queries().

This reworks query comparison in `compare_queries()` and `assertQueries()` to track and compare nested subqueries. Queries now support a `subqueries` field, which follows the same format of the main expected queries list, and this can be nested as deeply as required for the queries being executed. Any subquery inside of a `where` filter (via `Subquery()` or `Exists()`) will be transformed into a `Q(__SubqueryType__subquery__=index)` query, since this allows for direct comparison and equates to an index within the nested query comparison list. The recent support for `inner_query` has been removed in favor of this new support. Support is opt-in currently for `assertQueries()`, to maintain backwards-compatibility, but will be enabled by default in Djblets 5. The normalization and formatting support has been enhanced to support subqueries and F-expressions, and to display the way the code would be written in Python with `Q(...)`, `F(...)`, etc. This makes it far easier to compare and update queries.

57ba205b1bf983de9b02ec504d56d0edebe9c182

Issues

Description	From	Last Updated
'djblets.db.query_comparator.QueryMismatch' imported but unused Column: 5 Error code: F401	reviewbot	Nov. 6, 2023, 12:02 a.m.
Can get rid of this first paragraph since we say the same thing in the 2nd paragraph.	maubin	Nov. 14, 2023, 12:27 p.m.
There's an extra : here.	maubin	Nov. 14, 2023, 12:28 p.m.

flake8 failed.

JSHint passed.

flake8

djblets/testing/testcases.py (Diff revision 1)

Show all issues

'djblets.db.query_comparator.QueryMismatch' imported but unused

Column: 5
Error code: F401

Change Summary:

Removed an unused import.

Commits:

	Summary	ID
	Add support for extended subquery comparison in compare_queries(). This reworks query comparison in `compare_queries()` and `assertQueries()` to track and compare nested subqueries. Queries now support a `subqueries` field, which follows the same format of the main expected queries list, and this can be nested as deeply as required for the queries being executed. Any subquery inside of a `where` filter (via `Subquery()` or `Exists()`) will be transformed into a `Q(__SubqueryType__subquery__=index)` query, since this allows for direct comparison and equates to an index within the nested query comparison list. The recent support for `inner_query` has been removed in favor of this new support. Support is opt-in currently for `assertQueries()`, to maintain backwards-compatibility, but will be enabled by default in Djblets 5. The normalization and formatting support has been enhanced to support subqueries and F-expressions, and to display the way the code would be written in Python with `Q(...)`, `F(...)`, etc. This makes it far easier to compare and update queries.	07f6cf2d1320aaa969ac52c2d554495c0b3f9ce2
	Add support for extended subquery comparison in compare_queries(). This reworks query comparison in `compare_queries()` and `assertQueries()` to track and compare nested subqueries. Queries now support a `subqueries` field, which follows the same format of the main expected queries list, and this can be nested as deeply as required for the queries being executed. Any subquery inside of a `where` filter (via `Subquery()` or `Exists()`) will be transformed into a `Q(__SubqueryType__subquery__=index)` query, since this allows for direct comparison and equates to an index within the nested query comparison list. The recent support for `inner_query` has been removed in favor of this new support. Support is opt-in currently for `assertQueries()`, to maintain backwards-compatibility, but will be enabled by default in Djblets 5. The normalization and formatting support has been enhanced to support subqueries and F-expressions, and to display the way the code would be written in Python with `Q(...)`, `F(...)`, etc. This makes it far easier to compare and update queries.	651308090d58b1ff905af35eb509f664c57fa98e

Diff:

Revision 2 (+3702 -444)

Show changes

	djblets/db/query_comparator.py
	djblets/db/tests/test_query_comparator.py
	djblets/testing/testcases.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Change Summary:

Added some missing modifications to assertQueries() for some compare_queries() changes.

Commits:

	Summary	ID
	Add support for extended subquery comparison in compare_queries(). This reworks query comparison in `compare_queries()` and `assertQueries()` to track and compare nested subqueries. Queries now support a `subqueries` field, which follows the same format of the main expected queries list, and this can be nested as deeply as required for the queries being executed. Any subquery inside of a `where` filter (via `Subquery()` or `Exists()`) will be transformed into a `Q(__SubqueryType__subquery__=index)` query, since this allows for direct comparison and equates to an index within the nested query comparison list. The recent support for `inner_query` has been removed in favor of this new support. Support is opt-in currently for `assertQueries()`, to maintain backwards-compatibility, but will be enabled by default in Djblets 5. The normalization and formatting support has been enhanced to support subqueries and F-expressions, and to display the way the code would be written in Python with `Q(...)`, `F(...)`, etc. This makes it far easier to compare and update queries.	651308090d58b1ff905af35eb509f664c57fa98e
	Add support for extended subquery comparison in compare_queries(). This reworks query comparison in `compare_queries()` and `assertQueries()` to track and compare nested subqueries. Queries now support a `subqueries` field, which follows the same format of the main expected queries list, and this can be nested as deeply as required for the queries being executed. Any subquery inside of a `where` filter (via `Subquery()` or `Exists()`) will be transformed into a `Q(__SubqueryType__subquery__=index)` query, since this allows for direct comparison and equates to an index within the nested query comparison list. The recent support for `inner_query` has been removed in favor of this new support. Support is opt-in currently for `assertQueries()`, to maintain backwards-compatibility, but will be enabled by default in Djblets 5. The normalization and formatting support has been enhanced to support subqueries and F-expressions, and to display the way the code would be written in Python with `Q(...)`, `F(...)`, etc. This makes it far easier to compare and update queries.	4f4b49507766eab0f1ebc87a15208bf6cfcd7abd

Diff:

Revision 3 (+3730 -494)

Show changes

	djblets/db/query_comparator.py
	djblets/db/tests/test_query_comparator.py
	djblets/testing/testcases.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Change Summary:

Fixed reporting mismatched subqueries when the parent query's attributes matched.

Commits:

	Summary	ID
	Add support for extended subquery comparison in compare_queries(). This reworks query comparison in `compare_queries()` and `assertQueries()` to track and compare nested subqueries. Queries now support a `subqueries` field, which follows the same format of the main expected queries list, and this can be nested as deeply as required for the queries being executed. Any subquery inside of a `where` filter (via `Subquery()` or `Exists()`) will be transformed into a `Q(__SubqueryType__subquery__=index)` query, since this allows for direct comparison and equates to an index within the nested query comparison list. The recent support for `inner_query` has been removed in favor of this new support. Support is opt-in currently for `assertQueries()`, to maintain backwards-compatibility, but will be enabled by default in Djblets 5. The normalization and formatting support has been enhanced to support subqueries and F-expressions, and to display the way the code would be written in Python with `Q(...)`, `F(...)`, etc. This makes it far easier to compare and update queries.	4f4b49507766eab0f1ebc87a15208bf6cfcd7abd
	Add support for extended subquery comparison in compare_queries(). This reworks query comparison in `compare_queries()` and `assertQueries()` to track and compare nested subqueries. Queries now support a `subqueries` field, which follows the same format of the main expected queries list, and this can be nested as deeply as required for the queries being executed. Any subquery inside of a `where` filter (via `Subquery()` or `Exists()`) will be transformed into a `Q(__SubqueryType__subquery__=index)` query, since this allows for direct comparison and equates to an index within the nested query comparison list. The recent support for `inner_query` has been removed in favor of this new support. Support is opt-in currently for `assertQueries()`, to maintain backwards-compatibility, but will be enabled by default in Djblets 5. The normalization and formatting support has been enhanced to support subqueries and F-expressions, and to display the way the code would be written in Python with `Q(...)`, `F(...)`, etc. This makes it far easier to compare and update queries.	f5ad3222935a7320725a6fbc1d5c22f7c5077c83

Diff:

Revision 4 (+3740 -494)

Show changes

	djblets/db/query_comparator.py
	djblets/db/tests/test_query_comparator.py
	djblets/testing/testcases.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Change Summary:


Fixed some regressions in the legacy no-subqueries mode.
Expected queries no longer have their subqueries normalized, in order to force expected queries to provide the new subquery placeholders.

Commits:

	Summary	ID
	Add support for extended subquery comparison in compare_queries(). This reworks query comparison in `compare_queries()` and `assertQueries()` to track and compare nested subqueries. Queries now support a `subqueries` field, which follows the same format of the main expected queries list, and this can be nested as deeply as required for the queries being executed. Any subquery inside of a `where` filter (via `Subquery()` or `Exists()`) will be transformed into a `Q(__SubqueryType__subquery__=index)` query, since this allows for direct comparison and equates to an index within the nested query comparison list. The recent support for `inner_query` has been removed in favor of this new support. Support is opt-in currently for `assertQueries()`, to maintain backwards-compatibility, but will be enabled by default in Djblets 5. The normalization and formatting support has been enhanced to support subqueries and F-expressions, and to display the way the code would be written in Python with `Q(...)`, `F(...)`, etc. This makes it far easier to compare and update queries.	f5ad3222935a7320725a6fbc1d5c22f7c5077c83
	Add support for extended subquery comparison in compare_queries(). This reworks query comparison in `compare_queries()` and `assertQueries()` to track and compare nested subqueries. Queries now support a `subqueries` field, which follows the same format of the main expected queries list, and this can be nested as deeply as required for the queries being executed. Any subquery inside of a `where` filter (via `Subquery()` or `Exists()`) will be transformed into a `Q(__SubqueryType__subquery__=index)` query, since this allows for direct comparison and equates to an index within the nested query comparison list. The recent support for `inner_query` has been removed in favor of this new support. Support is opt-in currently for `assertQueries()`, to maintain backwards-compatibility, but will be enabled by default in Djblets 5. The normalization and formatting support has been enhanced to support subqueries and F-expressions, and to display the way the code would be written in Python with `Q(...)`, `F(...)`, etc. This makes it far easier to compare and update queries.	f6b4db082790484f98176f5d305d279e118afb6d

Diff:

Revision 5 (+3852 -504)

Show changes

	djblets/db/query_comparator.py
	djblets/db/tests/test_query_comparator.py
	djblets/testing/testcases.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

djblets/db/query_comparator.py (Diff revision 5)

Show all issues

Can get rid of this first paragraph since we say the same thing in the 2nd paragraph.

djblets/db/query_comparator.py (Diff revision 5)

Show all issues

There's an extra : here.

chipx86 Nov. 14, 2023, 12:29 p.m.

While it looks like a mistake, it's actually ReST syntax for "the next indented thing is a code block". Short-hand for when .. code-block:: is too heavy-weight (and in fact is part of base ReST, rather than the Sphinx extension of directives).

maubin Nov. 14, 2023, 12:43 p.m.
```
Oh got it.
```

Change Summary:

Removed an extra unnecessary paragraph in a description.

Commits:

	Summary	ID
	Add support for extended subquery comparison in compare_queries(). This reworks query comparison in `compare_queries()` and `assertQueries()` to track and compare nested subqueries. Queries now support a `subqueries` field, which follows the same format of the main expected queries list, and this can be nested as deeply as required for the queries being executed. Any subquery inside of a `where` filter (via `Subquery()` or `Exists()`) will be transformed into a `Q(__SubqueryType__subquery__=index)` query, since this allows for direct comparison and equates to an index within the nested query comparison list. The recent support for `inner_query` has been removed in favor of this new support. Support is opt-in currently for `assertQueries()`, to maintain backwards-compatibility, but will be enabled by default in Djblets 5. The normalization and formatting support has been enhanced to support subqueries and F-expressions, and to display the way the code would be written in Python with `Q(...)`, `F(...)`, etc. This makes it far easier to compare and update queries.	f6b4db082790484f98176f5d305d279e118afb6d
	Add support for extended subquery comparison in compare_queries(). This reworks query comparison in `compare_queries()` and `assertQueries()` to track and compare nested subqueries. Queries now support a `subqueries` field, which follows the same format of the main expected queries list, and this can be nested as deeply as required for the queries being executed. Any subquery inside of a `where` filter (via `Subquery()` or `Exists()`) will be transformed into a `Q(__SubqueryType__subquery__=index)` query, since this allows for direct comparison and equates to an index within the nested query comparison list. The recent support for `inner_query` has been removed in favor of this new support. Support is opt-in currently for `assertQueries()`, to maintain backwards-compatibility, but will be enabled by default in Djblets 5. The normalization and formatting support has been enhanced to support subqueries and F-expressions, and to display the way the code would be written in Python with `Q(...)`, `F(...)`, etc. This makes it far easier to compare and update queries.	57ba205b1bf983de9b02ec504d56d0edebe9c182

Diff:

Revision 6 (+3848 -508)

Show changes

	djblets/db/query_comparator.py
	djblets/db/tests/test_query_comparator.py
	djblets/testing/testcases.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status: Closed (submitted)

Change Summary:

Pushed to release-3.x (d80aaa7)