Report same page links on local files

[nvdaes]

Link to issue number:

Fixes issue #17127

Summary of the issue:

Same page links are reported, but not on local files.
Fixup of PR #16994

Description of user facing changes

Same page links will be also reported on local files like HTML documents.

Description of development approach

In the samePageURL function, "file" has been added to validSchemes.

Testing strategy:

• Tested manually with NVDA's user guide.
• Performed unit tests.

Known issues with pull request:

None

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 URL comparison functionality to support "file" scheme URLs in addition to "http" and "https".

• Tests

  • Added new test cases to improve coverage for URL comparison, including scenarios for local file URLs and external links.

[nvdaes]

@coderabbitai review

[coderabbitai]

Walkthrough

The pull request introduces modifications to the isSamePageURL function in the URL utility module, enhancing its ability to compare URLs by incorporating support for the "file" scheme alongside the existing "http" and "https" schemes. Additionally, new test cases are added to ensure proper functionality and coverage for the updated logic, particularly concerning local file URLs.

Changes

Files	Change Summary
source/utils/urlUtils.py	Modified isSamePageURL function to include comparison for "file" scheme URLs, alongside "http" and "https".
tests/unit/test_util/test_urlUtils.py	Added tests for local file URL comparisons and differentiation from external HTTP links.

Possibly related issues

• Improve the report link feature #17127: The changes in this PR address the need to report same page links for local files, as highlighted in the issue description.

---

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

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.

Tip

Early access features: enabled

We are currently testing the following features in early access:

• OpenAI o1 for code reviews: OpenAI's new o1 model is being tested for code reviews. This model has advanced reasoning capabilities and can provide more nuanced feedback on your code.

Note:

• You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file.
• • Please join our Discord Community to provide feedback and report issues on the discussion post.

[amirsol81]

@nvdaes Thanks for implementing this! Will it also work in local help systems - a.k.a. CHM files?

[nvdaes]

Thanks @SaschaCowley. I think that your suggestion is addressed and this is ready for review.

[SaschaCowley]

@nvdaes I think something has gone wrong with your merge; I'm seeing 105 changed files.

[nvdaes]

Thanks @SaschaCowley . I think that now it's ready.

[SaschaCowley]

Thanks, @nvdaes.