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

issueid #0000 updated telemetry npm package #253

Conversation

ajinkyapandetekdi
Copy link
Collaborator

@ajinkyapandetekdi ajinkyapandetekdi commented Jan 10, 2025

Summary by CodeRabbit

  • Dependencies
    • Removed old telemetry SDK @project-sunbird/telemetry-sdk
    • Added new telemetry SDK @tekdi/all-telemetry-sdk to project dependencies
  • Telemetry
    • Updated telemetry service import to the new SDK
    • Maintained existing telemetry initialization and event handling logic

Copy link

coderabbitai bot commented Jan 10, 2025

Walkthrough

The pull request introduces a new telemetry SDK dependency to the project. The changes involve updating the package.json file to include the @tekdi/all-telemetry-sdk package and modifying the import statement in src/App.js to use the new telemetry SDK. The core functionality remains consistent, with only the telemetry service provider being switched.

Changes

File Change Summary
package.json Removed dependency @project-sunbird/telemetry-sdk and added @tekdi/all-telemetry-sdk@^0.0.32
src/App.js Updated telemetry SDK import from @project-sunbird/telemetry-sdk to @tekdi/all-telemetry-sdk and reformatted handleBeforeUnload function for readability

Sequence Diagram

sequenceDiagram
    participant App as Application
    participant Telemetry as Telemetry SDK
    
    App->>Telemetry: Initialize SDK
    App->>Telemetry: Track Events
    App->>Telemetry: Sync Events
    Telemetry-->>App: Event Handling Complete
Loading

Possibly related PRs


📜 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 78764b1 and b816d69.

📒 Files selected for processing (1)
  • package.json (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • package.json

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

@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

🧹 Nitpick comments (1)
src/App.js (1)

77-79: Improve code readability using optional chaining.

Replace multiple && operators with optional chaining for better readability and maintainability.

-      window.telemetry &&
-        window.telemetry.syncEvents &&
-        window.telemetry.syncEvents();
+      window.telemetry?.syncEvents?.();
🧰 Tools
🪛 Biome (1.9.4)

[error] 77-79: Change to an optional chain.

Unsafe fix: Change to an optional chain.

(lint/complexity/useOptionalChain)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 7041ea6 and 78764b1.

📒 Files selected for processing (2)
  • package.json (1 hunks)
  • src/App.js (2 hunks)
🧰 Additional context used
🪛 Biome (1.9.4)
src/App.js

[error] 77-79: Change to an optional chain.

Unsafe fix: Change to an optional chain.

(lint/complexity/useOptionalChain)

🔇 Additional comments (3)
src/App.js (2)

Line range hint 1-120: PR title seems inconsistent with changes.

The PR title mentions "Jumble word issue" but the changes are related to switching telemetry SDKs. Please clarify if:

  1. These changes are intended to fix the jumble word issue
  2. The PR title needs to be updated to reflect the actual changes
🧰 Tools
🪛 Biome (1.9.4)

[error] 77-79: Change to an optional chain.

Unsafe fix: Change to an optional chain.

(lint/complexity/useOptionalChain)


11-11: Verify compatibility with the new telemetry SDK.

The switch from @project-sunbird/telemetry-sdk to @tekdi/all-telemetry-sdk is a significant change. Ensure that:

  1. All telemetry events are being captured correctly
  2. The new SDK provides the same interface for initialize, end, and other telemetry methods used in the application
package.json (1)

17-17: Verify the early version of the new SDK.

The new SDK is at version 0.0.32, which typically indicates it's in early development. Please ensure:

  1. The package is stable enough for production use
  2. There are no breaking changes in recent versions

@ajinkyapandetekdi ajinkyapandetekdi changed the title Jumble word issue issueid #0000 updated telemetry npm package Jan 10, 2025
Copy link

@gouravmore gouravmore merged commit aaa9790 into Sunbird-ALL:all-1.3-feedback-change Jan 10, 2025
2 checks passed
This was referenced Jan 10, 2025
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