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

chore(air-discount-scheme): Empty data logging #16072

Merged
merged 5 commits into from
Sep 19, 2024

Conversation

thordurhhh
Copy link
Member

@thordurhhh thordurhhh commented Sep 19, 2024

What

Empty data logging for ADS

Why

Throwing errors on user-error. No need for that, too many errors reported when it's just an empty response from natreg.

Checklist:

  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • Formatting passes locally with my changes
  • I have rebased against main before asking for a review

Summary by CodeRabbit

  • New Features

    • Enhanced logging capabilities in the National Registry and User services for improved observability.
  • Bug Fixes

    • Adjusted error handling in the User service to log warnings instead of throwing errors when no records are found.
  • Tests

    • Introduced mock logging providers in the test suites for UserService, DiscountController, and DiscountService to simulate logging behavior during tests.

@thordurhhh thordurhhh requested a review from a team as a code owner September 19, 2024 10:03
Copy link
Contributor

coderabbitai bot commented Sep 19, 2024

Walkthrough

The changes involve the addition of logging functionality in the NationalRegistryService and UserService classes. In NationalRegistryService, a logging statement is added to the getUser method to log when an individual is not found. In UserService, a logger is injected, and a warning log is added when no records are found in the National Registry, altering the method's control flow to return an empty array instead of throwing an error. Mock logging providers are also added to the test suites for both services to enhance test isolation.

Changes

File Path Change Summary
apps/.../nationalRegistry/nationalRegistry.service.ts Added logging statement in getUser method when individual not found.
apps/.../user/user.service.ts Injected Logger in UserService, added warning log for missing National Registry records, and altered control flow to return an empty array.
apps/.../user/test/unit/user.service.spec.ts Added mock implementation of LOGGER_PROVIDER in test setup for UserService.
apps/.../discount/test/unit/discount.controller.spec.ts Added mock implementation of LOGGER_PROVIDER in test setup for DiscountController.
apps/.../discount/test/unit/discount.service.spec.ts Added mock implementation of LOGGER_PROVIDER in test setup for DiscountService.

Possibly related PRs

  • fix(multiple): remove phone from error logs #15897: The changes in this PR enhance error logging functionality, similar to the logging improvements made in the getUser method of the NationalRegistryService, indicating a focus on better observability and error handling in the application.

Suggested labels

automerge

Suggested reviewers

  • thordurhhh
  • sigruntg

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

@thorkellmani thorkellmani left a comment

Choose a reason for hiding this comment

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

LGTM 🌻

@thordurhhh thordurhhh added the deprecated:automerge (Disabled) Merge this PR as soon as all checks pass label Sep 19, 2024
Copy link

codecov bot commented Sep 19, 2024

Codecov Report

Attention: Patch coverage is 40.00000% with 3 lines in your changes missing coverage. Please review.

Project coverage is 36.70%. Comparing base (3716660) to head (f3f971d).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
...cheme/backend/src/app/modules/user/user.service.ts 50.00% 2 Missing ⚠️
...dules/nationalRegistry/nationalRegistry.service.ts 0.00% 1 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main   #16072      +/-   ##
==========================================
+ Coverage   36.66%   36.70%   +0.04%     
==========================================
  Files        6746     6735      -11     
  Lines      138686   138459     -227     
  Branches    39397    39377      -20     
==========================================
- Hits        50852    50827      -25     
+ Misses      87834    87632     -202     
Flag Coverage Δ
air-discount-scheme-backend 54.10% <40.00%> (-0.01%) ⬇️
api 3.39% <ø> (ø)
api-domains-air-discount-scheme 36.85% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
...dules/nationalRegistry/nationalRegistry.service.ts 19.64% <0.00%> (-0.36%) ⬇️
...cheme/backend/src/app/modules/user/user.service.ts 77.58% <50.00%> (-0.60%) ⬇️

... and 22 files with indirect coverage changes


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 3716660...f3f971d. Read the comment docs.

@oddsson oddsson added deprecated:automerge (Disabled) Merge this PR as soon as all checks pass and removed deprecated:automerge (Disabled) Merge this PR as soon as all checks pass labels Sep 19, 2024
@thordurhhh thordurhhh removed the deprecated:automerge (Disabled) Merge this PR as soon as all checks pass label Sep 19, 2024
@datadog-island-is
Copy link

datadog-island-is bot commented Sep 19, 2024

Datadog Report

All test runs 9ea2061 🔗

3 Total Test Services: 0 Failed, 3 Passed
➡️ Test Sessions change in coverage: 5 no change

Test Services
Service Name Failed Known Flaky New Flaky Passed Skipped Total Time Code Coverage Change Test Service View
air-discount-scheme-backend 0 0 0 81 0 29.91s 1 no change Link
api 0 0 0 4 0 2.79s 1 no change Link
api-domains-air-discount-scheme 0 0 0 6 0 19.68s 1 no change Link

@thordurhhh thordurhhh added the deprecated:automerge (Disabled) Merge this PR as soon as all checks pass label Sep 19, 2024
@kodiakhq kodiakhq bot merged commit 93a02be into main Sep 19, 2024
35 checks passed
@kodiakhq kodiakhq bot deleted the ads/logging-for-empty-data branch September 19, 2024 12:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deprecated:automerge (Disabled) Merge this PR as soon as all checks pass
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants