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

change position of 'Delete this plan' button #3322

Conversation

CREDO23
Copy link
Contributor

@CREDO23 CREDO23 commented Nov 12, 2024

Description

Fix #3127

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

Screenshot from 2024-11-12 03-11-02

Current screenshots

Screenshot from 2024-11-12 03-10-42

Summary by CodeRabbit

  • New Features

    • Introduced a confirmation popup for deleting daily plans, enhancing user control.
    • Added functionality to manage the loading state during plan deletions.
  • Improvements

    • Streamlined logic for filtering plans and updating local storage based on user actions.

Copy link
Contributor

coderabbitai bot commented Nov 12, 2024

Walkthrough

The pull request introduces modifications to the UserProfilePlans component, enhancing daily plan management, particularly the deletion process. The useDailyPlan hook now includes properties for deleting daily plans, and a confirmation popup is implemented for deletion actions. Additionally, the logic for managing local storage and filtering plans has been refined to improve state management. The changes aim to streamline user interactions with daily plans while ensuring clarity in the component's functionality.

Changes

Files Change Summary
apps/web/lib/features/user-profile-plans.tsx - Updated useDailyPlan to return deleteDailyPlan and deleteDailyPlanLoading.
- Added popupOpen state for confirmation popup visibility.
- Adjusted useEffect hooks for local storage updates.
- Simplified filtering logic in AllPlans.

Assessment against linked issues

Objective Addressed Explanation
Reposition the "Delete this plan" button in various views (#3127) The changes do not address the positioning of the delete button as required.

Possibly related PRs

Suggested labels

Improvement

Suggested reviewers

  • evereq
  • Cedric921

Poem

🐰 In the meadow where plans do bloom,
A popup now clears up the gloom.
With a click, the tasks take flight,
Deleting plans, oh what a sight!
So hop along, let’s make it right! 🌼

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/lib/features/user-profile-plans.tsx

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.


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.

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: 2

🧹 Outside diff range and nitpick comments (1)
apps/web/lib/features/user-profile-plans.tsx (1)

187-246: Improve confirmation popup implementation

The delete button and confirmation popup implementation has a few areas for improvement:

  1. The empty fragment (<></>) in the else condition is unnecessary
  2. The inline comment //button open popup is redundant
  3. Consider extracting the delete button and popup into a separate component for better maintainability

Apply these changes:

- {canSeeActivity ? (
-   <div className="flex justify-end">
-     <AlertPopup
+ {canSeeActivity && todayPlan[0] && (
+   <div className="flex justify-end">
+     <AlertPopup
        open={popupOpen}
        buttonOpen={
-         //button open popup
          <Button
            onClick={() => {
              setPopupOpen((prev) => !prev);
            }}
            variant="outline"
            className="px-4 py-2 text-sm font-medium text-red-600 border border-red-600 rounded-md bg-light--theme-light dark:!bg-dark--theme-light"
          >
            {t('common.plan.DELETE_THIS_PLAN')}
          </Button>
        }
      >
-     </AlertPopup>
-   </div>
- ) : (
-   <></>
- )}
+     </AlertPopup>
+   </div>
+ )}
🧰 Tools
🪛 Biome

[error] 188-245: 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)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 1a1d0c6 and 6a149ce.

📒 Files selected for processing (1)
  • apps/web/lib/features/user-profile-plans.tsx (6 hunks)
🧰 Additional context used
🪛 Biome
apps/web/lib/features/user-profile-plans.tsx

[error] 188-245: 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 (2)
apps/web/lib/features/user-profile-plans.tsx (2)

61-70: LGTM: Hook usage is properly implemented

The useDailyPlan hook destructuring now includes deleteDailyPlan and deleteDailyPlanLoading, which aligns with the PR objective of managing plan deletion functionality.


290-290: Verify dependency array in useEffect

The useEffect dependency array in AllPlans component now depends on todayPlan instead of filteredPlans.current. This is correct as todayPlan is the source of truth for today's plans.

Also applies to: 305-305

Comment on lines +211 to +215
if (requirePlan) {
localStorage.removeItem(
DAILY_PLAN_SUGGESTION_MODAL_DATE
);
}
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

Consider error handling for localStorage operations

The localStorage operation during plan deletion should be wrapped in a try-catch block as it can throw errors in certain browser conditions (e.g., private browsing mode).

Apply this change:

  if (requirePlan) {
+   try {
      localStorage.removeItem(
        DAILY_PLAN_SUGGESTION_MODAL_DATE
      );
+   } catch (error) {
+     console.error('Failed to remove from localStorage:', error);
+   }
  }
📝 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
if (requirePlan) {
localStorage.removeItem(
DAILY_PLAN_SUGGESTION_MODAL_DATE
);
}
if (requirePlan) {
try {
localStorage.removeItem(
DAILY_PLAN_SUGGESTION_MODAL_DATE
);
} catch (error) {
console.error('Failed to remove from localStorage:', error);
}
}

Comment on lines +208 to +223
disabled={deleteDailyPlanLoading}
onClick={async () => {
try {
if (requirePlan) {
localStorage.removeItem(
DAILY_PLAN_SUGGESTION_MODAL_DATE
);
}
todayPlan[0].id &&
(await deleteDailyPlan(todayPlan[0].id));
} catch (error) {
console.error(error);
} finally {
setPopupOpen(false);
}
}}
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 user feedback for deletion errors

The error handling during plan deletion only logs to console. Consider showing a user-friendly error message when deletion fails.

Consider adding a toast notification or error message in the UI:

  onClick={async () => {
    try {
      if (requirePlan) {
        localStorage.removeItem(
          DAILY_PLAN_SUGGESTION_MODAL_DATE
        );
      }
      todayPlan[0].id &&
        (await deleteDailyPlan(todayPlan[0].id));
    } catch (error) {
      console.error(error);
+     // Assuming you have a toast notification system
+     showErrorToast(t('common.errors.FAILED_TO_DELETE_PLAN'));
    } finally {
      setPopupOpen(false);
    }
  }}

Committable suggestion skipped: line range outside the PR's diff.

@evereq evereq merged commit 47212e4 into develop Nov 14, 2024
13 checks passed
@evereq evereq deleted the 3127-bugs-daily-plan--change-positioning-of-delete-this-plan-button branch November 14, 2024 21:35
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.

[Bugs] Daily Plan | Change positioning of “Delete this plan” button
2 participants