-
Notifications
You must be signed in to change notification settings - Fork 3
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat(map): download collection metrics [EP-3002] #328
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
207 changes: 207 additions & 0 deletions
207
...th-map/src/components/collection/collection-downloadmetrics/CollectionDownloadMetrics.tsx
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,207 @@ | ||
| /* | ||
| * Copyright 2018-2020 National Geographic Society | ||
| * | ||
| * Use of this software does not constitute endorsement by National Geographic | ||
| * Society (NGS). The NGS name and NGS logo may not be used for any purpose without | ||
| * written permission from NGS. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); you may not use | ||
| * this file except in compliance with the License. You may obtain a copy of the | ||
| * License at | ||
| * | ||
| * https://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software distributed | ||
| * under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR | ||
| * CONDITIONS OF ANY KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations under the License. | ||
| */ | ||
|
|
||
| import { ICollection } from 'modules/collections/model'; | ||
| import React, { useState, useEffect } from 'react'; | ||
| import { useTranslation } from 'react-i18next'; | ||
| import { Controller, useForm } from 'react-hook-form'; | ||
|
|
||
| import { TitleHero, Card, ReactSelect, serializeFilters } from '@marapp/earth-shared'; | ||
| import MetricService from 'services/MetricService'; | ||
|
|
||
| import JSZip from 'jszip'; | ||
| import FileSaver from 'file-saver'; | ||
| import json2csv from 'json2csv'; | ||
| import { groupBy } from 'lodash'; | ||
| import flatten from 'flat'; | ||
|
|
||
| interface IProps { | ||
| collection: ICollection; | ||
| onCancel: () => void; | ||
| onDownloadStart: () => void; | ||
| onDownloadEnd: () => void; | ||
| onDownloadError: (err: string) => void; | ||
| onDownloadSuccess: () => void; | ||
| } | ||
|
|
||
| export function CollectionDownloadMetrics(props: IProps) { | ||
| const { | ||
| collection, | ||
| onCancel, | ||
| onDownloadStart, | ||
| onDownloadEnd, | ||
| onDownloadError, | ||
| onDownloadSuccess, | ||
| } = props; | ||
| const { t } = useTranslation(); | ||
| const { name, organization, slug: collectionSlug } = collection; | ||
| const [metricSlugs, setMetricSlugs] = useState([]); | ||
| const [isLoadingMetricSlugs, setIsLoadingMetricSlugs] = useState(false); | ||
| const { register, handleSubmit, formState, control, watch } = useForm({ | ||
| mode: 'onChange', | ||
| }); | ||
| const { dirty, isValid, isSubmitting } = formState; | ||
| const metricsWatcher = watch('metrics'); | ||
|
|
||
| useEffect(() => { | ||
| (async () => { | ||
| setIsLoadingMetricSlugs(true); | ||
|
|
||
| const data = await MetricService.fetchMetricSlugs({ group: organization }); | ||
|
|
||
| setMetricSlugs(data.map((item) => ({ value: item.slug, label: item.slug }))); | ||
|
|
||
| setIsLoadingMetricSlugs(false); | ||
| })(); | ||
| }, []); | ||
|
|
||
| return ( | ||
| <form onSubmit={handleSubmit(onSubmit)} className="sidebar-content-full ng-form ng-form-dark"> | ||
| <Card elevation="high" className="ng-margin-bottom"> | ||
| <TitleHero title={name} subtitle={organization} extra={t('Collection')} /> | ||
| </Card> | ||
|
|
||
| <div className="scroll-container"> | ||
| <Card elevation="raised"> | ||
| <label>{t('Select metrics for download')}</label> | ||
| <Controller | ||
| as={ReactSelect} | ||
| name="metrics" | ||
| type="metrics" | ||
| placeholder={t('Select metrics to download data files')} | ||
| className="marapp-qa-downloadmetricsdropdown ng-margin-medium-bottom" | ||
| options={metricSlugs} | ||
| isLoading={isLoadingMetricSlugs} | ||
| defaultValue={[]} | ||
| control={control} | ||
| isClearable={true} | ||
| isSearchable={true} | ||
| isMulti={true} | ||
| closeMenuOnSelect={false} | ||
| /> | ||
| <label>{t('Select a file type for download')}</label> | ||
| <div className="legend-item-group--radio ng-margin-top ng-margin-medium-bottom"> | ||
| <div className="ng-display-inline-block ng-margin-medium-right"> | ||
| <input | ||
| type="radio" | ||
| id={`radio-csv`} | ||
| value={'csv'} | ||
| name="fileType" | ||
| ref={register({ | ||
| required: true, | ||
| })} | ||
| className="marapp-qa-downloadmetricscsv" | ||
| /> | ||
| <label htmlFor={`radio-csv`}> | ||
| <span className="legend-item-group--symbol" /> | ||
| <span className="legend-item-group--name">CSV</span> | ||
| </label> | ||
| </div> | ||
| <div className="ng-display-inline-block ng-margin-medium-left"> | ||
| <input | ||
| type="radio" | ||
| id={`radio-json`} | ||
| value={'json'} | ||
| name="fileType" | ||
| ref={register({ | ||
| required: true, | ||
| })} | ||
| className="marapp-qa-downloadmetricsjson" | ||
| /> | ||
| <label htmlFor={`radio-json`}> | ||
| <span className="legend-item-group--symbol" /> | ||
| <span className="legend-item-group--name">JSON</span> | ||
| </label> | ||
| </div> | ||
| </div> | ||
| <button | ||
| type="submit" | ||
| className="marapp-qa-actiondownload ng-button ng-button-primary ng-margin-right" | ||
| disabled={!isValid || isSubmitting || !dirty || !metricsWatcher?.length} | ||
| > | ||
| {t('Download')} | ||
| </button> | ||
| <button | ||
| className="marapp-qa-actioncancel ng-button ng-button-secondary" | ||
| onClick={onCancel} | ||
| > | ||
| {t('Cancel')} | ||
| </button> | ||
| </Card> | ||
| </div> | ||
| </form> | ||
| ); | ||
|
|
||
| async function onSubmit(values) { | ||
| onDownloadStart(); | ||
|
|
||
| const { metrics, fileType } = values; | ||
|
|
||
| try { | ||
| const data = await MetricService.downloadMetrics(collectionSlug, { | ||
| filter: serializeFilters({ | ||
| slug: metrics.map((metric) => metric.value), | ||
| }), | ||
| group: organization, | ||
| include: 'location', | ||
| select: 'location.name', | ||
| }); | ||
|
|
||
| const zip = new JSZip(); | ||
|
|
||
| const metricTypes = groupBy(data, 'slug'); | ||
| const locationNameField = '#'; | ||
|
|
||
| Object.keys(metricTypes).forEach((metricType) => { | ||
| const normalizedData = metricTypes[metricType].map((item) => ({ | ||
| [locationNameField]: item.location.name, | ||
| ...item.metric, | ||
| })); | ||
| const fileName = `${metricType}.${fileType}`; | ||
|
|
||
| if (fileType === 'csv') { | ||
| const json2csvParser = new json2csv.Parser(); | ||
|
|
||
| zip.file( | ||
| fileName, | ||
| json2csvParser.parse( | ||
| normalizedData.map(({ [locationNameField]: locationName, ...item }) => ({ | ||
| [locationNameField]: locationName, | ||
| ...flatten(item), | ||
| })) | ||
| ) | ||
| ); | ||
| } else { | ||
| zip.file(fileName, JSON.stringify(normalizedData)); | ||
| } | ||
| }); | ||
|
|
||
| const zipName = `${collectionSlug}-metrics.zip`; | ||
| const zipContent = await zip.generateAsync({ type: 'blob' }); | ||
|
|
||
| FileSaver.saveAs(zipContent, zipName); | ||
| onDownloadSuccess(); | ||
| } catch (e) { | ||
| onDownloadError('Something went wrong'); | ||
| console.log(e); | ||
| } | ||
|
|
||
| onDownloadEnd(); | ||
| } | ||
| } | ||
20 changes: 20 additions & 0 deletions
20
packages/earth-map/src/components/collection/collection-downloadmetrics/index.ts
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| /* | ||
| * Copyright 2018-2020 National Geographic Society | ||
| * | ||
| * Use of this software does not constitute endorsement by National Geographic | ||
| * Society (NGS). The NGS name and NGS logo may not be used for any purpose without | ||
| * written permission from NGS. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); you may not use | ||
| * this file except in compliance with the License. You may obtain a copy of the | ||
| * License at | ||
| * | ||
| * https://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software distributed | ||
| * under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR | ||
| * CONDITIONS OF ANY KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations under the License. | ||
| */ | ||
|
|
||
| export { CollectionDownloadMetrics } from './CollectionDownloadMetrics'; |
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
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should clear the previous error message somehow.
One suggestion could be to add
onDownloadSuccess()prop and call it here