DM-11387: fix several issue related to backgrounding

loitly · loitly · commit 89312530a509 · 2017-08-02T13:46:16.000-07:00
- added a checkbox to enable email notification
- sync the checkbox and email field between download dialog and background monitor
- remove 'resend email' feature which is confusing
- when email notification is enabled, an email will be sent for each job when it's completed.
diff --git a/src/firefly/java/edu/caltech/ipac/firefly/server/packagedata/BackgroundInfoCacher.java b/src/firefly/java/edu/caltech/ipac/firefly/server/packagedata/BackgroundInfoCacher.java
@@ -171,21 +171,9 @@ private void updateInfo(BackgroundInfo info) {
      */
     private static void mergeInfoIntoStatus(BackgroundInfo info, BackgroundStatus bgStatus) {
         if (info != null && bgStatus != null) {
-            if (bgStatus.getParam(ServerParams.TITLE) == null) {
-                bgStatus.setParam(ServerParams.TITLE, info.getTitle());
-            } else {
-                info.setTitle(bgStatus.getParam(ServerParams.TITLE));
-            }
-            if (bgStatus.getParam(ServerParams.EMAIL) == null) {
-                bgStatus.setParam(ServerParams.EMAIL, info.getEmailAddress());
-            } else {
-                info.setEmail(bgStatus.getParam(ServerParams.EMAIL));
-            }
-            if (bgStatus.getParam(BackgroundStatus.DATA_TAG) == null) {
-                bgStatus.setParam(BackgroundStatus.DATA_TAG, info.getDataTag());
-            } else {
-                info.setDataTag(bgStatus.getParam(BackgroundStatus.DATA_TAG));
-            }
+            bgStatus.setParam(ServerParams.TITLE, info.getTitle());
+            bgStatus.setParam(ServerParams.EMAIL, info.getEmailAddress());
+            bgStatus.setParam(BackgroundStatus.DATA_TAG, info.getDataTag());
         }
     }
 
diff --git a/src/firefly/java/edu/caltech/ipac/firefly/server/query/SearchManager.java b/src/firefly/java/edu/caltech/ipac/firefly/server/query/SearchManager.java
@@ -206,7 +206,7 @@ public FileInfo getFileInfo(TableServerRequest request) throws DataAccessExcepti
     public BackgroundStatus getRawDataSetBackground(TableServerRequest request, Request clientRequest, int waitMillis) throws RPCException {
 
         Logger.briefDebug("Backgrounded search started:" + waitMillis + " wait, req:" + request);
-        String email= request.getMeta(ServerParams.EMAIL) == null ? "" : request.getMeta(ServerParams.EMAIL);
+        String email= request.getMeta(ServerParams.EMAIL);
         SearchWorker worker= new SearchWorker(request, clientRequest);
         String title = request.getTblTitle() == null ? request.getRequestId() : request.getTblTitle();
         BackgroundEnv.BackgroundProcessor processor=
diff --git a/src/firefly/js/core/background/BackgroundCntlr.js b/src/firefly/js/core/background/BackgroundCntlr.js
@@ -3,7 +3,7 @@
  */
 
 import {take} from 'redux-saga/effects';
-import {set, get, has, pick} from 'lodash';
+import {set, get, has, pick, isNil} from 'lodash';
 
 import {flux} from '../../Firefly.js';
 import {smartMerge} from '../../tables/TableUtil.js';
@@ -72,8 +72,8 @@ export function dispatchBgStatus(bgStatus) {
  * set the email used for background status notification 
  * @param {string}  email
  */
-export function dispatchBgSetEmail(email) {
-    flux.process({ type : BG_SET_EMAIL, payload: {email} });
+export function dispatchBgSetEmailInfo({email, enableEmail}) {
+    flux.process({ type : BG_SET_EMAIL, payload: {email, enableEmail} });
 }
 
 /**
@@ -176,12 +176,11 @@ function bgJobCancel(action) {
 
 function bgSetEmail(action) {
     return (dispatch) => {
-        const {email=''} = action.payload;
-        SearchServices.setEmail(email);
-        dispatch(action);
-        if (email) {
-            SearchServices.resendEmail(email);
+        const {email, enableEmail} = action.payload;
+        if (!isNil(email)) {
+            SearchServices.setEmail(email);
         }
+        dispatch(action);
     };
 }
 
@@ -211,10 +210,14 @@ function reducer(state={}, action={}) {
         case BG_STATUS :
             return handleBgStatusUpdate(state, action);
             break;
-        case BG_SET_EMAIL :
-            const {email} = action.payload;
-            return updateSet(state, 'email', email);
+        case BG_SET_EMAIL : {
+            const {email, enableEmail} = action.payload;
+            let nstate = state;
+            if (!isNil(email)) nstate = updateSet(state, 'email', email);
+            if (!isNil(enableEmail)) nstate = updateSet(state, 'enableEmail', enableEmail);
+            return nstate;
             break;
+        }
         case BG_ALLOW_DATA_TAG :
             const {patterns} = action.payload;
             return updateSet(state, 'allowDataTag', patterns);
@@ -243,7 +246,7 @@ function handleBgJobAdd(state, action) {
     var bgstats = action.payload;
     bgstats = transform(bgstats);
     const nState = set({}, ['jobs', bgstats.ID], bgstats);
-    if (bgstats.email) nState.email = bgstats.email;
+    if (!nState.email && !isNil(bgstats.email)) nState.email = bgstats.email;       // use email from server if one is not set
     return smartMerge(state, nState);
 }
 
diff --git a/src/firefly/js/core/background/BackgroundMonitor.jsx b/src/firefly/js/core/background/BackgroundMonitor.jsx
@@ -3,7 +3,7 @@
  */
 
 import React, {PureComponent} from 'react';
-import {get, set, isEmpty, unset} from 'lodash';
+import {get, set, isEmpty, unset, isNil} from 'lodash';
 
 import DialogRootContainer from '../../ui/DialogRootContainer.jsx';
 import {PopupPanel} from '../../ui/PopupPanel.jsx';
@@ -13,7 +13,7 @@ import Validate from '../../util/Validate.js';
 import {HelpIcon} from '../../ui/HelpIcon.jsx';
 import {dispatchShowDialog, dispatchHideDialog} from '../../core/ComponentCntlr.js';
 import {getBackgroundInfo, BG_STATE, isActive, isDone, isSuccess, emailSent, canCreateScript} from './BackgroundUtil.js';
-import {dispatchBgStatus, dispatchJobRemove, dispatchBgSetEmail, dispatchJobCancel} from './BackgroundCntlr.js';
+import {dispatchBgStatus, dispatchJobRemove, dispatchBgSetEmailInfo, dispatchJobCancel} from './BackgroundCntlr.js';
 import {downloadWithProgress} from '../../util/WebUtil.js';
 import {DownloadProgress} from '../../rpc/SearchServicesJson.js';
 import {showScriptDownloadDialog} from '../../ui/ScriptDownloadDialog.jsx';
@@ -48,7 +48,7 @@ class BackgroundMonitor extends SimpleComponent {
     }
 
     render() {
-        const {jobs={}, email='', help_id} = this.state || {};
+        const {jobs={}, email='', help_id, enableEmail} = this.state || {};
         const packages = Object.entries(jobs)
                         .filter(([id, job]) => get(job, 'TYPE') === 'PACKAGE')
                         .map( ([id, job]) => {
@@ -71,7 +71,7 @@ class BackgroundMonitor extends SimpleComponent {
                     {!isEmpty(searches) && searches}
                     {!isEmpty(unknown) && unknown}
                 </div>
-                <BgFooter {...{help_id, email}}/>
+                <BgFooter {...{help_id, email, enableEmail}}/>
             </div>
         );
     }
@@ -86,27 +86,38 @@ class BgFooter extends PureComponent {
     onEmailChanged(v) {
         if (get(v, 'valid')) {
             const {email} = this.props;
-            if (email !== v.value) dispatchBgSetEmail(v.value);
+            if (email !== v.value) dispatchBgSetEmailInfo({email: v.value});
         }
     }
 
     render() {
-        const {help_id = 'basics.bgmon', email} = this.props;
+        const {help_id = 'basics.bgmon', email=''} = this.props;
+        const enableEmail = isNil(this.props.enableEmail) ? !!email : this.props.enableEmail;
+        const toggleEnableEmail = (e) => {
+            const enableEmail = e.target.checked;
+            const email = enableEmail ? email : '';
+            dispatchBgSetEmailInfo({email, enableEmail});
+        };
         return (
             <div className='BGMon__footer' key='bgMonFooter'>
                 <button className='button std hl' onClick={this.onHide}
                         title='Hide Background Monitor'>Hide</button>
-                <InputField
-                    validator={Validate.validateEmail.bind(null, 'an email field')}
-                    tooltip='Enter an email to be notified when a process completes.'
-                    label='Email:'
-                    labelStyle={{display: 'inline-block', width: 40, fontWeight: 'bold'}}
-                    value={email}
-                    placeholder='Enter an email to get notification'
-                    size={27}
-                    onChange={this.onEmailChanged.bind(this)}
-                    actOn={['blur','enter']}
-                />
+                <div>
+                    <div style={{width: 235}}><input type='checkbox' checked={enableEmail} value='' onChange={toggleEnableEmail}/>Enable email notification</div>
+                    {enableEmail &&
+                        <InputField
+                            validator={Validate.validateEmail.bind(null, 'an email field')}
+                            tooltip='Enter an email to be notified when a process completes.'
+                            label='Email:'
+                            labelStyle={{display: 'inline-block', marginLeft: 18, width: 32, fontWeight: 'bold'}}
+                            value={email}
+                            placeholder='Enter an email to get notification'
+                            size={27}
+                            onChange={this.onEmailChanged.bind(this)}
+                            actOn={['blur','enter']}
+                        />
+                    }
+                </div>
                 <div>
                     <HelpIcon helpId={help_id} />
                 </div>
diff --git a/src/firefly/js/core/background/BackgroundUtil.js b/src/firefly/js/core/background/BackgroundUtil.js
@@ -2,7 +2,7 @@
  * License information at https://github.com/Caltech-IPAC/firefly/blob/master/License.txt
  */
 
-import {get, omit} from 'lodash';
+import {get, omit, isNil} from 'lodash';
 import Enum from 'enum';
 
 import {flux} from '../../Firefly.js';
@@ -42,6 +42,15 @@ export function getBgEmail() {
     return get(flux.getState(), [BACKGROUND_PATH, 'email']);
 }
 
+/**
+ * returns the email related info.  Currently, it's email and enableEmail.
+ * @returns {object.<string, }
+ */
+export function getBgEmailInfo() {
+    let {email, enableEmail} =  get(flux.getState(), BACKGROUND_PATH) || {};
+    enableEmail = isNil(enableEmail) ? !!email : enableEmail;
+    return {email, enableEmail};
+}
 
 export function emailSent(bgStatus) {
     return get(bgStatus, 'ATTRIBUTES', '').includes('EmailSent');
diff --git a/src/firefly/js/ui/DownloadDialog.jsx b/src/firefly/js/ui/DownloadDialog.jsx
@@ -4,7 +4,7 @@
 
 import React, {PureComponent} from 'react';
 import PropTypes from 'prop-types';
-import {set, cloneDeep} from 'lodash';
+import {set, cloneDeep, get} from 'lodash';
 
 import {flux} from '../Firefly.js';
 import DialogRootContainer from './DialogRootContainer.jsx';
@@ -13,16 +13,17 @@ import {dispatchShowDialog, dispatchHideDialog} from '../core/ComponentCntlr.js'
 import {FormPanel} from './FormPanel.jsx';
 import {FieldGroup} from './FieldGroup.jsx';
 import Validate from '../util/Validate.js';
+import {InputField} from './InputField.jsx';
 import {ListBoxInputField} from './ListBoxInputField.jsx';
 import {CheckboxGroupInputField} from './CheckboxGroupInputField.jsx';
-import FieldGroupUtils from '../fieldGroup/FieldGroupUtils.js';
 import {ValidationField} from './ValidationField.jsx';
 import {showInfoPopup} from './PopupUtil.jsx';
+import {SimpleComponent} from './SimpleComponent.jsx';
 
 import {makeTblRequest, getTblInfoById, getActiveTableId} from '../tables/TableUtil.js';
-import {dispatchPackage, doOnPackage} from '../core/background/BackgroundCntlr.js';
+import {dispatchPackage, dispatchBgSetEmailInfo} from '../core/background/BackgroundCntlr.js';
+import {getBgEmailInfo} from '../core/background/BackgroundUtil.js';
 import {SelectInfo} from '../tables/SelectInfo.js';
-import {dispatchAddSaga} from '../core/MasterSaga.js';
 import {DataTagMeta} from '../tables/TableUtil.js';
 
 const DOWNLOAD_DIALOG_ID = 'Download Options';
@@ -124,59 +125,49 @@ DownloadButton.propTypes = {
 };
 
 
-export class DownloadOptionPanel extends PureComponent {
+export class DownloadOptionPanel extends SimpleComponent {
 
-    constructor(props) {
-        super(props);
-        const sendEmail = FieldGroupUtils.getFldValue(FieldGroupUtils.getGroupFields(props.groupKey), 'sendEmail');
-        this.state = {sendEmail, mask: false};
-        this.onSubmit = this.onSubmit.bind(this);
-    }
-
-    componentDidMount() {
-        this.removeListener= flux.addListener(() => this.storeUpdate());
-    }
-
-    componentWillUnmount() {
-        this.removeListener && this.removeListener();
-        this.isUnmounted = true;
+    getNextState() {
+        const {email, enableEmail} = getBgEmailInfo();
+        return {mask:false, email, enableEmail};
     }
 
-    storeUpdate() {
-        const {groupKey} = this.props;
-        if (!this.isUnmounted) {
-            const sendEmail = FieldGroupUtils.getFldValue(FieldGroupUtils.getGroupFields(groupKey), 'sendEmail');
-            this.setState({sendEmail});
+    onEmailChanged(v) {
+        if (get(v, 'valid')) {
+            const {email} = this.state;
+            if (email !== v.value) dispatchBgSetEmailInfo({email: v.value});
         }
     }
 
-    onSubmit(options) {
-        const {tbl_id, dlParams, dataTag, cutoutSize} = this.props;
-        var {request, selectInfo} = getTblInfoById(tbl_id);
-        const {FileGroupProcessor} = dlParams;
-        const Title = dlParams.Title || options.Title;
-        const dreq = makeTblRequest(FileGroupProcessor, Title, Object.assign(dlParams, {cutoutSize}, options));
-        this.setState({mask: true});
-        request = set(cloneDeep(request), DataTagMeta, dataTag);
-        dispatchAddSaga(doOnPackage, {title: Title, callback:() => {
-            this.setState({mask: false});
-            showDownloadDialog(this, false);
-        }});
-        dispatchPackage(dreq, request, SelectInfo.newInstance(selectInfo).toString());
-    }
-
     render() {
-        const {groupKey, cutoutSize, help_id, children, style, title} = this.props;
-        const {mask, sendEmail} = this.state;
+        const {groupKey, cutoutSize, help_id, children, style, title, tbl_id, dlParams, dataTag} = this.props;
+        const {mask, email, enableEmail} = this.state;
         const labelWidth = 110;
         const ttl = title || DOWNLOAD_DIALOG_ID;
+
+        const onSubmit = (options) => {
+            var {request, selectInfo} = getTblInfoById(tbl_id);
+            const {FileGroupProcessor} = dlParams;
+            const Title = dlParams.Title || options.Title;
+            const dreq = makeTblRequest(FileGroupProcessor, Title, Object.assign(dlParams, {cutoutSize}, options));
+            request = set(cloneDeep(request), DataTagMeta, dataTag);
+            dispatchPackage(dreq, request, SelectInfo.newInstance(selectInfo).toString());
+            showDownloadDialog(this, false);
+        };
+
+        const toggleEnableEmail = (e) => {
+            const enableEmail = e.target.checked;
+            const email = enableEmail ? email : ''; 
+            dispatchBgSetEmailInfo({email, enableEmail});
+        };
+
         return (
             <div style = {Object.assign({margin: '4px', position: 'relative', minWidth: 350}, style)}>
                 {mask && <div style={{width: '100%', height: '100%'}} className='loading-mask'/>}
                 <FormPanel
                     submitText = 'Prepare Download'
                     groupKey = {groupKey}
-                    onSubmit = {this.onSubmit}
+                    onSubmit = {onSubmit}
                     onCancel = {() => dispatchHideDialog(ttl)}
                     help_id  = {help_id}>
                     <FieldGroup groupKey={'DownloadDialog'} keepState={true}>
@@ -211,29 +202,20 @@ export class DownloadOptionPanel extends PureComponent {
                                     ]}
                             labelWidth = {labelWidth}
                         />
-                        <CheckboxGroupInputField
-                            wrapperStyle={{marginTop: 20}}
-                            fieldKey='sendEmail'
-                            initialState= {{label : ' '}}
-                            options={[
-                                        {label: 'Also send me email with URLs to download', value: 'true'}
-                                    ]}
-                            labelWidth = {0}
+
+                        <div style={{width: 235, marginTop: 10}}><input type='checkbox' checked={enableEmail} onChange={toggleEnableEmail}/>Enable email notification</div>
+                        {enableEmail &&
+                        <InputField
+                            validator={Validate.validateEmail.bind(null, 'an email field')}
+                            tooltip='Enter an email to be notified when a process completes.'
+                            label='Email:'
+                            labelStyle={{display: 'inline-block', marginLeft: 18, width: 32, fontWeight: 'bold'}}
+                            value={email}
+                            placeholder='Enter an email to get notification'
+                            size={27}
+                            onChange={this.onEmailChanged.bind(this)}
+                            actOn={['blur','enter']}
                         />
-                        {sendEmail &&
-                            <div>
-                                <ValidationField
-                                    wrapperStyle={{marginTop: 5, marginLeft: 80}}
-                                    initialState = {{
-                                           value: '',
-                                           validator: Validate.validateEmail.bind(null, 'Email'),
-                                           label : 'Email:',
-                                           tooltip: 'Enter or modify your email address',
-                                       }}
-                                    fieldKey = 'Email'
-                                    size = {30}
-                                    labelWidth = {30}/>
-                            </div>
                         }
                     </FieldGroup>
                 </FormPanel>
@@ -275,7 +257,7 @@ DownloadOptionPanel.defaultProps= {
  * @param {boolean} [show=true] show or hide this dialog
  */
 function showDownloadDialog(panel, show=true) {
-    let ttl = panel.props.title || DOWNLOAD_DIALOG_ID;
+    const ttl = panel.props.title || DOWNLOAD_DIALOG_ID;
     if (show) {
         const content= (
             <PopupPanel title={ttl} >
