Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Update regex to detect all variants of /* istanbul ignore */ comments #3217 #3221

Conversation

khushipatil1523
Copy link
Contributor

@khushipatil1523 khushipatil1523 commented Jan 9, 2025

Issue Number:

Fixes #3217

Description:
What Changed:
The regular expression in the code_coverage_disable_check.py script has been updated to ensure that all variants of the /* istanbul ignore / comment are detected. This includes:
/ istanbul ignore /
/ istanbul ignore next /
/ istanbul ignore line /
/ istanbul ignore next -- https://github.com/preserve */

Snapshots/Videos: dummy test files to check that its working or not
Screenshot 2025-01-09 185826

If relevant, did you update the documentation?

N/A

Does this PR introduce a breaking change?

No

Other information

N/A

Summary by CodeRabbit

  • Chores
    • Updated code coverage disable detection script to improve regex pattern matching for TypeScript files.
    • Enhanced flexibility in identifying code coverage disable statements.

Copy link
Contributor

coderabbitai bot commented Jan 9, 2025

Walkthrough

The pull request modifies the .github/workflows/scripts/code_coverage_disable_check.py script, specifically updating the regular expression in the has_code_coverage_disable function. The change enhances the script's ability to detect code coverage disable statements in TypeScript files by adding flexibility to the regex pattern. The modification allows for an optional comment segment following the next or -line keywords, making the code coverage detection more comprehensive.

Changes

File Change Summary
.github/workflows/scripts/code_coverage_disable_check.py Updated regex pattern to enhance matching of code coverage disable statements in TypeScript files.

Assessment against linked issues

Objective Addressed Explanation
Detect all /* istanbul ignore statements
Handle cases like /* istanbul ignore next -- @preserve */
Maintain existing functionality

Possibly related PRs

Suggested reviewers

  • palisadoes
  • noman2002

Poem

🐰 A regex rabbit's tale of might,
Hunting code coverage with delight,
Flexible patterns, comments in tow,
Catching ignore lines, high and low,
Testing magic, now shining bright! 🔍


📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5825453 and cc76e26.

