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

[Feat]: Added Bulk Deletion Functionality For Time Entries #3402

Merged
merged 2 commits into from
Dec 8, 2024

Conversation

Innocent-Akim
Copy link
Contributor

@Innocent-Akim Innocent-Akim commented Dec 6, 2024

Description

#3221
Please include a summary of the changes and the related issue.

Type of Change

  • Bug fix
  • New feature
  • Breaking change
  • Documentation update

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings

Previous screenshots

Please add here videos or images of previous status

Current screenshots

Please add here videos or images of previous status

Summary by CodeRabbit

Release Notes

  • New Features

    • Introduced an AlertConfirmationModal for enhanced confirmation actions.
    • Improved validation for start and end times in the EditTaskModal.
    • Enhanced state management for selected timesheets in the DataTableTimeSheet.
  • Bug Fixes

    • Updated logic to ensure proper handling of timesheet deletions and confirmations.
  • Improvements

    • Adjusted modal styling for better responsiveness.
    • Streamlined timesheet log handling and state management for clarity.

Copy link
Contributor

coderabbitai bot commented Dec 6, 2024

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 eslint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

apps/web/app/hooks/features/useTimelogFilterOptions.ts

Oops! Something went wrong! :(

ESLint: 8.46.0

ESLint couldn't find the config "next/core-web-vitals" to extend from. Please check that the name of the config is correct.

The config "next/core-web-vitals" was referenced from the config file in "/apps/web/.eslintrc.json".

If you still have problems, please stop by https://eslint.org/chat/help to chat with the team.

Walkthrough

This pull request introduces several modifications across multiple components, primarily focusing on enhancing the EditTaskModal with improved validation for time inputs and responsive styling adjustments. The useTimesheet hook has been simplified, particularly in how it manages timesheet logs and handles deletions. A new AlertConfirmationModal component has been added to improve user interactions for confirmation actions. Additionally, the DataTableTimeSheet component has been updated to accommodate these changes, including state management for selected timesheets.

Changes

File Path Change Summary
apps/web/app/[locale]/timesheet/[memberId]/components/EditTaskModal.tsx Updated modal width and added validation for start/end times in handleUpdateSubmit. Modified handleSelectedValuesChange to update projectId.
apps/web/app/hooks/features/useTimesheet.ts Simplified destructuring in useTimelogFilterOptions, updated deleteTaskTimesheet function signature, and refined filtering logic.
apps/web/lib/components/alert-dialog-confirmation.tsx Introduced AlertConfirmationModal for enhanced confirmation actions, retaining existing component functionality.
apps/web/lib/features/integrations/calendar/table-time-sheet.tsx Renamed AlertDialogConfirmation to AlertConfirmationModal, updated state management for selected timesheets, and modified confirmation handling.
apps/web/app/hooks/features/useTimelogFilterOptions.ts Added selectTimesheetId state variable, updated handleSelectRowTimesheet, and modified return object to include new state.

Possibly related issues

Possibly related PRs

Suggested labels

feature, Bug fix

Suggested reviewers

  • evereq

Poem

🐰 In the modal's cozy light,
Timesheet tasks now feel just right.
With validations set to play,
Deletions smooth, come what may.
A hop, a click, all's in line,
Managing time, oh how divine! 🌟


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 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.

@Innocent-Akim Innocent-Akim changed the title [Feat]: added bulk deletion functionality for time entries [Feat]: Added bulk deletion functionality for time entries Dec 6, 2024
@Innocent-Akim Innocent-Akim changed the title [Feat]: Added bulk deletion functionality for time entries [Feat]: Added Bulk Deletion Functionality For Time Entries Dec 6, 2024
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: 6

🧹 Outside diff range and nitpick comments (2)
apps/web/lib/features/integrations/calendar/table-time-sheet.tsx (2)

160-163: Consider using more descriptive variable names for modals

Using generic names like modal and alertConfirmationModal with overlapping property names (isOpen, openModal, etc.) can lead to confusion and potential mistakes. Consider renaming these variables and their destructured properties to more descriptive names to improve code readability and maintainability.

Suggested changes:

- const modal = useModal();
- const alertConfirmationModal = useModal();
- const { isOpen, openModal, closeModal } = modal;
- const { isOpen: isOpenAlert, openModal: openAlertConfirmation, closeModal: closeAlertConfirmation } = alertConfirmationModal;
+ const rejectionModal = useModal();
+ const deletionModal = useModal();
+ const { isOpen: isRejectionOpen, openModal: openRejectionModal, closeModal: closeRejectionModal } = rejectionModal;
+ const { isOpen: isDeletionOpen, openModal: openDeletionModal, closeModal: closeDeletionModal } = deletionModal;

170-172: Rename parameter 'items' to 'timesheetId' for clarity

In the handleSelectRowTimesheet function, the parameter items represents a single timesheet ID. Renaming it to timesheetId would enhance readability and make the code's intent clearer.

Suggested changes:

- const handleSelectRowTimesheet = (items: string) => {
-   setSelectTimesheetId((prev) => prev.includes(items) ? prev.filter((filter) => filter !== items) : [...prev, items])
+ const handleSelectRowTimesheet = (timesheetId: string) => {
+   setSelectTimesheetId((prev) =>
+     prev.includes(timesheetId)
+       ? prev.filter((id) => id !== timesheetId)
+       : [...prev, timesheetId]
+   )
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 88fc30c and af592c3.

📒 Files selected for processing (4)
  • apps/web/app/[locale]/timesheet/[memberId]/components/EditTaskModal.tsx (1 hunks)
  • apps/web/app/hooks/features/useTimesheet.ts (3 hunks)
  • apps/web/lib/components/alert-dialog-confirmation.tsx (2 hunks)
  • apps/web/lib/features/integrations/calendar/table-time-sheet.tsx (10 hunks)
🔇 Additional comments (1)
apps/web/lib/features/integrations/calendar/table-time-sheet.tsx (1)

493-495: Ensure 'Undo' action properly restores deleted timesheet

The 'Undo' action in the toast suggests that the timesheet can be restored, but it's unclear if this functionality is implemented. If the 'Undo' feature is not available, consider removing the action to prevent user confusion.

Please confirm whether the 'Undo' action in the toast notification restores the deleted timesheet. If not implemented, remove the ToastAction to avoid misleading users.

Also applies to: 498-500

@Innocent-Akim Innocent-Akim self-assigned this Dec 6, 2024
@Innocent-Akim Innocent-Akim added the Don't Merge Do not merge this PR until label not removed label Dec 6, 2024
@Innocent-Akim Innocent-Akim marked this pull request as draft December 6, 2024 05:28
@Innocent-Akim Innocent-Akim added bug Something isn't working WEB Web app Ever Teams labels Dec 6, 2024
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

🧹 Outside diff range and nitpick comments (3)
apps/web/app/hooks/features/useTimelogFilterOptions.ts (3)

33-33: Improve type safety and naming of selection handler

The handler correctly implements toggle functionality but could benefit from better typing and naming.

Consider these improvements:

-const handleSelectRowTimesheet = (items: string) => {
+const handleToggleTimesheetSelection = (timesheetId: string) => {
-  setSelectTimesheetId((prev) => prev.includes(items) ? prev.filter((filter) => filter !== items) : [...prev, items])
+  setSelectTimesheetId((prev) => 
+    prev.includes(timesheetId) 
+      ? prev.filter((id) => id !== timesheetId) 
+      : [...prev, timesheetId]
+  )
}

47-47: Consider comprehensive cleanup of selection states

The cleanup effect only resets selectTimesheetId but ignores other selection states like selectedItems.

Consider cleaning up all selection-related states:

-return () => setSelectTimesheetId([]);
+return () => {
+  setSelectTimesheetId([]);
+  setSelectedItems([]);
+  setSelectTimesheet(null); // if applicable
+};

60-61: Consider grouping related state exports

The return object exposes both old and new selection states, but they're not grouped together for better readability.

Consider grouping related state exports together:

 return {
   statusState,
   employee,
   project,
   task,
   setEmployeeState,
   setProjectState,
   setTaskState,
   setStatusState,
   handleSelectRowTimesheet,
-  selectTimesheetId,
-  setSelectTimesheetId,
   handleSelectRowByStatusAndDate,
   selectedItems,
   selectTimesheet,
   setSelectTimesheet,
+  selectTimesheetId,
+  setSelectTimesheetId,
   timesheetGroupByDays,
   setTimesheetGroupByDays,
   generateTimeOptions,
   setPuTimesheetStatus,
   puTimesheetStatus
 };
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between af592c3 and 5f80059.

📒 Files selected for processing (2)
  • apps/web/app/hooks/features/useTimelogFilterOptions.ts (4 hunks)
  • apps/web/lib/features/integrations/calendar/table-time-sheet.tsx (10 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • apps/web/lib/features/integrations/calendar/table-time-sheet.tsx
🔇 Additional comments (2)
apps/web/app/hooks/features/useTimelogFilterOptions.ts (2)

Line range hint 1-72: Implementation aligns well with bulk deletion requirements

The changes effectively support the bulk deletion functionality by introducing multi-select capability while maintaining backward compatibility. The implementation is solid with good separation of concerns.


14-14: Consider consolidating timesheet selection states

The hook maintains both selectTimesheet and selectTimesheetId states for handling timesheet selection. This could lead to confusion and maintenance issues.

Consider deprecating selectTimesheet state if it's no longer needed, or document the distinct purpose of each state if both are required.

@Innocent-Akim Innocent-Akim added Bug fix and removed bug Something isn't working Don't Merge Do not merge this PR until label not removed labels Dec 6, 2024
@Innocent-Akim Innocent-Akim requested a review from evereq December 8, 2024 10:23
@evereq evereq merged commit 7cf00f0 into develop Dec 8, 2024
13 checks passed
@evereq evereq deleted the feat/bulk-delete-time-entries branch December 8, 2024 17:29
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.

2 participants