## PR2: Report builder refactor — DataSource abstraction
The existing report builders (timeseries + summary) had their SQL
queries inlined — each builder constructed its own scopes, groupings,
and aggregations directly. This made it hard to swap the underlying data
source without duplicating builder logic.
This PR extracts all raw-event querying into a `Reports::RawDataSource`
behind a `Reports::DataSource` factory. Builders now call
`data_source.timeseries`, `.aggregate`, or `.summary` instead of
constructing queries themselves. Behavior is identical —
`DataSource.for(...)` returns `RawDataSource` in all cases today.
The timeseries path had two separate builders (`CountReportBuilder`,
`AverageReportBuilder`) that were selected via a metric-name case
statement in `Conversations::BaseReportBuilder`. These are replaced by a
single `ReportBuilder` that delegates to the data source. The metric
type (count vs average) is now decided inside the data source, not the
builder.
Summary builders similarly moved their inline SQL into
`RawDataSource#summary`, which returns a unified hash keyed by dimension
ID.
the rollup read path.
## Flow
### Before
```
ReportsController ──▶ case metric ──▶ AverageReportBuilder ──▶ inline SQL ──▶ DB
└──▶ CountReportBuilder ──▶ inline SQL ──▶ DB
SummaryController ──▶ AgentSummaryBuilder ──▶ inline SQL ──▶ DB
└──▶ InboxSummaryBuilder ──▶ inline SQL ──▶ DB
└──▶ TeamSummaryBuilder ──▶ inline SQL ──▶ DB
```
### After
```
ReportsController ──▶ ReportBuilder ──┐
├──▶ DataSource.for ──▶ RawDataSource ──▶ DB
SummaryController ──▶ SummaryBuilder ──┘
```
### Expected (after rollup read path)
```
ReportsController ──▶ ReportBuilder ──┐
├──▶ DataSource.for ──▶ RawDataSource ──▶ reporting_events
SummaryController ──▶ SummaryBuilder ──┘ └──▶ RollupDataSource ──▶ reporting_events_rollups
```
### What changed
- `Reports::DataSource` factory + `Reports::RawDataSource`
- `TimezoneHelper#timezone_name_from_params` — prefers IANA name, falls
back to offset
- Unified `Timeseries::ReportBuilder` replaces `CountReportBuilder` +
`AverageReportBuilder`
- Summary builders delegate to `DataSource` instead of querying directly
### How to test
This is a pure refactor — all existing report pages (Overview, Agent,
Inbox, Label, Team) should produce identical numbers. No feature flag or
new config needed.
---------
Co-authored-by: Muhsin Keloth <muhsinkeramam@gmail.com>
Co-authored-by: Tanmay Deep Sharma <tanmaydeepsharma21@gmail.com>
Co-authored-by: Tanmay Deep Sharma <32020192+tds-1@users.noreply.github.com>
68 lines
1.3 KiB
Ruby
68 lines
1.3 KiB
Ruby
class V2::Reports::Timeseries::BaseTimeseriesBuilder
|
|
include TimezoneHelper
|
|
include DateRangeHelper
|
|
|
|
DEFAULT_GROUP_BY = 'day'.freeze
|
|
|
|
pattr_initialize :account, :params
|
|
|
|
def scope
|
|
case dimension_type.to_sym
|
|
when :account
|
|
account
|
|
when :inbox
|
|
inbox
|
|
when :agent
|
|
user
|
|
when :label
|
|
label
|
|
when :team
|
|
team
|
|
end
|
|
end
|
|
|
|
def data_source
|
|
@data_source ||= Reports::DataSource.for(
|
|
account: account,
|
|
metric: params[:metric],
|
|
dimension_type: dimension_type,
|
|
dimension_id: params[:id],
|
|
scope: scope,
|
|
range: range,
|
|
group_by: group_by,
|
|
timezone_offset: params[:timezone_offset],
|
|
business_hours: params[:business_hours]
|
|
)
|
|
end
|
|
|
|
def inbox
|
|
@inbox ||= account.inboxes.find(params[:id])
|
|
end
|
|
|
|
def user
|
|
@user ||= account.users.find(params[:id])
|
|
end
|
|
|
|
def label
|
|
@label ||= account.labels.find(params[:id])
|
|
end
|
|
|
|
def team
|
|
@team ||= account.teams.find(params[:id])
|
|
end
|
|
|
|
def group_by
|
|
@group_by ||= %w[day week month year hour].include?(params[:group_by]) ? params[:group_by] : DEFAULT_GROUP_BY
|
|
end
|
|
|
|
def timezone
|
|
@timezone ||= timezone_name_from_offset(params[:timezone_offset])
|
|
end
|
|
|
|
private
|
|
|
|
def dimension_type
|
|
(params[:type].presence || 'account').to_s
|
|
end
|
|
end
|