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

Convert PostsOfflineNotification.jsx to tsx #3868

Merged
merged 3 commits into from
Nov 21, 2024

Conversation

joel-jeremy
Copy link
Contributor

No description provided.

@actual-github-bot actual-github-bot bot changed the title Convert PostsOfflineNotification.jsx to tsx [WIP] Convert PostsOfflineNotification.jsx to tsx Nov 21, 2024
Copy link

netlify bot commented Nov 21, 2024

Deploy Preview for actualbudget ready!

Name Link
🔨 Latest commit afb2ba9
🔍 Latest deploy log https://app.netlify.com/sites/actualbudget/deploys/673f69803cdac00008947c68
😎 Deploy Preview https://deploy-preview-3868.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 Nov 21, 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
10 5.46 MB → 5.46 MB (+175 B) +0.00%
Changeset
File Δ Size
src/components/schedules/PostsOfflineNotification.tsx 🆕 +3.69 kB 0 B → 3.69 kB
node_modules/clsx/dist/clsx.js 🆕 +509 B 0 B → 509 B
node_modules/clsx/dist/clsx.js?commonjs-module 🆕 +27 B 0 B → 27 B
node_modules/react-grid-layout/build/ReactGridLayout.js 📉 -1 B (-0.00%) 24.96 kB → 24.96 kB
node_modules/react-grid-layout/build/GridItem.js 📉 -1 B (-0.00%) 21.49 kB → 21.49 kB
node_modules/react-grid-layout/build/components/WidthProvider.js 📉 -1 B (-0.02%) 5.22 kB → 5.22 kB
src/components/schedules/PostsOfflineNotification.jsx 🔥 -3.62 kB (-100%) 3.62 kB → 0 B
node_modules/clsx/dist/clsx.mjs 🔥 -368 B (-100%) 368 B → 0 B
node_modules/clsx/dist/clsx.mjs?commonjs-proxy 🔥 -64 B (-100%) 64 B → 0 B
View detailed bundle breakdown

Added

No assets were added

Removed

No assets were removed

Bigger

Asset File Size % Changed
static/js/index.js 3.44 MB → 3.44 MB (+242 B) +0.01%

Smaller

Asset File Size % Changed
static/js/ReportRouter.js 1.52 MB → 1.52 MB (-67 B) -0.00%

Unchanged

Asset File Size % Changed
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/useAccountPreviewTransactions.js 1.63 kB 0%
static/js/AppliedFilters.js 21.32 kB 0%
static/js/BackgroundImage.js 122.29 kB 0%
static/js/narrow.js 82.72 kB 0%
static/js/wide.js 241.19 kB 0%

Copy link
Contributor

github-actions bot commented Nov 21, 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.32 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.32 MB 0%

@joel-jeremy joel-jeremy changed the title [WIP] Convert PostsOfflineNotification.jsx to tsx Convert PostsOfflineNotification.jsx to tsx Nov 21, 2024
Copy link
Contributor

coderabbitai bot commented Nov 21, 2024

Walkthrough

The pull request introduces modifications to the PostsOfflineNotification component located in PostsOfflineNotification.tsx. Key changes include the addition of an import statement for PayeeEntity to enhance type checking for payee IDs. The useTranslation hook is updated to destructure i18n, allowing access to language settings directly from the i18n instance. The logic for retrieving the payees array from location.state has been revised to ensure it checks for the existence of location.state and its payees property, casting it to an array of PayeeEntity['id'] for improved type safety. Additionally, the payeeNamesList variable now utilizes i18n.language instead of t.language, aligning with the updated destructured variable. These changes collectively enhance the component's type safety and localization handling.

Possibly related PRs

Suggested labels

:sparkles: Merged

Suggested reviewers

  • matt-fidd
  • MikesGlitch

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 eslint (1.23.1)

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

packages/desktop-client/src/components/schedules/PostsOfflineNotification.tsx

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the plugin "eslint-plugin-eslint-plugin".

(The package "eslint-plugin-eslint-plugin" was not found when loaded as a Node module from the directory "/packages/eslint-plugin-actual".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install eslint-plugin-eslint-plugin@latest --save-dev

The plugin "eslint-plugin-eslint-plugin" was referenced from the config file in "packages/eslint-plugin-actual/.eslintrc.js".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.


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 (1)
packages/desktop-client/src/components/schedules/PostsOfflineNotification.tsx (1)

25-29: Consider using a type guard instead of type assertion

While the current implementation is functional, we can improve type safety by using a type guard instead of a type assertion.

Here's a suggested improvement:

-  const locationState = location.state;
-  const payees =
-    locationState && 'payees' in locationState
-      ? (locationState.payees as Array<PayeeEntity['id']>)
-      : [];
+  interface LocationState {
+    payees: Array<PayeeEntity['id']>;
+  }
+  
+  const locationState = location.state as LocationState | null;
+  const payees = locationState?.payees ?? [];

This approach:

  • Defines a clear interface for the expected state
  • Uses optional chaining and nullish coalescing for cleaner code
  • Provides better TypeScript type inference
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between f523d25 and afb2ba9.

⛔ Files ignored due to path filters (1)
  • upcoming-release-notes/3868.md is excluded by !**/*.md
📒 Files selected for processing (1)
  • packages/desktop-client/src/components/schedules/PostsOfflineNotification.tsx (3 hunks)
🔇 Additional comments (4)
packages/desktop-client/src/components/schedules/PostsOfflineNotification.tsx (4)

8-8: LGTM: Clean type import addition

The PayeeEntity type import is properly added and follows TypeScript conventions.


20-20: LGTM: Improved i18n access

The destructuring of both t and i18n from useTranslation follows i18next best practices and provides cleaner access to internationalization features.


41-41: LGTM: Correct i18n language reference

The update to use i18n.language instead of t.language is correct and consistent with the i18next API.


Line range hint 31-34: Verify event handler types

While the TypeScript conversion looks good overall, let's ensure the event handlers are properly typed.

Also applies to: 91-97

✅ Verification successful

Event handler typing is correctly implemented

The TypeScript implementation is properly done:

  • The onPost function is correctly typed as an async function with no parameters
  • All required types are properly imported (PayeeEntity)
  • The event handler is used in a type-safe manner with the Button component
  • The dispatch and send functions are properly imported and used with correct types
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check for similar components in the codebase to verify event handler typing patterns
ast-grep --pattern 'function $name($params) {
  await send($$$);
  dispatch($$$);
}'

# Look for Modal component usage patterns
ast-grep --pattern 'Modal name=$_>
  {({ state: { $_ } }) => $$$}'

Length of output: 155


Script:

#!/bin/bash
# Let's try a more specific pattern to find event handler patterns
ast-grep --pattern 'async function $name() {
  $$$
}'

# Also check the imports and component definition
rg -B 5 "async function onPost" packages/desktop-client/src/components/schedules/PostsOfflineNotification.tsx

# Look for similar send/dispatch patterns
rg "send\('schedule/force-run-service'\)" -A 2

Length of output: 696


Script:

#!/bin/bash
# Let's check the imports and type definitions
rg -l "import.*from" packages/desktop-client/src/components/schedules/PostsOfflineNotification.tsx

# Check the component's props and type definitions
cat packages/desktop-client/src/components/schedules/PostsOfflineNotification.tsx

# Look for similar async event handlers in the codebase for typing patterns
ast-grep --pattern 'async function $name(): $return_type {
  $$$
}'

Length of output: 3952

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