Refactor Duplicate Site Fields Checker: Improve Efficiency

[Baalmart]

Description

This pull request introduces significant improvements to the Duplicate Site Fields Checker functionality. The main changes focus on enhancing efficiency, improving error handling, and updating the associated unit tests to reflect these changes.

Changes Made

• Refactoring of the main checkDuplicateSiteFields function
• Introduction of helper functions groupSitesByFieldValue and findDuplicatesForField
• Improved error handling and logging
• Simplification of the main logic flow
• Updates to the FIELDS_TO_CHECK configuration

Testing

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

Affected Services

• Which services were modified:
  • device registry

API Documentation Updated?

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

Additional Notes

This pull request introduces significant improvements to the Duplicate Site Fields Checker functionality. The main changes focus on enhancing efficiency, improving error handling, and updating the associated unit tests to reflect these changes.

Summary by CodeRabbit

• New Features

  • Enhanced duplicate site field checking with configurable job scheduling.
  • Improved logging efficiency by consolidating duplicate detection messages.

• Bug Fixes

  • Updated test cases to handle missing fields and special characters more effectively.

• Tests

  • Expanded test coverage for edge cases related to duplicate detection.

[coderabbitai]

Caution

Review failed

The pull request is closed.

📝 Walkthrough

📝 Walkthrough

Walkthrough

The changes in this pull request enhance the functionality of the check-duplicate-site-fields-job.js file by introducing a configurable job scheduling constant and refining the logic for detecting duplicate site fields. The logging mechanism has been improved to consolidate duplicate warnings, and the test suite has been updated to cover new edge cases and refine existing tests. Overall, these modifications aim to streamline the duplicate checking process and enhance test coverage.

Changes

File	Change Summary
src/device-registry/bin/jobs/check-duplicate-site-fields-job.js	- Added constant WARNING_FREQUENCY_HOURS = 6 for job scheduling. - Updated job schedule to use the new constant. - Improved logging for duplicate detection.
src/device-registry/bin/jobs/test/ut_check-duplicate-site-fields-job.js	- Renamed test case for clarity. - Updated tests for handling missing fields and special characters. - Added new edge case tests for duplicates and field values.

Possibly related issues

• Enhance test coverage for check-duplicate-site-fields-job.js #3824: This issue seeks to enhance test coverage for check-duplicate-site-fields-job.js, which aligns with the added tests in this PR.
• Add tests for additional edge cases in check-duplicate-site-fields-job.js #3825: This issue requests the addition of tests for edge cases in check-duplicate-site-fields-job.js, which corresponds to the new edge cases implemented in this PR.

Possibly related PRs

• fix projections for get devices summary #3448: This PR modifies the dbProjections object, which may relate to the fields being projected in the check-duplicate-site-fields-job.js file, particularly regarding how data is fetched and processed.
• adding more return fields to summary of devices #3506: Similar to fix projections for get devices summary #3448, this PR also alters the dbProjections object, affecting how data is retrieved, which could impact the duplicate checking logic in the main PR.
• just reducing the payload for devices summary endpoint #3679: This PR updates the dbProjections object to reduce payload size, which may relate to the efficiency of data retrieval in the duplicate checking process.
• removing the name as one of Site identifiers #3811: This PR removes the unique constraint on the name field in the siteSchema, which directly impacts how duplicates are handled in the context of site identifiers, relevant to the duplicate checking logic in the main PR.

🌟 In the realm of code, where logic does flow,
A job checks for duplicates, now better to know.
With warnings combined, and tests that expand,
The future looks bright, with improvements so grand!
Let's celebrate changes, both clever and bright,
In the world of our code, everything feels right! 🎉

---

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 28.57143% with 5 lines in your changes missing coverage. Please review.

Project coverage is 11.77%. Comparing base (c911f32) to head (eaac0eb).

Files with missing lines	Patch %	Lines
...gistry/bin/jobs/check-duplicate-site-fields-job.js	28.57%	5 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff            @@
##           staging    #3829   +/-   ##
========================================
  Coverage    11.77%   11.77%           
========================================
  Files          114      114           
  Lines        15205    15205           
  Branches       274      274           
========================================
+ Hits          1790     1791    +1     
+ Misses       13415    13414    -1     

Files with missing lines	Coverage Δ
...gistry/bin/jobs/check-duplicate-site-fields-job.js	29.41% <28.57%> (+1.96%)	⬆️

[github-actions]

Device registry changes in this PR available for preview here