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(skilavottord): Inspect why traffic endpoint is not always returning data #16151

Merged
merged 3 commits into from
Sep 25, 2024

Conversation

birkirkristmunds
Copy link
Member

@birkirkristmunds birkirkristmunds commented Sep 25, 2024

TS-919

What

  • Added loggers
  • make sure Traffic is only called when needed

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 vehicle deregistration process by ensuring traffic queries only run once vehicle readiness is confirmed.
  • Bug Fixes

    • Improved handling of traffic data retrieval, ensuring robust logging and default responses when no data is available.

- Added loggers
- make sure Traffic is only called when needed
@birkirkristmunds birkirkristmunds requested a review from a team as a code owner September 25, 2024 12:12
Copy link
Contributor

coderabbitai bot commented Sep 25, 2024

Walkthrough

The changes introduce a new state variable in the Confirm component to track the completion of a vehicle deregistration readiness query. The control flow is modified to ensure that a traffic query only executes after confirming the vehicle's readiness. Additionally, the SamgongustofaService class is updated to handle server responses more robustly by checking for entries in the traffic data before processing, improving error handling when no data is available.

Changes

File(s) Change Summary
apps/skilavottord/web/screens/DeregisterVehicle/Confirm/Confirm.tsx Introduced vehicleReadyToDeregisteredQueryCompleted state variable to track query completion; modified traffic query execution based on this state.
apps/skilavottord/ws/src/app/modules/samgongustofa/samgongustofa.service.ts Added conditional checks to handle traffic data responses; logs warnings for missing data and returns a default traffic object when no entries are found.

Possibly related PRs

Suggested labels

automerge

Suggested reviewers

  • helgifr
  • veronikasif

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
Contributor

@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: 0

🧹 Outside diff range and nitpick comments (2)
apps/skilavottord/web/screens/DeregisterVehicle/Confirm/Confirm.tsx (1)

141-145: LGTM: Query callback enhances monitoring, with room for improvement

The addition of the onCompleted callback to SkilavottordVehicleReadyToDeregisteredQuery is a good step towards better monitoring of the traffic data retrieval process. It aligns well with the PR objectives.

However, there's room for a small improvement in the null check:

Consider using an optional chain for a more concise null check:

onCompleted: (data) => {
  if (data?.skilavottordVehicleReadyToDeregistered) {
    setVehicleReadyToDeregisteredQueryCompleted(true)
  }
},

This change will make the code more robust and align with TypeScript best practices. Would you like me to implement this change for you?

🧰 Tools
Biome

[error] 142-142: Change to an optional chain.

Unsafe fix: Change to an optional chain.

(lint/complexity/useOptionalChain)

apps/skilavottord/ws/src/app/modules/samgongustofa/samgongustofa.service.ts (1)

350-392: LGTM! Changes align well with PR objectives.

The implemented changes effectively address the issue of inconsistent data return from the traffic endpoint. The additional logging will greatly facilitate monitoring and debugging. These improvements align perfectly with the stated PR objectives.

Consider using type assertion for better type safety.

For improved type safety, consider using a type assertion when reducing the traffic data:

const traffic = Object.values(result.data).reduce<Traffic>(
  (prev, current) =>
    new Date(prev.useDate) > new Date(current.useDate)
      ? prev
      : current
);

This ensures that TypeScript knows the exact type of traffic without the need for an additional type assertion.

Optimize performance by avoiding multiple getShortPermno calls.

To slightly improve performance, consider storing the result of getShortPermno(permno) in a variable before the logging statements:

const shortPermno = getShortPermno(permno);
logger.info(`car-recycling: Got traffic data for ${shortPermno}`, {
  // ...
});

if (!traffic.outInStatus) {
  logger.warn(`car-recycling: No traffic data being returned for ${shortPermno}`, {
    // ...
  });
}

This avoids calling getShortPermno multiple times with the same argument.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 2366141 and 2f75509.

📒 Files selected for processing (2)
  • apps/skilavottord/web/screens/DeregisterVehicle/Confirm/Confirm.tsx (3 hunks)
  • apps/skilavottord/ws/src/app/modules/samgongustofa/samgongustofa.service.ts (1 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
apps/skilavottord/web/screens/DeregisterVehicle/Confirm/Confirm.tsx (1)

Pattern apps/**/*: "Confirm that the code adheres to the following:

  • NextJS best practices, including file structure, API routes, and static generation methods.
  • Efficient state management and server-side rendering techniques.
  • Optimal use of TypeScript for component and utility type safety."
apps/skilavottord/ws/src/app/modules/samgongustofa/samgongustofa.service.ts (1)

Pattern apps/**/*: "Confirm that the code adheres to the following:

  • NextJS best practices, including file structure, API routes, and static generation methods.
  • Efficient state management and server-side rendering techniques.
  • Optimal use of TypeScript for component and utility type safety."
Biome
apps/skilavottord/web/screens/DeregisterVehicle/Confirm/Confirm.tsx

[error] 142-142: Change to an optional chain.

Unsafe fix: Change to an optional chain.

(lint/complexity/useOptionalChain)

🔇 Additional comments not posted (3)
apps/skilavottord/web/screens/DeregisterVehicle/Confirm/Confirm.tsx (3)

104-107: LGTM: New state variable improves query flow control

The introduction of vehicleReadyToDeregisteredQueryCompleted state variable is a good addition. It helps in controlling the flow of queries by ensuring that the traffic query only runs after confirming the vehicle is ready for deregistration. This aligns well with the PR objective of enhancing the functionality of the traffic endpoint.


155-155: LGTM: Skip condition optimizes query execution

The addition of the skip condition to SkilavottordTrafficQuery is an excellent optimization. It ensures that the traffic query is only executed after confirming that the vehicle is ready for deregistration. This change directly addresses the PR objective of invoking the traffic endpoint only when necessary, potentially improving both performance and reliability.


Line range hint 1-359: Summary: Changes effectively address PR objectives

The modifications in this file successfully address the main objectives of the PR:

  1. The new state variable and query callbacks enhance monitoring of the traffic data retrieval process.
  2. The skip condition ensures that the traffic endpoint is only invoked when necessary.
  3. These changes collectively contribute to improving the consistency and reliability of data returned by the traffic endpoint.

The code adheres to NextJS and TypeScript best practices, with a minor suggestion for improvement in the null check. Overall, these changes should effectively resolve the issues outlined in ticket TS-919.

🧰 Tools
Biome

[error] 142-142: Change to an optional chain.

Unsafe fix: Change to an optional chain.

(lint/complexity/useOptionalChain)

@datadog-island-is
Copy link

datadog-island-is bot commented Sep 25, 2024

Datadog Report

All test runs d3a6236 🔗

35 Total Test Services: 0 Failed, 34 Passed
🔻 Test Sessions change in coverage: 1 decreased (-0.09%), 147 no change

Test Services
This report shows up to 10 services
Service Name Failed Known Flaky New Flaky Passed Skipped Total Time Code Coverage Change Test Service View
air-discount-scheme-web 0 0 0 2 0 7.62s 1 no change Link
api 0 0 0 4 0 3.02s 1 no change Link
application-api-files 0 0 0 12 0 5.63s 1 no change Link
application-core 0 0 0 90 0 18.61s 1 no change Link
application-system-api 0 0 0 111 2 3m 27.14s 1 no change Link
application-template-api-modules 0 0 0 109 0 1m 44.78s 1 no change Link
application-templates-accident-notification 0 0 0 98 0 17.79s 1 no change Link
application-templates-criminal-record 0 0 0 2 0 11.76s 1 no change Link
application-templates-driving-license 0 0 0 13 0 16.53s 1 no change Link
application-templates-example-payment 0 0 0 2 0 11.26s 1 no change Link

🔻 Code Coverage Decreases vs Default Branch (1)

  • skilavottord-ws - jest 25.32% (-0.09%) - Details

Copy link

codecov bot commented Sep 25, 2024

Codecov Report

Attention: Patch coverage is 0% with 11 lines in your changes missing coverage. Please review.

Project coverage is 36.63%. Comparing base (3a2a05f) to head (b47f0e8).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
...app/modules/samgongustofa/samgongustofa.service.ts 0.00% 11 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main   #16151      +/-   ##
==========================================
- Coverage   36.63%   36.63%   -0.01%     
==========================================
  Files        6771     6771              
  Lines      139472   139476       +4     
  Branches    39668    39670       +2     
==========================================
- Hits        51100    51099       -1     
- Misses      88372    88377       +5     
Flag Coverage Δ
air-discount-scheme-web 0.00% <ø> (ø)
api 3.39% <ø> (ø)
application-api-files 57.59% <ø> (ø)
application-core 71.29% <ø> (ø)
application-system-api 41.55% <ø> (+<0.01%) ⬆️
application-template-api-modules 23.62% <ø> (ø)
application-templates-accident-notification 22.14% <ø> (ø)
application-templates-car-recycling 3.12% <ø> (ø)
application-templates-criminal-record 26.63% <ø> (ø)
application-templates-driving-license 18.63% <ø> (ø)
application-templates-estate 12.34% <ø> (ø)
application-templates-example-payment 25.41% <ø> (ø)
application-templates-financial-aid 14.34% <ø> (ø)
application-templates-general-petition 23.68% <ø> (ø)
application-templates-health-insurance 26.62% <ø> (ø)
application-templates-inheritance-report 6.45% <ø> (ø)
application-templates-marriage-conditions 15.23% <ø> (ø)
application-templates-mortgage-certificate 43.96% <ø> (ø)
application-templates-parental-leave 30.15% <ø> (ø)
application-types 6.71% <ø> (ø)
application-ui-components 1.28% <ø> (ø)
application-ui-shell 21.29% <ø> (ø)
auth-react 22.80% <ø> (ø)
clients-charge-fjs-v2 24.11% <ø> (ø)
contentful-apps 5.76% <ø> (ø)
financial-aid-backend 56.52% <ø> (ø)
financial-aid-shared 19.03% <ø> (ø)
island-ui-core 28.52% <ø> (ø)
judicial-system-web 28.19% <ø> (ø)
portals-admin-regulations-admin 1.93% <ø> (ø)
portals-core 16.17% <ø> (ø)
services-auth-personal-representative 45.65% <ø> (ø)
shared-components 27.68% <ø> (ø)
shared-form-fields 31.61% <ø> (ø)
skilavottord-ws 24.24% <0.00%> (-0.11%) ⬇️
web 1.83% <ø> (ø)

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

Files with missing lines Coverage Δ
...app/modules/samgongustofa/samgongustofa.service.ts 50.00% <0.00%> (-2.64%) ⬇️

... and 1 file 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 3a2a05f...b47f0e8. Read the comment docs.

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

@veronikasif veronikasif left a comment

Choose a reason for hiding this comment

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

lgtm 💯

@kodiakhq kodiakhq bot merged commit 33c68ca into main Sep 25, 2024
120 checks passed
@kodiakhq kodiakhq bot deleted the fix/skilavottord-traffic-data-missing branch September 25, 2024 15:59
birkirkristmunds added a commit that referenced this pull request Sep 27, 2024
…ning data (#16151)

- Added loggers
- make sure Traffic is only called when needed

Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
kodiakhq bot added a commit that referenced this pull request Sep 27, 2024
* chore(skilavottord): Inspect why traffic endpoint is not always returning data (#16151)

- Added loggers
- make sure Traffic is only called when needed

Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>

* fix(skilavottord): Error when trying to view and save recycling companies (#16159)

- Fix path when trying to view recycling company
- Fix error when trying to save recycling company

Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>

---------

Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
thoreyjona pushed a commit that referenced this pull request Oct 2, 2024
…ning data (#16151)

- Added loggers
- make sure Traffic is only called when needed

Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
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.

2 participants