Service Export

[jonathanfallon]

Refacto du service Export.

Tickets

• 2350

• 1772

• 1753

• Suivi du refacto Carpool V2
• Dépendances à trip.list
• Documentation à mettre à jour
• Champs du fichier dans la doc

Features

• [x] (back) utilisation de carpool_v2.carpools à la place de trip.list
• [x] (back) export au format XLSX
• [ ] (front) connexion avec le front actuel
• [ ] (front) nouvelle interface : listing des exports, commande, config, etc...
• [ ] (api) commande et téléchargement des exports

Summary by CodeRabbit

• New Features

  • Added export routes for Export V2 and V3.
  • Introduced classes for handling parameter conversion and export request creation.
  • Implemented middleware for setting default timezone and filtering requests based on user permissions.
  • Added sanitize function for string sanitization.
  • Introduced CastToArrayMiddleware for array casting properties.

• Bug Fixes

  • Updated default timezone to "Europe/Paris" for consistency.
  • Enhanced parameter validation and error handling in various services.

• Tests

  • Added test suites for new middleware and functions.
  • Refactored and expanded existing test cases for improved coverage.

• Chores

  • Reordered and organized exports and imports for better readability and maintenance.
  • Updated configuration options in .env.example related to export services.

[coderabbitai[bot]]

Walkthrough

The latest update introduces several enhancements and fixes across the API. It refines configurations, optimizes type handling, improves middleware interfaces, standardizes string sanitization, and enriches export functionalities with new services and middleware actions. Additionally, timezone management has been streamlined, and significant improvements have been made in handling export parameters and authorization checks.

Changes

File(s) / Group of Files	Change Summary
api/.env.example	Added configurations for timespan settings related to export services.
api/src/config/time.ts	Introduced defaultTimezone constant with timezone value "Europe/Paris".
api/src/ilos/common/...	Updated MiddlewareInterface, reorganized exports, removed FunctionMiddlewareInterface.
api/src/ilios/core/...	Replaced FunctionMiddlewareInterface with NextFunction in various methods.
api/src/pdc/helpers/...	Added sanitize function, updated date handling logic, and refactored helper functions.
api/src/pdc/providers/...	Introduced CastToArrayMiddleware, reordered bindings, and updated export routes for V2 and V3.
api/src/pdc/services/export/...	Added new actions, middlewares, and services; streamlined file creation and name handling functionalities.
api/src/pdc/services/policy/...	Integrated defaultTimezone; updated default parameters in ApplyAction and FinalizeAction.
api/src/pdc/services/export/models/	Introduced new methods and parameters adjustments in Campaign, CarpoolRow, Export, and ExportParams.
api/src/pdc/services/export/...	Refactored test cases for new and updated functionalities.

Sequence Diagrams

sequenceDiagram
    participant User
    participant API
    participant Middleware
    participant ExportService

    User->>API: Request export data
    API->>Middleware: Validate request
    Middleware->>ExportService: Process export
    ExportService->>Middleware: Return processed data
    Middleware->>API: Forward data
    API->>User: Respond with export data

Poem

"In the code where changes flow, A bunny's joy begins to show. With sanitized strings and timezones tight, Middleware glides through the night. Exports and permissions, finely tuned, A developer's melody, perfectly attuned."

🐇✨🚀

---

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.