betagouv / preuve-covoiturage

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

Carpool v2: policy service migration #2478

Closed nmrgt closed 6 months ago

nmrgt commented 6 months ago

fix #2475

Summary by CodeRabbit

coderabbitai[bot] commented 6 months ago

Walkthrough

The recent updates introduce significant enhancements to the carpool policy management system, focusing on integrating a new version of carpool data (v2). These changes include database migrations to add new columns and indices, updates to data seeding methods, and adjustments to data schemas and testing files to accommodate new identity and operator fields.

Changes

File Path Change Summary
api/src/db/migrations/...update_policy_incentives.js Adds migration script for updating carpool policy incentives.
api/src/db/migrations/policy/...migrate_to_carpool_v2.up.sql Alters policy.incentives table to add new columns and indices.
api/src/pdc/providers/seed/Migrator.ts
api/src/pdc/providers/seed/carpools.ts
Updates to carpool data seeding methods and structure.
api/src/pdc/services/policy/engine/helpers/limits.spec.ts Updates test references for passenger and driver identities, adds new operator fields.
shared/acquisition/common/schemas/...
shared/cee/common/ceeSchema.ts
Modifies identity key validation in schemas to use a regular expression pattern.

Assessment against linked issues

Objective Addressed Explanation
Support for carpool v2 in the policy service (#2475)
Addition of "operator_journey_id" column (#2475)
Utilization of carpool v2 data instead of policy.trip (#2475)
Continued use of carpoolv1._id for backward compatibility (#2475) It's unclear if backward compatibility is maintained as the changes primarily focus on carpool v2.

Poem

🐇 CodeRabbit's Ode to Carpool v2 🚗💨
In the land of code, where the bits align,
A new carpool version, v2, so fine!
With fields anew and schemas tight,
Our policies update through the night.
Here's to changes, big and small,
May our carpool data never stall!


Recent Review Details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between d174f8721c6a37f0ad8d29699c107dff8343845a and 34ee98167977c92215b6e7b75d32ef49df6ca4f8.
Files selected for processing (1) * api/src/pdc/services/cee/actions/ImportCeeIdentityAction.integration.spec.ts (1 hunks)
Additional comments not posted (1)
api/src/pdc/services/cee/actions/ImportCeeIdentityAction.integration.spec.ts (1)
`44-44`: Ensure the `identity_key` is validated against the new regex pattern in the tests.
Verification successful --- The verification process has confirmed that the `identity_key` is indeed validated against the specified regex pattern in the `ImportCeeIdentityAction.integration.spec.ts` file. This aligns with the expectations set in the review comment, ensuring that the new field `identity_key` adheres to the necessary validation criteria within the test environment. **Conclusion:** - The `identity_key` validation against the regex pattern `[a-f0-9]{64}` is present in the test file as required.
Scripts Executed The following scripts were executed for the analysis: --- Script: ```shell #!/bin/bash # Description: Verify that the `identity_key` is validated against the regex pattern in the test file. # Test: Search for the regex pattern validation for `identity_key`. Expect: Matches. rg --files-with-matches --type typescript $'^[a-f0-9]{64}$' "api/src/pdc/services/cee/actions/ImportCeeIdentityAction.integration.spec.ts" ``` Length of output: 172 --- --- Script: ```shell #!/bin/bash # Description: Verify that the `identity_key` is validated against the regex pattern in the test file. # Test: Search for the regex pattern validation for `identity_key`. Expect: Matches. rg --files-with-matches 'identity_key.*[a-f0-9]{64}' "api/src/pdc/services/cee/actions/ImportCeeIdentityAction.integration.spec.ts" ``` Length of output: 208
--- 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.