Migration Carpool V2 : CEE Applications

[jonathanfallon]

2474

Summary by CodeRabbit

• New Features

  • Added a new migration script to introduce journey_id column in the database.
  • Introduced a function to convert Carpool V2 statuses to Carpool V1 statuses.
  • Added a verbose logging option for database migrations.
  • New target drop_test_databases added for easier test database management.

• Bug Fixes

  • Corrected typos and improved status handling in Carpool and Cee services.

• Chores

  • Updated .gitignore to ignore .pgclirc files.
  • Simplified Docker Compose version declarations for development and end-to-end testing.

• Tests

  • Added comprehensive test cases for status conversion and Cee application registration.

• Documentation

  • Added deprecation notices and updated interface documentation for Carpool and Cee services.

[coderabbitai[bot]]

Walkthrough

This update introduces several enhancements and fixes across the project. Key changes include adding .pgclirc to .gitignore, updating VS Code settings for TypeScript imports, and adding a new drop_test_databases target in the justfile. Significant modifications were made to the database schema and migrations, particularly for the cee_applications table. Additionally, various updates were made to TypeScript files to handle Carpool V2 and V1 status conversions, improve repository methods, and enhance test configurations.

Changes

File(s)	Change Summary
.gitignore	Added .pgclirc to ignored files.
.vscode/settings.json	Updated TypeScript import settings and path mappings.
api/justfile	Added drop_test_databases target.
api/src/db/migrations/...add_journey_id_column.js	Added migration script for journey_id column.
api/src/db/migrations/cee/...add_journey_id_column.*.sql	Modified schema for operator_journey_id and indexes.
api/src/pdc/providers/carpool/helpers/...StatusConverter.*.ts	Added status converter function and tests for Carpool V2 to V1.
api/src/pdc/providers/carpool/interfaces/common.ts	Deprecated CarpoolV1StatusEnum.
api/src/pdc/providers/seed/Migrator.ts	Added verbose property for conditional logging.
api/src/pdc/providers/test/dbMacro.ts	Conditional database retention based on environment variable.
api/src/pdc/services/cee/actions/RegisterCeeAction.*.ts	Updated imports, fixed typos, and enhanced status handling.
api/src/pdc/services/cee/interfaces/CeeRepositoryProviderInterface.ts	Added fields and updated types in interfaces.
api/src/pdc/services/cee/providers/CeeRepositoryProvider.*.ts	Updated SQL queries and table references.
docker-compose.*.yml	Adjusted version declarations.
flake.nix	Added postgresql_14 package.
shared/cee/common/CeeApplicationInterface.ts	Updated types and corrected typos in interface names.
shared/cee/registerApplication.contract.ts	Corrected typos in import statements and interface names.

🐇 In the code, a journey's begun, With columns and tables, a new run. TypeScript's imports now align, Carpool statuses intertwine. Databases drop on command, All changes, perfectly planned. Let's code, let's build, let's shine! 🌟 🐇

---

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.