betagouv / preuve-covoiturage

Registre de preuve de covoiturage
https://app.covoiturage.beta.gouv.fr
Apache License 2.0
33 stars 12 forks source link

feat: add geo process command for carpool v2 #2471

Closed nmrgt closed 4 months ago

nmrgt commented 4 months ago

Summary by CodeRabbit

coderabbitai[bot] commented 4 months ago

Walkthrough

The recent updates enhance the CarpoolAcquisitionService by introducing a failedOnly filter and modifying return types for better clarity in processing outcomes. Several repositories received syntax improvements and functional tweaks, particularly in handling parameters and query structuring. Additionally, a new ProcessGeoCommand class enriches the command suite, and ESLint configurations have been adjusted to allow specific console methods.

Changes

File Path Change Summary
.../carpool/providers/CarpoolAcquisitionService.ts Added failedOnly parameter, changed return type, and improved error handling.
.../carpool/repositories/CarpoolGeoRepository.ts Introduced failedOnly parameter in findProcessable and adjusted error handling in updateGeoCodes.
.../carpool/repositories/CarpoolRepository.ts Improved readability by adding space before ! operator.
.../carpool/repositories/CarpoolRequestRepository.ts Reformatted SQL query string for better readability.
.../services/acquisition/ServiceProvider.ts Added ProcessGeoCommand to command list.
.../services/acquisition/commands/ProcessGeoCommand.ts New class for processing acquisition geo data with various controls.
docker/lint/.eslintrc.js Modified ESLint rule to allow 'timeLog'.

🐰✨ A hop, a skip, in the code we dive, New changes arrive, making data thrive. Through lines and queries, we refine and tweak, Ensuring the service is never weak. In the burrow of code, where the carrots grow, We celebrate updates, with a cheerful glow! 🌟🐇


Recent Review Details **Configuration used: CodeRabbit UI**
Commits Files that changed from the base of the PR and between 27f6750b9461c3a804bbc2f69cc23ce391f394cd and d96803999d863578afc6514dd3b0a65390e6e9aa.
Files selected for processing (9) * api/src/pdc/providers/carpool/providers/CarpoolAcquisitionService.integration.spec.ts (2 hunks) * api/src/pdc/providers/carpool/providers/CarpoolAcquisitionService.ts (1 hunks) * api/src/pdc/providers/carpool/repositories/CarpoolGeoRepository.integration.spec.ts (3 hunks) * api/src/pdc/providers/carpool/repositories/CarpoolGeoRepository.ts (3 hunks) * api/src/pdc/providers/carpool/repositories/CarpoolRepository.ts (1 hunks) * api/src/pdc/providers/carpool/repositories/CarpoolRequestRepository.ts (1 hunks) * api/src/pdc/services/acquisition/ServiceProvider.ts (1 hunks) * api/src/pdc/services/acquisition/commands/ProcessGeoCommand.ts (1 hunks) * docker/lint/.eslintrc.js (1 hunks)
Files skipped from review due to trivial changes (3) * api/src/pdc/providers/carpool/providers/CarpoolAcquisitionService.integration.spec.ts * api/src/pdc/providers/carpool/repositories/CarpoolRepository.ts * api/src/pdc/providers/carpool/repositories/CarpoolRequestRepository.ts
Additional comments not posted (7)
docker/lint/.eslintrc.js (1)
`31-31`: Adding 'timeLog' to the 'allow' array in the 'no-console' rule is appropriate for enhanced debugging. Good addition.
api/src/pdc/services/acquisition/commands/ProcessGeoCommand.ts (1)
`5-61`: The implementation of `ProcessGeoCommand` is well-structured and clear. The use of command options and the looping mechanism are correctly implemented.
api/src/pdc/services/acquisition/ServiceProvider.ts (1)
`30-30`: The addition of `ProcessGeoCommand` to the service provider configuration is correctly implemented. Good integration.
api/src/pdc/providers/carpool/repositories/CarpoolGeoRepository.ts (2)
`26-47`: > :memo: **NOTE** > This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [14-44] The modifications to the `findProcessable` method to accept a `failedOnly` parameter and handle it in the SQL query are correctly implemented. --- `72-72`: The update to the `errors` field in the `upsert` method is correctly implemented, ensuring better error handling.
api/src/pdc/providers/carpool/repositories/CarpoolGeoRepository.integration.spec.ts (1)
`39-51`: The formatting changes in the test file improve readability and maintain the functionality of the tests. Good improvements.
api/src/pdc/providers/carpool/providers/CarpoolAcquisitionService.ts (1)
`110-130`: The updates to the `processGeo` method, including the handling of the `failedOnly` parameter and the return of the number of items processed, are correctly implemented. Enhanced error handling and logging are also noted.
--- 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.` 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 a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@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.