refactor token routes definitions

[Baalmart]

Description

Refactor token routes definitions

Changes Made

• Refactor token routes definitions
• refactored the validation logic
• Ensure that the input validation for token creation is working by fixing a runtime error.

Testing

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

Affected Services

• Which services were modified:
  • Auth Service

Endpoints Ready for Testing

• New endpoints ready for testing:
  • create token
  • verify token

API Documentation Updated?

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

Additional Notes

refactor token routes definitions

Summary by CodeRabbit

• New Features

  • Introduced a new module alias @validators for improved module resolution.
  • Added a new route for listing tokens with unknown IPs.
  • Expanded token management capabilities with comprehensive validation and new endpoints for IP management.

• Bug Fixes

  • Enhanced validation logic for token and IP address operations.

• Tests

  • Implemented a comprehensive suite of unit tests for validation functions.

• Documentation

  • Updated validation functions to ensure clarity and maintainability.

[coderabbitai]

Caution

Review failed

The pull request is closed.

📝 Walkthrough

📝 Walkthrough

Walkthrough

The pull request introduces several changes to the auth-service of the application. Key modifications include the addition of a new module alias for validators in the package.json, a complete restructuring of the token router tests to utilize Jest, and significant updates to the token management routes for improved validation. New validation functions have been implemented, enhancing the clarity and maintainability of the code. Additionally, a new file for unit tests related to validation functions has been created, ensuring robust testing of the new validation logic.

Changes

File Path	Change Summary
src/auth-service/package.json	Added module alias @validators to _moduleAliases.
src/auth-service/routes/v2/test/ut_tokens.js	Restructured tests to use Jest; expanded test coverage for token management and IP blacklisting/whitelisting.
src/auth-service/routes/v2/tokens.js	Updated validation logic; replaced express-validator with custom validators; added new routes for token management.
src/auth-service/routes/v2/tokens.old.js	Implemented a new router for token management with various endpoints and validation logic using express-validator.
src/auth-service/validators/test/ut_token.validators.js	Created unit tests for validation functions related to tenant and token management.
src/auth-service/validators/token.validators.js	Introduced validation middleware functions for tenant, token, and IP address handling.

Possibly related issues

• Refactor 'listExpiringTokens' and 'listExpiredTokens' to reduce code duplication #3641: The refactor of listExpiringTokens and listExpiredTokens aims to reduce code duplication, which aligns with the overall goal of enhancing maintainability in the token management logic.

Possibly related PRs

• Enhancements for expired and expiring tokens #3244: Changes related to token expiration may connect with the new validation logic introduced in this PR.
• refactoring the createValidateSelectedSitesField middleware function #3658: Refactoring validation logic for selected sites directly relates to the new validators added in this PR.
• Enhance Middleware to Support Validation of Optional Selected Sites as Array or Object #3699: Enhancements to middleware for validating selected sites are relevant to the new validation functions introduced.
• refactoring the devices routes #3709: Refactoring of device routes may involve validation logic that connects with the changes in this PR.

"In the realm of tokens, a new alias shines,
Validators unite, with clearer designs.
Jest takes the stage, tests now refined,
IPs and tenants, all neatly aligned.
A codebase reborn, with structure and grace,
In the world of auth, we've found our place!" 🎉

---

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

All modified and coverable lines are covered by tests ✅

Project coverage is 11.76%. Comparing base (319c59f) to head (a4eaef5).

Additional details and impacted files

@@           Coverage Diff            @@
##           staging    #3852   +/-   ##
========================================
  Coverage    11.76%   11.76%           
========================================
  Files          114      114           
  Lines        15218    15218           
  Branches       274      274           
========================================
  Hits          1791     1791           
  Misses       13427    13427           

[github-actions]

Auth-service changes in this PR available for preview here

[github-advanced-security]

CodeQL found more than 20 potential problems in the proposed changes. Check the Files changed tab for more details.