Skip to content

fix: avoid redundant getNodeInfo() call on app start#3849

Open
myxmaster wants to merge 1 commit intoZeusLN:masterfrom
myxmaster:remove-nodeinfostore-channels-reaction
Open

fix: avoid redundant getNodeInfo() call on app start#3849
myxmaster wants to merge 1 commit intoZeusLN:masterfrom
myxmaster:remove-nodeinfostore-channels-reaction

Conversation

@myxmaster
Copy link
Copy Markdown
Collaborator

Description

NodeInfoStore had a MobX reaction that called getNodeInfo() whenever ChannelsStore.channels was written. During startup, fetchData() already calls getNodeInfo() sequentially before getChannels() runs, so when getChannels() resolves and writes to this.channels, the reaction fired a second redundant getNodeInfo().

The reaction was introduced in #2720 (commit 9d8b330), probably to keep nodeInfo.currentBlockHeight fresh for the LSPS7 lease expiry display in Channel.tsx.

Fix: remove the broad reaction from NodeInfoStore and move the targeted getNodeInfo() call into LSPStore's existing channels reaction, which is already gated on supportsLSPScustomMessage() && lspPubkey && channel belongs to LSP. Both reactions watch the same observable, so the LSP reaction fires in every scenario where the original one did, but only for users who actually have an LSP channel configured, and never unconditionally on startup.

No LSPS7 behaviour is lost: currentBlockHeight is read at navigation time, which is after node data has been fetched on startup - and for live channel changes, the LSPStore reaction now refreshes it.

This pull request is categorized as a:

  • New feature
  • Bug fix
  • Code refactor
  • Configuration change
  • Locales update
  • Quality assurance
  • Other

Checklist

  • I’ve run yarn run tsc and made sure my code compiles correctly
  • I’ve run yarn run lint and made sure my code didn’t contain any problematic patterns
  • I’ve run yarn run prettier and made sure my code is formatted correctly
  • I’ve run yarn run test and made sure all of the tests pass

Testing

If you modified or added a utility file, did you add new unit tests?

  • No, I’m a fool
  • Yes
  • N/A

I have tested this PR on the following platforms (please specify OS version and phone model/VM):

  • Android
  • iOS

I have tested this PR with the following types of nodes (please specify node version and API version where appropriate):

  • Embedded LND
  • LND (REST)
  • LND (Lightning Node Connect)
  • Core Lightning (CLNRest)
  • Nostr Wallet Connect
  • LndHub

Locales

  • I’ve added new locale text that requires translations
  • I’m aware that new translations should be made on the ZEUS Transfix page and not directly to this repo

Third Party Dependencies and Packages

  • Contributors will need to run yarn after this PR is merged in
  • 3rd party dependencies have been modified:
    • verify that package.json and yarn.lock have been properly updated
    • verify that dependencies are installed for both iOS and Android platforms

Other:

  • Changes were made that require an update to the README
  • Changes were made that require an update to onboarding

@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request optimizes the application's startup sequence by addressing an unnecessary API call. It refactors how node information is fetched, preventing a duplicate request during initialization and ensuring that critical data, like the current block height, is still updated efficiently and only when necessary, particularly for users leveraging LSP channels.

Highlights

  • Redundant API Call Removed: Eliminated a redundant getNodeInfo() call that was firing on app startup due to a MobX reaction in NodeInfoStore, which was triggered after getChannels() resolved.
  • Node Info Update Relocated: Moved the getNodeInfo() call to an existing MobX reaction within LSPStore, ensuring that node information is still updated when relevant channels change, but only for users with configured LSP channels.
  • LSPS7 Lease Expiry Display Maintained: Confirmed that the currentBlockHeight for LSPS7 lease expiry display remains accurate, as it's either fetched during initial navigation or updated by the new LSPStore reaction for live channel changes.
Changelog
  • stores/LSPStore.ts
    • Added a call to this.nodeInfoStore.getNodeInfo() within the existing MobX reaction that monitors channelsStore.channels.
  • stores/NodeInfoStore.ts
    • Removed the reaction import from MobX.
    • Deleted the MobX reaction block from the constructor that previously called this.getNodeInfo() when channelsStore.channels changed.
Activity
  • The pull request is categorized as a bug fix.
  • The author has confirmed that tsc, lint, prettier, and test checks have passed.
  • Testing was performed on Android with an LND (REST) node.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request addresses a performance issue by removing a redundant getNodeInfo() call that occurred on application startup. The change involves removing a broad MobX reaction from NodeInfoStore that was triggered every time the channel list was updated. Instead, the getNodeInfo() call is moved into a more specific reaction within LSPStore, ensuring it only runs when there are changes to LSP-related channels. This is a well-reasoned optimization that correctly targets the intended functionality (keeping block height fresh for LSPS7) without the performance overhead of unnecessary API calls. The implementation is clean and aligns with the detailed explanation in the pull request description.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant