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: adding logger for undefined source event #3879

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

shrouti1507
Copy link
Contributor

What are the changes introduced in this PR?

We have got bugsnag error :
Screenshot 2024-11-15 at 12 05 03 PM

Adding logger to get more info

What is the related Linear task?

Resolves INT-2873

Please explain the objectives of your changes below

Put down any required details on the broader aspect of your changes. If there are any dependent changes, mandatorily mention them here

Any changes to existing capabilities/behaviour, mention the reason & what are the changes ?

N/A

Any new dependencies introduced with this change?

N/A

Any new generic utility introduced or modified. Please explain the changes.

N/A

Any technical or performance related pointers to consider with the change?

N/A

@coderabbitai review


Developer checklist

  • My code follows the style guidelines of this project

  • No breaking changes are being introduced.

  • All related docs linked with the PR?

  • All changes manually tested?

  • Any documentation changes needed with this change?

  • Is the PR limited to 10 file changes?

  • Is the PR limited to one linear task?

  • Are relevant unit and component test-cases added in new readability format?

Reviewer checklist

  • Is the type of change in the PR title appropriate as per the changes?

  • Verified that there are no credentials or confidential data exposed with the changes.

@devops-github-rudderstack
Copy link
Contributor

Copy link

codecov bot commented Nov 15, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.05%. Comparing base (e90d2ad) to head (cbec731).
Report is 1 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #3879   +/-   ##
========================================
  Coverage    89.05%   89.05%           
========================================
  Files          618      618           
  Lines        33071    33072    +1     
  Branches      7814     7815    +1     
========================================
+ Hits         29452    29453    +1     
  Misses        3336     3336           
  Partials       283      283           

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

Copy link

sonarcloud bot commented Nov 15, 2024

@@ -28,6 +28,11 @@ export class SourceController {
);
ctx.body = resplist;
} catch (err: any) {
Copy link
Collaborator

Choose a reason for hiding this comment

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

No need to mention module again in error message - we have structured logging now. Focus on mentioning the error message.
events can't be logged, it's a security risk - how did you overlooked it ? Is there specific reason to log events ?
cc: @sanpj2292

Copy link
Contributor

Choose a reason for hiding this comment

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

how did you overlooked it ? Is there specific reason to log events ?

The inclusion of events was a call we took to understand what is the event which is causing a problem. The reason is we don't have a lot of context on what kind of event was received to us & even though we get the error message, we would not be in a position to properly identify the problem and come up with a fix.

In this particular bugsnag issue, we saw that sourceEvents came in as a non-array which means there is some problem in adaption logic. And is it undefined, string, object -- we absolutely have no-clue

We will remove events from getting logged but we should definitely find an alternate (if not already in consideration or present) to address this

Copy link
Contributor

Choose a reason for hiding this comment

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

@shrouti1507 let's remove events from the log getting emitted for an error

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.

4 participants