Skip to content

🐸 Rybbit - open-source and privacy-friendly alternative to Google Analytics that is 10x more intuitive.

Refactor weekly report types and related services to replace SingleColData with MetricData for improved consistency in data handling. Update API and email templates accordingly to reflect the new metric-based structure.

Bill Yang5ef28ee29ebd
diff --git a/server/src/api/analytics/getMetric.ts b/server/src/api/analytics/getMetric.ts
index 21c06955a..9e87a6065 100644
--- a/server/src/api/analytics/getMetric.ts
+++ b/server/src/api/analytics/getMetric.ts
@@ -4,7 +4,7 @@ import { FilterParameter } from "./types.js";
import { getFilterStatement, getSqlParam, getTimeStatement, processResults } from "./utils.js";
import { FilterParams } from "@rybbit/shared";
-interface GetSingleColRequest {
+interface GetMetricRequest {
Params: {
site: string;
};
@@ -15,7 +15,7 @@ interface GetSingleColRequest {
}>;
}
-type GetSingleColResponse = {
+type GetMetricResponse = {
value: string;
// title is only used for pathname
title?: string;
@@ -30,7 +30,7 @@ type GetSingleColResponse = {
}[];
// This type represents a single item in the array returned *within* the data property
-type SingleColItem = {
+type MetricItem = {
value: string;
title?: string;
pathname?: string;
@@ -43,12 +43,12 @@ type SingleColItem = {
};
// This is the structure the API will now send
-type GetSingleColPaginatedResponse = {
- data: SingleColItem[];
+type GetMetricPaginatedResponse = {
+ data: MetricItem[];
totalCount: number;
};
-const getQuery = (request: FastifyRequest<GetSingleColRequest>, isCountQuery: boolean = false) => {
+const getQuery = (request: FastifyRequest<GetMetricRequest>, isCountQuery: boolean = false) => {
const { filters, parameter, limit, page } = request.query;
const site = request.params.site;
@@ -393,7 +393,7 @@ const getQuery = (request: FastifyRequest<GetSingleColRequest>, isCountQuery: bo
`;
};
-export async function getMetric(req: FastifyRequest<GetSingleColRequest>, res: FastifyReply) {
+export async function getMetric(req: FastifyRequest<GetMetricRequest>, res: FastifyReply) {
const { parameter, page } = req.query;
const site = req.params.site;
@@ -421,7 +421,7 @@ export async function getMetric(req: FastifyRequest<GetSingleColRequest>, res: F
}),
]);
- const items = await processResults<SingleColItem>(dataResult);
+ const items = await processResults<MetricItem>(dataResult);
const countData = await processResults<{ totalCount: number }>(countResult);
const totalCount = countData.length > 0 ? countData[0].totalCount : 0;
diff --git a/server/src/lib/email/templates/WeeklyReportEmail.tsx b/server/src/lib/email/templates/WeeklyReportEmail.tsx
index 8b8f96971..b4fde5a9a 100644
--- a/server/src/lib/email/templates/WeeklyReportEmail.tsx
+++ b/server/src/lib/email/templates/WeeklyReportEmail.tsx
@@ -12,7 +12,7 @@ import {
pixelBasedPreset,
} from "@react-email/components";
import * as React from "react";
-import type { OrganizationReport, SingleColData } from "../../../services/weekyReports/weeklyReportTypes.js";
+import type { OrganizationReport, MetricData } from "../../../services/weekyReports/weeklyReportTypes.js";
interface WeeklyReportEmailProps {
userName: string;
@@ -38,8 +38,8 @@ interface TopListItemProps {
interface TopListSectionProps {
title: string;
- items: SingleColData[];
- renderLabel: (item: SingleColData) => React.ReactNode;
+ items: MetricData[];
+ renderLabel: (item: MetricData) => React.ReactNode;
showFavicon?: boolean;
labelClassName?: string;
className?: string;
diff --git a/server/src/services/weekyReports/weeklyReportService.ts b/server/src/services/weekyReports/weeklyReportService.ts
index 7aaac12fc..cf3b51e1e 100644
--- a/server/src/services/weekyReports/weeklyReportService.ts
+++ b/server/src/services/weekyReports/weeklyReportService.ts
@@ -8,7 +8,7 @@ import { processResults } from "../../api/analytics/utils.js";
import { createServiceLogger } from "../../lib/logger/logger.js";
import { sendWeeklyReportEmail } from "../../lib/email/email.js";
import { IS_CLOUD } from "../../lib/const.js";
-import type { OverviewData, SingleColData, SiteReport, OrganizationReport } from "./weeklyReportTypes.js";
+import type { OverviewData, MetricData, SiteReport, OrganizationReport } from "./weeklyReportTypes.js";
class WeeklyReportService {
private cronTask: cron.ScheduledTask | null = null;
@@ -87,7 +87,7 @@ class WeeklyReportService {
startDate: string,
endDate: string,
limit: number = 5
- ): Promise<SingleColData[]> {
+ ): Promise<MetricData[]> {
try {
let query = "";
@@ -212,7 +212,7 @@ class WeeklyReportService {
},
});
- return await processResults<SingleColData>(result);
+ return await processResults<MetricData>(result);
} catch (error) {
this.logger.error({ error, siteId, parameter }, "Error fetching top N data");
return [];
diff --git a/server/src/services/weekyReports/weeklyReportTypes.ts b/server/src/services/weekyReports/weeklyReportTypes.ts
index a83c7e288..4a943b452 100644
--- a/server/src/services/weekyReports/weeklyReportTypes.ts
+++ b/server/src/services/weekyReports/weeklyReportTypes.ts
@@ -7,7 +7,7 @@ export interface OverviewData {
session_duration: number;
}
-export interface SingleColData {
+export interface MetricData {
value: string;
count: number;
percentage: number | null;
@@ -19,10 +19,10 @@ export interface SiteReport {
siteDomain: string;
currentWeek: OverviewData;
previousWeek: OverviewData;
- topCountries: SingleColData[];
- topPages: SingleColData[];
- topReferrers: SingleColData[];
- deviceBreakdown: SingleColData[];
+ topCountries: MetricData[];
+ topPages: MetricData[];
+ topReferrers: MetricData[];
+ deviceBreakdown: MetricData[];
}
export interface OrganizationReport {