[WEB-2380] chore: cycle sidebar refactor #5759
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,69 @@ | ||||||
| "use client"; | ||||||
| import { FC, Fragment } from "react"; | ||||||
| import { observer } from "mobx-react"; | ||||||
| // plane ui | ||||||
| import { Loader } from "@plane/ui"; | ||||||
| // components | ||||||
| import ProgressChart from "@/components/core/sidebar/progress-chart"; | ||||||
| import { validateCycleSnapshot } from "@/components/cycles"; | ||||||
| // helpers | ||||||
| import { getDate } from "@/helpers/date-time.helper"; | ||||||
| // hooks | ||||||
| import { useCycle } from "@/hooks/store"; | ||||||
|
|
||||||
| type ProgressChartProps = { | ||||||
| workspaceSlug: string; | ||||||
| projectId: string; | ||||||
| cycleId: string; | ||||||
| }; | ||||||
| export const SidebarChart: FC<ProgressChartProps> = observer((props) => { | ||||||
| const { workspaceSlug, projectId, cycleId } = props; | ||||||
|
|
||||||
| // hooks | ||||||
| const { getEstimateTypeByCycleId, getCycleById } = useCycle(); | ||||||
|
|
||||||
| // derived data | ||||||
| const cycleDetails = validateCycleSnapshot(getCycleById(cycleId)); | ||||||
| const cycleStartDate = getDate(cycleDetails?.start_date); | ||||||
| const cycleEndDate = getDate(cycleDetails?.end_date); | ||||||
| const totalEstimatePoints = cycleDetails?.total_estimate_points || 0; | ||||||
| const totalIssues = cycleDetails?.total_issues || 0; | ||||||
| const estimateType = getEstimateTypeByCycleId(cycleId); | ||||||
|
|
||||||
| const chartDistributionData = | ||||||
| estimateType === "points" ? cycleDetails?.estimate_distribution : cycleDetails?.distribution || undefined; | ||||||
|
|
||||||
| const completionChartDistributionData = chartDistributionData?.completion_chart || undefined; | ||||||
|
There was a problem hiding this comment. 🛠️ Refactor suggestion Remove unnecessary Similarly, the Simplify the code as: - const completionChartDistributionData = chartDistributionData?.completion_chart || undefined;
+ const completionChartDistributionData = chartDistributionData?.completion_chart;📝 Committable suggestion
Suggested change
|
||||||
|
|
||||||
| if (!workspaceSlug || !projectId || !cycleId) return null; | ||||||
|
|
||||||
| return ( | ||||||
| <div> | ||||||
| <div className="relative flex items-center gap-2"> | ||||||
| <div className="flex items-center justify-center gap-1 text-xs"> | ||||||
| <span className="h-2.5 w-2.5 rounded-full bg-[#A9BBD0]" /> | ||||||
| <span>Ideal</span> | ||||||
| </div> | ||||||
| <div className="flex items-center justify-center gap-1 text-xs"> | ||||||
| <span className="h-2.5 w-2.5 rounded-full bg-[#4C8FFF]" /> | ||||||
| <span>Current</span> | ||||||
| </div> | ||||||
| </div> | ||||||
| {cycleStartDate && cycleEndDate && completionChartDistributionData ? ( | ||||||
| <Fragment> | ||||||
| <ProgressChart | ||||||
| distribution={completionChartDistributionData} | ||||||
| startDate={cycleStartDate} | ||||||
| endDate={cycleEndDate} | ||||||
| totalIssues={estimateType === "points" ? totalEstimatePoints : totalIssues} | ||||||
|
There was a problem hiding this comment. 🛠️ Refactor suggestion Consider renaming When Consider renaming the prop to better reflect its purpose, such as - totalIssues={estimateType === "points" ? totalEstimatePoints : totalIssues}
+ totalCount={estimateType === "points" ? totalEstimatePoints : totalIssues}You'll also need to update the
|
||||||
| plotTitle={estimateType === "points" ? "points" : "issues"} | ||||||
| /> | ||||||
| </Fragment> | ||||||
| ) : ( | ||||||
| <Loader className="w-full h-[160px] mt-4"> | ||||||
| <Loader.Item width="100%" height="100%" /> | ||||||
| </Loader> | ||||||
| )} | ||||||
|
Comment on lines
+52
to
+66
There was a problem hiding this comment. Enhance error handling for missing data If Consider adding error handling to inform the user if data cannot be loaded: {cycleStartDate && cycleEndDate && completionChartDistributionData ? (
// existing code
) : hasError ? (
<div className="text-center text-sm text-red-500">Failed to load data.</div>
) : (
<Loader className="w-full h-[160px] mt-4">
<Loader.Item width="100%" height="100%" />
</Loader>
)}You'll need to implement |
||||||
| </div> | ||||||
| ); | ||||||
| }); | ||||||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| export * from "./root"; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| "use client"; | ||
| import React, { FC } from "react"; | ||
| // components | ||
| import { SidebarChart } from "./base"; | ||
|
|
||
| type Props = { | ||
| workspaceSlug: string; | ||
| projectId: string; | ||
| cycleId: string; | ||
| }; | ||
|
|
||
| export const SidebarChartRoot: FC<Props> = (props) => <SidebarChart {...props} />; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🛠️ Refactor suggestion
Simplify 'chartDistributionData' assignment
The use of
|| undefinedis redundant sincecycleDetails?.distributionwill returnundefinedif it doesn't exist.Consider simplifying the code as follows:
📝 Committable suggestion