On changing network, causes to the dashboard to refetch data by sstefdev · Pull Request #137 · RequestNetwork/web-components

sstefdev · 2024-09-17T09:16:29Z

Fixes #95

Problem

When someone tries to use the button Switch Network or even switch network from their wallet, that triggers a refetch of the whole table and gives impression of page reloading

Solution

Checking if the actuall address changed solved this, now we only refetch when the network changes
Added preventDefault to the button just in case
Added window.ethereum functions to the types file
Signle invoice now closes only on wallet account change

Summary by CodeRabbit

New Features
- Enhanced wallet address and network handling for improved request fetching.
- Added event handling methods for Ethereum functionality in the interface.
- Introduced customizable click handling in button components.
Bug Fixes
- Streamlined error handling and loading state management in request fetching.
Documentation
- Updated interface definitions for better clarity on new properties and methods.

coderabbitai · 2024-09-17T09:16:38Z

Walkthrough

The changes involve enhancements to the view-requests.svelte component for improved handling of wallet address and network changes, as well as updates to the global.d.ts file for Ethereum functionality. Additionally, the button.svelte component is modified to allow more flexible click event handling. New variables and methods are introduced to optimize performance and usability in managing requests and event listeners.

Changes

File	Change Summary
`packages/invoice-dashboard/src/lib/view-requests.svelte`	Introduced `previousWalletAddress` and `previousNetwork` to optimize fetching requests based on wallet state changes. Modified `getRequests` for better error handling and conditional execution. Updated reactive statements for performance.
`packages/invoice-dashboard/src/types/global.d.ts`	Enhanced `Window` interface with `on` and `removeListener` methods for event handling, and added `autoRefreshOnNetworkChange` property to manage network change behavior.
`shared/components/button/button.svelte`	Added `onClick` and `preventDefault` properties for flexible click event handling. Encapsulated click logic in `handleClick` function to manage default actions and custom behavior.

Assessment against linked issues

