Require authentication for facility CSV downloads and log requests

CHANGELOG.md

@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ### Added
 
 ### Changed
+- Require authentication for facility CSV downloads and log requests [#697](https://github.com/open-apparel-registry/open-apparel-registry/pull/697)
 
 ### Deprecated
 

src/app/src/actions/logDownload.js

@@ -0,0 +1,44 @@
+import { createAction } from 'redux-act';
+
+import apiRequest from '../util/apiRequest';
+
+import {
+    makeLogDownloadUrl,
+    logErrorAndDispatchFailure,
+    downloadFacilitiesCSV,
+} from '../util/util';
+
+export const startLogDownload =
+    createAction('START_LOG_DOWNLOAD');
+export const failLogDownload =
+    createAction('FAIL_LOG_DOWNLOAD');
+export const completeLogDownload =
+    createAction('COMPLETE_LOG_DOWNLOAD');
+
+export function logDownload() {
+    return (dispatch, getState) => {
+        dispatch(startLogDownload());
+
+        const {
+            facilities: {
+                facilities: {
+                    data: {
+                        features: facilities,
+                    },
+                },
+            },
+        } = getState();
+
+        const path = `${window.location.pathname}${window.location.search}${window.location.hash}`;
+        const recordCount = facilities ? facilities.length : 0;
+        return apiRequest
+            .post(makeLogDownloadUrl(path, recordCount))
+            .then(() => downloadFacilitiesCSV(facilities))
+            .then(() => dispatch(completeLogDownload()))
+            .catch(err => dispatch(logErrorAndDispatchFailure(
+                err,
+                'An error prevented the download',
+                failLogDownload,
+            )));
+    };
+}

src/app/src/components/FilterSidebarFacilitiesTab.jsx

@@ -1,15 +1,20 @@
-import React, { Fragment } from 'react';
+import React, { Fragment, useState, useEffect } from 'react';
 import { arrayOf, bool, func, string } from 'prop-types';
 import { connect } from 'react-redux';
 import { Link } from 'react-router-dom';
 import CircularProgress from '@material-ui/core/CircularProgress';
+import Dialog from '@material-ui/core/Dialog';
+import DialogTitle from '@material-ui/core/DialogTitle';
+import DialogContent from '@material-ui/core/DialogContent';
+import DialogActions from '@material-ui/core/DialogActions';
 import Typography from '@material-ui/core/Typography';
 import Button from '@material-ui/core/Button';
 import List from '@material-ui/core/List';
 import ListItem from '@material-ui/core/ListItem';
 import ListItemText from '@material-ui/core/ListItemText';
 import Divider from '@material-ui/core/Divider';
 import get from 'lodash/get';
+import { toast } from 'react-toastify';
 
 import ControlledTextInput from './ControlledTextInput';
 
@@ -18,11 +23,17 @@ import {
     updateSidebarFacilitiesTabTextFilter,
 } from '../actions/ui';
 
+import { logDownload } from '../actions/logDownload';
+
 import { facilityCollectionPropType } from '../util/propTypes';
 
+import {
+    authLoginFormRoute,
+    authRegisterFormRoute,
+} from '../util/constants';
+
 import {
     makeFacilityDetailLink,
-    downloadFacilitiesCSV,
     getValueFromEvent,
     caseInsensitiveIncludes,
     sortFacilitiesAlphabeticallyByName,
@@ -79,10 +90,23 @@ function FilterSidebarFacilitiesTab({
     fetching,
     data,
     error,
+    logDownloadError,
+    user,
     returnToSearchTab,
     filterText,
     updateFilterText,
+    handleDownload,
 }) {
+    const [loginRequiredDialogIsOpen, setLoginRequiredDialogIsOpen] = useState(false);
+    const [requestedDownload, setRequestedDownload] = useState(false);
+
+    useEffect(() => {
+        if (requestedDownload && logDownloadError) {
+            toast('A problem prevented downloading the facilities');
+            setRequestedDownload(false);
+        }
+    }, [logDownloadError, requestedDownload]);
+
     if (fetching) {
         return (
             <div
@@ -184,6 +208,9 @@ function FilterSidebarFacilitiesTab({
         ? `Displaying ${filteredFacilities.length} facilities of ${facilitiesCount} results`
         : `Displaying ${filteredFacilities.length} facilities`;
 
+    const LoginLink = props => <Link to={authLoginFormRoute} {...props} />;
+    const RegisterLink = props => <Link to={authRegisterFormRoute} {...props} />;
+
     const listHeaderInsetComponent = (
         <div style={facilitiesTabStyles.listHeaderStyles}>
             <Typography
@@ -198,7 +225,16 @@ function FilterSidebarFacilitiesTab({
                         variant="outlined"
                         color="primary"
                         styles={facilitiesTabStyles.listHeaderButtonStyles}
-                        onClick={() => downloadFacilitiesCSV(orderedFacilities)}
+                        onClick={
+                            () => {
+                                if (user) {
+                                    setRequestedDownload(true);
+                                    handleDownload();
+                                } else {
+                                    setLoginRequiredDialogIsOpen(true);
+                                }
+                            }
+                        }
                     >
                         Download CSV
                     </Button>
@@ -256,25 +292,75 @@ function FilterSidebarFacilitiesTab({
                     }
                 </List>
             </div>
+            <Dialog open={loginRequiredDialogIsOpen}>
+                { loginRequiredDialogIsOpen ? (
+                    <>
+                        <DialogTitle>
+                          Log In To Download
+                        </DialogTitle>
+                        <DialogContent>
+                            <Typography>
+                              You must log in with an Open Apparel Registry
+                              account before downloading your search results.
+                            </Typography>
+                        </DialogContent>
+                        <DialogActions>
+                            <Button
+                                variant="outlined"
+                                color="secondary"
+                                onClick={() => setLoginRequiredDialogIsOpen(false)}
+                            >
+                                Cancel
+                            </Button>
+                            <Button
+                                variant="outlined"
+                                color="primary"
+                                onClick={() => setLoginRequiredDialogIsOpen(false)}
+                                component={RegisterLink}
+                            >
+                                Register
+                            </Button>
+                            <Button
+                                variant="outlined"
+                                color="primary"
+                                onClick={() => setLoginRequiredDialogIsOpen(false)}
+                                component={LoginLink}
+                            >
+                                Log In
+                            </Button>
+                        </DialogActions>
+                    </>
+                ) : (
+                    <div style={{ display: 'none' }} />
+                )}
+            </Dialog>
         </Fragment>
     );
 }
 
 FilterSidebarFacilitiesTab.defaultProps = {
     data: null,
     error: null,
+    logDownloadError: null,
 };
 
 FilterSidebarFacilitiesTab.propTypes = {
     data: facilityCollectionPropType,
     fetching: bool.isRequired,
     error: arrayOf(string),
+    logDownloadError: arrayOf(string),
     returnToSearchTab: func.isRequired,
     filterText: string.isRequired,
     updateFilterText: func.isRequired,
+    handleDownload: func.isRequired,
 };
 
 function mapStateToProps({
+    auth: {
+        user: {
+            user,
+        },
+    },
     facilities: {
         facilities: {
             data,
@@ -287,12 +373,17 @@ function mapStateToProps({
             filterText,
         },
     },
+    logDownload: {
+        error: logDownloadError,
+    },
 }) {
     return {
         data,
         error,
         fetching,
         filterText,
+        user,
+        logDownloadError,
     };
 }
 
@@ -301,6 +392,7 @@ function mapDispatchToProps(dispatch) {
         returnToSearchTab: () => dispatch(makeSidebarSearchTabActive()),
         updateFilterText: e =>
             dispatch((updateSidebarFacilitiesTabTextFilter(getValueFromEvent(e)))),
+        handleDownload: () => dispatch(logDownload()),
     };
 }
 

src/app/src/reducers/LogDownloadReducer.js

@@ -0,0 +1,28 @@
+import { createReducer } from 'redux-act';
+import update from 'immutability-helper';
+
+import {
+    startLogDownload,
+    failLogDownload,
+    completeLogDownload,
+} from '../actions/logDownload';
+
+const initialState = Object.freeze({
+    fetching: false,
+    error: null,
+});
+
+export default createReducer({
+    [startLogDownload]: state => update(state, {
+        fetching: { $set: true },
+        error: { $set: initialState.error },
+    }),
+    [failLogDownload]: (state, payload) => update(state, {
+        fetching: { $set: false },
+        error: { $set: payload },
+    }),
+    [completeLogDownload]: state => update(state, {
+        fetching: { $set: false },
+        error: { $set: initialState.error },
+    }),
+}, initialState);

src/app/src/reducers/index.js

@@ -26,8 +26,9 @@ import DashboardListsReducer from './DashboardListsReducer';
 import DeleteFacilityReducer from './DeleteFacilityReducer';
 import MergeFacilitiesReducer from './MergeFacilitiesReducer';
 import AdjustFacilityMatchesReducer from './AdjustFacilityMatchesReducer';
+import LogDownloadReducer from './LogDownloadReducer';
 
-export default combineReducers((({
+export default combineReducers({
     auth: AuthReducer,
     profile: ProfileReducer,
     upload: UploadReducer,
@@ -48,4 +49,5 @@ export default combineReducers((({
     deleteFacility: DeleteFacilityReducer,
     mergeFacilities: MergeFacilitiesReducer,
     adjustFacilityMatches: AdjustFacilityMatchesReducer,
-})));
+    logDownload: LogDownloadReducer,
+});

src/app/src/util/util.js

@@ -127,6 +127,8 @@ export const makeGetClientInfoURL = () => {
     return `${clientInfoURL}${clientInfoURLSuffix}`;
 };
 
+export const makeLogDownloadUrl = (path, recordCount) => `/api/log-download/?path=${path}&record_count=${recordCount}`;
+
 export const getValueFromObject = ({ value }) => value;
 
 export const createQueryStringFromSearchFilters = ({

src/django/api/constants.py

@@ -83,3 +83,8 @@ class Certifications:
     RESPONSIBLE_DOWN_STANDARD = 'Responsible Down Standard (RDS)'
     RESPONSIBLE_WOOL_STANDARD = 'Responsible Wool Standard (RWS)'
     SAB8000 = 'SA8000'
+
+
+class LogDownloadQueryParams:
+    PATH = 'path'
+    RECORD_COUNT = 'record_count'

src/django/api/migrations/0028_create_downloadlog.py

@@ -0,0 +1,26 @@
+# Generated by Django 2.2.3 on 2019-07-19 22:14
+
+from django.conf import settings
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('api', '0027_merge_20190716_2207'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='DownloadLog',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('path', models.CharField(help_text='The requested resource path', max_length=2083)),
+                ('record_count', models.IntegerField(help_text='The number of records in the downloaded file')),
+                ('created_at', models.DateTimeField(auto_now_add=True)),
+                ('updated_at', models.DateTimeField(auto_now=True)),
+                ('user', models.ForeignKey(help_text='The User account that made the request', on_delete=django.db.models.deletion.CASCADE, to=settings.AUTH_USER_MODEL)),
+            ],
+        ),
+    ]

src/django/api/models.py

@@ -1190,3 +1190,26 @@ class ProductionType(models.Model):
         blank=False,
         help_text='A suggested value for production type'
     )
+
+
+class DownloadLog(models.Model):
+    """
+    Log CSV download requests from the web client
+    """
+    user = models.ForeignKey(
+        'User',
+        null=False,
+        on_delete=models.CASCADE,
+        help_text='The User account that made the request'
+    )
+    path = models.CharField(
+        max_length=2083,
+        null=False,
+        help_text='The requested resource path'
+    )
+    record_count = models.IntegerField(
+        null=False,
+        help_text='The number of records in the downloaded file'
+    )
+    created_at = models.DateTimeField(auto_now_add=True)
+    updated_at = models.DateTimeField(auto_now=True)

src/django/api/serializers.py

@@ -847,3 +847,8 @@ def validate_merge(self, merge_id):
         if not Facility.objects.filter(id=merge_id).exists():
             raise ValidationError(
                 'Facility {} does not exist.'.format(merge_id))
+
+
+class LogDownloadQueryParamsSerializer(Serializer):
+    path = CharField(required=True)
+    record_count = IntegerField(required=True)