hotfxes around the approximate GPS value endpoints

[Baalmart]

Description

hotfxes around the approximate GPS value endpoints

Changes Made

• hotfxes around the approximate GPS value endpoints

Testing

• Tested locally
• Tested against staging environment
• Relevant tests passed: [List test names]

Affected Services

• Which services were modified:
  • Device Registry

Endpoints Ready for Testing

• New endpoints ready for testing:
  • GET approximate coordiantes
  • POST approximate coordinates

API Documentation Updated?

• Yes, API documentation was updated
• No, API documentation does not need updating

Additional Notes

hotfxes around the approximate GPS value endpoints

Summary by CodeRabbit

• New Features
  • Introduced two new routes for handling approximate coordinates:
    • POST /approximate for creating coordinates with validation.
    • GET /approximate for retrieving coordinates with validation.
• Improvements
  • Enhanced validation for latitude and longitude across new and existing routes.

[coderabbitai]

Caution

Review failed

The pull request is closed.

📝 Walkthrough

📝 Walkthrough

Walkthrough

The changes in this pull request enhance the handling of approximate coordinates in the device registry API. The createApproximateCoordinates method in create-site.js has been updated to destructure properties from a merged object of req.body, req.query, and req.params. Additionally, two new routes for POST and GET requests to /approximate have been introduced in sites.js, which include validation for latitude and longitude. The validation for existing routes has also been adjusted to ensure stricter requirements for these fields.

Changes

File Path	Change Summary
src/device-registry/controllers/create-site.js	Modified createApproximateCoordinates method to destructure properties from a merged object of req.body, req.query, and req.params.
src/device-registry/routes/v2/sites.js	Added POST and GET routes at /approximate for handling approximate coordinates with validation for latitude and longitude. Updated validation for existing /nearest routes.

Possibly related PRs

• adding more return fields to summary of devices #3506: This PR modifies the dbProjections object in the same file as the main PR, affecting properties related to geographical data, which may relate to the handling of coordinates in the createApproximateCoordinates method.
• just reducing the payload for devices summary endpoint #3679: This PR also alters the dbProjections object, specifically adding exclusions for fields related to devices and grids, which could impact how approximate coordinates are processed in conjunction with the changes made in the main PR.
• Removed the .customSanitizer() blocks that were forcing 5 decimal places #3802: This PR modifies the validation logic for latitude and longitude fields in src/device-registry/routes/v2/sites.js, which is directly related to the changes made in the main PR regarding how coordinates are handled in the createApproximateCoordinates method.

🌍 In the realm of coordinates, we now find,
Flexibility and checks, all intertwined.
With routes for the approximate, clear and bright,
Latitude and longitude, validated right!
A dance of data, from body to query,
Enhancing our API, making it merry! 🎉

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.

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

[codecov]

Codecov Report

Attention: Patch coverage is 10.52632% with 17 lines in your changes missing coverage. Please review.

Project coverage is 11.77%. Comparing base (fcdeffc) to head (8c3d2cf).

Files with missing lines	Patch %	Lines
src/device-registry/routes/v2/sites.js	11.11%	16 Missing ⚠️
src/device-registry/controllers/create-site.js	0.00%	1 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##           staging    #3848      +/-   ##
===========================================
- Coverage    11.77%   11.77%   -0.01%     
===========================================
  Files          114      114              
  Lines        15205    15223      +18     
  Branches       274      274              
===========================================
+ Hits          1791     1793       +2     
- Misses       13414    13430      +16     

Files with missing lines	Coverage Δ
src/device-registry/controllers/create-site.js	3.65% <0.00%> (ø)
src/device-registry/routes/v2/sites.js	21.32% <11.11%> (-1.56%)	⬇️

[github-actions]

Device registry changes in this PR available for preview here