Skip to content

Comments

[WEB-2419] chore: add toast alerts post access change of a page#5569

Merged
pushya22 merged 1 commit intopreviewfrom
chore/page-access-toast
Sep 12, 2024
Merged

[WEB-2419] chore: add toast alerts post access change of a page#5569
pushya22 merged 1 commit intopreviewfrom
chore/page-access-toast

Conversation

@aaryan610
Copy link
Member

@aaryan610 aaryan610 commented Sep 9, 2024

Improvements:

A toast alert now appears when the user changes the access of a page.

Media:

Screen.Recording.2024-09-09.at.20.47.49.mov

Plane issue: WEB-2419

Summary by CodeRabbit

  • New Features

    • Enhanced the Page Quick Actions component with asynchronous access level changes.
    • Introduced success and error toast notifications to improve user feedback during access changes.
  • Bug Fixes

    • Improved error handling during access level changes to provide better user experience.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Sep 9, 2024

Walkthrough

The pull request updates the action property of the MENU_ITEMS array in the PageQuickActions component to an asynchronous function. This function manages the logic for changing a page's access level by determining the appropriate action based on the current access state, executing it within a try-catch block, and providing user feedback through toast notifications for both success and error scenarios.

Changes

Files Change Summary
web/core/components/pages/dropdowns/quick-actions.tsx Updated action property in MENU_ITEMS to an asynchronous function for handling access changes and user notifications.

Possibly related PRs

Suggested labels

🌟enhancement, 🧹chore

Poem

🐇 In the meadow where quick actions play,
A new way to change, brightens the day.
With toasts of success and whispers of care,
Access levels shift, with joy in the air.
Hopping along, we embrace the new flow,
For every small change helps our garden grow! 🌼

Tip

New features

Walkthrough comment now includes:

  • Possibly related PRs: A list of potentially related PRs to help you recall past context.
  • Suggested labels: CodeRabbit can now suggest labels by learning from your past PRs. You can also provide custom labeling instructions in the UI or configuration file.

Notes:

  • Please share any feedback in the discussion post on our Discord.
  • Possibly related PRs, automatic label suggestions based on past PRs, learnings, and possibly related issues require data opt-in (enabled by default).

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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 99a7867 and cd3b3d7.

Files selected for processing (1)
  • web/core/components/pages/dropdowns/quick-actions.tsx (1 hunks)

Comment on lines +51 to +70
action: async () => {
const changedPageType = access === 0 ? "private" : "public";

try {
if (access === 0) await makePrivate();
else await makePublic();

setToast({
type: TOAST_TYPE.SUCCESS,
title: "Success!",
message: `The page has been marked ${changedPageType} and moved to the ${changedPageType} section.`,
});
} catch (err) {
setToast({
type: TOAST_TYPE.ERROR,
title: "Error!",
message: `The page couldn't be marked ${changedPageType}. Please try again.`,
});
}
},
Copy link
Contributor

Choose a reason for hiding this comment

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

Approve changes with suggestions for enhanced error handling.

The asynchronous function within the action property of MENU_ITEMS is well-implemented, providing clear user feedback through toast notifications. The use of a try-catch block for error handling is a good practice.

However, consider enhancing the error handling by logging the error or providing more detailed feedback to the user. This could help in diagnosing issues more effectively in production.

+ import { logError } from "@/helpers/error.helper";

  try {
    if (access === 0) await makePrivate();
    else await makePublic();
    setToast({
      type: TOAST_TYPE.SUCCESS,
      title: "Success!",
      message: `The page has been marked ${changedPageType} and moved to the ${changedPageType} section.`,
    });
  } catch (err) {
    logError(err); // Log the error for better diagnostics
    setToast({
      type: TOAST_TYPE.ERROR,
      title: "Error!",
      message: `The page couldn't be marked ${changedPageType}. Please try again. Error: ${err.message}`,
    });
  }

Committable suggestion was skipped due to low confidence.

@pushya22 pushya22 merged commit ddbd9df into preview Sep 12, 2024
@pushya22 pushya22 deleted the chore/page-access-toast branch September 12, 2024 09:03
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.

3 participants