mirror of
https://github.com/umami-software/umami.git
synced 2026-02-17 19:15:37 +01:00
segments implementation and migration update. update getRequestFilters to include filter groups.
This commit is contained in:
parent
1ccc8a1a86
commit
f61421b742
16 changed files with 188 additions and 23 deletions
|
|
@ -2,6 +2,7 @@
|
||||||
CREATE TABLE "segment" (
|
CREATE TABLE "segment" (
|
||||||
"segment_id" UUID NOT NULL,
|
"segment_id" UUID NOT NULL,
|
||||||
"website_id" UUID NOT NULL,
|
"website_id" UUID NOT NULL,
|
||||||
|
"type" VARCHAR(200) NOT NULL,
|
||||||
"name" VARCHAR(200) NOT NULL,
|
"name" VARCHAR(200) NOT NULL,
|
||||||
"filters" JSONB NOT NULL,
|
"filters" JSONB NOT NULL,
|
||||||
"created_at" TIMESTAMPTZ(6) DEFAULT CURRENT_TIMESTAMP,
|
"created_at" TIMESTAMPTZ(6) DEFAULT CURRENT_TIMESTAMP,
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,3 @@
|
||||||
-- AlterTable
|
|
||||||
ALTER TABLE "segment" ADD COLUMN "type" VARCHAR(200) NOT NULL;
|
|
||||||
|
|
||||||
-- CreateTable
|
-- CreateTable
|
||||||
CREATE TABLE "revenue" (
|
CREATE TABLE "revenue" (
|
||||||
"revenue_id" UUID NOT NULL,
|
"revenue_id" UUID NOT NULL,
|
||||||
|
|
|
||||||
91
src/app/api/segments/[segmentId]/route.ts
Normal file
91
src/app/api/segments/[segmentId]/route.ts
Normal file
|
|
@ -0,0 +1,91 @@
|
||||||
|
import { z } from 'zod';
|
||||||
|
import { parseRequest } from '@/lib/request';
|
||||||
|
import { deleteReport, getReport, updateReport } from '@/queries';
|
||||||
|
import { canDeleteReport, canUpdateReport, canViewReport } from '@/lib/auth';
|
||||||
|
import { unauthorized, json, notFound, ok } from '@/lib/response';
|
||||||
|
import { reportTypeParam } from '@/lib/schema';
|
||||||
|
|
||||||
|
export async function GET(request: Request, { params }: { params: Promise<{ reportId: string }> }) {
|
||||||
|
const { auth, error } = await parseRequest(request);
|
||||||
|
|
||||||
|
if (error) {
|
||||||
|
return error();
|
||||||
|
}
|
||||||
|
|
||||||
|
const { reportId } = await params;
|
||||||
|
|
||||||
|
const report = await getReport(reportId);
|
||||||
|
|
||||||
|
if (!(await canViewReport(auth, report))) {
|
||||||
|
return unauthorized();
|
||||||
|
}
|
||||||
|
|
||||||
|
report.parameters = JSON.parse(report.parameters);
|
||||||
|
|
||||||
|
return json(report);
|
||||||
|
}
|
||||||
|
|
||||||
|
export async function POST(
|
||||||
|
request: Request,
|
||||||
|
{ params }: { params: Promise<{ reportId: string }> },
|
||||||
|
) {
|
||||||
|
const schema = z.object({
|
||||||
|
websiteId: z.string().uuid(),
|
||||||
|
type: reportTypeParam,
|
||||||
|
name: z.string().max(200),
|
||||||
|
description: z.string().max(500),
|
||||||
|
parameters: z.object({}).passthrough(),
|
||||||
|
});
|
||||||
|
|
||||||
|
const { auth, body, error } = await parseRequest(request, schema);
|
||||||
|
|
||||||
|
if (error) {
|
||||||
|
return error();
|
||||||
|
}
|
||||||
|
|
||||||
|
const { reportId } = await params;
|
||||||
|
const { websiteId, type, name, description, parameters } = body;
|
||||||
|
|
||||||
|
const report = await getReport(reportId);
|
||||||
|
|
||||||
|
if (!report) {
|
||||||
|
return notFound();
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!(await canUpdateReport(auth, report))) {
|
||||||
|
return unauthorized();
|
||||||
|
}
|
||||||
|
|
||||||
|
const result = await updateReport(reportId, {
|
||||||
|
websiteId,
|
||||||
|
userId: auth.user.id,
|
||||||
|
type,
|
||||||
|
name,
|
||||||
|
description,
|
||||||
|
parameters: JSON.stringify(parameters),
|
||||||
|
} as any);
|
||||||
|
|
||||||
|
return json(result);
|
||||||
|
}
|
||||||
|
|
||||||
|
export async function DELETE(
|
||||||
|
request: Request,
|
||||||
|
{ params }: { params: Promise<{ reportId: string }> },
|
||||||
|
) {
|
||||||
|
const { auth, error } = await parseRequest(request);
|
||||||
|
|
||||||
|
if (error) {
|
||||||
|
return error();
|
||||||
|
}
|
||||||
|
|
||||||
|
const { reportId } = await params;
|
||||||
|
const report = await getReport(reportId);
|
||||||
|
|
||||||
|
if (!(await canDeleteReport(auth, report))) {
|
||||||
|
return unauthorized();
|
||||||
|
}
|
||||||
|
|
||||||
|
await deleteReport(reportId);
|
||||||
|
|
||||||
|
return ok();
|
||||||
|
}
|
||||||
43
src/app/api/segments/route.ts
Normal file
43
src/app/api/segments/route.ts
Normal file
|
|
@ -0,0 +1,43 @@
|
||||||
|
import { z } from 'zod';
|
||||||
|
import { hashPassword, canCreateUser } from '@/lib/auth';
|
||||||
|
import { ROLES } from '@/lib/constants';
|
||||||
|
import { uuid } from '@/lib/crypto';
|
||||||
|
import { parseRequest } from '@/lib/request';
|
||||||
|
import { unauthorized, json, badRequest } from '@/lib/response';
|
||||||
|
import { createUser, getUserByUsername } from '@/queries';
|
||||||
|
|
||||||
|
export async function POST(request: Request) {
|
||||||
|
const schema = z.object({
|
||||||
|
id: z.string().uuid().optional(),
|
||||||
|
username: z.string().max(255),
|
||||||
|
password: z.string(),
|
||||||
|
role: z.string().regex(/admin|user|view-only/i),
|
||||||
|
});
|
||||||
|
|
||||||
|
const { auth, body, error } = await parseRequest(request, schema);
|
||||||
|
|
||||||
|
if (error) {
|
||||||
|
return error();
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!(await canCreateUser(auth))) {
|
||||||
|
return unauthorized();
|
||||||
|
}
|
||||||
|
|
||||||
|
const { id, username, password, role } = body;
|
||||||
|
|
||||||
|
const existingUser = await getUserByUsername(username, { showDeleted: true });
|
||||||
|
|
||||||
|
if (existingUser) {
|
||||||
|
return badRequest('User already exists');
|
||||||
|
}
|
||||||
|
|
||||||
|
const user = await createUser({
|
||||||
|
id: id || uuid(),
|
||||||
|
username,
|
||||||
|
password: hashPassword(password),
|
||||||
|
role: role ?? ROLES.user,
|
||||||
|
});
|
||||||
|
|
||||||
|
return json(user);
|
||||||
|
}
|
||||||
|
|
@ -32,7 +32,7 @@ export async function GET(
|
||||||
}
|
}
|
||||||
|
|
||||||
const filters = {
|
const filters = {
|
||||||
...getRequestFilters(query),
|
...(await getRequestFilters(query)),
|
||||||
startDate,
|
startDate,
|
||||||
endDate,
|
endDate,
|
||||||
timezone,
|
timezone,
|
||||||
|
|
|
||||||
|
|
@ -48,7 +48,7 @@ export async function GET(
|
||||||
const { startDate, endDate } = await getRequestDateRange(query);
|
const { startDate, endDate } = await getRequestDateRange(query);
|
||||||
const column = FILTER_COLUMNS[type] || type;
|
const column = FILTER_COLUMNS[type] || type;
|
||||||
const filters = {
|
const filters = {
|
||||||
...getRequestFilters(query),
|
...(await getRequestFilters(query)),
|
||||||
startDate,
|
startDate,
|
||||||
endDate,
|
endDate,
|
||||||
};
|
};
|
||||||
|
|
|
||||||
|
|
@ -35,7 +35,7 @@ export async function GET(
|
||||||
const { startDate, endDate, unit } = await getRequestDateRange(query);
|
const { startDate, endDate, unit } = await getRequestDateRange(query);
|
||||||
|
|
||||||
const filters = {
|
const filters = {
|
||||||
...getRequestFilters(query),
|
...(await getRequestFilters(query)),
|
||||||
startDate,
|
startDate,
|
||||||
endDate,
|
endDate,
|
||||||
timezone,
|
timezone,
|
||||||
|
|
|
||||||
|
|
@ -29,7 +29,7 @@ export async function GET(
|
||||||
|
|
||||||
const { startDate, endDate } = await getRequestDateRange(query);
|
const { startDate, endDate } = await getRequestDateRange(query);
|
||||||
|
|
||||||
const filters = getRequestFilters(query);
|
const filters = await getRequestFilters(query);
|
||||||
|
|
||||||
const metrics = await getWebsiteSessionStats(websiteId, {
|
const metrics = await getWebsiteSessionStats(websiteId, {
|
||||||
...filters,
|
...filters,
|
||||||
|
|
|
||||||
|
|
@ -37,7 +37,7 @@ export async function GET(
|
||||||
endDate,
|
endDate,
|
||||||
);
|
);
|
||||||
|
|
||||||
const filters = getRequestFilters(query);
|
const filters = await getRequestFilters(query);
|
||||||
|
|
||||||
const metrics = await getWebsiteStats(websiteId, {
|
const metrics = await getWebsiteStats(websiteId, {
|
||||||
...filters,
|
...filters,
|
||||||
|
|
|
||||||
|
|
@ -1,9 +1,9 @@
|
||||||
import { z } from 'zod';
|
|
||||||
import { canViewWebsite } from '@/lib/auth';
|
import { canViewWebsite } from '@/lib/auth';
|
||||||
import { EVENT_COLUMNS, FILTER_COLUMNS, GROUP_FILTERS, SESSION_COLUMNS } from '@/lib/constants';
|
import { EVENT_COLUMNS, FILTER_COLUMNS, FILTER_GROUPS, SESSION_COLUMNS } from '@/lib/constants';
|
||||||
import { getValues } from '@/queries';
|
import { getRequestDateRange, parseRequest } from '@/lib/request';
|
||||||
import { parseRequest, getRequestDateRange } from '@/lib/request';
|
|
||||||
import { badRequest, json, unauthorized } from '@/lib/response';
|
import { badRequest, json, unauthorized } from '@/lib/response';
|
||||||
|
import { getWebsiteSegments, getValues } from '@/queries';
|
||||||
|
import { z } from 'zod';
|
||||||
|
|
||||||
export async function GET(
|
export async function GET(
|
||||||
request: Request,
|
request: Request,
|
||||||
|
|
@ -33,12 +33,18 @@ export async function GET(
|
||||||
if (
|
if (
|
||||||
!SESSION_COLUMNS.includes(type) &&
|
!SESSION_COLUMNS.includes(type) &&
|
||||||
!EVENT_COLUMNS.includes(type) &&
|
!EVENT_COLUMNS.includes(type) &&
|
||||||
!GROUP_FILTERS.includes(type)
|
!FILTER_GROUPS.includes(type)
|
||||||
) {
|
) {
|
||||||
return badRequest('Invalid type.');
|
return badRequest('Invalid type.');
|
||||||
}
|
}
|
||||||
|
|
||||||
const values = await getValues(websiteId, FILTER_COLUMNS[type], startDate, endDate, search);
|
let values;
|
||||||
|
|
||||||
|
if (FILTER_GROUPS.includes(type)) {
|
||||||
|
values = (await getWebsiteSegments(websiteId, type)).map(segment => ({ value: segment.name }));
|
||||||
|
} else {
|
||||||
|
values = await getValues(websiteId, FILTER_COLUMNS[type], startDate, endDate, search);
|
||||||
|
}
|
||||||
|
|
||||||
return json(values.filter(n => n).sort());
|
return json(values.filter(n => n).sort());
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -21,6 +21,8 @@ export function useFilterParams(websiteId: string) {
|
||||||
city,
|
city,
|
||||||
event,
|
event,
|
||||||
tag,
|
tag,
|
||||||
|
segment,
|
||||||
|
cohort,
|
||||||
},
|
},
|
||||||
} = useNavigation();
|
} = useNavigation();
|
||||||
|
|
||||||
|
|
@ -42,5 +44,7 @@ export function useFilterParams(websiteId: string) {
|
||||||
city,
|
city,
|
||||||
event,
|
event,
|
||||||
tag,
|
tag,
|
||||||
|
segment,
|
||||||
|
cohort,
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -47,7 +47,7 @@ export const SESSION_COLUMNS = [
|
||||||
'host',
|
'host',
|
||||||
];
|
];
|
||||||
|
|
||||||
export const GROUP_FILTERS = ['segment', 'cohort'];
|
export const FILTER_GROUPS = ['segment', 'cohort'];
|
||||||
|
|
||||||
export const FILTER_COLUMNS = {
|
export const FILTER_COLUMNS = {
|
||||||
url: 'url_path',
|
url: 'url_path',
|
||||||
|
|
@ -67,6 +67,7 @@ export const FILTER_COLUMNS = {
|
||||||
event: 'event_name',
|
event: 'event_name',
|
||||||
tag: 'tag',
|
tag: 'tag',
|
||||||
segment: 'segment',
|
segment: 'segment',
|
||||||
|
cohort: 'cohort',
|
||||||
};
|
};
|
||||||
|
|
||||||
export const COLLECTION_TYPE = {
|
export const COLLECTION_TYPE = {
|
||||||
|
|
|
||||||
|
|
@ -1,9 +1,9 @@
|
||||||
import { z, ZodSchema } from 'zod';
|
import { z, ZodSchema } from 'zod';
|
||||||
import { FILTER_COLUMNS } from '@/lib/constants';
|
import { FILTER_COLUMNS, FILTER_GROUPS } from '@/lib/constants';
|
||||||
import { badRequest, unauthorized } from '@/lib/response';
|
import { badRequest, unauthorized } from '@/lib/response';
|
||||||
import { getAllowedUnits, getMinimumUnit } from '@/lib/date';
|
import { getAllowedUnits, getMinimumUnit } from '@/lib/date';
|
||||||
import { checkAuth } from '@/lib/auth';
|
import { checkAuth } from '@/lib/auth';
|
||||||
import { getWebsiteDateRange } from '@/queries';
|
import { getWebsiteSegment, getWebsiteDateRange } from '@/queries';
|
||||||
|
|
||||||
export async function getJsonBody(request: Request) {
|
export async function getJsonBody(request: Request) {
|
||||||
try {
|
try {
|
||||||
|
|
@ -85,14 +85,21 @@ export async function getRequestDateRange(query: Record<string, any>) {
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
export function getRequestFilters(query: Record<string, any>) {
|
export async function getRequestFilters(query: Record<string, any>, websiteId?: string) {
|
||||||
return Object.keys(FILTER_COLUMNS).reduce((obj, key) => {
|
const result: Record<string, any> = {};
|
||||||
|
|
||||||
|
for (const key of Object.keys(FILTER_COLUMNS)) {
|
||||||
const value = query[key];
|
const value = query[key];
|
||||||
|
|
||||||
if (value !== undefined) {
|
if (value !== undefined) {
|
||||||
obj[key] = value;
|
if (FILTER_GROUPS.includes(key)) {
|
||||||
|
const segment = await getWebsiteSegment(websiteId, value);
|
||||||
|
// merge filters into result
|
||||||
|
Object.assign(result, segment.filters);
|
||||||
|
} else {
|
||||||
|
result[key] = value;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
}
|
||||||
|
|
||||||
return obj;
|
return result;
|
||||||
}, {});
|
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -17,6 +17,8 @@ export const filterParams = {
|
||||||
host: z.string().optional(),
|
host: z.string().optional(),
|
||||||
language: z.string().optional(),
|
language: z.string().optional(),
|
||||||
event: z.string().optional(),
|
event: z.string().optional(),
|
||||||
|
segment: z.string().optional(),
|
||||||
|
cohort: z.string().optional(),
|
||||||
};
|
};
|
||||||
|
|
||||||
export const pagingParams = {
|
export const pagingParams = {
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,5 @@
|
||||||
export * from '@/queries/prisma/report';
|
export * from '@/queries/prisma/report';
|
||||||
|
export * from '@/queries/prisma/segment';
|
||||||
export * from '@/queries/prisma/team';
|
export * from '@/queries/prisma/team';
|
||||||
export * from '@/queries/prisma/teamUser';
|
export * from '@/queries/prisma/teamUser';
|
||||||
export * from '@/queries/prisma/user';
|
export * from '@/queries/prisma/user';
|
||||||
|
|
|
||||||
|
|
@ -13,6 +13,18 @@ export async function getSegment(segmentId: string): Promise<Segment> {
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export async function getWebsiteSegment(websiteId: string, name: string): Promise<Segment> {
|
||||||
|
return prisma.client.segment.findFirst({
|
||||||
|
where: { websiteId, name },
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
export async function getWebsiteSegments(websiteId: string, type: string): Promise<Segment[]> {
|
||||||
|
return prisma.client.Segment.findMany({
|
||||||
|
where: { websiteId, type },
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
export async function createSegment(data: Prisma.SegmentUncheckedCreateInput): Promise<Segment> {
|
export async function createSegment(data: Prisma.SegmentUncheckedCreateInput): Promise<Segment> {
|
||||||
return prisma.client.Segment.create({ data });
|
return prisma.client.Segment.create({ data });
|
||||||
}
|
}
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue