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(change-operator): Add missing mileage field when removing all operators #17404

Merged
merged 2 commits into from
Jan 6, 2025

Conversation

johannaagma
Copy link
Member

@johannaagma johannaagma commented Jan 3, 2025

...

Attach a link to issue if relevant

What

Specify what you're trying to achieve

Why

Specify why you need to achieve this

Screenshots / Gifs

Attach Screenshots / Gifs to help reviewers understand the scope of the pull request

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 operator management by adding optional mileage tracking when closing operators without a contract.
  • Improvements

    • Updated method to support optional mileage data transmission during operator closure process.

@johannaagma johannaagma requested a review from a team as a code owner January 3, 2025 16:11
Copy link
Contributor

coderabbitai bot commented Jan 3, 2025

Walkthrough

The pull request introduces a modification to the saveOperators method in the VehicleOperatorsClient class. The change involves adding a new optional mileage parameter to the method, which can be included when closing operators without a contract. This enhancement allows for the transmission of mileage data during the API call, specifically within the postCloseOperatorsWithoutContractModel object.

Changes

File Change Summary
libs/clients/transport-authority/vehicle-operators/src/lib/vehicleOperatorsClient.service.ts Updated saveOperators method to include optional mileage parameter in the postCloseOperatorsWithoutContractModel object

Suggested labels

automerge


📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between dd1b223 and f15e27a.

📒 Files selected for processing (1)
  • libs/clients/transport-authority/vehicle-operators/src/lib/vehicleOperatorsClient.service.ts (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
libs/clients/transport-authority/vehicle-operators/src/lib/vehicleOperatorsClient.service.ts (1)

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

  • Reusability of components and hooks across different NextJS apps.
  • TypeScript usage for defining props and exporting types.
  • Effective tree-shaking and bundling practices."
🔇 Additional comments (1)
libs/clients/transport-authority/vehicle-operators/src/lib/vehicleOperatorsClient.service.ts (1)

138-138: Confirm handling of the optional mileage field.

If mileage is null or omitted, confirm that the downstream service (closeWithoutcontractPost) can handle a missing or null mileage value gracefully. Additionally, ensure that all calling sites passing mileage to this method are aware that the parameter is optional.

Would you like a script to search for all invocations of saveOperators to verify that mileage is properly passed or handled?


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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

@johannaagma johannaagma added the automerge Merge this PR as soon as all checks pass label Jan 3, 2025
Copy link

codecov bot commented Jan 3, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 35.70%. Comparing base (56d6e6e) to head (d92de77).
Report is 1 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main   #17404      +/-   ##
==========================================
+ Coverage   35.67%   35.70%   +0.03%     
==========================================
  Files        6932     6931       -1     
  Lines      148878   148746     -132     
  Branches    42538    42492      -46     
==========================================
+ Hits        53107    53108       +1     
+ Misses      95771    95638     -133     
Flag Coverage Δ
api 3.33% <ø> (ø)
application-system-api 38.73% <ø> (+0.01%) ⬆️
application-template-api-modules 27.67% <ø> (-0.01%) ⬇️

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

Files with missing lines Coverage Δ
...perators/src/lib/vehicleOperatorsClient.service.ts 18.36% <ø> (ø)

... 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 56d6e6e...d92de77. Read the comment docs.

@datadog-island-is
Copy link

Datadog Report

All test runs 0c60ff1 🔗

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

Test Services
Service Name Failed Known Flaky New Flaky Passed Skipped Total Time Code Coverage Change Test Service View
api 0 0 0 4 0 2.62s 1 no change Link
application-system-api 0 0 0 46 0 2m 9.95s 1 no change Link
application-template-api-modules 0 0 0 118 0 2m 4.85s 1 no change Link

@kodiakhq kodiakhq bot merged commit 139ef83 into main Jan 6, 2025
41 checks passed
@kodiakhq kodiakhq bot deleted the fix/mileage-remove-operator branch January 6, 2025 13:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automerge Merge this PR as soon as all checks pass
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants