For optimisation, reducing default limit from 1000 to 100

[Baalmart]

WHAT DOES THIS PR DO?

• [x] For optimisation,reducing default limit from 1000 to 100

HOW DO I TEST OUT THIS PR?

• [ ] Analytics: Link to Analytics README
• [x] Auth Service: Link to Auth Service README
• [ ] Calibrate: Link to Calibrate README
• [ ] Data Proxy: Link to Data Proxy README
• [ ] Device Monitoring: Link to Device Monitoring README
• [ ] Device Registry: Link to Device Registry README
• [ ] Device Status: Link to Device Status README
• [ ] Device Uptime: Link to Device Uptime README
• [ ] Exceedances: Link to Exceedances README
• [ ] Firebase: Link to Firebase README
• [ ] GP Model: Link to GP Model README
• [ ] Incentives: Link to Incentives README
• [ ] Kafka Connectors: Link to Kafka Connectors
• [ ] Locate: Link to Locate README
• [ ] Metadata: Link to Metadata README
• [ ] Predict: Link to Predict README
• [ ] Spatial: Link to Spatial
• [ ] View: Link to View README
• [ ] Workflows: Link to Workflows README

WHICH ENDPOINTS SHOULD BE READY FOR TESTING?:

• [x] Get users
• [x] Get user information

Summary by CodeRabbit

• Bug Fixes

  • Default pagination limit adjusted from 1000 to 100. This change ensures more efficient loading of user lists and other paginated resources.
  • Improved validation logic for pagination parameters for better handling of invalid input.

• Refactor

  • Updated internal validation functions to use Number.isNaN for improved accuracy in limit and skip parameter checks.

[coderabbitai[bot]]

[!WARNING]

Review failed

The pull request is closed.

Walkthrough

## Walkthrough This update focuses on adjusting pagination parameters in various parts of the authentication service. The default limit for listing and paginating through users and other entities has been reduced from 1000 to 100. Additionally, validation functions now use `Number.isNaN` instead of `isNaN` to check numeric parameters, enhancing the validation process. ## Changes | File Path | Change Summary | |------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `src/auth-service/models/User.js` | Changed default `limit` parameter in `list` function from 1000 to 100. | | .../routes/v2/permissions.js | Default limit value set to 100 instead of 1000 if the provided limit is invalid in pagination validation function. | | .../routes/v2/preferences.js | Adjusted validation logic for pagination parameters, setting default limit to 100 instead of 1000 if invalid. | | .../routes/v2/requests.js | Default limit in `validatePagination` function changed to 100 instead of 1000 when provided limit is less than 1. | | .../routes/v2/roles.js | Changed default limit to 100 from 1000 in pagination validation logic and used `Number.isNaN` for validation. | | .../routes/v2/scopes.js | Modified default limit to 100 from 1000 in `validatePagination` function if parsed limit is less than 1. | | .../routes/v2/searchHistory.js | Set default limit to 100 instead of 1000 in `validatePagination` function if limit is invalid. | | .../routes/v2/tokens.js | Adjusted default limit in `validatePagination` function from 1000 to 100 when provided limit is less than 1. | | .../routes/v2/types.js | Default limit in `validatePagination` function set to 100 instead of 1000 if provided limit is less than 1. | | .../routes/v2/users.js | Modified default limit to 100 from 1000 if provided limit is less than 1. | | .../routes/v2/candidates.js | Updated `validatePagination` function to use `Number.isNaN` and set default limit to 100 from 1000. | | .../routes/v2/checklist.js | Used `Number.isNaN` in `validatePagination` function and set default limit to 100 from 1000 and skip to 0 if values are invalid. | | .../routes/v2/clients.js | Adjusted validation logic in `validatePagination` function to use `Number.isNaN` and set default limit to 100 from 1000. | | .../routes/v2/defaults.js | Modified `validatePagination` function to use `Number.isNaN` for checks and adjust default limit to 100 from 1000, skip to 0 from 0 if values are invalid. | | .../routes/v2/departments.js | Updated `validatePagination` function to use `Number.isNaN`, setting default limit to 100 from 1000. | | .../routes/v2/favorites.js | Changed `validatePagination` function to use `Number.isNaN` and set default limit to 100 from 1000, skip to 0 from 0 if values are invalid. | | .../routes/v2/groups.js | Modified `validatePagination` function to use `Number.isNaN`, setting default limit to 100 from 1000. | | .../routes/v2/inquiries.js | Adjusted `validatePagination` function to use `Number.isNaN` and changed default limit to 100 from 1000 if limit is less than 1. | | .../routes/v2/locationHistory.js | Set default limit to 100 from 1000, skip to 0 from 0 in `validatePagination` function, using `Number.isNaN` for validation. | | .../routes/v2/networks-old.js | Changed default limit in `validatePagination` function to 100 from 1000, skip to 0 from 0 and used `Number.isNaN` for validation. | | .../routes/v2/networks.js | Updated `validatePagination` function to use `Number.isNaN` and set default limit to 100 from 1000. | ## Poem > In the realm of code so bright, > Limits changed to make things light. > From thousands to hundreds, a gentle shift, > Ensuring queries are swift and swift. > With `Number.isNaN`, we validate, > Cleaner, leaner, we paginate. > 🚀 Keep coding great! 🚀

---

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@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 as 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. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

[codecov[bot]]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 30.26%. Comparing base (b1afecb) to head (fdfd917). Report is 25 commits behind head on staging.

Additional details and impacted files

[](https://app.codecov.io/gh/airqo-platform/AirQo-api/pull/3267?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=airqo-platform) ```diff @@ Coverage Diff @@ ## staging #3267 +/- ## ======================================== Coverage 30.26% 30.26% ======================================== Files 184 184 Lines 24522 24522 Branches 3209 3209 ======================================== Hits 7421 7421 Misses 16987 16987 Partials 114 114 ```

[github-actions[bot]]

Auth-service changes in this PR available for preview here

[github-actions[bot]]

Auth-service changes in this PR available for preview here