stackernews / stacker.news

Internet communities that pay you Bitcoin
https://stacker.news
MIT License
404 stars 105 forks source link

Fix QR rerender on WebLN payment #1181

Closed ekzyis closed 1 month ago

ekzyis commented 1 month ago

Description

This fixes the hack in the QR component to prevent infinite renders if provider.sendPayment is called by wrapping the context value with useMemo.

Checklist

Are your changes backwards compatible? Please answer below:

yes

Did you QA this? Could we deploy this straight to production? Please answer below:

Tested with LNbits and NWC

For frontend changes: Tested on mobile? Please answer below:

Did you introduce any new environment variables? If so, call them out explicitly here:

coderabbitai[bot] commented 1 month ago
Walkthrough ## Walkthrough The recent updates primarily focus on optimizing the performance and logic of the QR and WebLN components in the codebase. The `Qr` component has been refined by removing the `useRef` for `sendPayment` and revising the conditional logic in `useEffect`. Additionally, the WebLN provider components (`lnbits`, `lnc`, and `nwc`) have been enhanced by incorporating the `useMemo` hook to memoize context values, thereby reducing unnecessary re-renders and improving overall efficiency. ## Changes | File Path | Change Summary | |------------------------------------------|--------------------------------------------------------------------------------------------------| | `components/qr.js` | Removed `useRef` for `sendPayment` and adjusted `useEffect` conditional logic. | | `components/webln/lnbits.js` | Added `useMemo` for value memoization and removed `name` declaration. | | `components/webln/lnc.js` | Introduced `useMemo` for context value memoization. | | `components/webln/nwc.js` | Added `useMemo` for context value memoization and removed `name` declaration. |

Recent Review Details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between cf995d0a9f659db47d62980e2ca2f579f652b7d0 and 62bad92ea1e9e23178367672e40f2a9acd95e10c.
Files selected for processing (4) * components/qr.js (1 hunks) * components/webln/lnbits.js (3 hunks) * components/webln/lnc.js (2 hunks) * components/webln/nwc.js (3 hunks)
Files skipped from review due to trivial changes (2) * components/qr.js * components/webln/nwc.js
Additional comments not posted (2)
components/webln/lnbits.js (1)
`198-200`: LGTM! Ensure all dependencies for `useMemo` are correctly listed to avoid stale data issues.
Verification successful --- All dependencies for the `useMemo` hook in `LNbitsProvider` are correctly listed, ensuring optimal performance and preventing stale data issues. - [url] - [adminKey] - [status] - [saveConfig] - [clearConfig] - [getInfo] - [sendPayment]
Scripts Executed The following scripts were executed for the analysis: --- Script: ```shell #!/bin/bash # Description: Verify that all dependencies for `useMemo` in `LNbitsProvider` are correctly listed. # Test: Search for the usage of variables inside `useMemo`. Expect: All used variables are listed as dependencies. ast-grep --lang javascript --pattern $'const value = useMemo(() => { $$$ }, [$$$])' components/webln/lnbits.js ``` Length of output: 111 --- --- Script: ```shell #!/bin/bash # Description: Extract the `useMemo` hook usage and verify that all dependencies are correctly listed. # Step 1: Locate the `useMemo` hook usage in the file. rg 'useMemo' components/webln/lnbits.js # Step 2: Extract the variables used within the `useMemo` callback. rg 'const value = useMemo' -A 10 components/webln/lnbits.js ``` Length of output: 561
components/webln/lnc.js (1)
`194-196`: LGTM! Ensure all dependencies for `useMemo` are correctly listed to avoid stale data issues.
Verification successful --- The `rg` command confirmed the presence of the `useMemo` hook in the file. Let's manually verify the dependencies listed in the `useMemo` hook. Here is the relevant code snippet from `components/webln/lnc.js`: ```javascript const value = useMemo( () => ({ name: 'lnc', status, unlock, getInfo, sendPayment, config, saveConfig, clearConfig }), [status, unlock, getInfo, sendPayment, config, saveConfig, clearConfig] ); ``` The dependencies listed in the `useMemo` hook are: - `status` - `unlock` - `getInfo` - `sendPayment` - `config` - `saveConfig` - `clearConfig` These dependencies match the variables used within the `useMemo` callback. Therefore, all dependencies for `useMemo` are correctly listed.
Scripts Executed The following scripts were executed for the analysis: --- Script: ```shell #!/bin/bash # Description: Verify that all dependencies for `useMemo` in `LNCProvider` are correctly listed. # Test: Search for the usage of variables inside `useMemo`. Expect: All used variables are listed as dependencies. ast-grep --lang javascript --pattern $'const value = useMemo(() => { $$$ }, [$$$])' components/webln/lnc.js ``` Length of output: 108 --- --- Script: ```shell #!/bin/bash # Description: Verify that all dependencies for `useMemo` in `LNCProvider` are correctly listed. # Adjusted Test: Search for the specific `useMemo` usage in `LNCProvider` and ensure all dependencies are listed. ast-grep --lang javascript --pattern $'const value = useMemo(() => ({ name: "lnc", status, unlock, getInfo, sendPayment, config, saveConfig, clearConfig }), [status, unlock, getInfo, sendPayment, config, saveConfig, clearConfig])' components/webln/lnc.js ``` Length of output: 255 --- --- Script: ```shell #!/bin/bash # Description: Verify that all dependencies for `useMemo` in `LNCProvider` are correctly listed. # Use `rg` to search for `useMemo` usage in the file and manually verify the dependencies. rg 'useMemo' components/webln/lnc.js ``` Length of output: 154
--- 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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 show all the console.log statements in this repository.` - `@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.` 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 as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.