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: set default log level to warn #2039

Merged

Conversation

saikumarrs
Copy link
Member

@saikumarrs saikumarrs commented Feb 12, 2025

PR Description

Updated the default log level of the legacy SDK to "warn". This will allow the deprecated warning to be printed on the console for NPM installations.

Linear task (optional)

https://linear.app/rudderstack/issue/SDK-2949/add-deprecation-warnings-in-legacy-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 the default logging configuration so that, by default, warnings and less severe messages (such as informational and debug logs) are recorded. This change provides enhanced visibility for monitoring and troubleshooting without requiring manual configuration adjustments.

@saikumarrs saikumarrs requested a review from a team as a code owner February 12, 2025 11:30
Copy link
Contributor

coderabbitai bot commented Feb 12, 2025

📝 Walkthrough

Walkthrough

The pull request updates the default logging level within the logging utility. The constant DEF_LOG_LEVEL in the log utility file is changed from LOG_LEVEL_ERROR to LOG_LEVEL_WARN. As a result, upon initialization, the logger will now capture warning-level messages (and those more verbose) by default, instead of only error-level messages. The internal control flow, particularly in the setLogLevel method, remains the same.

Changes

File Change Summary
packages/analytics-js-common/.../utils/logUtil.js Updated DEF_LOG_LEVEL from LOG_LEVEL_ERROR to LOG_LEVEL_WARN, altering the default log output.

Sequence Diagram(s)

(No sequence diagrams generated as the control flow remains unchanged.)

Possibly related PRs

Suggested reviewers

  • ChryssaAliferi
  • vgupta98

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 2be4b83 and 6182c3b.

📒 Files selected for processing (1)
  • packages/analytics-js-common/src/v1.1/utils/logUtil.js (1 hunks)
🧰 Additional context used
🧠 Learnings (1)
packages/analytics-js-common/src/v1.1/utils/logUtil.js (1)
Learnt from: MoumitaM
PR: rudderlabs/rudder-sdk-js#1876
File: packages/analytics-js/src/services/Logger/Logger.ts:14-14
Timestamp: 2024-11-12T15:14:23.319Z
Learning: In 'packages/analytics-js/src/services/Logger/Logger.ts', changing `DEFAULT_LOG_LEVEL` from `'ERROR'` to `'LOG'` is intentional.
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: Bundle size checks
  • GitHub Check: Security and code quality checks
  • GitHub Check: Unit Tests and Lint
  • GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (1)
packages/analytics-js-common/src/v1.1/utils/logUtil.js (1)

5-5: LGTM! Change aligns with the requirement to show deprecation warnings.

The update to use LOG_LEVEL_WARN as the default log level will ensure that deprecated warnings are printed on the console. Users can still adjust the verbosity using setLogLevel if needed.

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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.

Copy link

codecov bot commented Feb 12, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 61.36%. Comparing base (2be4b83) to head (6182c3b).
Report is 1 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #2039   +/-   ##
========================================
  Coverage    61.36%   61.36%           
========================================
  Files          478      478           
  Lines        16393    16393           
  Branches      3239     3240    +1     
========================================
  Hits         10060    10060           
+ Misses        5118     5109    -9     
- Partials      1215     1224    +9     

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

