✨ [maykinmedia/commonground-api-common#142] Use exception handler registry from commonground-api-common #723

OlhaZahoruiko · 2026-01-26T09:49:08Z

Fixes maykinmedia/commonground-api-common#142

Changes

[Describe the changes here]

codecov-commenter · 2026-01-26T09:51:26Z

Codecov Report

❌ Patch coverage is 84.61538% with 2 lines in your changes missing coverage. Please review.
✅ Project coverage is 84.92%. Comparing base (13b0d5f) to head (563ba23).
⚠️ Report is 4 commits behind head on master.

Files with missing lines	Patch %	Lines
src/objects/utils/views.py	81.81%	1 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #723      +/-   ##
==========================================
- Coverage   84.98%   84.92%   -0.06%     
==========================================
  Files         141      141              
  Lines        2843     2832      -11     
  Branches      224      222       -2     
==========================================
- Hits         2416     2405      -11     
  Misses        375      375              
  Partials       52       52

☔ 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.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

github-actions · 2026-01-26T09:56:25Z

Bencher Report

Branch	feature/142-custom-exception-handlers
Testbed	ubuntu-latest

Click to view all benchmark results

Benchmark	Latency	Benchmark Result milliseconds (ms) (Result Δ%)	Upper Boundary milliseconds (ms) (Limit %)
performance_test/tests/test_objects_list.py::test_objects_api_list_filter_by_object_type	📈 view plot 🚷 view threshold	125.32 ms (+0.14%) Baseline: 125.13 ms	131.39 ms (95.38%)
performance_test/tests/test_objects_list.py::test_objects_api_list_filter_one_result	📈 view plot 🚷 view threshold	23.66 ms (+1.14%) Baseline: 23.39 ms	24.56 ms (96.32%)
performance_test/tests/test_objects_list.py::test_objects_api_list_large_page_size_page_1	📈 view plot 🚷 view threshold	312.56 ms (+1.30%) Baseline: 308.54 ms	323.97 ms (96.48%)
performance_test/tests/test_objects_list.py::test_objects_api_list_large_page_size_page_5	📈 view plot 🚷 view threshold	307.91 ms (-0.35%) Baseline: 309.00 ms	324.45 ms (94.90%)
performance_test/tests/test_objects_list.py::test_objects_api_list_small_page_size_page_20	📈 view plot 🚷 view threshold	133.96 ms (-0.18%) Baseline: 134.21 ms	140.92 ms (95.06%)

🐰 View full continuous benchmarking report in Bencher

danielmursa-dev · 2026-01-30T10:29:34Z

src/objects/tests/v2/test_filters.py

        response = self.client.get(self.url, {"type": objecttype_url})

        self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST)
+


Now, since the response is consistent with other projects, with invalid_params, etc., you can use this method to get the errors from vng_api_common.tests import get_validation_errors.

You can apply this for all tests as well.

danielmursa-dev · 2026-01-30T10:29:38Z

src/objects/tests/v2/test_filters.py

