✨ Add filter information to readme and metadata #4229
Conversation
| // delete url query params that the download api uses but that are not related to grapher | ||
| delete params.v1 | ||
| delete params.csvType | ||
| delete params.useColumnShortNames |
There was a problem hiding this comment.
Would it be worth the extra effort to use a whitelist here (and in the creation of urlWithFilters) ? Otherwise you can add arbitrary text to the query string and get a readme that says whatever anyone wants.
There was a problem hiding this comment.
Good point! It means that when we do this for MDims we'll have to expand the whitelist but it's probably the better way to do things.
functions/_common/urlTools.ts
Outdated
| @@ -0,0 +1,12 @@ | |||
| export function getGrapherFilters( | |||
| searchParams: URLSearchParams | |||
| ): Record<string, unknown> { | |||
There was a problem hiding this comment.
I think it's actually not possible to get anything but a string as one of the values here.
functions/_common/readmeTools.ts
Outdated
| yield `### Active Filters` | ||
| yield "" | ||
| yield `A filtered subset of the full data was downloaded. The following filters were applied:` | ||
| for (const entry of Object.entries(filterSettings)) { |
There was a problem hiding this comment.
If getGrapherFilters was typed with Record<string, string> then you could do the sugary thing of
for (const [key, val] of Object.entries(filterSettings)) {
which is 100% absolutely completely not necessary. I'm just sharing coz I think it's neat 🙂
There was a problem hiding this comment.
True, this is nicer :)
When using the download API, add information about active filters to the metadata and readme.