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

[Goals]: fix no messages #1507 #3721

Merged
merged 3 commits into from
Oct 25, 2024
Merged

[Goals]: fix no messages #1507 #3721

merged 3 commits into from
Oct 25, 2024

Conversation

youngcw
Copy link
Member

@youngcw youngcw commented Oct 23, 2024

fixes #1507

image

@actual-github-bot actual-github-bot bot changed the title [Goals]: fix no messages #1507 [WIP] [Goals]: fix no messages #1507 Oct 23, 2024
Copy link

netlify bot commented Oct 23, 2024

Deploy Preview for actualbudget ready!

Name Link
🔨 Latest commit 0bb3cd8
🔍 Latest deploy log https://app.netlify.com/sites/actualbudget/deploys/6719504e4dd9f10008cc51ad
😎 Deploy Preview https://deploy-preview-3721.demo.actualbudget.org
📱 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.

Copy link
Contributor

github-actions bot commented Oct 23, 2024

Bundle Stats — desktop-client

Hey there, this message comes from a GitHub action that helps you and reviewers to understand how these changes affect the size of this project's bundle.

As this PR is updated, I'll keep you updated on how the bundle size is impacted.

Total

Files count Total bundle size % Changed
9 5.32 MB → 5.32 MB (+54 B) +0.00%
Changeset
File Δ Size
home/runner/work/actual/actual/packages/loot-core/src/client/actions/queries.ts 📈 +54 B (+0.66%) 7.96 kB → 8.01 kB
View detailed bundle breakdown

Added

No assets were added

Removed

No assets were removed

Bigger

Asset File Size % Changed
static/js/index.js 3.33 MB → 3.33 MB (+54 B) +0.00%

Smaller

No assets were smaller

Unchanged

Asset File Size % Changed
static/js/indexeddb-main-thread-worker-e59fee74.js 13.5 kB 0%
static/js/resize-observer.js 18.37 kB 0%
static/js/BackgroundImage.js 122.29 kB 0%
static/js/narrow.js 82.57 kB 0%
static/js/usePreviewTransactions.js 1.64 kB 0%
static/js/AppliedFilters.js 21.3 kB 0%
static/js/wide.js 232.12 kB 0%
static/js/ReportRouter.js 1.51 MB 0%

Copy link
Contributor

github-actions bot commented Oct 23, 2024

Bundle Stats — loot-core

Hey there, this message comes from a GitHub action that helps you and reviewers to understand how these changes affect the size of this project's bundle.

As this PR is updated, I'll keep you updated on how the bundle size is impacted.

Total

Files count Total bundle size % Changed
1 1.27 MB 0%

Changeset

No files were changed

View detailed bundle breakdown

Added

No assets were added

Removed

No assets were removed

Bigger

No assets were bigger

Smaller

No assets were smaller

Unchanged

Asset File Size % Changed
kcab.worker.js 1.27 MB 0%

@youngcw
Copy link
Member Author

youngcw commented Oct 23, 2024

@joel-jeremy I don't know how to add the nice undo button, but maybe that could be a separate PR.

@youngcw youngcw changed the title [WIP] [Goals]: fix no messages #1507 [Goals]: fix no messages #1507 Oct 23, 2024
@youngcw youngcw added this to the v24.11.0 milestone Oct 23, 2024
Copy link
Contributor

coderabbitai bot commented Oct 23, 2024

Walkthrough

The pull request introduces changes to the applyBudgetAction function within the queries.ts file, specifically targeting the handling of the apply-goal-template and overwrite-goal-template cases. Previously, these cases awaited the send function call directly, without dispatching any notifications. The new implementation modifies this by wrapping the send calls in dispatch(addNotification(...)), ensuring that notifications are now dispatched for both actions. This change aligns the notification handling of these budget actions with other cases that already included notification dispatching. No other significant changes to the logic, error handling, or control flow were made in the rest of the file.

Assessment against linked issues

