Skip to content

📈 Open source, privacy-first web analytics — a cookie-less Google Analytics alternative with built-in error tracking and performance monitoring. Self-host it or use our cloud. Get started for free!

dashboard sorting

Blue Mousebf09e84c6e0d
diff --git a/backend/apps/cloud/src/project/project-extra.service.ts b/backend/apps/cloud/src/project/project-extra.service.ts
index bc67dc0ac..2485ae5a2 100644
--- a/backend/apps/cloud/src/project/project-extra.service.ts
+++ b/backend/apps/cloud/src/project/project-extra.service.ts
@@ -14,6 +14,14 @@ dayjs.extend(utc)
interface TrafficPaginationOptions extends PaginationOptionsInterface {
mode?: 'high-traffic' | 'low-traffic' | 'performance' | 'lost-traffic'
period?: '1h' | '1d' | '7d' | '4w' | '3M' | '12M' | '24M' | 'all'
+ sort?:
+ | 'alpha_asc'
+ | 'alpha_desc'
+ | 'date_asc'
+ | 'date_desc'
+ | 'pageviews_asc'
+ | 'pageviews_desc'
+ | 'last_visit_desc'
}
@Injectable()
@@ -58,7 +66,10 @@ export class ProjectExtraService {
${search ? `AND host ILIKE {search:String}` : ''}
AND created BETWEEN ${timeFrameClause.currentStart} AND ${timeFrameClause.currentEnd}
GROUP BY host, pid
- ORDER BY visits DESC
+ ${options.sort === 'alpha_asc' ? 'ORDER BY host ASC' : ''}
+ ${options.sort === 'alpha_desc' ? 'ORDER BY host DESC' : ''}
+ ${options.sort === 'pageviews_asc' ? 'ORDER BY visits ASC' : ''}
+ ${options.sort === 'pageviews_desc' ? 'ORDER BY visits DESC' : ''}
)
SELECT *
FROM hostStats
@@ -149,7 +160,7 @@ export class ProjectExtraService {
return chResults.map(chResult => ({
...project,
- name: chResult.host || project.name,
+ name: (chResult.host || project.name) as string,
trafficStats: {
visits: chResult.visits || 0,
},
@@ -158,9 +169,19 @@ export class ProjectExtraService {
.flat()
const results = new Pagination<Project>({
- results: enrichedProjects.sort(
- (a, b) => (b.trafficStats?.visits || 0) - (a.trafficStats?.visits || 0),
- ),
+ results: enrichedProjects.sort((a, b) => {
+ switch (options.sort) {
+ case 'alpha_asc':
+ return a.name.localeCompare(b.name)
+ case 'alpha_desc':
+ return b.name.localeCompare(a.name)
+ case 'pageviews_asc':
+ return (a.trafficStats?.visits || 0) - (b.trafficStats?.visits || 0)
+ case 'pageviews_desc':
+ default:
+ return (b.trafficStats?.visits || 0) - (a.trafficStats?.visits || 0)
+ }
+ }),
total,
})
@@ -232,7 +253,6 @@ export class ProjectExtraService {
chunks.push(projectIds.slice(i, i + CHUNK_SIZE))
}
- // Build the appropriate Clickhouse query based on mode
const timeFrameClause = this.getTimeFrameClause(options.period)
let query = ''
let countQuery = ''
@@ -328,7 +348,9 @@ export class ProjectExtraService {
FROM hostStats
WHERE last_visit < (now() - INTERVAL 48 HOUR)
AND total_visits > 0
- ORDER BY last_visit DESC
+ ${options.sort === 'alpha_asc' ? 'ORDER BY host ASC' : ''}
+ ${options.sort === 'alpha_desc' ? 'ORDER BY host DESC' : ''}
+ ${options.sort === 'last_visit_desc' || !options.sort ? 'ORDER BY last_visit DESC' : ''}
`
countQuery = `
@@ -567,7 +589,7 @@ export class ProjectExtraService {
return chResults.map(chResult => ({
...project,
- name: chResult.host || project.name,
+ name: (chResult.host || project.name) as string,
trafficStats: {
visits: chResult.visits || chResult.current_visits || 0,
percentageChange: chResult.percentage_change,
@@ -593,6 +615,17 @@ export class ProjectExtraService {
return (a.trafficStats.visits || 0) - (b.trafficStats.visits || 0)
}
+ if (options.mode === 'lost-traffic' && isHostnameNavigationEnabled) {
+ switch (options.sort) {
+ case 'alpha_asc':
+ return a.name.localeCompare(b.name)
+ case 'alpha_desc':
+ return b.name.localeCompare(a.name)
+ default:
+ return (b.trafficStats.visits || 0) - (a.trafficStats.visits || 0)
+ }
+ }
+
return (b.trafficStats.visits || 0) - (a.trafficStats.visits || 0)
}),
total,
diff --git a/backend/apps/cloud/src/project/project.controller.ts b/backend/apps/cloud/src/project/project.controller.ts
index 34bcb89b9..19c246484 100644
--- a/backend/apps/cloud/src/project/project.controller.ts
+++ b/backend/apps/cloud/src/project/project.controller.ts
@@ -156,6 +156,11 @@ export class ProjectController {
required: false,
type: String,
})
+ @ApiQuery({
+ name: 'sort',
+ required: false,
+ type: String,
+ })
@ApiResponse({ status: 200, type: [Project] })
@Auth([], true)
async get(
@@ -175,11 +180,21 @@ export class ProjectController {
period: '1h' | '1d' | '7d' | '4w' | '3M' | '12M' | '24M' | 'all' = '7d',
@Query('use-hostname-navigation')
useHostnameNavigation: string = 'false',
+ @Query('sort')
+ sort?: 'alpha_asc' | 'alpha_desc' | 'date_asc' | 'date_desc',
): Promise<Pagination<Project> | Project[] | object> {
const isHostnameNavigationEnabled = useHostnameNavigation === 'true'
this.logger.log(
- { userId, take, skip, mode, timeFrame: period, useHostnameNavigation },
+ {
+ userId,
+ take,
+ skip,
+ mode,
+ timeFrame: period,
+ useHostnameNavigation,
+ sort,
+ },
'GET /project',
)
@@ -192,19 +207,28 @@ export class ProjectController {
}
if (!mode || mode === 'default') {
- let paginated: Pagination<Project>
+ let paginated
if (isHostnameNavigationEnabled) {
paginated = await this.projectExtraService.paginateHostnameNavigation(
- { take, skip, period },
+ {
+ take,
+ skip,
+ period,
+ sort,
+ },
userId,
search,
)
} else {
paginated = await this.projectService.paginate(
- { take, skip },
+ {
+ take,
+ skip,
+ },
userId,
search,
+ sort,
)
}
@@ -217,6 +241,7 @@ export class ProjectController {
skip,
mode,
period,
+ sort,
},
userId,
search,
diff --git a/backend/apps/cloud/src/project/project.service.ts b/backend/apps/cloud/src/project/project.service.ts
index 48e11db22..d67f1cdf2 100644
--- a/backend/apps/cloud/src/project/project.service.ts
+++ b/backend/apps/cloud/src/project/project.service.ts
@@ -453,6 +453,7 @@ export class ProjectService {
options: PaginationOptionsInterface,
userId: string,
search?: string,
+ sort?: string,
): Promise<Pagination<Project>> {
const queryBuilder = this.projectsRepository
.createQueryBuilder('project')
@@ -505,10 +506,25 @@ export class ProjectService {
.setParameter('search', search ? `%${search.trim()}%` : '')
}
- queryBuilder
- .orderBy('project.name', 'ASC')
- .skip(options.skip || 0)
- .take(options.take || 100)
+ // Add sorting based on options.sort
+ switch (sort) {
+ case 'alpha_asc':
+ queryBuilder.orderBy('project.name', 'ASC')
+ break
+ case 'alpha_desc':
+ queryBuilder.orderBy('project.name', 'DESC')
+ break
+ case 'date_asc':
+ queryBuilder.orderBy('project.created', 'ASC')
+ break
+ case 'date_desc':
+ queryBuilder.orderBy('project.created', 'DESC')
+ break
+ default:
+ queryBuilder.orderBy('project.name', 'ASC')
+ }
+
+ queryBuilder.skip(options.skip || 0).take(options.take || 100)
const [results, total] = await queryBuilder.getManyAndCount()
const processedResults = await processProjectsUser(results, [
diff --git a/web/app/api/index.ts b/web/app/api/index.ts
index 2adffb0e1..43eafbafb 100644
--- a/web/app/api/index.ts
+++ b/web/app/api/index.ts
@@ -272,10 +272,11 @@ export const getProjects = (
mode?: string,
period?: string,
useHostnameNavigation?: boolean,
+ sort?: string,
) =>
api
.get(
- `/project?take=${take}&skip=${skip}&search=${search}&mode=${mode}&period=${period}&use-hostname-navigation=${useHostnameNavigation}`,
+ `/project?take=${take}&skip=${skip}&search=${search}&mode=${mode}&period=${period}&use-hostname-navigation=${useHostnameNavigation}&sort=${sort}`,
)
.then(
(
diff --git a/web/app/pages/Dashboard/Dashboard.tsx b/web/app/pages/Dashboard/Dashboard.tsx
index 1f4a2ef7c..355461420 100644
--- a/web/app/pages/Dashboard/Dashboard.tsx
+++ b/web/app/pages/Dashboard/Dashboard.tsx
@@ -31,6 +31,7 @@ import { Overall, Project } from '~/lib/models/Project'
import { getProjects, getLiveVisitors, getOverallStats, getOverallStatsCaptcha } from '~/api'
import { DASHBOARD_TABS, Tabs } from './Tabs'
import { PeriodSelector } from './PeriodSelector'
+import { SortSelector, SORT_OPTIONS } from './SortSelector'
import useBreakpoint from '~/hooks/useBreakpoint'
const PAGE_SIZE_OPTIONS = [12, 24, 48, 96]
@@ -82,6 +83,11 @@ const Dashboard = () => {
return periodParam || '7d'
})
+ const [sortBy, setSortBy] = useState(() => {
+ const sortParam = searchParams.get('sort')
+ return sortParam && Object.values(SORT_OPTIONS).includes(sortParam as any) ? sortParam : SORT_OPTIONS.ALPHA_ASC
+ })
+
const pageAmount = Math.ceil(paginationTotal / pageSize)
// This search represents what's inside the search input
@@ -120,6 +126,12 @@ const Dashboard = () => {
updateURL({ period, page: '1' })
}
+ const handleSortChange = (sort: string) => {
+ setSortBy(sort)
+ setPage(1)
+ updateURL({ sort, page: '1' })
+ }
+
const handleViewModeChange = (mode: 'grid' | 'list') => {
setViewMode(mode)
setCookie('dashboard_view', mode, 7884000) // 3 months
@@ -143,6 +155,7 @@ const Dashboard = () => {
tab?: string,
period?: string,
isHostnameNavigationEnabled?: boolean,
+ sort?: string,
) => {
if (isLoading) {
return
@@ -150,7 +163,7 @@ const Dashboard = () => {
setIsLoading(true)
try {
- const result = await getProjects(take, skip, search, tab, period, isHostnameNavigationEnabled)
+ const result = await getProjects(take, skip, search, tab, period, isHostnameNavigationEnabled, sort)
setProjects(result.results)
setPaginationTotal(result.total)
} catch (reason: any) {
@@ -165,10 +178,18 @@ const Dashboard = () => {
return
}
- loadProjects(pageSize, (page - 1) * pageSize, debouncedSearch, activeTab, activePeriod, isHostnameNavigationEnabled)
+ loadProjects(
+ pageSize,
+ (page - 1) * pageSize,
+ debouncedSearch,
+ activeTab,
+ activePeriod,
+ isHostnameNavigationEnabled,
+ sortBy,
+ )
// eslint-disable-next-line react-hooks/exhaustive-deps
- }, [page, pageSize, debouncedSearch, activeTab, activePeriod, isHostnameNavigationEnabled, authLoading])
+ }, [page, pageSize, debouncedSearch, activeTab, activePeriod, isHostnameNavigationEnabled, authLoading, sortBy])
// Set up interval for live visitors
useEffect(() => {
@@ -310,7 +331,7 @@ const Dashboard = () => {
</div>
)}
</div>
- <div className='flex items-center gap-1'>
+ <div className='flex flex-wrap items-center gap-1'>
{activeTab === 'lost-traffic' ? null : showPeriodSelector ? (
<PeriodSelector
activePeriod={activePeriod}
@@ -318,6 +339,14 @@ const Dashboard = () => {
isLoading={isLoading === null || isLoading}
/>
) : null}
+ {['high-traffic', 'low-traffic', 'performance'].includes(activeTab) ? null : (
+ <SortSelector
+ activeTab={activeTab}
+ activeSort={sortBy}
+ setActiveSort={handleSortChange}
+ isLoading={isLoading === null || isLoading}
+ />
+ )}
<div className='ml-1 hidden space-x-2 sm:mr-3 lg:block lg:px-3'>
<button
type='button'
@@ -422,7 +451,7 @@ const Dashboard = () => {
>
{_map(projects, (project) => (
<ProjectCard
- key={project.id}
+ key={`${project.id}-${project.name}`}
project={project}
live={liveStats[project.id] ?? (_isEmpty(liveStats) ? null : 'N/A')}
overallStats={overallStats[project.id]}
diff --git a/web/app/pages/Dashboard/SortSelector.tsx b/web/app/pages/Dashboard/SortSelector.tsx
new file mode 100644
index 000000000..2642c0455
--- /dev/null
+++ b/web/app/pages/Dashboard/SortSelector.tsx
@@ -0,0 +1,151 @@
+import React, { Fragment, useEffect, useMemo } from 'react'
+import { Popover, PopoverButton, PopoverPanel, Transition } from '@headlessui/react'
+import { ChevronDownIcon } from '@heroicons/react/20/solid'
+import { useTranslation } from 'react-i18next'
+import _map from 'lodash/map'
+import cx from 'clsx'
+import { ArrowUpDown } from 'lucide-react'
+import { DASHBOARD_TABS } from './Tabs'
+import useFeatureFlag from '~/hooks/useFeatureFlag'
+import { FeatureFlag } from '~/lib/models/User'
+import { useSelector } from 'react-redux'
+import { StateType } from '~/lib/store'
+
+interface SortSelectorProps {
+ activeSort: string
+ setActiveSort: (sort: string) => void
+ isLoading: boolean
+ activeTab: (typeof DASHBOARD_TABS)[number]['id']
+}
+
+export const SORT_OPTIONS = {
+ ALPHA_ASC: 'alpha_asc',
+ ALPHA_DESC: 'alpha_desc',
+ DATE_ASC: 'date_asc',
+ DATE_DESC: 'date_desc',
+ PAGEVIEWS_ASC: 'pageviews_asc',
+ PAGEVIEWS_DESC: 'pageviews_desc',
+ LAST_VISIT_DESC: 'last_visit_desc',
+} as const
+
+export const SortSelector = ({ activeSort, setActiveSort, isLoading, activeTab }: SortSelectorProps) => {
+ const { t } = useTranslation('common')
+
+ const { loading: authLoading } = useSelector((state: StateType) => state.auth)
+
+ const isHostnameNavigationEnabled = useFeatureFlag(FeatureFlag['dashboard-hostname-cards'])
+
+ const sortOptions = useMemo(() => {
+ return [
+ ...(activeTab === 'lost-traffic' && !isHostnameNavigationEnabled
+ ? []
+ : [
+ {
+ label: t('dashboard.sortAlphaAsc'),
+ sort: SORT_OPTIONS.ALPHA_ASC,
+ },
+ {
+ label: t('dashboard.sortAlphaDesc'),
+ sort: SORT_OPTIONS.ALPHA_DESC,
+ },
+ ]),
+ ...(isHostnameNavigationEnabled || activeTab !== 'default'
+ ? []
+ : [
+ {
+ label: t('dashboard.sortDateAsc'),
+ sort: SORT_OPTIONS.DATE_ASC,
+ },
+ {
+ label: t('dashboard.sortDateDesc'),
+ sort: SORT_OPTIONS.DATE_DESC,
+ },
+ ]),
+ ...(!isHostnameNavigationEnabled || activeTab !== 'default'
+ ? []
+ : [
+ {
+ label: t('dashboard.pageviewsDesc'),
+ sort: SORT_OPTIONS.PAGEVIEWS_DESC,
+ },
+ {
+ label: t('dashboard.pageviewsAsc'),
+ sort: SORT_OPTIONS.PAGEVIEWS_ASC,
+ },
+ ]),
+ ...(activeTab === 'lost-traffic'
+ ? [
+ {
+ label: t('dashboard.lastVisitDesc'),
+ sort: SORT_OPTIONS.LAST_VISIT_DESC,
+ },
+ ]
+ : []),
+ ]
+ }, [t, isHostnameNavigationEnabled, activeTab])
+
+ useEffect(() => {
+ if (authLoading) return
+
+ if (!sortOptions.find((item) => item.sort === activeSort)) {
+ setActiveSort(sortOptions[0].sort)
+ }
+ }, [sortOptions, activeSort, setActiveSort, authLoading])
+
+ const sortLabel = sortOptions.find((item) => item.sort === activeSort)?.label
+
+ if (sortOptions.length === 0 || authLoading) return null
+
+ return (
+ <Popover className='relative'>
+ {({ open }) => (
+ <>
+ <PopoverButton className='group inline-flex w-full px-2.5 py-2 text-sm font-medium text-gray-700 outline-none dark:text-gray-50 md:px-4'>
+ <ArrowUpDown className='mr-1 h-5 w-5' strokeWidth={1.5} />
+ <span>{sortLabel}</span>
+ <ChevronDownIcon
+ className={cx(
+ 'ml-2 h-5 w-5 transform-gpu text-gray-700 transition duration-150 ease-in-out group-hover:text-gray-500 dark:text-gray-50',
+ {
+ 'rotate-180': open,
+ },
+ )}
+ aria-hidden='true'
+ />
+ </PopoverButton>
+ <Transition
+ as={Fragment}
+ enter='transition ease-out duration-200'
+ enterFrom='opacity-0 translate-y-1'
+ enterTo='opacity-100 translate-y-0'
+ leave='transition ease-in duration-150'
+ leaveFrom='opacity-100 translate-y-0'
+ leaveTo='opacity-0 translate-y-1'
+ >
+ <PopoverPanel className='absolute left-1/2 right-0 z-20 mt-3 w-max max-w-sm -translate-x-1/2 transform px-4 sm:px-0 md:left-auto md:transform-none lg:max-w-3xl'>
+ <div className='overflow-hidden rounded-lg bg-gray-50 p-1 shadow-lg ring-1 ring-black/5 dark:bg-slate-800'>
+ <ul className='w-full text-left'>
+ {_map(sortOptions, (item) => (
+ <PopoverButton
+ as='li'
+ key={item.sort}
+ onClick={() => setActiveSort(item.sort)}
+ className={cx(
+ 'block cursor-pointer rounded-md px-4 py-2 text-sm text-gray-700 hover:bg-gray-200 dark:text-gray-50 dark:hover:bg-slate-700',
+ {
+ 'cursor-wait': isLoading,
+ },
+ )}
+ >
+ {item.label}
+ </PopoverButton>
+ ))}
+ </ul>
+ </div>
+ </PopoverPanel>
+ </Transition>
+ </>
+ )}
+ </Popover>
+ )
+}
diff --git a/web/public/locales/en.json b/web/public/locales/en.json
index b9b366be7..1afbfa3c5 100644
--- a/web/public/locales/en.json
+++ b/web/public/locales/en.json
@@ -690,6 +690,13 @@
"dashboard": {
"gridView": "Grid view",
"listView": "List view",
+ "sortAlphaAsc": "A to Z",
+ "sortAlphaDesc": "Z to A",
+ "sortDateAsc": "Oldest first",
+ "sortDateDesc": "Newest first",
+ "pageviewsDesc": "Most pageviews",
+ "pageviewsAsc": "Least pageviews",
+ "lastVisitDesc": "Recently visited first",
"uptime": "Uptime",
"captcha": "CAPTCHA",
"newProject": "New project",