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

Custom upcoming length #4206

Merged
merged 18 commits into from
Jan 23, 2025

Conversation

SamBobBarnes
Copy link
Contributor

@SamBobBarnes SamBobBarnes commented Jan 20, 2025

Add custom option to upcoming length selector.
Not sure I'm happy with the layout of this feature. I welcome any input.
Also the save functionality is a bit abrupt, not sure if a quick save animation is warranted, tho I haven't seen anything like that elsewhere in the application.

@actual-github-bot actual-github-bot bot changed the title Custom upcoming length [WIP] Custom upcoming length Jan 20, 2025
Copy link

netlify bot commented Jan 20, 2025

Deploy Preview for actualbudget ready!

Name Link
🔨 Latest commit 92862bf
🔍 Latest deploy log https://app.netlify.com/sites/actualbudget/deploys/67929ce4ce03c900088369f5
😎 Deploy Preview https://deploy-preview-4206.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 Jan 20, 2025

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.68 MB → 6.68 MB (+3.59 kB) +0.05%
Changeset
File Δ Size
src/components/schedules/CustomUpcomingLength.tsx 🆕 +1.42 kB 0 B → 1.42 kB
src/components/schedules/UpcomingLength.tsx 📈 +1.8 kB (+81.64%) 2.2 kB → 4 kB
home/runner/work/actual/actual/packages/loot-core/src/shared/schedules.ts 📈 +617 B (+7.06%) 8.53 kB → 9.13 kB
node_modules/define-data-property/index.js 📉 -9 B (-0.39%) 2.25 kB → 2.24 kB
node_modules/call-bind/index.js 📉 -9 B (-0.84%) 1.05 kB → 1.04 kB
node_modules/has-property-descriptors/index.js 📉 -9 B (-1.55%) 582 B → 573 B
node_modules/es-define-property/index.js 📉 -210 B (-37.50%) 560 B → 350 B
View detailed bundle breakdown

Added

No assets were added

Removed

No assets were removed

Bigger

Asset File Size % Changed
static/js/index.js 4.28 MB → 4.28 MB (+3.59 kB) +0.08%

Smaller

No assets were smaller

Unchanged

Asset File Size % Changed
static/js/nl.js 58.58 kB 0%
static/js/en-GB.js 92.98 kB 0%
static/js/en.js 99.31 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 111.19 kB 0%
static/js/BackgroundImage.js 122.29 kB 0%
static/js/pt-BR.js 103.38 kB 0%
static/js/AppliedFilters.js 10.52 kB 0%
static/js/useAccountPreviewTransactions.js 1.69 kB 0%
static/js/narrow.js 84.94 kB 0%
static/js/wide.js 102.8 kB 0%
static/js/ReportRouter.js 1.59 MB 0%

Copy link
Contributor

github-actions bot commented Jan 20, 2025

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 → 1.33 MB (+251 B) +0.02%
Changeset
File Δ Size
packages/loot-core/src/shared/schedules.ts 📈 +829 B (+6.91%) 11.72 kB → 12.53 kB
View detailed bundle breakdown

Added

No assets were added

Removed

No assets were removed

Bigger

Asset File Size % Changed
kcab.worker.js 1.33 MB → 1.33 MB (+251 B) +0.02%

Smaller

No assets were smaller

Unchanged

No assets were unchanged

@SamBobBarnes SamBobBarnes changed the title [WIP] Custom upcoming length Custom upcoming length Jan 20, 2025
Copy link
Contributor

coderabbitai bot commented Jan 20, 2025

Caution

Review failed

The head commit changed during the review from f36e769 to a6031ae.

Walkthrough

This pull request introduces a new CustomUpcomingLength React component in the desktop client, which allows users to select a custom time period for upcoming schedules. The component accepts two props: onChange, a function for handling changes, and tempValue, a string representing a temporary value. It utilizes the useTranslation hook for localization and manages its state for numeric values and units. The UpcomingLength component has also been updated to integrate this custom length selection, with enhanced state management and rendering logic. Additionally, a new getUpcomingDays function has been added to the schedules module, which converts various string representations of time intervals into corresponding numerical day values, enhancing flexibility in specifying upcoming schedule lengths across the application.

Possibly related PRs

Suggested labels

feature, enhancement, ui, scheduling

Suggested reviewers

  • youngcw
  • matt-fidd

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.

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

🧹 Nitpick comments (4)
packages/desktop-client/src/components/schedules/UpcomingLength.tsx (3)

54-66: Consider adding loading state and animation for save action.

To address the "abrupt" save concern mentioned in the PR description:

 const [tempUpcomingLength, setTempUpcomingLength] = useState(upcomingLength);
 const [useCustomLength, setUseCustomLength] = useState(
   nonCustomUpcomingLengthValues(tempUpcomingLength),
 );
 const [saveActive, setSaveActive] = useState(false);