Copy link

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 Module Federation Mapping - Modern - CDN 331 B 331 B (0%) 512 B
Plugins - Legacy - CDN 13.66 KB 13.66 KB (0%) 14 KB
Plugins - Modern - CDN 5.64 KB 5.64 KB (0%) 6 KB
Common - No bundling 17.79 KB 17.82 KB (+0.18% ▲) 18.4 KB
Load Snippet 762 B 762 B (0%) 1 KB
Core (v1.1) - NPM (ESM) 30.4 KB 30.39 KB (-0.03% ▼) 32 KB
Core (v1.1) - NPM (CJS) 30.63 KB 30.59 KB (-0.14% ▼) 32 KB
Core (v1.1) - NPM (UMD) 30.48 KB 30.44 KB (-0.13% ▼) 32 KB
Core (Content Script - v1.1) - NPM (ESM) 30.01 KB 29.98 KB (-0.08% ▼) 30.5 KB
Core (Content Script - v1.1) - NPM (CJS) 30.18 KB 30.17 KB (-0.05% ▼) 30.5 KB
Core (Content Script - v1.1) - NPM (UMD) 30.08 KB 30 KB (-0.28% ▼) 30.5 KB
Core (v1.1) - Legacy - CDN 32.32 KB 32.31 KB (-0.04% ▼) 32.5 KB
Core (v1.1) - Modern - CDN 30.38 KB 30.36 KB (-0.08% ▼) 32 KB
Service Worker - Legacy - NPM (ESM) 30.59 KB 30.59 KB (0%) 31 KB
Service Worker - Legacy - NPM (CJS) 30.86 KB 30.86 KB (0%) 31 KB
Service Worker - Legacy - NPM (UMD) 30.6 KB 30.6 KB (0%) 31 KB
Service Worker - Modern - NPM (ESM) 25.71 KB 25.71 KB (0%) 26 KB
Service Worker - Modern - NPM (CJS) 25.98 KB 25.98 KB (0%) 26.5 KB
Service Worker - Modern - NPM (UMD) 25.73 KB 25.73 KB (0%) 26 KB
Core - Legacy - NPM (ESM) 47.27 KB 47.27 KB (0%) 48 KB
Core - Legacy - NPM (CJS) 47.51 KB 47.51 KB (0%) 48 KB
Core - Legacy - NPM (UMD) 47.31 KB 47.31 KB (0%) 48 KB
Core - Legacy - CDN 47.41 KB 47.41 KB (0%) 47.5 KB
Core - Modern - NPM (ESM) 26.79 KB 26.79 KB (0%) 27 KB
Core - Modern - NPM (CJS) 27.01 KB 27.01 KB (0%) 27.1 KB
Core - Modern - NPM (UMD) 26.81 KB 26.81 KB (0%) 27 KB
Core - Modern - CDN 27.04 KB 27.04 KB (0%) 27.5 KB
Core (Bundled) - Legacy - NPM (ESM) 47.27 KB 47.27 KB (0%) 48 KB
Core (Bundled) - Legacy - NPM (CJS) 47.55 KB 47.55 KB (0%) 48 KB
Core (Bundled) - Legacy - NPM (UMD) 47.31 KB 47.31 KB (0%) 48 KB
Core (Bundled) - Modern - NPM (ESM) 38.5 KB 38.5 KB (0%) 39 KB
Core (Bundled) - Modern - NPM (CJS) 38.77 KB 38.77 KB (0%) 39 KB
Core (Bundled) - Modern - NPM (UMD) 38.53 KB 38.53 KB (0%) 39 KB
Core (Content Script) - Legacy - NPM (ESM) 47.25 KB 47.25 KB (0%) 48 KB
Core (Content Script) - Legacy - NPM (CJS) 47.49 KB 47.49 KB (0%) 48 KB
Core (Content Script) - Legacy - NPM (UMD) 47.28 KB 47.28 KB (0%) 48 KB
Core (Content Script) - Modern - NPM (ESM) 38.44 KB 38.44 KB (0%) 39 KB
Core (Content Script) - Modern - NPM (CJS) 38.71 KB 38.71 KB (0%) 39 KB
Core (Content Script) - Modern - NPM (UMD) 38.46 KB 38.46 KB (0%) 39 KB
All Integrations - Legacy - CDN 94.93 KB 94.91 KB (-0.02% ▼) 95.3 KB
All Integrations - Modern - CDN 90.38 KB 90.36 KB (-0.03% ▼) 91 KB

@saikumarrs saikumarrs merged commit f5387e0 into develop Feb 12, 2025
13 checks passed
@saikumarrs saikumarrs deleted the feature/sdk-2949-add-deprecation-warnings-in-legacy-sdk-2 branch February 12, 2025 12:16
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