Objective	Addressed	Explanation
Prevent dashboard reload on "Switch Chain" button (Issue #95)	❌	The changes do not address the dashboard reload issue directly.

Possibly related PRs

fix: added payment check when invoice is paid #83: Modifications in view-requests.svelte related to handling request data and the introduction of the isRequestPayed variable.
fix: using deprecated method for retrieving currencies from currency manager #103: Updates to currency handling logic in view-requests.svelte, relevant to managing requests and associated data.
feat: handle all request status #138: Changes in view-requests.svelte regarding the handling of request statuses, related to optimizing request fetching logic.

Suggested reviewers

sstefdev
rodrigopavezi
MantisClone

Recent review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between eb23dd8 and 1430cc0.

Files selected for processing (1)

packages/invoice-dashboard/src/lib/view-requests.svelte (3 hunks)

Additional comments not posted (4)

packages/invoice-dashboard/src/lib/view-requests.svelte (4)

61-62: LGTM!

The addition of previousWalletAddress and previousNetwork variables is a good optimization. It allows the component to track the last known wallet address and network, preventing unnecessary network calls when the address remains the same. This enhances the component's responsiveness to changes in the wallet state.

87-102: Great improvements to the getRequests function!

The addition of the check for wallet and requestNetwork before executing the request fetching logic is a good safety measure. It ensures that requests are only made when the necessary data is available, preventing potential errors.

Furthermore, the use of the finally block to reset the loading state improves the code's readability and reliability. It guarantees that the loading state is always reset, regardless of whether an error occurs during the request fetching process.

These changes enhance the robustness and user experience of the component.

106-124: Nice update to the getOneRequest function!

The addition of the check for activeRequest before executing the logic is a good practice. It prevents unnecessary function execution when there is no active request to fetch.

Moreover, the use of the finally block to reset the loading state, similar to the getRequests function, improves code consistency and reliability. It ensures that the loading state is always reset, regardless of any errors that may occur during the process.

These changes contribute to a more robust and user-friendly component.

136-153: Excellent refinement of the reactive statement!

Comparing the current wallet address and network against their previous values is a smart approach to detect changes in the wallet state. This allows the component to invoke the getRequests function only when necessary, i.e., when either the wallet address or network has changed.

This optimization enhances the component's performance by minimizing redundant network requests. It ensures that the component fetches requests only when there is a actual change in the wallet state, reducing unnecessary network overhead.

Furthermore, updating the previous wallet address and network after the comparison maintains an accurate record of the last known values. This ensures consistency in detecting future changes.

Overall, these changes significantly improve the component's responsiveness and efficiency in handling wallet state changes.

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 generate interesting stats about this repository and render them as a table.
-- @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.

MantisClone

Approved 👍 Pending comment resolution 🚧

I tested and the Switch chain button no longer causes a page reload, as intended 👍
Screencast from 09-17-2024 05:59:44 PM.webm

packages/invoice-dashboard/src/lib/view-requests.svelte

MantisClone · 2024-09-17T20:20:00Z

packages/invoice-dashboard/src/lib/view-requests.svelte

+  $: {
+    const currentWalletAddress = wallet?.accounts[0]?.address;
+    const currentNetwork = wallet?.chains[0]?.id;
+
+    if (
+      currentWalletAddress &&
+      currentWalletAddress !== previousWalletAddress
+    ) {
+      getRequests();
+      previousWalletAddress = currentWalletAddress;
+
+      activeRequest = undefined;
+    }
+
+    if (currentNetwork && currentNetwork !== previousNetwork) {
+      previousNetwork = currentNetwork;
+    }
+  }


What is the impact of having both the currentWalletAddress and currentNetwork logic in the same reactive statement $:?

Well, we are using it only there, so I thought we didn't need it outside this reactive statement.

fix: removed refetching data when changing network

c9535d3

sstefdev requested review from MantisClone, aimensahnoun and rodrigopavezi September 17, 2024 09:16

sstefdev linked an issue Sep 17, 2024 that may be closed by this pull request

Bad UX: On the Invoice View, the "Switch Chain" button causes the dashboard to reload, thus closing the invoice view and unselecting the invoice #95

Closed

fix: remove closing the single invoice when network change

eb23dd8

MantisClone approved these changes Sep 17, 2024

View reviewed changes

fix: move loading outside try-catch block

1430cc0

aimensahnoun approved these changes Sep 18, 2024

View reviewed changes

sstefdev requested review from MantisClone and aimensahnoun September 18, 2024 09:54

sstefdev merged commit c26d150 into main Sep 18, 2024

sstefdev deleted the 95-bad-ux-on-the-invoice-view-the-switch-chain-button-causes-the-dashboard-to-reload-thus-closing-the-invoice-view-and-unselecting-the-invoice branch September 18, 2024 10:05

coderabbitai bot mentioned this pull request Nov 24, 2024

feat: Add Chain Information to Invoice Dashboard #218

Merged

coderabbitai bot mentioned this pull request Dec 2, 2024

Feat/lit protocol #191

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

On changing network, causes to the dashboard to refetch data#137

On changing network, causes to the dashboard to refetch data#137
sstefdev merged 3 commits intomainfrom
95-bad-ux-on-the-invoice-view-the-switch-chain-button-causes-the-dashboard-to-reload-thus-closing-the-invoice-view-and-unselecting-the-invoice

sstefdev commented Sep 17, 2024 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Sep 17, 2024 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

MantisClone left a comment •

edited

Loading

Uh oh!

Uh oh!

MantisClone Sep 17, 2024

Uh oh!

sstefdev Sep 18, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

sstefdev commented Sep 17, 2024 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Problem

Solution

Summary by CodeRabbit

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Sep 17, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Assessment against linked issues

Possibly related PRs

Suggested reviewers

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

MantisClone left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

MantisClone Sep 17, 2024

Choose a reason for hiding this comment

Uh oh!

sstefdev Sep 18, 2024

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

sstefdev commented Sep 17, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Sep 17, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

MantisClone left a comment •

edited

Loading