Objective Addressed Explanation
Ensure that notifications are dispatched after applying goal templates (1507)

Possibly related PRs

  • Add goal info to the prewarm list #3514: This PR enhances budget-related calculations, which may indirectly relate to the notification handling changes in the main PR by improving the overall budget management experience.
  • clean up accidental push #3695: Although primarily a cleanup PR, it involves budget-related functions that could be impacted by the notification handling changes in the main PR, as both deal with budget actions.

Suggested labels

sparkles: Merged

Suggested reviewers

  • joel-jeremy

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

🧹 Outside diff range and nitpick comments (2)
packages/loot-core/src/client/actions/queries.ts (2)

41-45: Consider consistent formatting with other cases.

While the implementation is correct, consider making the formatting consistent with other similar cases (like 'apply-goal-template') for better code uniformity.

Consider this more concise format:

-        dispatch(
-          addNotification(
-            await send('budget/overwrite-goal-template', { month }),
-          ),
-        );
+        dispatch(
+          addNotification(await send('budget/overwrite-goal-template', { month })),
+        );

36-45: Good choice using notifications over modal dialogs.

The implementation leverages the existing notification system instead of modal dialogs, which is a better architectural choice because:

  1. It maintains consistency with other budget actions
  2. Notifications are less intrusive to the user workflow
  3. The existing notification system likely has proper styling and accessibility support
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 34f3cca and 0bb3cd8.

⛔ Files ignored due to path filters (1)
  • upcoming-release-notes/3721.md is excluded by !**/*.md
📒 Files selected for processing (1)
  • packages/loot-core/src/client/actions/queries.ts (1 hunks)
🧰 Additional context used
🔇 Additional comments (1)
packages/loot-core/src/client/actions/queries.ts (1)

36-38: LGTM! Implementation matches existing patterns.

The notification dispatch implementation for 'apply-goal-template' follows the established pattern seen in other cases like 'check-templates', ensuring consistent user feedback.

Let's verify the notification handling implementation:

✅ Verification successful

Let me gather more information about the notification patterns in the codebase to ensure consistency.


Let me verify the implementation of the server-side handler to ensure it returns appropriate notification messages.


Based on the gathered information, I can now provide the final response:

Implementation correctly handles notifications for goal template operations

The implementation is verified to be correct and consistent because:

  • The server-side handler types in handlers.d.ts confirm that budget/apply-goal-template returns a Promise<Notification>
  • The notification dispatch pattern matches other similar budget operations like check-templates, overwrite-goal-template, and cleanup-goal-template
  • The implementation properly handles async/await and follows the established pattern of wrapping server responses in notifications
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for consistent notification handling patterns across budget actions
# Expect: Similar dispatch(addNotification(await send(...))) pattern

# Search for notification dispatch patterns in budget-related actions
rg -U "case '.*?':\s+dispatch\(addNotification\(await send\('budget/" 

Length of output: 281


Script:

#!/bin/bash
# Let's look for all notification patterns in budget-related actions with more context
rg -U "case '.*?':.*?send\('budget/" -A 5 packages/loot-core/src/client/actions/queries.ts

# Also check for other addNotification patterns
rg "addNotification\(" -A 2 packages/loot-core/src/client/actions/queries.ts

Length of output: 721


Script:

#!/bin/bash
# Check the server-side implementation of the budget/apply-goal-template handler
rg -U "budget/apply-goal-template.*?\{" -A 10

# Also look for the notification message format in similar handlers
rg -U "budget/(check|cleanup|overwrite)-goal-template.*?\{" -A 10

Length of output: 4461

Copy link
Contributor

@matt-fidd matt-fidd left a comment

Choose a reason for hiding this comment

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

LGTM

@youngcw youngcw merged commit 4b06345 into master Oct 25, 2024
20 checks passed
@youngcw youngcw deleted the youngcw/fix-template-notif branch October 25, 2024 00:25
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.

[Bug]: Goals: Error messages don't present after appying
2 participants