chore: fix this.rootSpan undefined bug in PageLoadInstrumentation

[dvj1988]

Description

Fix this context in the enable method
this.rootSpan is undefined in the fn this.addDeviceAttributes

The issue occurs because this.rootSpan is undefined when the enable method is called. This PR resolves the issue by converting the enable method to an arrow function, ensuring that the this value is preserved from its lexical scope.

Fixes #Issue Number
or
Fixes Issue URL

Warning

If no issue exists, please create an issue first, and check with the maintainers if the issue is valid.

Automation

/ok-to-test tags="@tag.Sanity"

🔍 Cypress test results

Tip

🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/10960896859
Commit: d40ebc1
Cypress dashboard.
Tags: @tag.Sanity
Spec:

---

Fri, 20 Sep 2024 14:53:02 UTC

Communication

Should the DevRel and Marketing teams inform users about this change?

• Yes
• No

Summary by CodeRabbit

• New Features

  • Enhanced page load instrumentation with improved initialization logic.
  • Added a new enable method for future functionality.

• Bug Fixes

  • Streamlined the initialization process for better performance and clarity.

[coderabbitai]

Walkthrough

The PageLoadInstrumentation class has been updated to enhance its initialization and method structure. The init method now includes the registration of a connection change listener and connection attributes, improving the setup process. Additionally, a new enable method has been added as a placeholder. The call to this.init() has been moved to the constructor, ensuring immediate initialization after starting the root span for page load. The previous empty implementation of init has been removed, resulting in a cleaner and more efficient class design.

Changes

File Path	Change Summary
app/client/src/UITelemetry/PageLoadInstrumentation.ts	- Updated init() method to include connection listener registration. - Added enable() method as a placeholder. - Moved this.init() call to the constructor. - Removed previous empty implementation of init.

Possibly related PRs

• chore: Page load instrumentation: add network and device info to page load spans #36395: This PR modifies the PageLoadInstrumentation class in the same file, focusing on enhancing telemetry data collection and updating the enable method.

In the realm of code, changes unfold,
A class reborn, its story told.
With init refined and enable in place,
The structure now shines with newfound grace.
Connection listeners dance in the light,
Page load's journey feels just right! 🎉

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[dvj1988]

/build-deploy-preview skip-tests=true

[github-actions]

Deploying Your Preview: https://github.com/appsmithorg/appsmith/actions/runs/10959785026.
Workflow: On demand build Docker image and deploy preview.
skip-tests: true.
env: ``.
PR: 36459.
recreate: .

[github-actions]

Deploy-Preview-URL: https://ce-36459.dp.appsmith.com

[dvj1988]

/build-deploy-preview skip-tests=true

[github-actions]

Deploying Your Preview: https://github.com/appsmithorg/appsmith/actions/runs/10960255947.
Workflow: On demand build Docker image and deploy preview.
skip-tests: true.
env: ``.
PR: 36459.
recreate: .

[github-actions]

Deploy-Preview-URL: https://ce-36459.dp.appsmith.com

[dvj1988]

/build-deploy-preview skip-tests=true

[github-actions]

Deploying Your Preview: https://github.com/appsmithorg/appsmith/actions/runs/10960910680.
Workflow: On demand build Docker image and deploy preview.
skip-tests: true.
env: ``.
PR: 36459.
recreate: .

[coderabbitai]

Actionable comments posted: 0

Outside diff range and nitpick comments (1)

app/client/src/UITelemetry/PageLoadInstrumentation.ts (1)

71-74: The enable method looks good, but let's tidy it up a bit. 🧹

Since the method is intentionally left empty, we can remove the empty lines to keep the code clean and concise. Here's a quick suggestion:

  enable() {
-   // enable method is present in the base class and needs to be implemented
-   // Leaving it empty as there is no need to do anything here
+   // Required by the base class, intentionally left empty
  }

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 9bbf794 and d40ebc1.

Files selected for processing (1)

• app/client/src/UITelemetry/PageLoadInstrumentation.ts (2 hunks)

Additional comments not posted (1)

app/client/src/UITelemetry/PageLoadInstrumentation.ts (1)

Line range hint 49-69: Excellent work on the init method, class! 👏

The initialization logic looks spot-on. You've done a great job of registering the necessary listeners, adding device attributes, and setting up the observation of resource timings. Keep up the good work!

[github-actions]

Deploy-Preview-URL: https://ce-36459.dp.appsmith.com