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

chore: fix sonarqube scan #1995

Merged
merged 1 commit into from
Jan 7, 2025
Merged

Conversation

saikumarrs
Copy link
Member

@saikumarrs saikumarrs commented Jan 7, 2025

PR Description

I've used the latest SonarQube action in the workflow as suggested by Sonar.
Also, paths in the reports are fixed per the latest action.

Additionally, optimised the tests workflow by not building the packages.

The warning we used to get in the workflows:

[SonarScanner](https://github.com/rudderlabs/rudder-sdk-js/actions/runs/12595041635/job/35103551750#step:11:30)
This action is deprecated and will be removed in a future release. Please use the sonarqube-scan-action action instead. The sonarqube-scan-action is a drop-in replacement for this action.

Linear task (optional)

https://linear.app/rudderstack/issue/SDK-2826/move-error-reporting-functionality-to-the-core-sdk

Cross Browser Tests

Please confirm you have tested for the following browsers:

  • Chrome
  • Firefox
  • IE11

Sanity Suite

  • All sanity suite test cases pass locally

Security

  • The code changed/added as part of this pull request won't create any security issues with how the software is being used.

Summary by CodeRabbit

  • Chores
    • Updated path variables in GitHub runner script to improve path handling and replacement logic
    • Modified path prefix configurations to include trailing slashes for more consistent path management

@saikumarrs saikumarrs self-assigned this Jan 7, 2025
@saikumarrs saikumarrs requested a review from a team as a code owner January 7, 2025 16:05
Copy link
Contributor

coderabbitai bot commented Jan 7, 2025

📝 Walkthrough

Walkthrough

The pull request modifies the fix-reports-path-in-github-runner.sh script, focusing on adjusting path-related variables for report generation. The changes involve removing a specific prefix replacement path, and adding trailing slashes to absolute path variables for both default and self-hosted GitHub runner environments. These modifications aim to improve path handling and replacement mechanisms within the script's path processing logic.

Changes

File Change Summary
scripts/fix-reports-path-in-github-runner.sh - Removed defaultPrefixToReplace value, setting it to an empty string
- Added trailing slash to defaultAbsolutePathPrefix
- Added trailing slash to selfHostedAbsolutePathPrefix

The changes are minimal and focused on path variable modifications in the shell script, which likely impact how file paths are processed during report generation in GitHub runner environments.


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.

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

@saikumarrs
Copy link
Member Author

@coderabbitai review

Copy link
Contributor

coderabbitai bot commented Jan 7, 2025

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

Copy link

sonarqubecloud bot commented Jan 7, 2025

@saikumarrs
Copy link
Member Author

@coderabbitai review

Copy link
Contributor

coderabbitai bot commented Jan 7, 2025

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@saikumarrs
Copy link
Member Author

@coderabbitai review

Copy link
Contributor

coderabbitai bot commented Jan 7, 2025

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

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: 0

🧹 Nitpick comments (1)
scripts/fix-reports-path-in-github-runner.sh (1)

4-4: Remove unused variable defaultAbsolutePathPrefix.

The defaultAbsolutePathPrefix variable is declared but never used in the script. If it's not needed for external use, consider removing it to improve code maintainability.

-defaultAbsolutePathPrefix="home/runner/work/rudder-sdk-js/rudder-sdk-js/"
🧰 Tools
🪛 Shellcheck (0.10.0)

[warning] 4-4: defaultAbsolutePathPrefix appears unused. Verify use (or export if used externally).

(SC2034)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0dfb893 and 5c924bc.

⛔ Files ignored due to path filters (2)
  • .github/workflows/unit-tests-and-lint.yml is excluded by !**/*.yml
  • package.json is excluded by !**/*.json
📒 Files selected for processing (1)
  • scripts/fix-reports-path-in-github-runner.sh (1 hunks)
🧰 Additional context used
🪛 Shellcheck (0.10.0)
scripts/fix-reports-path-in-github-runner.sh

[warning] 4-4: defaultAbsolutePathPrefix appears unused. Verify use (or export if used externally).

(SC2034)

⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Bundle size checks
🔇 Additional comments (2)
scripts/fix-reports-path-in-github-runner.sh (2)

3-3: Verify the empty prefix replacement with SonarQube documentation.

The removal of the "/github/workspace" prefix suggests a change in path handling for the new SonarQube action. Please ensure this aligns with the official documentation for the new sonarqube-scan-action.

✅ Verification successful

Empty prefix replacement is correct for path normalization

The empty prefix is the right approach as the script's purpose is to strip absolute paths from coverage, eslint, and sonar reports, making them portable across different environments. The script correctly handles both default and self-hosted runner paths, ensuring consistent report paths for SonarQube analysis.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check if the new SonarQube action documentation mentions path handling changes
gh api repos/SonarSource/sonarqube-scan-action/contents/README.md | jq -r '.content' | base64 -d | grep -A 5 -B 5 "github/workspace"

Length of output: 227


Script:

#!/bin/bash
# Find references to the script and its usage
rg -l "fix-reports-path-in-github-runner" --type yaml --type sh

# Show the content of the script to understand the full context
cat scripts/fix-reports-path-in-github-runner.sh

# Look for test files related to this script
fd test.*sh$ scripts/

Length of output: 1084


4-5: Review path concatenation in sed commands.

The addition of trailing slashes to path prefixes combined with leading slashes in some sed patterns could lead to double slashes (e.g., //). While this might work, it's better to maintain consistent path handling.

🧰 Tools
🪛 Shellcheck (0.10.0)

[warning] 4-4: defaultAbsolutePathPrefix appears unused. Verify use (or export if used externally).

(SC2034)

Copy link

github-actions bot commented Jan 7, 2025

size-limit report 📦

Name Size (Base) Size (Current) Size Limit Status
Cookies Utils - Legacy - NPM (ESM) 1.54 KB 1.54 KB (0%) 2 KB
Cookies Utils - Legacy - NPM (CJS) 1.75 KB 1.75 KB (0%) 2 KB
Cookies Utils - Legacy - NPM (UMD) 1.54 KB 1.54 KB (0%) 2 KB
Cookies Utils - Modern - NPM (ESM) 1.17 KB 1.17 KB (0%) 1.5 KB
Cookies Utils - Modern - NPM (CJS) 1.4 KB 1.4 KB (0%) 1.5 KB
Cookies Utils - Modern - NPM (UMD) 1.16 KB 1.16 KB (0%) 1.5 KB
Plugins Module Federation Mapping - Legacy - CDN 332 B 332 B (0%) 512 B
Plugins - Legacy - CDN 15.75 KB 15.75 KB (0%) 16 KB
Plugins Module Federation Mapping - Modern - CDN 331 B 331 B (0%) 512 B
Plugins - Modern - CDN 7.2 KB 7.2 KB (0%) 7.5 KB
Common - No bundling 17.79 KB 17.81 KB (+0.11% ▲) 18.4 KB
Load Snippet 762 B 762 B (0%) 1 KB
Core (v1.1) - NPM (ESM) 30.25 KB 30.25 KB (0%) 32 KB
Core (v1.1) - NPM (CJS) 30.47 KB 30.47 KB (0%) 32 KB
Core (v1.1) - NPM (UMD) 30.29 KB 30.29 KB (0%) 32 KB
Core (Content Script - v1.1) - NPM (ESM) 29.81 KB 29.81 KB (0%) 30.5 KB
Core (Content Script - v1.1) - NPM (CJS) 29.97 KB 29.97 KB (0%) 30.5 KB
Core (Content Script - v1.1) - NPM (UMD) 29.81 KB 29.81 KB (0%) 30 KB
Core - Legacy - CDN 48.99 KB 48.99 KB (0%) 49 KB
Core - Modern - CDN 25.02 KB 25.02 KB (0%) 25.5 KB
Service Worker - Legacy - NPM (ESM) 30.62 KB 30.62 KB (0%) 31 KB
Service Worker - Legacy - NPM (CJS) 30.85 KB 30.85 KB (0%) 31 KB
Service Worker - Legacy - NPM (UMD) 30.58 KB 30.58 KB (0%) 31 KB
Service Worker - Modern - NPM (ESM) 25.71 KB 25.71 KB (0%) 26 KB
Service Worker - Modern - NPM (CJS) 26 KB 26 KB (0%) 26.5 KB
Service Worker - Modern - NPM (UMD) 25.75 KB 25.75 KB (0%) 26 KB
Core - Legacy - NPM (ESM) 48.79 KB 48.79 KB (0%) 49 KB
Core - Legacy - NPM (CJS) 49.05 KB 49.05 KB (0%) 49.1 KB
Core - Legacy - NPM (UMD) 48.84 KB 48.84 KB (0%) 49 KB
Core - Modern - NPM (ESM) 24.75 KB 24.75 KB (0%) 25 KB
Core - Modern - NPM (CJS) 24.94 KB 24.94 KB (0%) 25.5 KB
Core - Modern - NPM (UMD) 24.77 KB 24.77 KB (0%) 25 KB
Core (Bundled) - Legacy - NPM (ESM) 48.79 KB 48.79 KB (0%) 49 KB
Core (Bundled) - Legacy - NPM (CJS) 49.11 KB 49.11 KB (0%) 49.2 KB
Core (Bundled) - Legacy - NPM (UMD) 48.84 KB 48.84 KB (0%) 49 KB
Core (Bundled) - Modern - NPM (ESM) 39.69 KB 39.69 KB (0%) 40 KB
Core (Bundled) - Modern - NPM (CJS) 39.98 KB 39.98 KB (0%) 40.5 KB
Core (Bundled) - Modern - NPM (UMD) 39.78 KB 39.78 KB (0%) 40 KB
Core (Content Script) - Legacy - NPM (ESM) 48.29 KB 48.29 KB (0%) 48.5 KB
Core (Content Script) - Legacy - NPM (CJS) 48.52 KB 48.52 KB (0%) 48.6 KB
Core (Content Script) - Legacy - NPM (UMD) 48.25 KB 48.25 KB (0%) 48.5 KB
Core (Content Script) - Modern - NPM (ESM) 39.22 KB 39.22 KB (0%) 39.5 KB
Core (Content Script) - Modern - NPM (CJS) 39.44 KB 39.44 KB (0%) 40 KB
Core (Content Script) - Modern - NPM (UMD) 39.26 KB 39.26 KB (0%) 39.5 KB
All Integrations - Legacy - CDN 94.72 KB 94.72 KB (0%) 95.3 KB
All Integrations - Modern - CDN 90.29 KB 90.29 KB (0%) 91 KB

Copy link

codecov bot commented Jan 7, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 61.27%. Comparing base (0dfb893) to head (5c924bc).
Report is 1 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #1995   +/-   ##
========================================
  Coverage    61.27%   61.27%           
========================================
  Files          484      484           
  Lines        16616    16616           
  Branches      3329     3331    +2     
========================================
  Hits         10182    10182           
- Misses        5225     5243   +18     
+ Partials      1209     1191   -18     

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

@saikumarrs saikumarrs merged commit c928e6e into develop Jan 7, 2025
13 of 14 checks passed
@saikumarrs saikumarrs deleted the chore.fix-sonar-scan-sdk-2826 branch January 7, 2025 16:28
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.

2 participants