Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhanced Resource Page #9768

Open
wants to merge 13 commits into
base: develop
Choose a base branch
from

Conversation

manmeetnagii
Copy link
Contributor

@manmeetnagii manmeetnagii commented Jan 5, 2025

Proposed Changes

@ohcnetwork/care-fe-code-reviewers

Summary by CodeRabbit

Release Notes

  • New Features

    • Added a new resource management page with Kanban board and list view
    • Introduced ability to toggle between board and list views for resources
    • Added export functionality for resource requests
  • Localization

    • Added new localization option for status selection
  • UI/UX Changes

    • Simplified resource routing
    • Enhanced resource management interface with drag-and-drop capabilities
  • Removed Components

    • Deprecated previous Kanban board and list view components for resources

@manmeetnagii manmeetnagii requested a review from a team as a code owner January 5, 2025 17:58
Copy link
Contributor

coderabbitai bot commented Jan 5, 2025

Walkthrough

This pull request introduces a comprehensive redesign of the resource management interface. The changes include removing the separate BoardView and ListView components and replacing them with a unified ResourcePage component. A new localization key for status selection has been added, and the routing for resources has been simplified. The new implementation provides a more integrated and flexible approach to managing resources with drag-and-drop functionality and view switching capabilities.

Changes

File Change Summary
public/locale/en.json Added new localization key "select_status": "Select Status"
src/Routers/routes/ResourceRoutes.tsx Removed Redirect, BoardView, and ListView imports; Added ResourcePage import; Simplified routing
src/components/Kanban/Board.tsx Completely removed KanbanBoard and KanbanSection components
src/components/Resource/ResourceBoard.tsx Deleted entire file containing BoardView component
src/components/Resource/ResourceList.tsx Deleted entire file containing ListView component
src/components/Resource/ResourcePage.tsx Added new comprehensive ResourcePage component

Assessment against linked issues

Objective Addressed Explanation
Consistent Board/List switch button [#9677] Unable to definitively confirm UI consistency without visual review

Possibly related PRs

Suggested Labels

needs review, tested

Suggested Reviewers

  • rithviknishad
  • Jacobjeevan

Poem

🐰 Hop, hop, through code's terrain,
Resources dance, no longer plain!
Board and list now intertwine,
With drag and drop, they now align.
A rabbit's view of progress bright! 🚀


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

netlify bot commented Jan 5, 2025

Deploy Preview for care-ohc ready!

Name Link
🔨 Latest commit 50d2528
🔍 Latest deploy log https://app.netlify.com/sites/care-ohc/deploys/67817974e862350008416569
😎 Deploy Preview https://deploy-preview-9768--care-ohc.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@manmeetnagii
Copy link
Contributor Author

@rithviknishad review this one

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (4)
src/components/Kanban/Board.tsx (1)

38-39: Removed horizontal scrolling buttons and simplified layout.

The new two-tier container approach (outer

+ flex boxes) is neat. Ensure no accessibility regression for users who relied on the previous scroll control.

src/components/Resource/ResourceCardList.tsx (1)

26-85: Card layout effectively conveys resource info.

Using a grid and separate display for title, status, and emergency badge is clear, providing a well-organized view. Ensure each field is accessible with descriptive ARIA labels if needed.

src/components/Resource/ResourcePage.tsx (1)

94-126: Consider removing redundant fragments.

A fragment wrapping a single child is flagged by the linter. You can safely remove it to reduce JSX verbosity.

- <>
   <div className="flex lg:flex-row flex-col w-full justify-end gap-2">
- </>
🧰 Tools
🪛 Biome (1.9.4)

[error] 94-126: Avoid using unnecessary Fragment.

A fragment is redundant if it contains only one child, or if it is the child of a html element, and is not a keyed fragment.
Unsafe fix: Remove the Fragment

(lint/complexity/noUselessFragments)

public/locale/en.json (1)

1616-1616: LGTM! Consider adding a placeholder variant.

The new translation key follows the naming convention and is properly placed. For consistency with other selection fields in the application, consider adding a placeholder variant:

 "select_status": "Select Status",
+"select_status_placeholder": "Select a status",
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c34bf37 and 66126a4.

📒 Files selected for processing (7)
  • public/locale/en.json (1 hunks)
  • src/Routers/routes/ResourceRoutes.tsx (1 hunks)
  • src/components/Kanban/Board.tsx (3 hunks)
  • src/components/Resource/ResourceBoard.tsx (0 hunks)
  • src/components/Resource/ResourceCardList.tsx (1 hunks)
  • src/components/Resource/ResourceList.tsx (0 hunks)
  • src/components/Resource/ResourcePage.tsx (1 hunks)
💤 Files with no reviewable changes (2)
  • src/components/Resource/ResourceList.tsx
  • src/components/Resource/ResourceBoard.tsx
🧰 Additional context used
🪛 Biome (1.9.4)
src/components/Resource/ResourcePage.tsx

[error] 94-126: Avoid using unnecessary Fragment.

A fragment is redundant if it contains only one child, or if it is the child of a html element, and is not a keyed fragment.
Unsafe fix: Remove the Fragment

(lint/complexity/noUselessFragments)

🔇 Additional comments (16)
src/Routers/routes/ResourceRoutes.tsx (2)

3-3: Successfully imported the new ResourcePage component.

The import statement is clear and aligns with the consolidated view approach.


8-8: Route consolidation looks good.

Replacing the old BoardView/ListView routes with ResourcePage is consistent with the PR objective of unifying the resource views.

src/components/Kanban/Board.tsx (2)

137-137: Height change from calc(100vh-200px) to calc(100vh-340px).

Increasing the offset reduces visible space, which might cause more scrolling. Verify on smaller devices to ensure no usability issues.


169-169: Placeholder usage in Droppable context.

Including provided.placeholder ensures proper rendering of dragged items. This is currently a best practice for React DnD.

src/components/Resource/ResourceCardList.tsx (5)

1-3: Imports are well-structured.

Imports for Link and useTranslation are minimal and aligned with usage below.


11-13: Interface definition is clear.

ResourceCardListProps is concise, making the component’s expected data structure explicit.


18-24: Graceful handling of empty data.

Rendering "no_results_found" message improves user feedback when there are no resources.


131-135: “View all details” link for each resource.

This link offers a direct route to resource details, improving discoverability.


142-142: Export statement confirmed.

Exporting ResourceCardList as default matches the new consolidated design approach.

src/components/Resource/ResourcePage.tsx (7)

42-45: Lazy loading the KanbanBoard component.

This reduces initial bundle size and is a strong performance optimization for routes that may not require the board immediately.


51-67: ResourcePage initialization logic.

Storing filter states (boardFilter, viewMode) is straightforward. The fallback to default active statuses plus an option for completed items is well-structured.


68-77: Fetch logic using useTanStackQueryInstead.

Looks correct. The query configuration matches the advanced filter structure. Confirm that all relevant data fields are included in the final payload for the Resource list.


79-84: Export function for CSV.

Nice use of request with csv: true. This helps quickly integrate a CSV export feature.


129-227: Board view integration.

The board filter and drag-and-drop updates to resource status align well with the consolidated view. Watch out for edge cases when switching between active and completed boards.


228-297: List view integration with advanced filters.

Combining the ResourceCardList, refresh actions, and pagination is well-organized. The consistent approach to filtering across both views helps unify UX.


302-302: Exporting ResourcePage.

This final export aligns with the route changes in ResourceRoutes.tsx, ensuring navigational consistency.

@rithviknishad
Copy link
Member

rithviknishad commented Jan 5, 2025

  1. Solve conflicts in old PR itself instead of reopening new PRs. Use it as an opportunity to learn git.

  2. Changes requested in previous PR are not done here.

@manmeetnagii
Copy link
Contributor Author

  1. Solve conflicts in old PR itself instead of reopening new PRs. Use it as an opportunity to learn git.
  2. Changes requested in previous PR are not done here.

I am unable to reopen that PR as I've reforked the repo 😅

@rithviknishad
Copy link
Member

solve the changes requested in previous PR here atleast then?

@rithviknishad rithviknishad reopened this Jan 5, 2025
@manmeetnagii
Copy link
Contributor Author

solve the changes requested in previous PR here atleast then?

I think I've done that🤔Let me list the changes.

  1. Deletion of ''/resource/board'' and ''/resource/list' routes and components' files related to them. ✅
  2. Removal of ''log updates" ✅
  3. Created a separate component for ResourceCardList ✅
  4. Deletion of https://github.com/ohcnetwork/care_fe/blob/develop/src/components/Kanban/Board.tsx. file. This file is used in ResourcePage.tsx component that's why I didn't delete it.

@github-actions github-actions bot added needs-triage question Further information is requested labels Jan 5, 2025
@rithviknishad
Copy link
Member

let's keep the implementation idential to the one in appointments, and delete that kanban board

@manmeetnagii
Copy link
Contributor Author

let's keep the implementation idential to the one in appointments, and delete that kanban board

got it

@Jacobjeevan Jacobjeevan added changes required and removed question Further information is requested needs-triage labels Jan 5, 2025
@manmeetnagii
Copy link
Contributor Author

manmeetnagii commented Jan 6, 2025

let's keep the implementation idential to the one in appointments, and delete that kanban board

@rithviknishad Do we need DragDropContext in resource page board view?

@github-actions github-actions bot added needs-triage question Further information is requested labels Jan 6, 2025
@manmeetnagii
Copy link
Contributor Author

@rithviknishad , I’ve tried implementing this in the same way as the AppointmentPage. Is this correct?

const appliedFilters = formatFilter(qParams);
const [viewMode, setViewMode] = useState<"board" | "list">("board");
const { exportFile } = useExport();
const { loading, data, refetch } = useTanStackQueryInstead(
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Switch to using useQuery + query here.

Do the same for other API calls in this component 👍

});
return data as QueryResponse<T>;
} catch (error) {
console.error("Error fetching section data:", error);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove the console log

const options = section.fetchOptions(section.id);
const fetchPage = async ({ pageParam = 0 }) => {
try {
const data = await callApi(options.route, {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

useQuery instead of callApi.

const [boardFilter, setBoardFilter] = useState(ACTIVE);
// eslint-disable-next-line
const appliedFilters = formatFilter(qParams);
const [viewMode, setViewMode] = useState<"board" | "list">("board");
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You should add the logic for storing in localStorage for viewMode, right now it resets on every page load.

We can create a hook to handle that in a different issue, since we will have multiple components having a similar view.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Jacobjeevan for now I've use useEffect, should I create a new issue for the hook itself? 🤔

@Jacobjeevan Jacobjeevan removed question Further information is requested needs-triage labels Jan 10, 2025
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

🧹 Nitpick comments (2)
src/components/Resource/ResourcePage.tsx (2)

300-325: Optimize performance with React.memo.

Consider memoizing the ResourceColumn component to prevent unnecessary re-renders when parent components update.

-function ResourceColumn<T extends { id: string }>(
+const ResourceColumn = React.memo(<T extends { id: string }>(
   props: ResourceColumnProps<T>,
 ) {
   const board = useRef<HTMLDivElement>(null);
   return (
     // ... component implementation
   );
-}
+});

480-593: Improve type safety and styling maintainability.

Consider the following improvements:

  1. Use proper type checking for the resource parameter
  2. Extract repeated CSS classes into reusable Tailwind components
-  return data.map((resource: ResourceRequest, i) => (
+  return data.map((resource, i) => (
     <div
       key={i}
-      className="w-full border border-b-2 border-gray-200  col-span-6"
+      className={clsx(
+        "w-full border border-b-2 border-gray-200 col-span-6",
+        "resource-row"
+      )}
     >

Consider creating a CSS module or Tailwind components for commonly used class combinations to improve maintainability.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 66126a4 and 50d2528.

📒 Files selected for processing (3)
  • public/locale/en.json (1 hunks)
  • src/components/Kanban/Board.tsx (0 hunks)
  • src/components/Resource/ResourcePage.tsx (1 hunks)
💤 Files with no reviewable changes (1)
  • src/components/Kanban/Board.tsx
🚧 Files skipped from review as they are similar to previous changes (1)
  • public/locale/en.json

Comment on lines +148 to +163
<Select
defaultValue="active"
onValueChange={(value) =>
setBoardFilter(value === "completed" ? COMPLETED : ACTIVE)
}
>
<SelectTrigger className="w-full lg:w-[180px]">
<SelectValue defaultValue={"completed"} />
</SelectTrigger>
<SelectContent>
<SelectGroup>
<SelectItem value="active">{t("active")}</SelectItem>
<SelectItem value="completed">{t("completed")}</SelectItem>
</SelectGroup>
</SelectContent>
</Select>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Fix inconsistent default values in Select component.

The defaultValue prop in SelectTrigger and the defaultValue in SelectValue are inconsistent. The SelectTrigger uses "active" while SelectValue uses "completed".

 <Select
   defaultValue="active"
   onValueChange={(value) =>
     setBoardFilter(value === "completed" ? COMPLETED : ACTIVE)
   }
 >
   <SelectTrigger className="w-full lg:w-[180px]">
-    <SelectValue defaultValue={"completed"} />
+    <SelectValue defaultValue={"active"} />
   </SelectTrigger>
   <SelectContent>
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
<Select
defaultValue="active"
onValueChange={(value) =>
setBoardFilter(value === "completed" ? COMPLETED : ACTIVE)
}
>
<SelectTrigger className="w-full lg:w-[180px]">
<SelectValue defaultValue={"completed"} />
</SelectTrigger>
<SelectContent>
<SelectGroup>
<SelectItem value="active">{t("active")}</SelectItem>
<SelectItem value="completed">{t("completed")}</SelectItem>
</SelectGroup>
</SelectContent>
</Select>
<Select
defaultValue="active"
onValueChange={(value) =>
setBoardFilter(value === "completed" ? COMPLETED : ACTIVE)
}
>
<SelectTrigger className="w-full lg:w-[180px]">
<SelectValue defaultValue={"active"} />
</SelectTrigger>
<SelectContent>
<SelectGroup>
<SelectItem value="active">{t("active")}</SelectItem>
<SelectItem value="completed">{t("completed")}</SelectItem>
</SelectGroup>
</SelectContent>
</Select>

Comment on lines +344 to +357
const fetchPage = async ({ pageParam = 0 }) => {
try {
const data = await query(options.route, {
queryParams: {
...options.options?.query,
offset: pageParam,
limit: defaultLimit,
},
})({ signal: new AbortController().signal });
return data as QueryResponse<T>;
} catch (error) {
return { results: [], next: null, count: 0 };
}
};
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Improve error handling and request cancellation.

The current implementation has two issues:

  1. The AbortController is created but never stored or used effectively
  2. The error handling silently fails without providing useful information
 const fetchPage = async ({ pageParam = 0 }) => {
+  const controller = new AbortController();
   try {
     const data = await query(options.route, {
       queryParams: {
         ...options.options?.query,
         offset: pageParam,
         limit: defaultLimit,
       },
-    })({ signal: new AbortController().signal });
+    })({ signal: controller.signal });
     return data as QueryResponse<T>;
   } catch (error) {
+    if (error instanceof Error) {
+      console.error(`Failed to fetch page: ${error.message}`);
+    }
     return { results: [], next: null, count: 0 };
   }
 };
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
const fetchPage = async ({ pageParam = 0 }) => {
try {
const data = await query(options.route, {
queryParams: {
...options.options?.query,
offset: pageParam,
limit: defaultLimit,
},
})({ signal: new AbortController().signal });
return data as QueryResponse<T>;
} catch (error) {
return { results: [], next: null, count: 0 };
}
};
const fetchPage = async ({ pageParam = 0 }) => {
const controller = new AbortController();
try {
const data = await query(options.route, {
queryParams: {
...options.options?.query,
offset: pageParam,
limit: defaultLimit,
},
})({ signal: controller.signal });
return data as QueryResponse<T>;
} catch (error) {
if (error instanceof Error) {
console.error(`Failed to fetch page: ${error.message}`);
}
return { results: [], next: null, count: 0 };
}
};

Comment on lines +91 to +96
const exportAction = async () => {
const { data } = await request(routes.downloadResourceRequests, {
query: { ...appliedFilters, csv: true },
});
return data ?? null;
};
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Add error handling to exportAction function.

The function should handle potential network errors and invalid responses explicitly.

 const exportAction = async () => {
+  try {
     const { data } = await request(routes.downloadResourceRequests, {
       query: { ...appliedFilters, csv: true },
     });
     return data ?? null;
+  } catch (error) {
+    console.error('Failed to export resource requests:', error);
+    throw new Error(t('failed_to_export'));
+  }
 };
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
const exportAction = async () => {
const { data } = await request(routes.downloadResourceRequests, {
query: { ...appliedFilters, csv: true },
});
return data ?? null;
};
const exportAction = async () => {
try {
const { data } = await request(routes.downloadResourceRequests, {
query: { ...appliedFilters, csv: true },
});
return data ?? null;
} catch (error) {
console.error('Failed to export resource requests:', error);
throw new Error(t('failed_to_export'));
}
};

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Enhancement: Consistent design of Board/List switch button in Resources and Appointment pages
3 participants