[Tooling] Automate detection of missing responses or gRPC status errors

[bryanchriswhite]

Objective

Improve overall developer/end-user experience by ensuring consistency around the application of best practices with respect to the gRPC client/server UX.

Origin Document

See: #974 (review)

Goals

• Automate the mitigation of regression with respect to either of the following conditions:
  • No protobuf query/msg response type has zero fields.
  • No gRPC query/msg responses are empty.
  • All gRPC query/msg handler error returns are wrapped in gRPC status errors with the most appropriate code.

Deliverables

• A PR which adds a script (or subcommand) which detects non-gRPC-status error returns in query/msg handler methods.
  • ([Tooling] Add protocheck status-errors subcmd to check for non-gRPC status error returns #929)
• A PR which adds a script (or subcommand) which detects empty query/msg types & responses
  • ([Tooling] Add protocheck responses subcmd to check for empty responses #970)
• A PR which adds CI jobs/steps for both new checks.

Non-goals / Non-deliverables

• Refactoring existing and unrelated CI or scripts.
• Fleshing out a comprehensive set of AST traversal helpers.

General deliverables

• Comments: Add/update TODOs and comments alongside the source code so it is easier to follow.
• Testing: Add new tests (unit and/or E2E) to the test suite.
• Makefile: Add new targets to the Makefile to make the new functionality easier to use.
• Documentation: Update architectural or development READMEs; use mermaid diagrams where appropriate.

---

Creator: @bryanchriswhite