+const [isSaving, setIsSaving] = useState(false);

 useEffect(() => {
   if (tempUpcomingLength !== upcomingLength) {
     setSaveActive(true);
   } else {
     setSaveActive(false);
   }
 }, [tempUpcomingLength, upcomingLength]);

Then update the save handler:

 const saveUpcomingLength = () => {
+  setIsSaving(true);
   setUpcomingLength(tempUpcomingLength);
+  setTimeout(() => {
+    setIsSaving(false);
+    close();
+  }, 500);
 };

107-112: Add ARIA labels for better accessibility.

The custom length section should be properly labeled for screen readers:

-{useCustomLength && (
+{useCustomLength && (
+  <div role="region" aria-label={t('Custom length selector')}>
     <CustomUpcomingLength
       onChange={setTempUpcomingLength}
       tempValue={tempUpcomingLength}
     />
+  </div>
 )}

122-132: Add keyboard shortcut for save action.

Consider adding keyboard shortcut support:

+import { useHotkeys } from 'react-hotkeys-hook';

+useHotkeys('mod+s', (e) => {
+  e.preventDefault();
+  if (saveActive) {
+    saveUpcomingLength();
+  }
+});

 <Button
   isDisabled={!saveActive}
   onPress={() => {
     saveUpcomingLength();
     close();
   }}
   type="submit"
   variant="primary"
+  aria-keyshortcuts="Control+S"
 >
   <Trans>Save</Trans>
 </Button>
packages/loot-core/src/shared/schedules.test.ts (1)

347-361: Add edge case tests for getUpcomingDays.

Consider adding tests for the following scenarios:

 describe('getUpcomingDays', () => {
   it.each([
     ['1', 1],
     ['7', 7],
     ['14', 14],
     ['oneMonth', 32],
     ['currentMonth', 31],
     ['2-day', 2],
     ['5-week', 35],
     ['3-month', 90],
     ['4-year', 1460],
+    ['invalid-unit', 7],    // Test invalid unit fallback
+    ['abc', 7],            // Test non-numeric fallback
+    ['0-day', 1],          // Test zero value handling
+    ['-1-day', 1],         // Test negative value handling
   ])('value of %s returns %i days', (value: string, expected: number) => {
     expect(getUpcomingDays(value)).toEqual(expected);
   });
 });
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between dd2b0a8 and 6cfd7a9.

⛔ Files ignored due to path filters (1)
  • upcoming-release-notes/4206.md is excluded by !**/*.md
📒 Files selected for processing (4)
  • packages/desktop-client/src/components/schedules/CustomUpcomingLength.tsx (1 hunks)
  • packages/desktop-client/src/components/schedules/UpcomingLength.tsx (3 hunks)
  • packages/loot-core/src/shared/schedules.test.ts (2 hunks)
  • packages/loot-core/src/shared/schedules.ts (1 hunks)
🔇 Additional comments (1)
packages/desktop-client/src/components/schedules/CustomUpcomingLength.tsx (1)

1-10: LGTM! Well-structured props interface and imports.

The component's interface is well-defined with clear prop types and necessary imports.

@youngcw
Copy link
Member

youngcw commented Jan 20, 2025

I cant wait to be able to see the next 20 years of my daily schedule 😆. Looks good so far. Ill let Matt do the review.

@youngcw
Copy link
Member

youngcw commented Jan 20, 2025

This does bring up a potentially real problem that the schedules load after the table so if there is a lot of schedules to go through then it can take a while for them to show. That is probably for a different time since very few people will be using more than a few weeks worth of forward looking.

@matt-fidd
Copy link
Contributor

I like it! Just the one comment I've piggybacked onto CodeRabbit

@matt-fidd
Copy link
Contributor

This does bring up a potentially real problem that the schedules load after the table so if there is a lot of schedules to go through then it can take a while for them to show. That is probably for a different time since very few people will be using more than a few weeks worth of forward looking.

We should look to have a loading indication somewhere, although if anyone is trying to have years worth of schedules showing then they should probably expect it to be a little behind.

@matt-fidd
Copy link
Contributor

The "up" incrementing arrow in the number input is working for me, but the down isn't decrementing. I think you need a step=1 prop on the Input

@matt-fidd
Copy link
Contributor

matt-fidd commented Jan 22, 2025

Looks like the 1 month and 1 year options are taking you just to the beginning of the next month/year

1 month:
image

1 year:
image

I can have a look at the code later on but first thought is it's only getting enough days to the end of the period, not to keep the current date within the next period

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! 🎉

@matt-fidd matt-fidd merged commit f09f4af into actualbudget:master Jan 23, 2025
20 checks passed
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