betagouv / preuve-covoiturage

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

fix: APDF listing #2520

Closed jonathanfallon closed 2 months ago

jonathanfallon commented 2 months ago

fix APDF listing and Certificate creation

Summary by CodeRabbit

coderabbitai[bot] commented 2 months ago

Walkthrough

This update enhances various parts of the codebase, prominently introducing null checks for improved robustness, reordering imports for better readability, and refining error handling for clarity. Key changes include adjustments to the pdfDoc initialization, enhanced error messaging in the S3StorageProvider, revisions of property names for consistency, and new import statements alongside some refactored method signatures.

Changes

Files and Changes Grouped Summary
api/src/pdc/providers/pdfcert/PdfCertProvider.ts, .../PdfCertProviderInterfaceResolver.ts Added Buffer import, handled null checks, and adjusted document properties.
api/src/pdc/providers/storage/S3StorageProvider.ts Improved error messages and minor logging adjustments.
.../helpers/buckets.ts Reordered import statements for clarity.
.../apdf/actions/ListAction.ts Reordered imports, added null checks, and enhanced error handling.
.../apdf/providers/StorageRepositoryProvider.ts Updated filter and mapping functions to use new property names (Size to size, Key to key).
.../operator/providers/OperatorPgRepositoryProvider.ts Added Buffer import, reorganized existing imports.
.../user/commands/SeedUsersCommand.ts Introduced Options interface, switched environmental variables access to Deno.env.get, and refined SQL query logic with conflict handling.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant PdfCertProvider
    participant S3StorageProvider
    participant StorageRepositoryProvider
    participant Database

    User->>PdfCertProvider: Request to create PDF Certificate
    PdfCertProvider->>PdfCertProvider: Check for pdfDoc null
    alt pdfDoc is null
        PdfCertProvider->>User: Return error message
    else pdfDoc is not null
        PdfCertProvider->>S3StorageProvider: Create bucket client
        S3StorageProvider->>S3StorageProvider: Validate client creation
        alt Client creation fails
            S3StorageProvider->>PdfCertProvider: Return specific error message
            PdfCertProvider->>User: Return error
        else Client creation successful
            S3StorageProvider->>StorageRepositoryProvider: List objects in bucket
            StorageRepositoryProvider->>Database: Query objects
            Database->>StorageRepositoryProvider: Return object list (mapped to 'size' and 'key')
            StorageRepositoryProvider->>S3StorageProvider: Return object list
            S3StorageProvider->>PdfCertProvider: Return object list
            PdfCertProvider->>User: Return success
        end
    end

Poem

A Rabbit's Tune for Code Improvements

In the forest of code, where changes roam free, 🐰
Null checks and new routes, our path to decree.
Imports realigned, like stars in the night, ✨
Enhanced error text, for clarity and light.
With each tiny tweak, our system's more grand,
A codebase that’s now, more fit for the land. 🌟


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.