[Typescript] Update validateBudgetName and uniqueBudgetName return types #4208

joel-jeremy · 2025-01-20T18:38:14Z

netlify · 2025-01-20T18:38:31Z

✅ Deploy Preview for actualbudget ready!

Name	Link
🔨 Latest commit	`7e19f1f`
🔍 Latest deploy log	https://app.netlify.com/sites/actualbudget/deploys/678f3007b1ee23000867023c
😎 Deploy Preview	https://deploy-preview-4208.demo.actualbudget.org
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

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

github-actions · 2025-01-20T18:40:34Z

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
15	6.69 MB → 6.69 MB (+921 B)	+0.01%

Changeset

File	Δ	Size
`node_modules/es-define-property/index.js`	📈 +210 B (+60.00%)	350 B → 560 B
`node_modules/has-property-descriptors/index.js`	📈 +9 B (+1.57%)	573 B → 582 B
`node_modules/call-bind/index.js`	📈 +9 B (+0.85%)	1.04 kB → 1.05 kB
`locale/pt-BR.json`	📈 +672 B (+0.61%)	108.13 kB → 108.78 kB
`node_modules/define-data-property/index.js`	📈 +9 B (+0.39%)	2.24 kB → 2.25 kB
`home/runner/work/actual/actual/packages/loot-core/src/client/actions/budgets.ts`	📈 +12 B (+0.18%)	6.42 kB → 6.43 kB

View detailed bundle breakdown

Added

No assets were added

Removed

No assets were removed

Bigger

Asset	File Size	% Changed
static/js/pt-BR.js	108.13 kB → 108.78 kB (+672 B)	+0.61%
static/js/index.js	4.28 MB → 4.28 MB (+249 B)	+0.01%

Smaller

No assets were smaller

Unchanged

Asset	File Size	% Changed
static/js/nl.js	62.88 kB	0%
static/js/en-GB.js	97.97 kB	0%
static/js/en.js	98.94 kB	0%
static/js/indexeddb-main-thread-worker-e59fee74.js	13.5 kB	0%
static/js/workbox-window.prod.es5.js	5.69 kB	0%
static/js/resize-observer.js	18.37 kB	0%
static/js/uk.js	118.39 kB	0%
static/js/BackgroundImage.js	122.29 kB	0%
static/js/useAccountPreviewTransactions.js	1.69 kB	0%
static/js/AppliedFilters.js	10.52 kB	0%
static/js/narrow.js	84.83 kB	0%
static/js/wide.js	101.32 kB	0%
static/js/ReportRouter.js	1.59 MB	0%

github-actions · 2025-01-20T18:40:35Z

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.33 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.33 MB	0%

coderabbitai · 2025-01-20T18:40:45Z

Walkthrough

The pull request focuses on updating the type annotations for two functions, validateBudgetName and uniqueBudgetName, in the packages/loot-core/src/client/actions/budgets.ts file. The changes involve transforming these functions from synchronous to asynchronous by modifying their return types to use Promise. Specifically, validateBudgetName now returns a Promise resolving to an object with a valid boolean and an optional message, while uniqueBudgetName now returns a Promise resolving to a string. These modifications aim to accurately represent the asynchronous nature of the functions' underlying operations.

Assessment against linked issues

Objective	Addressed	Explanation
Mark `uniqueBudgetName` as async and return `Promise<string>` [#4205]	✅
Mark `validateBudgetName` as async and return `Promise<{ valid: boolean; message?: string; }>` [#4205]	✅

Possibly related PRs

Duplicate Budget #3847: The changes involve the addition of the duplicateBudget function related to budget duplication.
[Typescript migration] Migrate AccountSyncCheck to ts #3757: Includes the uniqueBudgetName function for ensuring budget name uniqueness.
[TypeScript] Add types to loot-core app #4155: This PR enhances type safety in the application, aligning with changes in this PR that update function signatures and return types.

Suggested labels

sparkles: Merged

Suggested reviewers

UnderKoen
matt-fidd

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 82c5e44 and 7e19f1f.

⛔ Files ignored due to path filters (1)

upcoming-release-notes/4208.md is excluded by !**/*.md

📒 Files selected for processing (1)

packages/loot-core/src/client/actions/budgets.ts (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

packages/loot-core/src/client/actions/budgets.ts

⏰ Context from checks skipped due to timeout of 90000ms (5)

GitHub Check: build (macos-latest)
GitHub Check: build (windows-latest)
GitHub Check: build (ubuntu-latest)
GitHub Check: Wait for Netlify build to finish
GitHub Check: Analyze

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.

actual-github-bot bot changed the title ~~Update validateBudgetName and uniqueBudgetName per coderabbit review~~ [WIP] Update validateBudgetName and uniqueBudgetName per coderabbit review Jan 20, 2025

actual-github-bot bot added the 🚧 WIP label Jan 20, 2025

joel-jeremy changed the title ~~[WIP] Update validateBudgetName and uniqueBudgetName per coderabbit review~~ [Typescript] Update validateBudgetName and uniqueBudgetName return types Jan 20, 2025

actual-github-bot bot added 🔍 Ready for review and removed 🚧 WIP labels Jan 20, 2025

joel-jeremy added 2 commits January 20, 2025 21:26

Update validateBudgetName and uniqueBudgetName per coderabbit review

75d7987

Release notes

7e19f1f

joel-jeremy force-pushed the fix-4205 branch from 82c5e44 to 7e19f1f Compare January 21, 2025 05:26

matt-fidd approved these changes Jan 21, 2025

View reviewed changes

actual-github-bot bot added ✅ Approved and removed 🔍 Ready for review labels Jan 21, 2025

joel-jeremy merged commit 1442662 into master Jan 21, 2025
20 checks passed

actual-github-bot bot added ✨ Merged and removed ✅ Approved labels Jan 21, 2025

joel-jeremy deleted the fix-4205 branch January 21, 2025 18:44

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Typescript] Update validateBudgetName and uniqueBudgetName return types #4208

[Typescript] Update validateBudgetName and uniqueBudgetName return types #4208

joel-jeremy commented Jan 20, 2025

netlify bot commented Jan 20, 2025 •

edited

Loading

github-actions bot commented Jan 20, 2025 •

edited

Loading

github-actions bot commented Jan 20, 2025 •

edited

Loading

coderabbitai bot commented Jan 20, 2025 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

[Typescript] Update validateBudgetName and uniqueBudgetName return types #4208

[Typescript] Update validateBudgetName and uniqueBudgetName return types #4208

Conversation

joel-jeremy commented Jan 20, 2025

netlify bot commented Jan 20, 2025 • edited Loading

✅ Deploy Preview for actualbudget ready!

github-actions bot commented Jan 20, 2025 • edited Loading

Bundle Stats — desktop-client

github-actions bot commented Jan 20, 2025 • edited Loading

Bundle Stats — loot-core

coderabbitai bot commented Jan 20, 2025 • edited Loading

Walkthrough

Assessment against linked issues

Possibly related PRs

Suggested labels

Suggested reviewers

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

netlify bot commented Jan 20, 2025 •

edited

Loading

github-actions bot commented Jan 20, 2025 •

edited

Loading

github-actions bot commented Jan 20, 2025 •

edited

Loading

coderabbitai bot commented Jan 20, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)