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: Don't send events with null to Segment #32600

Merged
merged 1 commit into from
Apr 11, 2024
Merged

Conversation

sharat87
Copy link
Member

@sharat87 sharat87 commented Apr 11, 2024

Recently, we made two fixes to SegmentConfig to fix NPEs that were preventing some events from being sent to Segment.

  1. fix: NPE in SegmentConfig #32498
  2. chore: Fix NPE in Segment exception logging #32351

But this ended up sending too much to Segment now. That, and clearly we weren't missing anything by not sending those events with null in them.

So we're bringing back that protection of NPEs. The protection of not sending value-less events to Segment. But in a more, educated way.

We're adding null checks, and not sending anything when we see a null.

Considering that context, a more accurate diff to review would be between the SegmentConfig before those two PRs, and the SegmentConfig in this PR. This diff can be seen here.

@github-actions github-actions bot added the Bug Something isn't working label Apr 11, 2024
@sharat87 sharat87 marked this pull request as ready for review April 11, 2024 10:39
Copy link
Contributor

coderabbitai bot commented Apr 11, 2024

Walkthrough

Walkthrough

This update refines error handling in the analyticsRunner method of SegmentConfig.java. It introduces more precise error logging and conditions, enhancing the clarity and robustness of error management.

Changes

File Path Change Summary
.../appsmith-server/.../SegmentConfig.java Enhanced error logging and handling in analyticsRunner method.

Possibly related issues

  • [Bug]: The Same events are displayed multiple times #16650: Although this issue focuses on reducing duplicate events due to redundant API calls, the improved error handling in this PR could indirectly aid in identifying and resolving such issues by providing clearer error logs and conditions. This could help in debugging and fixing the root causes of duplicate events.

Recent Review Details

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 1de9d15 and 7adb491.
Files selected for processing (1)
  • app/server/appsmith-server/src/main/java/com/appsmith/server/configurations/SegmentConfig.java (2 hunks)
Additional comments not posted (1)
app/server/appsmith-server/src/main/java/com/appsmith/server/configurations/SegmentConfig.java (1)

64-85: The enhanced error handling and logging in the analyticsRunner method are well-implemented and align with the PR's objectives to prevent sending events with null values. However, consider adding a more detailed comment explaining the rationale behind each null check for future maintainability.


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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

final String stackTrace =
ObjectUtils.defaultIfNull(error == null ? null : ExceptionUtils.getStackTrace(error), "");

if (logData.getMessage() == null) {
Copy link
Contributor

Choose a reason for hiding this comment

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

Nit, could you please prepend a common qualifier to these logs so it's easy to check for any kind of failure in logs?

Copy link
Member Author

Choose a reason for hiding this comment

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

I initially did that, but noticed that this log object is for this class, so the log line should show SegmentConfig in it, right? Doesn't it? 🤔

Copy link
Contributor

Choose a reason for hiding this comment

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

Nah I don't think we print that info in our logs, we've explicitly excluded it in our logging pattern.

Copy link
Contributor

Choose a reason for hiding this comment

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

I've approved the PR anyway, this can be an addition, since we might want to fast-track cherry-picking this to master.

Copy link
Member Author

Choose a reason for hiding this comment

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

Hm., I could've sworn we included the category into the log format. 🤷
Perhaps we can add that in? 🤔

@sharat87 sharat87 merged commit c831644 into release Apr 11, 2024
22 of 23 checks passed
@sharat87 sharat87 deleted the chore/bring-back-npe branch April 11, 2024 11:51
sharat87 added a commit that referenced this pull request Apr 11, 2024
Recently, we made two fixes to `SegmentConfig` to fix NPEs that were
preventing some events from being sent to Segment.

1. #32498
2. #32351

But this ended up sending _too much_ to Segment now. That, and clearly
we weren't missing anything by not sending those events with `null` in
them.

So we're bringing back that protection of NPEs. The protection of not
sending value-less events to Segment. But in a more, educated way.

We're adding `null` checks, and not sending anything when we see a
`null`.

Considering that context, a more accurate diff to review would be
between the [`SegmentConfig` before those two
PRs](https://github.com/appsmithorg/appsmith/blob/d6e74bf0122b0e5a91e175c3d2a70fef9fd68bb1/app/server/appsmith-server/src/main/java/com/appsmith/server/configurations/SegmentConfig.java),
and the `SegmentConfig` in this PR. This diff can be seen here.

(cherry picked from commit c831644)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants