fix PDF rendering issue #70
Conversation
It appears that the visualization is prematurely notifying the PDF rendering that the visualization has completed rendering. This fix adds waits to make sure all promises have finished before calling done.
bryans99
requested review from
Itzaprado and
yesudeep
and removed request for
a team and
Itzaprado
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @bryans99, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request addresses a PDF rendering issue by ensuring that the visualization waits for all rendering promises to complete before notifying the PDF renderer that the process is done. This is achieved by making the buildReportTable function asynchronous and adding await calls to key rendering functions, as well as wrapping the call in a promise to handle errors.
Highlights
- Asynchronous Rendering: The
buildReportTablefunction is now asynchronous to ensure all rendering promises are resolved before proceeding. - Await Calls: Added
awaitcalls toremoveStyles()andrenderTable()to properly synchronize the rendering process. - Promise Handling: Wrapped the
buildReportTablecall in theupdatefunction with a.then()block to ensuredone()is called after the table is built, and added a.catch()block to handle potential errors.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
The code changes introduce waits to make sure all promises have finished before calling done, to address a PDF rendering issue. I've identified a potential bug where an animation-heavy function (addOverlay) is not being awaited, which could lead to the PDF rendering issue persisting. I've also recommended using .finally() to reduce code duplication when signaling completion.
| @@ -527,7 +527,7 @@ const buildReportTable = function ( | |||
| ); | |||
| }; | |||
|
|
|||
| renderTable().then(() => { | |||
| await renderTable().then(() => { | |||
There was a problem hiding this comment.
The addOverlay() call on line 534 within this then block is not awaited. Since addOverlay performs animations, not awaiting it means buildReportTable will resolve and done() will be called before the animations are complete. This likely means the PDF rendering issue will persist. To fix this, you should await addOverlay().
await renderTable();There was a problem hiding this comment.
The animate custom theme should NOT be used if the visualization is rendered. Thats a larger change
| @@ -42,7 +42,7 @@ const buildReportTable = function ( | |||
| const chartCentreX = bounds.x + bounds.width / 2; | |||
| const chartCentreY = bounds.y + bounds.height / 2; | |||
|
|
|||
| removeStyles().then(() => { | |||
| await removeStyles().then(() => { | |||
There was a problem hiding this comment.
Using await with .then() is an anti-pattern1 as it mixes two different asynchronous handling styles. Since buildReportTable is an async function, it would be more idiomatic and readable to use await directly.
await removeStyles();Style Guide References
Footnotes
There was a problem hiding this comment.
Agreed but I did not want to refactor that much code. I'm happy to let the content team do more work on this
| buildReportTable(config, dataTable, updateColumnOrder, element) | ||
| .then(() => { | ||
| // DEBUG OUTPUT AND DONE | ||
| // console.log('dataTable', dataTable) | ||
| // console.log('container', document.getElementById('visContainer').parentNode) | ||
|
|
||
| done(); | ||
| done(); | ||
| }) | ||
| .catch(error => { | ||
| console.error(error); | ||
| done(); | ||
| }); |
There was a problem hiding this comment.
To avoid repeating the done() call in both the success and error paths, you could use .finally()1. This would make the code slightly cleaner and more maintainable by ensuring done() is always called, regardless of the outcome.
buildReportTable(config, dataTable, updateColumnOrder, element)
.then(() => {
// DEBUG OUTPUT AND DONE
// console.log('dataTable', dataTable)
// console.log('container', document.getElementById('visContainer').parentNode)
})
.catch(error => {
console.error(error);
})
.finally(() => {
done();
});Style Guide References
Footnotes
There was a problem hiding this comment.
I thought about it but I could not be arsed to do it
| // console.log('container', document.getElementById('visContainer').parentNode) | ||
| buildReportTable(config, dataTable, updateColumnOrder, element) | ||
| .then(() => { | ||
| // DEBUG OUTPUT AND DONE |
There was a problem hiding this comment.
Are you intending to keep these comments in the code?
There was a problem hiding this comment.
Yes, it appears to be to aid debubugging
|
A ticket will be assigned to the content team regarding this. I've done some cursory testing on this and the vis still works. Feel free to take this over or create a new PR base upon it |
It appears that the visualization is prematurely notifying the PDF rendering that the visualization has completed rendering. This fix adds waits to make sure all promises have finished before calling done.