more input validations for BULK updates of devices

[Baalmart]

Description

more input validations for BULK updates of devices

Changes Made

• more input validations for BULK updates of devices

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:
  • BULK update devices

API Documentation Updated?

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

Additional Notes

more input validations for BULK updates of devices

Summary by CodeRabbit

• New Features

  • Enhanced validation logic for bulk updates of device-related data, restricting the fields that can be modified.

• Bug Fixes

  • Improved input validation process for bulk updates by refining the allowed fields.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 11.68%. Comparing base (9608d2d) to head (a38c7bd).
Report is 2 commits behind head on staging.

Additional details and impacted files

@@           Coverage Diff            @@
##           staging    #4049   +/-   ##
========================================
  Coverage    11.68%   11.68%           
========================================
  Files          114      114           
  Lines        15427    15427           
  Branches       319      319           
========================================
  Hits          1803     1803           
  Misses       13624    13624           

Files with missing lines	Coverage Δ
...rc/device-registry/validators/device.validators.js	24.41% <ø> (ø)

[coderabbitai]

📝 Walkthrough

Walkthrough

The changes in this pull request focus on the validation logic for device-related data within the device.validators.js file. Specifically, several fields have been removed from the allowedFields array in the validateBulkUpdateDevices function, thereby limiting the attributes that can be updated during bulk operations. The validation for the updateData object has been refined to ensure compliance with this new restriction, while the overall structure of the validation functions remains unchanged.

Changes

File Path	Change Summary
src/device-registry/validators/device.validators.js	Removed multiple fields from the allowedFields array in validateBulkUpdateDevices, refining validation for bulk updates.

Possibly related issues

• Enhance test cases for PUT endpoints in 'src/device-registry/routes/v2/test/ut_devices.js' #3714: The changes in the validation logic may necessitate enhanced test cases for PUT endpoints to ensure they cover the new restrictions on fields.

Possibly related PRs

• adding input validations for the devices update routes #3707: This PR adds input validations for the devices update routes, which is directly related to the validation logic changes in the main PR that restricts the fields that can be updated during bulk operations.
• support for bulk update of devices #4047: This PR introduces support for bulk updates of devices, aligning with the changes in the main PR that modify the validation logic for bulk updates, ensuring only specified fields can be included.

🎉 In the realm of devices, a change we see,
Fields once allowed, now set free.
Validation tightened, a focus anew,
Bulk updates refined, just for you!
With fewer fields, we march ahead,
In the world of data, new paths we tread! 🌟

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4f975a1 and a38c7bd.

📒 Files selected for processing (1)

• src/device-registry/validators/device.validators.js (0 hunks)

💤 Files with no reviewable changes (1)

• src/device-registry/validators/device.validators.js

---

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

[github-actions]

Device registry changes in this PR available for preview here