Refactor the CSV export for CSP reasons #1453
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mgwalker
commented
May 5, 2022
| // Quick and simple export target #table_id into a csv | ||
| // inspired by https://stackoverflow.com/a/56370447 | ||
| function download_table_as_csv(table_id, filename_prefix) { | ||
| var csv_string = table_to_csv(table_id); |
There was a problem hiding this comment.
The Javascript changes from here down are where I ran prettier on the code. I tried to configure prettier to match the existing style instead of introducing a bunch of whitespace changes. It seems like most of the changes are whitespace alignment or semicolons.
Codecov Report
@@ Coverage Diff @@
## main #1453 +/- ##
=======================================
Coverage 90.11% 90.11%
=======================================
Files 51 51
Lines 2297 2297
=======================================
Hits 2070 2070
Misses 227 227 Continue to review full report at Codecov.
|
neilmb
approved these changes
May 6, 2022
mgwalker
force-pushed
the
mgwalker/1418-csv-export
branch
from
9f6fbda
to
64706d6
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Tock's CSP policy disallows inline Javascript, so
onclick=""attributes are forbidden. Those attributes are how CSV exports are triggered on the analytics page. The handler relies on a random pseudo ID that is generated at render time to identify the table being exported.This PR removes the
onclickattribute from the button, and addsdata-csv,data-csv-id, anddata-csv-nameattributes. Thedata-csvattribute is just a flag that the button should act as a CSV exporter.data-csv-idanddata-csv-nameare populated with the pseudo ID and filename hint, respectively.Then, after the DOM is loaded, this PR adds code that finds all button elements with a
data-csvattribute. It iterates over them, pulling out their IDs and names, and adding a click event listener. It uses the ID and name to finally call thedownload_table_as_csvfunction after the button is cilcked.Additional information