+        invalid_params = {p["name"]: p["reason"] for p in data["invalid_params"]}
+
        self.assertEqual(
-            response.json()["type"],
-            [
-                f"Select a valid object type. {objecttype_url} is not one of the available choices."
-            ],
+            invalid_params["type"],
+            f"Select a valid object type. {objecttype_url} is not one of the available choices.",


Suggested change

invalid_params = {p["name"]: p["reason"] for p in data["invalid_params"]}

self.assertEqual(

response.json()["type"],

[

f"Select a valid object type. {objecttype_url} is not one of the available choices."

],

invalid_params["type"],

f"Select a valid object type. {objecttype_url} is not one of the available choices.",

self.assertEqual(

get_validation_errors(response, "type"),

{

"name": "type",

"code": "invalid_choice",

"reason": f"Select a valid object type. {objecttype_url} is not one of the available choices.",

},

)

danielmursa-dev

Good 👍

stevenbal · 2026-02-10T09:59:03Z

requirements/base.in

 zgw-consumers[setup-configuration]
 mozilla-django-oidc-db[setup-configuration]
-commonground-api-common[oas]
+commonground-api-common[oas] @ git+https://github.com/maykinmedia/commonground-api-common.git@feature/142-exception-handler-mapping


Let's upgrade this to 2.11.0

Suggested change

commonground-api-common[oas] @ git+https://github.com/maykinmedia/commonground-api-common.git@feature/142-exception-handler-mapping

commonground-api-common[oas]

…istry from commonground-api-common

stevenbal

Remarks about tests, looks good otherwise

stevenbal · 2026-02-10T14:15:34Z

src/objects/tests/utils.py

+def get_invalid_param(response, field):
+    data = response.json()
+
+    for param in data.get("invalid_params", []):
+        if param["name"] == field:
+            return param
+
+    raise AssertionError(f"No invalid_param found for field '{field}'")


I think you can make use of from vng_api_common.tests import get_validation_errors for this I think

Suggested change

def get_invalid_param(response, field):

data = response.json()

for param in data.get("invalid_params", []):

if param["name"] == field:

return param

raise AssertionError(f"No invalid_param found for field '{field}'")

stevenbal · 2026-02-10T14:17:12Z

src/objects/utils/tests/test_exception_handler.py

 from sentry_sdk.transport import Transport
-
-from ..views import exception_handler
+from vng_api_common.exception_handling import exception_handler


Since this is already tested in the library: https://github.com/maykinmedia/commonground-api-common/blob/83160a164ce42af546de7ac9f0f6088ad677ba90/tests/test_exception_handler.py#L225C9-L225C42, let's remove this entire test file

stevenbal · 2026-02-10T14:28:35Z

src/objects/tests/v2/test_filters.py

-                "status": 500,
-                "detail": "This search operation is not supported by the underlying data store.",
-            },
+            response.data["detail"],


Let's keep the assertion on the entire response dict, you can pop the UUID from the dict because that one varies per run

stevenbal · 2026-02-10T14:36:49Z

src/objects/tests/v2/test_ordering.py

+        self.assertEqual(data["code"], "invalid")
+        self.assertIn("invalid_params", data)
+
+        ordering_error = next(


Here you can also make use of get_validation_errors

stevenbal · 2026-02-10T14:36:59Z

src/objects/tests/v2/test_validation.py

+        self.assertEqual(data["code"], "invalid")
+        self.assertIn("invalid_params", data)
+
+        type_error = next(


Here you can also make use of get_validation_errors

stevenbal · 2026-02-10T14:37:25Z

src/objects/tests/v2/test_validation.py

+        self.assertEqual(data["code"], "invalid")
+        self.assertIn("invalid_params", data)
+
+        type_error = next(


Here you can also make use of get_validation_errors

…ler registry from commonground-api-common

…on handler registry from commonground-api-common

github-actions · 2026-02-10T15:33:54Z

Bencher Report

Branch	feature/142-custom-exception-handlers
Testbed	ubuntu-24.04

Click to view all benchmark results

Benchmark	Latency	Benchmark Result milliseconds (ms) (Result Δ%)	Upper Boundary milliseconds (ms) (Limit %)
performance_test/tests/test_objects_list.py::test_objects_api_list_filter_by_object_type	📈 view plot 🚷 view threshold	120.51 ms (-2.76%) Baseline: 123.93 ms	130.13 ms (92.61%)
performance_test/tests/test_objects_list.py::test_objects_api_list_filter_one_result	📈 view plot 🚷 view threshold	21.97 ms (-4.84%) Baseline: 23.09 ms	24.24 ms (90.63%)
performance_test/tests/test_objects_list.py::test_objects_api_list_large_page_size_page_1	📈 view plot 🚷 view threshold	309.98 ms (-0.38%) Baseline: 311.16 ms	326.72 ms (94.88%)
performance_test/tests/test_objects_list.py::test_objects_api_list_large_page_size_page_5	📈 view plot 🚷 view threshold	303.03 ms (-2.33%) Baseline: 310.25 ms	325.76 ms (93.02%)
performance_test/tests/test_objects_list.py::test_objects_api_list_small_page_size_page_20	📈 view plot 🚷 view threshold	130.31 ms (-2.68%) Baseline: 133.89 ms	140.59 ms (92.69%)

🐰 View full continuous benchmarking report in Bencher

…exception handler registry from commonground-api-common

… Use exception handler registry from commonground-api-common

…mmon#142] Use exception handler registry from commonground-api-common

…-api-common#142] Use exception handler registry from commonground-api-common

danielmursa-dev · 2026-02-11T08:42:23Z

src/objects/tests/v2/test_filters.py

+
+        data = response.json()
+
+        invalid_params = {p["name"]: p for p in data["invalid_params"]}


Suggested change

invalid_params = {p["name"]: p for p in data["invalid_params"]}

error = get_validation_errors(response, "type")

danielmursa-dev · 2026-02-11T08:50:13Z

src/objects/tests/v2/test_filters.py

        self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST)
+
+        data = response.json()
+        invalid_params = {p["name"]: p["reason"] for p in data["invalid_params"]}


@OlhaZahoruiko I think you can use this method everywhere to get the error dict

@stevenbal should we also add the key for validations that are not provided? like here

objects-api/src/objects/api/validators.py

Line 93 in ff5f242

raise serializers.ValidationError(message, code=code)

Suggested change

invalid_params = {p["name"]: p["reason"] for p in data["invalid_params"]}

error = get_validation_errors(response, "")

OlhaZahoruiko force-pushed the feature/142-custom-exception-handlers branch from f19beff to 9f8bbc0 Compare January 27, 2026 11:59

OlhaZahoruiko marked this pull request as ready for review January 27, 2026 11:59

OlhaZahoruiko requested review from danielmursa-dev and stevenbal January 27, 2026 12:00

OlhaZahoruiko mentioned this pull request Jan 27, 2026

✨ [#142] Allow registering custom exception handlers in exce… maykinmedia/commonground-api-common#145

Merged

danielmursa-dev reviewed Jan 30, 2026

View reviewed changes

OlhaZahoruiko requested a review from danielmursa-dev February 3, 2026 08:59

stevenbal mentioned this pull request Feb 6, 2026

Allow defining a mapping of exceptions to responses for exception_handler maykinmedia/commonground-api-common#142

Open

stevenbal requested changes Feb 10, 2026

View reviewed changes

OlhaZahoruiko force-pushed the feature/142-custom-exception-handlers branch from 5ee4377 to 0dd574b Compare February 10, 2026 11:55

OlhaZahoruiko requested a review from stevenbal February 10, 2026 11:56

OlhaZahoruiko force-pushed the feature/142-custom-exception-handlers branch from 1e83b0b to 6de9948 Compare February 10, 2026 14:00

✨ [maykinmedia/commonground-api-common#142] Use exception handler reg…

d42b42e

…istry from commonground-api-common

OlhaZahoruiko force-pushed the feature/142-custom-exception-handlers branch from 6de9948 to d42b42e Compare February 10, 2026 14:21

stevenbal requested changes Feb 10, 2026

View reviewed changes

OlhaZahoruiko added 2 commits February 10, 2026 16:24

fixup! ✨ [maykinmedia/commonground-api-common#142] Use exception hand…

6416789

…ler registry from commonground-api-common

fixup! fixup! ✨ [maykinmedia/commonground-api-common#142] Use excepti…

858536a

…on handler registry from commonground-api-common

OlhaZahoruiko added 4 commits February 10, 2026 16:36

fixup! fixup! fixup! ✨ [maykinmedia/commonground-api-common#142] Use …

311e297

…exception handler registry from commonground-api-common

fixup! fixup! fixup! fixup! ✨ [maykinmedia/commonground-api-common#142]…

0328ad8

… Use exception handler registry from commonground-api-common

fixup! fixup! fixup! fixup! fixup! ✨ [maykinmedia/commonground-api-co…

d5b8ac9

…mmon#142] Use exception handler registry from commonground-api-common

fixup! fixup! fixup! fixup! fixup! fixup! ✨ [maykinmedia/commonground…

563ba23

…-api-common#142] Use exception handler registry from commonground-api-common

danielmursa-dev reviewed Feb 11, 2026

View reviewed changes

		response = self.client.get(self.url, {"type": objecttype_url})

		self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST)

	commonground-api-common[oas] @ git+https://github.com/maykinmedia/commonground-api-common.git@feature/142-exception-handler-mapping
	commonground-api-common[oas]


		data = response.json()

		invalid_params = {p["name"]: p for p in data["invalid_params"]}

	invalid_params = {p["name"]: p for p in data["invalid_params"]}
	error = get_validation_errors(response, "type")

	invalid_params = {p["name"]: p["reason"] for p in data["invalid_params"]}
	error = get_validation_errors(response, "")

✨ [maykinmedia/commonground-api-common#142] Use exception handler registry from commonground-api-common #723

Are you sure you want to change the base?

✨ [maykinmedia/commonground-api-common#142] Use exception handler registry from commonground-api-common #723

Uh oh!

Conversation

OlhaZahoruiko commented Jan 26, 2026

Uh oh!

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

Uh oh!

Codecov Report

Uh oh!

github-actions bot commented Jan 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

danielmursa-dev left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

stevenbal left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Feb 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

codecov-commenter commented Jan 26, 2026 •

edited

Loading

github-actions bot commented Jan 26, 2026 •

edited

Loading

github-actions bot commented Feb 10, 2026 •

edited

Loading