feat(EAP): Trace Item resolvers

[volokluev]

Context

In order to make room for new kinds of TraceItems (e.g. uptime monitors, errors, logs, etc),add a layer of indirection to the RPC layer

Before:

RPC Flask Endpoint -> RPCEndpoint.execute() -> Snuba query pipeline

After:

                                           /-> EAP resolver -> Snuba query pipeline (or whatever else)
RPC Flask Endpoint -> RPCEndpoint.execute() -> Uptime resolver -> Snuba query pipeline (or whatever else)
                                           \-> Errors resolver -> Snuba query pipeline (or whatever else)

For rationale, please read this doc

How it works:

Every EAP endpoint has a get_resolver method based on the TraceItemName passed in the request meta. A resolver has the same inputs and outputs as the RPCEndpoint.

For each endpoint in EAP, there is a resolver class:
https://github.com/getsentry/snuba/pull/6732/files#diff-c018ef30d919d555c5e69908ce74e5f9144d613de3588a48d849f8c757b58628R22-R53

For each TraceItem we have, we implement the appropriate resolvers, this PR moves EndpointTraceItemTable and EndpointTimeSeries implementations for EAP spans into resolver implementations.

Resolvers are picked up automatically if they follow the directory structure:

snuba/web/rpc/v1/resolvers
  |->R_eap_spans
  |->R_uptime
  |->R_logs
  |->R_etc

Implementing resolver classes in these directories will ❇️ just work ❇️ without needing to change endpoint code.

Outstanding things

It's not clear yet what is really "common" and what is not. We will figure this out through the course of doing this work

[codecov]

❌ 1 Tests Failed:

Tests completed	Failed	Passed	Skipped
700	1	699	1

View the top 1 failed tests by shortest run time

tests.clickhouse.optimize.test_optimize_scheduler::test_get_next_schedule_raises_exception

Stack Traces | 0.002s run time

Traceback (most recent call last):
  File ".../clickhouse/optimize/test_optimize_scheduler.py", line 242, in test_get_next_schedule_raises_exception
    with pytest.raises(OptimizedSchedulerTimeout):
  File ".../local/lib/python3.11.../site-packages/_pytest/python_api.py", line 970, in __exit__
    fail(self.message)
  File ".../local/lib/python3.11.../site-packages/_pytest/outcomes.py", line 196, in fail
    raise Failed(msg=reason, pytrace=pytrace)
Failed: DID NOT RAISE <class 'snuba.clickhouse.optimize.optimize_scheduler.OptimizedSchedulerTimeout'>

To view more test analytics, go to the Test Analytics Dashboard
📢 Thoughts on this report? Let us know!

[xurui-c]

Should we also implement resolvers for these in the future (subsequent PR)?

[volokluev]

Absolutely