betagouv / preuve-covoiturage

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

Service Export #2526

Closed jonathanfallon closed 1 month ago

jonathanfallon commented 2 months ago

Summary by CodeRabbit

coderabbitai[bot] commented 2 months ago

Walkthrough

The update introduces new middleware, modifies exported methods and classes, and enhances notification and logging functionalities. Key changes include updating method signatures to align with new parameters, simplifying and restructuring code imports, adding detailed documentation, and initiating default settings. These provide improved code organization, better error handling, and more robust middleware functionality.

Changes

File Path Change Summary
api/src/config/contacts.ts Added contacts.ts to manage support email and full name constants.
api/src/pdc/middlewares/DefaultTimezoneMiddleware.ts Introduced middleware for default timezone setting.
api/src/pdc/providers/middleware/CastToArrayMiddleware.ts Updated comments and function signature for casting properties.
api/src/pdc/providers/middleware/CopyFromContextMiddleware.ts Introduced copyFromContextMiddleware for custom data copying.
api/src/pdc/providers/middleware/HasPermissionMiddleware.ts
api/src/pdc/providers/middleware/ValidateDateMiddleware.ts
Updated process method signatures and improved documentation.
api/src/pdc/providers/notification/NotificationMailTransporter.ts Enhanced transporter initialization, configuration handling, and added new moustache method.
api/src/pdc/services/apdf/commands/ExportCommand.ts Updated description for --verbose option in ExportCommand.
api/src/pdc/services/application/config/permissions.ts Updated operator import path.
api/src/pdc/services/export/ServiceProvider.ts
api/src/pdc/services/export/actions/CreateAction.integration.spec.ts
api/src/pdc/services/export/actions/CreateActionV2.ts
api/src/pdc/services/export/actions/CreateActionV3.ts
Modified imports, adjusted middleware parameters, and test case configurations.
api/src/pdc/services/export/commands/ProcessCommand.ts Added storage and notify properties, and updated call method logic.
api/src/pdc/services/export/models/Campaign.ts
api/src/pdc/services/export/models/Export.ts
api/src/pdc/services/export/models/ExportParams.ts
Relocated import paths and updated ExportStatus enum and types in Export.ts.
api/src/pdc/services/export/repositories/ExportRepository.ts Added recipients method in ExportRepositoryInterface and ExportRepository class.
api/src/pdc/services/export/services/FileCreatorService.ts Changed write method return type, removed wrap method and integrated its functionality.
api/src/pdc/services/export/services/LogService.ts Added a new logger.error method call in exportFailed.
api/src/pdc/services/export/services/NotificationService.ts Introduced NotificationService with additional methods for notifications.
api/src/ilos/connection-postgres/PostgresConnection.ts Altered logging level from info to debug in PgPool class.

Poem

🌸 A rabbit coded through the night, Updating paths and setting right. With middleware sleek and smooth, In the code, it found its groove. Emails flew with much delight, Debug logs brought errors to light. Code so clean, a wondrous sight, The rabbit hopped, all filled with might. 🐇


[!TIP]

Early access features: enabled We are currently testing the following features in early access: - **OpenAI `gpt-4o` model for code reviews and chat**: OpenAI claims that this model is better at understanding and generating code than the previous models. We seek your feedback over the next few weeks before making it generally available. Note: - You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file. - Please join our [Discord Community](https://discord.com/invite/GsXnASn26c) to provide feedback and report issues. - OSS projects are currently opted into early access features by default.

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.