Skip to content

Refactor server interceptor and rich error building#976

Open
miruuna wants to merge 2 commits into
developfrom
miruuna/974-feature-grpc-rich-error---refactor-server-interceptor-and-exceptions
Open

Refactor server interceptor and rich error building#976
miruuna wants to merge 2 commits into
developfrom
miruuna/974-feature-grpc-rich-error---refactor-server-interceptor-and-exceptions

Conversation

@miruuna

@miruuna miruuna commented Jul 16, 2026

Copy link
Copy Markdown
Contributor

Description

Fixes issue #974

Refactor the definition and implementation of the server interceptor to decouple the definitions and associated rich error details of custom exceptions from the interceptor.

Type of change

  • New feature / enhancement
  • Optimization
  • Bug fix
  • Breaking change
  • Documentation

List of required branches from other repositories

WHAT PRs NEED TO BE INCLUDED TO MAKE THE CHANGE.

Change log

  • rich error building is now being done where exceptions are defined - src/drunc/exceptions.py
  • RichErrorServerInterceptor was refactored and simplified

Suggested manual testing checklist

Run unit tests for the session_manager and process_manager

Developer checklist

Prior to marking this as "Ready for Review"

Tests ran on: WHAT HOSTNAME from release RELEASE_NAME

Unit tests - some tests can't be ran on the CI. This is documented. If this PR checks a feature that can't be tested with CI, this has been marked appropriately.

Integration tests - the daqsystemtest_integtest_bundle requires a lot of resources, and connections to the EHN1 infrastructure. Check the cross referenced list if you can't run these. The developer needs to run at least the .

  • Unit tests (pytest --marker) passed
    • With relevant marker
    • [] Without marker
  • Integration tests passed
    • [] Only daqsystemtest_integtest_bundle.sh -k minimal_system_quick_test.py
    • Full daqsystemtest_integtest_bundle.sh
  • Testing skipped as there are no core code changes in this PR, this only relates to documentation/CI workflows
  • Drunc integration tests pass (./scripts/drunc_integtest_bundle.sh)

Final checklist prior to marking this as "Ready for Review"

  • Code is clearly commented.
  • New unit tests have been added, or is documented in # ISSUE NUMBER
  • A suitable reviewer has been chosen from this list.

Reviewer checklist

  • This branch has been rebased with develop prior to testing.
  • Suggested manual tests show changes.
  • CI workflows fails documented (if present)
  • Integration tests passed (on either np0x or IC HEP clusters)
    • Use the following guidelines to determine which of the integration tests you need to run
      • You do not need to run any integration tests if
        • Code changes are not associated with src/
        • PR changes only affect docstrings
        • In this case, be sure to validate any suggested manual testing.
      • Run only the minimum integration test as daqsystemtest_integtest_bundle.sh -k minimal_system_quick_test.py if
        • PR changes only affect a few log entries
        • PR changes are small, and do not have a large impact on the workflow (use carefully)
      • Otherwise run the full integration test bundle as daqsystemtest_integtest_bundle.sh
    • What to do if the integration tests fail?
      • Only concern yourself if failures related to drunc are in the log files
      • If non-drunc failure appears:
        • Validate failure in fresh working area
        • Contact Pawel if unsure
  • If you have ran the full integration test bundle, leave a comment on the PR stating
    • Which host the integration tests have ran on
    • [Optional] A copy of the test summary
  • Drunc integration tests pass (scripts/drunc_integtest_bundle.sh)

Once the above boxes are checked, the PR(s) can be merged following the steps below.

Prior to merging

Choose one of the following an complete all substeps
  • Changes only affect the Run Control, are in a single repository, and do not affect the end user.
    • Changes are documented in docstrings and code comments
    • Wiki has been updated if architectural or endpoint changes
  • Otherwise
    • Workflow changes demonstrated in the Change Log (if necessary)
    • Wiki has been updated (if necessary)
    • #dunedaq-integration Slack channel notified (see below)

Once completed, the reviewer can merge the PR.

Notification message for a Slack channel

Note - this should be to #dunedaq-integration for general workflow that isn't during a release candidate period, and to #daq-release-prep otherwise.

For an single merge that changes the user workflow

The CCM WG has an isolated PR ready to merge that affects user workflows. The PR is:

_URL_

I will leave time for any comments, otherwise will merge these at the end of the work day _Insert your time zone_.

For co-ordinated merge

The CCM WG has a set of co-ordinated merges ready to merge. The PRs are:

_URL_

_URL_


@miruuna miruuna changed the title Move rich error building to exceptions and simplify server interceptor Refactor server interceptor and rich error building Jul 16, 2026
@miruuna

miruuna commented Jul 21, 2026

Copy link
Copy Markdown
Contributor Author

@PawelPlesniak @jamesturner246 This is the first PR in the process of updating the rich error handling. As we are now extending the rich error handling to the controller, there is a higher number of exceptions to handle, which can become a bit messy in the current Server Interceptor format. The server interceptor just intercepts the error and aborts with the rich error and the rich error is constructed where the exceptions are actually defined.

I have added an overview of the rich error implementation in rich_error_handling_overview.md. Not sure what the right place for it is but it should be somewhere easily found by devs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Feature]: gRPC rich error - refactor Server Interceptor and exceptions

2 participants