Remove add-on update warning when launcher is running

[seanbudd]

Link to issue number:

Fixes #16783

Summary of the issue:

The update notification for add-ons occurs on the NVDA installer.
This should not happen, it should only run where NVDA should write to disk (e.g. manage the state of add-ons).
This excludes secure mode and the launcher environment.

Description of user facing changes

Add-on update notifications should not occur on the launcher any more

Description of development approach

Check NVDAState.shouldWriteToDisk rather than globalVars.appArgs.secure.

Testing strategy:

Tested STR of #16783

Known issues with pull request:

Code Review Checklist:

• Documentation:
  • Change log entry
  • User Documentation
  • Developer / Technical Documentation
  • Context sensitive help for GUI changes
• Testing:
  • Unit tests
  • System (end to end) tests
  • Manual testing
• UX of all users considered:
  • Speech
  • Braille
  • Low Vision
  • Different web browsers
  • Localization in other languages / culture than English
• API is compatible with existing add-ons.
• Security precautions taken.

Summary by CodeRabbit

• New Features
  • Enhanced the logic for automatic addon updates based on disk write permissions and update settings.

[coderabbitai]

Walkthrough

The change in messageDialogs.py modifies the logic for checking updatable addons. Instead of using globalVars.appArgs.secure, it now relies on NVDAState.shouldWriteToDisk() and the automatic updates configuration from config.conf. This prevents addon update notifications during NVDA installation, ensuring a smooth and uninterrupted process.

Changes

File	Change Summary
source/gui/addonStoreGui/controls/...	Modified the logic for addon update checking to use NVDAState.shouldWriteToDisk() and config.conf.

Sequence Diagram(s)

Old Flow

sequenceDiagram
    actor User
    participant NVDA
    participant AddonStore
    User ->> NVDA: Install or Update NVDA
    NVDA ->> AddonStore: Check for updates
    AddonStore -->> NVDA: Return updates
    NVDA ->> User: Show addon update notification

Loading

New Flow

sequenceDiagram
    actor User
    participant NVDA
    participant AddonStore
    User ->> NVDA: Install or Update NVDA
    NVDA ->> NVDA: Check NVDAState.shouldWriteToDisk() & config.conf
    alt Updates allowed
        NVDA ->> AddonStore: Check for updates
        AddonStore -->> NVDA: Return updates
        NVDA ->> User: Show addon update notification
    else No updates
        NVDA -->> User: No notification during installation
    end

Loading

Assessment against linked issues

Objective (Issue #)	Addressed	Explanation
Prevent addon update notification during NVDA installation (#16783)	✅

---

Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 3f0084e and d26d006.

Files selected for processing (1)

• source/gui/addonStoreGui/controls/messageDialogs.py (3 hunks)

Additional context used

Path-based instructions (1)

source/gui/addonStoreGui/controls/messageDialogs.py (2)

Pattern **/*: Focus on code smells, logic errors, edge cases, missing test cases, security flaws and serious issues. Avoid commenting on minor issues such as linting, formatting and style issues. This project uses tabs instead of spaces, do not suggest usage of spaces over tabs. Are there any 'red flags' in this code that might warrant closer investigation from a security standpoint? Explain what makes them suspicious.

---

Pattern **/*.py: _, pgettext, ngettext, and ngettext are defined globally, errors for this being undefined can be ignored.

Additional comments not posted (1)

source/gui/addonStoreGui/controls/messageDialogs.py (1)

550-553: Verify the logic change for checking updatable addons.

The change from globalVars.appArgs.secure to NVDAState.shouldWriteToDisk() ensures that addon update notifications are only shown when NVDA is in a state that allows writing to disk. This is a good change to prevent notifications during installation.

---

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
• Mastodon
• Reddit
• LinkedIn

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

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