[93] feat: pdf generation service

[shivankurchavan]

Draft PR

till now :

https://github.com/SamagraX-Stencil/stencil/assets/61339210/a5cd9b8b-2825-4414-b5de-e6d9eccf0fa6

[coderabbitai[bot]]

[!IMPORTANT]

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

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
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • 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 using 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.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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 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 for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[Savio629]

The pdf service is generating pdf on basis of given template.html and data.csv

It is working similar to fileupload service

The issue is if the data is huge then it can reach the limit

{
    "statuscode": 201,
    "data": [
        {
            "data": {
                "message": {
                    "statusCode": 500,
                    "message": "Certificate generation failed",
                    "errors": "Timed out after waiting 30000ms"
                },
                "statusCode": 201
            },
            "errors": []
        }
    ]
}

Should we ask an optional timeout from the user as a query?

https://github.com/user-attachments/assets/a37dfc1d-5999-4193-94a4-64670e69e789

The certificate comes out to be something like this

[Savio629]

#93

[techsavvyash]

@Savio629

1. What solution do you propose for solving the large data issue?
2. Where are we on the support for different templating engines? Even if not baked right into it have we structured the code in such a way that expansion to more template formats is very configurable?
3. Where are we on the queuing part of things?
4. Have you worked on an internal PDF churner service which is to be used incase the user does not want to use Gotenburg as discussed with Chakshu during the last weekly review call?
5. How have we solved for errors in PDF generation like headers and footers getting cut? This problem was discussed during the standups itself when this service was being discussed.

[techsavvyash]

6. The photos are not getting rendered in the screenshot itself the screenshot field is broken -- shows that something is not correct and needs fixing.

[techsavvyash]

7. In the response pasted in your comment it says 500 in data and 201 in statusCode why is that?

[Savio629]

In the response pasted in your comment it says 500 in data and 201 in statusCode why is that?

I feel the api req is being created/sent successfully which is why the statusCode is 201 but the response from the server is 500 as it timed out.

The photos are not getting rendered in the screenshot itself the screenshot field is broken -- shows that something is not correct and needs fixing.

I haven't sent the path of the photos to the server. Can you suggest some ways to do so? As i'm doing api request and a single image file won't be feasible and api doesn't accept a folder so should we sent a zip folder with assets?

[Savio629]

Tried to implement https://svelte.dev/docs/svelte-compiler https://github.com/withastro/compiler but didn't received expected output Will try out this package out https://www.npmjs.com/package/svelte-to-html

[Savio629]

• What solution do you propose for solving the large data issue?

  • Still researching and planning about that. Was thinking about using queues.

• Where are we on the support for different templating engines? Even if not baked right into it have we structured the code in such a way that expansion to more template formats is very configurable?

  • Rightnow we support handlebars, trying to integrate more templating engines. Also have structured the code in such way that expansion to more template is configurable

• Where are we on the queuing part of things?

  • Still researching and planning about it. Can you explain a bit more on how should we proceed for queuing files?

• Have you worked on an internal PDF churner service which is to be used incase the user does not want to use Gotenburg as discussed with Chakshu during the last weekly review call?

  • We are not using Gotenburg at the moment as gotenburg requires the html to be named as index.html which won't be feasible for us. https://gotenberg.dev/docs/6.x/html // @shivankurchavan

• How have we solved for errors in PDF generation like headers and footers getting cut? This problem was discussed during the standups itself when this service was being discussed.

  • There are no errors in headers and footers at the moment.

• The photos are not getting rendered in the screenshot itself the screenshot field is broken -- shows that something is not correct and needs fixing.

  • Fixed the issue in the latest commit

• In the response pasted in your comment it says 500 in data and 201 in statusCode why is that?

  • We were sending the response with 500 instead forgot to throw an error there. Will look into it