mirror of
https://github.com/makeplane/plane
synced 2024-06-14 14:31:34 +00:00
d575e8ec6b
* style: new custom analytics ui * fix: x-axis assignee tick values * chore: assignee names in the custom analytics table
289 lines
12 KiB
TypeScript
289 lines
12 KiB
TypeScript
import { useRouter } from "next/router";
|
|
|
|
import useSWR, { mutate } from "swr";
|
|
|
|
// services
|
|
import analyticsService from "services/analytics.service";
|
|
import projectService from "services/project.service";
|
|
import cyclesService from "services/cycles.service";
|
|
import modulesService from "services/modules.service";
|
|
// hooks
|
|
import useProjects from "hooks/use-projects";
|
|
import useToast from "hooks/use-toast";
|
|
// ui
|
|
import { PrimaryButton, SecondaryButton } from "components/ui";
|
|
// icons
|
|
import { ArrowDownTrayIcon, ArrowPathIcon, UserGroupIcon } from "@heroicons/react/24/outline";
|
|
import { ContrastIcon, LayerDiagonalIcon } from "components/icons";
|
|
// helpers
|
|
import { renderShortDate } from "helpers/date-time.helper";
|
|
// types
|
|
import { IAnalyticsParams, IAnalyticsResponse, IExportAnalyticsFormData, IProject } from "types";
|
|
// fetch-keys
|
|
import { ANALYTICS, CYCLE_DETAILS, MODULE_DETAILS, PROJECT_DETAILS } from "constants/fetch-keys";
|
|
// constants
|
|
import { NETWORK_CHOICES } from "constants/project";
|
|
|
|
type Props = {
|
|
analytics: IAnalyticsResponse | undefined;
|
|
params: IAnalyticsParams;
|
|
fullScreen: boolean;
|
|
isProjectLevel: boolean;
|
|
};
|
|
|
|
export const AnalyticsSidebar: React.FC<Props> = ({
|
|
analytics,
|
|
params,
|
|
fullScreen,
|
|
isProjectLevel = false,
|
|
}) => {
|
|
const router = useRouter();
|
|
const { workspaceSlug, projectId, cycleId, moduleId } = router.query;
|
|
|
|
const { projects } = useProjects();
|
|
|
|
const { setToastAlert } = useToast();
|
|
|
|
const { data: projectDetails } = useSWR(
|
|
workspaceSlug && projectId && !(cycleId || moduleId)
|
|
? PROJECT_DETAILS(projectId.toString())
|
|
: null,
|
|
workspaceSlug && projectId && !(cycleId || moduleId)
|
|
? () => projectService.getProject(workspaceSlug.toString(), projectId.toString())
|
|
: null
|
|
);
|
|
|
|
const { data: cycleDetails } = useSWR(
|
|
workspaceSlug && projectId && cycleId ? CYCLE_DETAILS(cycleId.toString()) : null,
|
|
workspaceSlug && projectId && cycleId
|
|
? () =>
|
|
cyclesService.getCycleDetails(
|
|
workspaceSlug.toString(),
|
|
projectId.toString(),
|
|
cycleId.toString()
|
|
)
|
|
: null
|
|
);
|
|
|
|
const { data: moduleDetails } = useSWR(
|
|
workspaceSlug && projectId && moduleId ? MODULE_DETAILS(moduleId.toString()) : null,
|
|
workspaceSlug && projectId && moduleId
|
|
? () =>
|
|
modulesService.getModuleDetails(
|
|
workspaceSlug.toString(),
|
|
projectId.toString(),
|
|
moduleId.toString()
|
|
)
|
|
: null
|
|
);
|
|
|
|
const exportAnalytics = () => {
|
|
if (!workspaceSlug) return;
|
|
|
|
const data: IExportAnalyticsFormData = {
|
|
x_axis: params.x_axis,
|
|
y_axis: params.y_axis,
|
|
};
|
|
|
|
if (params.segment) data.segment = params.segment;
|
|
if (params.project) data.project = params.project;
|
|
|
|
analyticsService
|
|
.exportAnalytics(workspaceSlug.toString(), data)
|
|
.then((res) =>
|
|
setToastAlert({
|
|
type: "success",
|
|
title: "Success!",
|
|
message: res.message,
|
|
})
|
|
)
|
|
.catch(() =>
|
|
setToastAlert({
|
|
type: "error",
|
|
title: "Error!",
|
|
message: "There was some error in exporting the analytics. Please try again.",
|
|
})
|
|
);
|
|
};
|
|
|
|
return (
|
|
<div
|
|
className={`p-5 pb-0 flex flex-col space-y-2 ${
|
|
fullScreen
|
|
? "pb-5 border-l border-brand-base md:h-full md:pb-5 md:border-l md:border-brand-base md:space-y-4 overflow-hidden"
|
|
: ""
|
|
}`}
|
|
>
|
|
<div className="flex items-center gap-2 flex-wrap">
|
|
<div className="flex items-center gap-1 bg-brand-surface-2 rounded-md px-3 py-1 text-brand-secondary text-xs">
|
|
<LayerDiagonalIcon height={14} width={14} />
|
|
{analytics ? analytics.total : "..."} Issues
|
|
</div>
|
|
</div>
|
|
<div className="h-full overflow-hidden">
|
|
{fullScreen ? (
|
|
<>
|
|
{!isProjectLevel && params.project && params.project.length > 0 && (
|
|
<div className="hidden h-full overflow-hidden md:flex md:flex-col">
|
|
<h4 className="font-medium">Selected Projects</h4>
|
|
<div className="space-y-6 mt-4 h-full overflow-y-auto">
|
|
{params.project.map((projectId) => {
|
|
const project: IProject = projects.find((p) => p.id === projectId);
|
|
|
|
return (
|
|
<div key={project.id}>
|
|
<h5 className="text-sm flex items-center gap-1">
|
|
{project.icon ? (
|
|
<span className="grid h-6 w-6 flex-shrink-0 place-items-center">
|
|
{String.fromCodePoint(parseInt(project.icon))}
|
|
</span>
|
|
) : (
|
|
<span className="grid h-8 w-8 flex-shrink-0 place-items-center rounded bg-gray-700 uppercase text-white">
|
|
{project?.name.charAt(0)}
|
|
</span>
|
|
)}
|
|
<span className="break-all">{project.name}</span>
|
|
</h5>
|
|
<div className="mt-4 space-y-3 pl-2">
|
|
<div className="flex items-center justify-between gap-2 text-xs">
|
|
<div className="flex items-center gap-2">
|
|
<UserGroupIcon className="h-4 w-4 text-brand-secondary" />
|
|
<h6>Total members</h6>
|
|
</div>
|
|
<span className="text-brand-secondary">{project.total_members}</span>
|
|
</div>
|
|
<div className="flex items-center justify-between gap-2 text-xs">
|
|
<div className="flex items-center gap-2">
|
|
<ContrastIcon height={16} width={16} />
|
|
<h6>Total cycles</h6>
|
|
</div>
|
|
<span className="text-brand-secondary">{project.total_cycles}</span>
|
|
</div>
|
|
<div className="flex items-center justify-between gap-2 text-xs">
|
|
<div className="flex items-center gap-2">
|
|
<UserGroupIcon className="h-4 w-4 text-brand-secondary" />
|
|
<h6>Total modules</h6>
|
|
</div>
|
|
<span className="text-brand-secondary">{project.total_modules}</span>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
);
|
|
})}
|
|
</div>
|
|
</div>
|
|
)}
|
|
{projectId ? (
|
|
cycleId && cycleDetails ? (
|
|
<div className="hidden md:block h-full overflow-y-auto">
|
|
<h4 className="font-medium break-all">Analytics for {cycleDetails.name}</h4>
|
|
<div className="space-y-4 mt-4">
|
|
<div className="flex items-center gap-2 text-xs">
|
|
<h6 className="text-brand-secondary">Lead</h6>
|
|
<span>
|
|
{cycleDetails.owned_by?.first_name} {cycleDetails.owned_by?.last_name}
|
|
</span>
|
|
</div>
|
|
<div className="flex items-center gap-2 text-xs">
|
|
<h6 className="text-brand-secondary">Start Date</h6>
|
|
<span>
|
|
{cycleDetails.start_date && cycleDetails.start_date !== ""
|
|
? renderShortDate(cycleDetails.start_date)
|
|
: "No start date"}
|
|
</span>
|
|
</div>
|
|
<div className="flex items-center gap-2 text-xs">
|
|
<h6 className="text-brand-secondary">Target Date</h6>
|
|
<span>
|
|
{cycleDetails.end_date && cycleDetails.end_date !== ""
|
|
? renderShortDate(cycleDetails.end_date)
|
|
: "No end date"}
|
|
</span>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
) : moduleId && moduleDetails ? (
|
|
<div className="hidden md:block h-full overflow-y-auto">
|
|
<h4 className="font-medium break-all">Analytics for {moduleDetails.name}</h4>
|
|
<div className="space-y-4 mt-4">
|
|
<div className="flex items-center gap-2 text-xs">
|
|
<h6 className="text-brand-secondary">Lead</h6>
|
|
<span>
|
|
{moduleDetails.lead_detail?.first_name}{" "}
|
|
{moduleDetails.lead_detail?.last_name}
|
|
</span>
|
|
</div>
|
|
<div className="flex items-center gap-2 text-xs">
|
|
<h6 className="text-brand-secondary">Start Date</h6>
|
|
<span>
|
|
{moduleDetails.start_date && moduleDetails.start_date !== ""
|
|
? renderShortDate(moduleDetails.start_date)
|
|
: "No start date"}
|
|
</span>
|
|
</div>
|
|
<div className="flex items-center gap-2 text-xs">
|
|
<h6 className="text-brand-secondary">Target Date</h6>
|
|
<span>
|
|
{moduleDetails.target_date && moduleDetails.target_date !== ""
|
|
? renderShortDate(moduleDetails.target_date)
|
|
: "No end date"}
|
|
</span>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
) : (
|
|
<div className="hidden md:flex md:flex-col h-full overflow-y-auto">
|
|
<div className="flex items-center gap-1">
|
|
{projectDetails?.icon ? (
|
|
<span className="grid h-6 w-6 flex-shrink-0 place-items-center">
|
|
{String.fromCodePoint(parseInt(projectDetails.icon))}
|
|
</span>
|
|
) : (
|
|
<span className="grid h-8 w-8 flex-shrink-0 place-items-center rounded bg-gray-700 uppercase text-white">
|
|
{projectDetails?.name.charAt(0)}
|
|
</span>
|
|
)}
|
|
<h4 className="font-medium break-all">{projectDetails?.name}</h4>
|
|
</div>
|
|
<div className="space-y-4 mt-4">
|
|
<div className="flex items-center gap-2 text-xs">
|
|
<h6 className="text-brand-secondary">Network</h6>
|
|
<span>
|
|
{
|
|
NETWORK_CHOICES[
|
|
`${projectDetails?.network}` as keyof typeof NETWORK_CHOICES
|
|
]
|
|
}
|
|
</span>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
)
|
|
) : null}
|
|
</>
|
|
) : null}
|
|
</div>
|
|
<div className="flex items-center gap-2 flex-wrap justify-self-end">
|
|
<SecondaryButton
|
|
onClick={() => {
|
|
if (!workspaceSlug) return;
|
|
|
|
mutate(ANALYTICS(workspaceSlug.toString(), params));
|
|
}}
|
|
>
|
|
<div className="flex items-center gap-2 -my-1">
|
|
<ArrowPathIcon className="h-3.5 w-3.5" />
|
|
Refresh
|
|
</div>
|
|
</SecondaryButton>
|
|
<PrimaryButton onClick={exportAnalytics}>
|
|
<div className="flex items-center gap-2 -my-1">
|
|
<ArrowDownTrayIcon className="h-3.5 w-3.5" />
|
|
Export as CSV
|
|
</div>
|
|
</PrimaryButton>
|
|
</div>
|
|
</div>
|
|
);
|
|
};
|