Summary

Split assertQueries's query capturing into a new utility function.

Review Request #13371 — Created Oct. 23, 2023 and submitted Oct. 27, 2023, 3:18 p.m.

Information

Owner

chipx86

Repository

Djblets

Branch

release-3.x

Bugs

Depends On

Blocks

13372

Reviewers

Groups

djblets

People

Description

This introduces djblets.db.query_catcher.catch_queries(), which
contains the query capturing logic from assertQueries(). Through this,
we now have a formal interface for query capturing that can be
maintained separately from assertQueries(), simplifying that logic
considerably.

With this being a utility function, it's now easier to introspect
queries during development and debug code without having to do the work
from within a unit test. This is very helpful when performance-tuning as
an alternative to checking django.db.connection.queries.

assertQueries() has been updated to use this.

Testing Done

All Djblets and Review Board unit tests pass.

Commits

Summary	ID
Split assertQueries's query capturing into a new utility function. This introduces `djblets.db.query_catcher.catch_queries()`, which contains the query capturing logic from `assertQueries()`. Through this, we now have a formal interface for query capturing that can be maintained separately from `assertQueries()`, simplifying that logic considerably. With this being a utility function, it's now easier to introspect queries during development and debug code without having to do the work from within a unit test. This is very helpful when performance-tuning as an alternative to checking `django.db.connection.queries`.	f35e140963db1730f0dccfd26f8c40fb95873e9e

Summary

Split assertQueries's query capturing into a new utility function.

This introduces `djblets.db.query_catcher.catch_queries()`, which contains the query capturing logic from `assertQueries()`. Through this, we now have a formal interface for query capturing that can be maintained separately from `assertQueries()`, simplifying that logic considerably. With this being a utility function, it's now easier to introspect queries during development and debug code without having to do the work from within a unit test. This is very helpful when performance-tuning as an alternative to checking `django.db.connection.queries`.

f35e140963db1730f0dccfd26f8c40fb95873e9e

Issues

Description	From	Last Updated
'traceback' imported but unused Column: 1 Error code: F401	reviewbot	Oct. 23, 2023, 3:42 p.m.
'django.contrib.auth.models.Permission' imported but unused Column: 1 Error code: F401	reviewbot	Oct. 23, 2023, 3:42 p.m.
'django.contrib.auth.models.User' imported but unused Column: 1 Error code: F401	reviewbot	Oct. 23, 2023, 3:42 p.m.
redefinition of unused 'test_with_delete' from line 103 Column: 5 Error code: F811	reviewbot	Oct. 23, 2023, 3:42 p.m.

flake8 failed.

JSHint passed.

flake8

djblets/db/tests/test_query_catcher.py (Diff revision 1)
The issue has been resolved. Show all issues
```
'traceback' imported but unused

Column: 1
Error code: F401
```
djblets/db/tests/test_query_catcher.py (Diff revision 1)
The issue has been resolved. Show all issues
```
'django.contrib.auth.models.Permission' imported but unused

Column: 1
Error code: F401
```
djblets/db/tests/test_query_catcher.py (Diff revision 1)
The issue has been resolved. Show all issues
```
'django.contrib.auth.models.User' imported but unused

Column: 1
Error code: F401
```
djblets/db/tests/test_query_catcher.py (Diff revision 1)
The issue has been resolved. Show all issues
```
redefinition of unused 'test_with_delete' from line 103

Column: 5
Error code: F811
```

Change Summary:


Removed unused imports.
Fixed a duplicate test name and re-ran tests.

Commits:

	Summary	ID
	Split assertQueries's query capturing into a new utility function. This introduces `djblets.db.query_catcher.catch_queries()`, which contains the query capturing logic from `assertQueries()`. Through this, we now have a formal interface for query capturing that can be maintained separately from `assertQueries()`, simplifying that logic considerably. With this being a utility function, it's now easier to introspect queries during development and debug code without having to do the work from within a unit test. This is very helpful when performance-tuning as an alternative to checking `django.db.connection.queries`.	9907ef8a8bf517bd5db9b47d5a5da9766c1c42a8
	Split assertQueries's query capturing into a new utility function. This introduces `djblets.db.query_catcher.catch_queries()`, which contains the query capturing logic from `assertQueries()`. Through this, we now have a formal interface for query capturing that can be maintained separately from `assertQueries()`, simplifying that logic considerably. With this being a utility function, it's now easier to introspect queries during development and debug code without having to do the work from within a unit test. This is very helpful when performance-tuning as an alternative to checking `django.db.connection.queries`.	a39c41f81731f94a64d3360945c6aea3a6b9ff90

Diff:

Revision 2 (+984 -302)

Show changes

	djblets/db/query_catcher.py
	djblets/db/tests/test_query_catcher.py
	djblets/testing/testcases.py
	docs/djblets/conf.py
	docs/djblets/coderef/index.rst

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Change Summary:

Added back the behavior of skipping queries that don't generate SQL.

Commits:

	Summary	ID
	Split assertQueries's query capturing into a new utility function. This introduces `djblets.db.query_catcher.catch_queries()`, which contains the query capturing logic from `assertQueries()`. Through this, we now have a formal interface for query capturing that can be maintained separately from `assertQueries()`, simplifying that logic considerably. With this being a utility function, it's now easier to introspect queries during development and debug code without having to do the work from within a unit test. This is very helpful when performance-tuning as an alternative to checking `django.db.connection.queries`.	a39c41f81731f94a64d3360945c6aea3a6b9ff90
	Split assertQueries's query capturing into a new utility function. This introduces `djblets.db.query_catcher.catch_queries()`, which contains the query capturing logic from `assertQueries()`. Through this, we now have a formal interface for query capturing that can be maintained separately from `assertQueries()`, simplifying that logic considerably. With this being a utility function, it's now easier to introspect queries during development and debug code without having to do the work from within a unit test. This is very helpful when performance-tuning as an alternative to checking `django.db.connection.queries`.	f35e140963db1730f0dccfd26f8c40fb95873e9e

Diff:

Revision 3 (+996 -302)

Show changes

	djblets/db/query_catcher.py
	djblets/db/tests/test_query_catcher.py
	djblets/testing/testcases.py
	docs/djblets/conf.py
	docs/djblets/coderef/index.rst

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to release-3.x (7b6fac9)