📒 Files selected for processing (1)
  • .github/workflows/scripts/code_coverage_disable_check.py (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • .github/workflows/scripts/code_coverage_disable_check.py
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Test Application
  • GitHub Check: Analyse Code With CodeQL (javascript)

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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

Copy link

github-actions bot commented Jan 9, 2025

Our Pull Request Approval Process

Thanks for contributing!

Testing Your Code

Remember, your PRs won't be reviewed until these criteria are met:

  1. We don't merge PRs with poor code quality.
    1. Follow coding best practices such that CodeRabbit.ai approves your PR.
  2. We don't merge PRs with failed tests.
    1. When tests fail, click on the Details link to learn more.
    2. Write sufficient tests for your changes (CodeCov Patch Test). Your testing level must be better than the target threshold of the repository
    3. Tests may fail if you edit sensitive files. Ask to add the ignore-sensitive-files-pr label if the edits are necessary.
  3. We cannot merge PRs with conflicting files. These must be fixed.

Our policies make our code better.

Reviewers

Do not assign reviewers. Our Queue Monitors will review your PR and assign them.
When your PR has been assigned reviewers contact them to get your code reviewed and approved via:

  1. comments in this PR or
  2. our slack channel

Reviewing Your Code

Your reviewer(s) will have the following roles:

  1. arbitrators of future discussions with other contributors about the validity of your changes
  2. point of contact for evaluating the validity of your work
  3. person who verifies matching issues by others that should be closed.
  4. person who gives general guidance in fixing your tests

CONTRIBUTING.md

Read our CONTRIBUTING.md file. Most importantly:

  1. PRs with issues not assigned to you will be closed by the reviewer
  2. Fix the first comment in the PR so that each issue listed automatically closes

Other

  1. 🎯 Please be considerate of our volunteers' time. Contacting the person who assigned the reviewers is not advised unless they ask for your input. Do not @ the person who did the assignment otherwise.
  2. Read the CONTRIBUTING.md file make

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5893198 and 243fa54.

📒 Files selected for processing (1)
  • .github/workflows/scripts/code_coverage_disable_check.py (1 hunks)
🧰 Additional context used
🪛 GitHub Actions: PR Workflow
.github/workflows/scripts/code_coverage_disable_check.py

[error] Unauthorized file modification. This file is protected and requires the 'ignore-sensitive-files-pr' label to modify or delete.

⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Analyse Code With CodeQL (javascript)
🔇 Additional comments (1)
.github/workflows/scripts/code_coverage_disable_check.py (1)

41-44: Protected file modification requires special label

The pipeline failure indicates this is a protected file that requires the 'ignore-sensitive-files-pr' label for modification.

Please add the required label to the PR to proceed with the changes.

🧰 Tools
🪛 GitHub Actions: PR Workflow

[error] Unauthorized file modification. This file is protected and requires the 'ignore-sensitive-files-pr' label to modify or delete.

.github/workflows/scripts/code_coverage_disable_check.py Outdated Show resolved Hide resolved
coderabbitai[bot]
coderabbitai bot previously approved these changes Jan 9, 2025
Copy link
Contributor

@palisadoes palisadoes left a comment

Choose a reason for hiding this comment

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

See comment.

.github/workflows/scripts/code_coverage_disable_check.py Outdated Show resolved Hide resolved
coderabbitai[bot]
coderabbitai bot previously approved these changes Jan 9, 2025
@palisadoes palisadoes added the ignore-sensitive-files-pr The contributor has a legitimate reason for editiing protected files label Jan 9, 2025
@palisadoes palisadoes self-requested a review January 9, 2025 15:45
Copy link
Contributor

@palisadoes palisadoes left a comment

Choose a reason for hiding this comment

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

  1. Your change does not cover any future istanbul commands.
  2. Change your script to cover lines that start with /* istanbul and end with */.
  3. Your choice does not cover the situation in this image found in a recent PR and referenced in the issue

image

@palisadoes
Copy link
Contributor

Please fix the failing test

Copy link

codecov bot commented Jan 10, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.17%. Comparing base (5893198) to head (cc76e26).
Report is 8 commits behind head on develop-postgres.

Additional details and impacted files
@@                  Coverage Diff                  @@
##           develop-postgres    #3221       +/-   ##
=====================================================
+ Coverage             10.78%   90.17%   +79.39%     
=====================================================
  Files                   308      330       +22     
  Lines                  7838     8488      +650     
  Branches               1709     1933      +224     
=====================================================
+ Hits                    845     7654     +6809     
+ Misses                 6932      604     -6328     
- Partials                 61      230      +169     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@khushipatil1523
Copy link
Contributor Author

  1. Your change does not cover any future istanbul commands.
  2. Change your script to cover lines that start with /* istanbul and end with */.
  3. Your choice does not cover the situation in this image found in a recent PR and referenced in the issue

image

Thank you for your feedback. I have made the necessary changes to the script to cover lines that start with /* istanbul and end with */. The issue you referenced from the recent PR has been addressed, and the changes are now in place.

Please let me know if there’s anything else you'd like me to adjust.

@palisadoes
Copy link
Contributor

Please test your work with repo files until completely validated

@khushipatil1523
Copy link
Contributor Author

Please test your work with repo files until completely validated

I have tested the script with the repo files by running the command python code_coverage_disable_check.py --directory C:\Users\khush\talawa-admin. The script returned the expected results, and I went through the codebase of the listed files in the output. They really contain variations of /* istanbul ignore next -- @preserve */ .
I'm concerned because there are too many files that contain this comment
Please let me know if any further adjustments are needed.

snapshot:
Screenshot 2025-01-10 112748

@palisadoes palisadoes merged commit eceaad9 into PalisadoesFoundation:develop-postgres Jan 10, 2025
18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ignore-sensitive-files-pr The contributor has a legitimate reason for editiing protected files
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants