Skip to content

Report same page links on local files#17161

Merged
SaschaCowley merged 7 commits into
nvaccess:masterfrom
nvdaes:samePageLinksLocal
Sep 18, 2024
Merged

Report same page links on local files#17161
SaschaCowley merged 7 commits into
nvaccess:masterfrom
nvdaes:samePageLinksLocal

Conversation

@nvdaes

@nvdaes nvdaes commented Sep 11, 2024 •
edited
Loading

Copy link
Copy Markdown
Collaborator

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 nvdaes marked this pull request as ready for review September 11, 2024 19:06
@nvdaes nvdaes requested a review from a team as a code owner September 11, 2024 19:06
@nvdaes nvdaes requested a review from SaschaCowley September 11, 2024 19:06
@nvdaes

nvdaes commented Sep 11, 2024

Copy link
Copy Markdown
Collaborator Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Sep 11, 2024 •
edited
Loading

Copy link
Copy Markdown
Contributor

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

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.

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.

@amirsol81

amirsol81 commented Sep 11, 2024

Copy link
Copy Markdown

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

SaschaCowley
SaschaCowley reviewed Sep 12, 2024
View reviewed changes
Comment thread source/utils/urlUtils.py Outdated
@seanbudd seanbudd added the conceptApproved Similar 'triaged' for issues, PR accepted in theory, implementation needs review. label Sep 17, 2024
@nvdaes nvdaes requested a review from a team as a code owner September 17, 2024 13:10
@nvdaes nvdaes requested a review from Qchristensen September 17, 2024 13:10
@nvdaes

nvdaes commented Sep 17, 2024

Copy link
Copy Markdown
Collaborator Author

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

@SaschaCowley

SaschaCowley commented Sep 17, 2024

Copy link
Copy Markdown
Member

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

@SaschaCowley SaschaCowley marked this pull request as draft September 17, 2024 23:42
@nvdaes nvdaes marked this pull request as ready for review September 18, 2024 05:37
@nvdaes

nvdaes commented Sep 18, 2024

Copy link
Copy Markdown
Collaborator Author

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

SaschaCowley
SaschaCowley approved these changes Sep 18, 2024
View reviewed changes

@SaschaCowley SaschaCowley left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks, @nvdaes.

@SaschaCowley SaschaCowley linked an issue Sep 18, 2024 that may be closed by this pull request
Improve the report link feature #17127
Closed
@SaschaCowley SaschaCowley merged commit 19505f6 into nvaccess:master Sep 18, 2024
@github-actions github-actions Bot added this to the 2025.1 milestone Sep 18, 2024
@coderabbitai coderabbitai Bot mentioned this pull request Nov 24, 2024
Merged
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@SaschaCowley SaschaCowley SaschaCowley approved these changes

@Qchristensen Qchristensen Awaiting requested review from Qchristensen Qchristensen was automatically assigned from nvaccess/userdocs

Assignees

No one assigned

Labels

conceptApproved Similar 'triaged' for issues, PR accepted in theory, implementation needs review.

Projects

None yet

Milestone

2025.1

Development

Successfully merging this pull request may close these issues.

Improve the report link feature

4 participants

@nvdaes @amirsol81 @SaschaCowley @seanbudd