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

Show the last bank sync in plain language instead of timestamp #4523

Merged
merged 2 commits into from
Mar 3, 2025

Conversation

matt-fidd
Copy link
Contributor

Thanks to the helper @tostasmistas introduced in #4459, this looks much better!

Before:
image

After:
image

Those screenshots are taken on different instances so the dates don't match.

@actual-github-bot actual-github-bot bot changed the title Show the last bank sync in plain language instead of timestamp [WIP] Show the last bank sync in plain language instead of timestamp Mar 3, 2025
Copy link

netlify bot commented Mar 3, 2025

Deploy Preview for actualbudget ready!

Name Link
🔨 Latest commit 91bd9b4
🔍 Latest deploy log https://app.netlify.com/sites/actualbudget/deploys/67c608df2554cc000858f74c
😎 Deploy Preview https://deploy-preview-4523.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.

@matt-fidd matt-fidd changed the title [WIP] Show the last bank sync in plain language instead of timestamp Show the last bank sync in plain language instead of timestamp Mar 3, 2025
Copy link
Contributor

github-actions bot commented Mar 3, 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
18 8.05 MB → 8.05 MB (-85 B) -0.00%
Changeset
File Δ Size
home/runner/work/actual/actual/packages/loot-core/src/shared/util.ts 📈 +159 B (+2.16%) 7.18 kB → 7.34 kB
node_modules/date-fns/esm/parse/index.js 📉 -4 B (-0.01%) 31.59 kB → 31.59 kB
node_modules/date-fns/esm/format/index.js 📉 -4 B (-0.01%) 27.27 kB → 27.27 kB
node_modules/date-fns/esm/formatDistance/index.js 📉 -4 B (-0.05%) 8.22 kB → 8.22 kB
node_modules/date-fns/esm/locale/en-US/_lib/formatDistance/index.js 📉 -45 B (-2.44%) 1.8 kB → 1.75 kB
node_modules/date-fns/esm/locale/en-US/index.js 📉 -33 B (-5.78%) 571 B → 538 B
src/components/banksync/AccountRow.tsx 📉 -154 B (-6.23%) 2.42 kB → 2.26 kB
View detailed bundle breakdown

Added

No assets were added

Removed

No assets were removed

Bigger

No assets were bigger

Smaller

Asset File Size % Changed
static/js/index.js 5.33 MB → 5.33 MB (-85 B) -0.00%

Unchanged

Asset File Size % Changed
static/js/en.js 103.63 kB 0%
static/js/en-GB.js 96.59 kB 0%
static/js/es.js 58.26 kB 0%
static/js/de.js 112.69 kB 0%
static/js/workbox-window.prod.es5.js 5.69 kB 0%
static/js/resize-observer.js 18.37 kB 0%
static/js/indexeddb-main-thread-worker-e59fee74.js 13.5 kB 0%
static/js/BackgroundImage.js 122.29 kB 0%
static/js/fr.js 113.61 kB 0%
static/js/uk.js 111.11 kB 0%
static/js/nl.js 95.56 kB 0%
static/js/pt-BR.js 110.57 kB 0%
static/js/useAccountPreviewTransactions.js 1.69 kB 0%
static/js/narrow.js 86.26 kB 0%
static/js/AppliedFilters.js 10.8 kB 0%
static/js/wide.js 103.68 kB 0%
static/js/ReportRouter.js 1.59 MB 0%

Copy link
Contributor

github-actions bot commented Mar 3, 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.34 MB 0%
Changeset
File Δ Size
packages/loot-core/src/shared/util.ts 📈 +175 B (+1.49%) 11.46 kB → 11.63 kB
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.34 MB 0%

Copy link
Contributor

coderabbitai bot commented Mar 3, 2025

Walkthrough

This pull request updates the way timestamps are displayed by removing a dedicated date formatting function and shifting to a relative time representation. In the AccountRow.tsx file, the previous tsToString function is removed and replaced with the tsToRelativeTime function, which now uses the user's language preference obtained via the useGlobalPref hook rather than the removed useDateFormat hook. Additionally, in util.ts, the tsToRelativeTime function is modified to include an options parameter with a capitalize property, allowing conditional capitalization of the formatted output.

Possibly related PRs

Suggested labels

:sparkles: Merged

Suggested reviewers

  • youngcw
✨ Finishing Touches
  • 📝 Generate Docstrings

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.
  • @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

🧹 Nitpick comments (1)
packages/loot-core/src/shared/util.ts (1)

504-510: Good implementation of conditional capitalization

The new code elegantly handles capitalization when requested, maintaining the original string when not needed. This enhances the display flexibility of timestamps throughout the application.

One small note: For consistency, you might want to apply the same capitalization logic to the "Unknown" return value (line 497) when ts is null, as it's currently always capitalized regardless of the options setting.

-  if (!ts) return 'Unknown';
+  if (!ts) {
+    const text = 'unknown';
+    return options.capitalize ? text.charAt(0).toUpperCase() + text.slice(1) : text;
+  }
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 5ebbff4 and 91bd9b4.

⛔ Files ignored due to path filters (1)
  • upcoming-release-notes/4523.md is excluded by !**/*.md
📒 Files selected for processing (2)
  • packages/desktop-client/src/components/banksync/AccountRow.tsx (2 hunks)
  • packages/loot-core/src/shared/util.ts (1 hunks)
🧰 Additional context used
🧠 Learnings (1)
packages/desktop-client/src/components/banksync/AccountRow.tsx (1)
Learnt from: matt-fidd
PR: actualbudget/actual#4253
File: packages/desktop-client/src/components/banksync/AccountRow.tsx:0-0
Timestamp: 2025-01-28T23:24:32.957Z
Learning: In the Actual codebase, timestamp formatting should use date-fns' `format` function with explicit format strings (e.g., 'HH:mm:ss' for time) instead of JavaScript's built-in `toLocaleTimeString()` for consistency.
⏰ Context from checks skipped due to timeout of 90000ms (5)
  • GitHub Check: Functional
  • GitHub Check: Visual regression
  • GitHub Check: build (macos-latest)
  • GitHub Check: build (windows-latest)
  • GitHub Check: build (ubuntu-latest)
🔇 Additional comments (5)
packages/loot-core/src/shared/util.ts (1)

490-496: Well-structured function signature enhancement

The function signature has been extended to include an optional options parameter with a capitalize property, defaulting to false. This improvement allows for more flexible text formatting while maintaining backward compatibility with existing calls.

packages/desktop-client/src/components/banksync/AccountRow.tsx (4)

6-6: Good use of shared utilities

Importing the utility function from a shared location rather than defining it locally follows the DRY principle and promotes code consistency across the application.


9-9: Appropriate hook replacement

The switch from a date format hook to using the global language preference aligns well with the move to relative time formatting, ensuring consistent localization across the app.


24-24: Good default language handling

Setting a default language ('en-US') ensures the application behaves predictably even if the language preference isn't set.


26-28: Improved user experience with relative timestamps

Using relative time with capitalization enhances readability and provides a more user-friendly representation of when an account was last synchronized. This change directly addresses the PR objective to "show the last bank sync in plain language instead of timestamp."

I'm applying knowledge from your previous feedback about timestamp formatting in the Actual codebase. This implementation properly uses date-fns formatting (via tsToRelativeTime) rather than JavaScript's built-in functions, maintaining consistency with the project's standards.

@matt-fidd matt-fidd merged commit c17cd28 into actualbudget:master Mar 3, 2025
21 checks passed
@matt-fidd matt-fidd deleted the banksync-relative-time branch March 3, 2025 21:58
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.

2 participants