feat(auto-deploy): Add OTP auto-deploy project setting

landonreed · landonreed · commit 223d093b6057 · 2021-01-28T17:49:30.000-05:00
corresponds to changes in ibi-group/datatools-server#361
diff --git a/i18n/english.yml b/i18n/english.yml
@@ -57,6 +57,19 @@ components:
     success: Success!
     warning: Warning!
   DeploymentSettings:
+    autoDeploy:
+      description: >
+        Once a pinned deployment has been configured and deployed to a
+        server (at least once), auto-deployment can be enabled so that whenever
+        a new version is processed for an associated feed source, a deployment
+        will be kicked off (assuming there are no critical errors with the new
+        version).
+      label: Enable auto-deploy
+      noPinnedDeployment: None selected
+      pinnedDeploymentHelp: >
+        Tip: Under the Deployments tab, click the thumbtack icon next to the
+        deployment you would like to target for auto-deployments.
+      title: Auto-deployment
     boundsPlaceholder: 'min_lon, min_lat, max_lon, max_lat'
     buildConfig:
       elevationBucket:
@@ -69,6 +82,8 @@ components:
       stationTransfers: Sta. Transfers
       subwayAccessTime: Subway Access Time
       title: Build Config
+    clear: Clear
+    manageServers: Manage deployment servers
     osm:
       bounds: Custom Extract Bounds
       custom: Use Custom Extract Bounds
diff --git a/lib/common/util/permissions.js b/lib/common/util/permissions.js
@@ -43,7 +43,7 @@ export function checkEntitiesForFeeds (
 
 /**
  * Checks whether it is possible for a user in this application to analyze
- * projet deployments
+ * project deployments
  */
 export function deploymentsEnabledAndAccessAllowedForProject (
   project: ?Project,
diff --git a/lib/manager/actions/projects.js b/lib/manager/actions/projects.js
@@ -4,7 +4,7 @@ import {createAction, type ActionType} from 'redux-actions'
 import {browserHistory} from 'react-router'
 
 import {createVoidPayloadAction, secureFetch} from '../../common/actions'
-import {getConfigProperty} from '../../common/util/config'
+import {getConfigProperty, isModuleEnabled} from '../../common/util/config'
 import {deploymentsEnabledAndAccessAllowedForProject} from '../../common/util/permissions'
 import {fetchProjectDeployments} from './deployments'
 import {fetchProjectFeeds} from './feeds'
@@ -139,15 +139,16 @@ export function deleteProject (project: Project) {
 export function updateProject (
   projectId: string,
   changes: {[string]: any},
-  fetchFeeds: ?boolean = false
+  fetchFeedsAndDeployments: ?boolean = false
 ) {
   return function (dispatch: dispatchFn, getState: getStateFn) {
     dispatch(savingProject())
     const url = `/api/manager/secure/project/${projectId}`
     return dispatch(secureFetch(url, 'put', changes))
       .then((res) => {
-        if (fetchFeeds) {
-          return dispatch(fetchProjectWithFeeds(projectId))
+        if (fetchFeedsAndDeployments) {
+          dispatch(fetchProjectWithFeeds(projectId))
+          isModuleEnabled('deployment') && dispatch(fetchProjectDeployments(projectId))
         } else {
           return dispatch(fetchProject(projectId))
         }
diff --git a/lib/manager/components/DeploymentSettings.js b/lib/manager/components/DeploymentSettings.js
@@ -1,9 +1,21 @@
 // @flow
 
 import Icon from '@conveyal/woonerf/components/icon'
-import objectPath from 'object-path'
+// $FlowFixMe coalesce method is missing in flow type
+import {coalesce, get, set} from 'object-path'
 import React, {Component} from 'react'
-import {Row, Col, Button, Panel, Glyphicon, Radio, FormGroup, ControlLabel, FormControl} from 'react-bootstrap'
+import {
+  Button,
+  Checkbox,
+  Col,
+  ControlLabel,
+  FormControl,
+  FormGroup,
+  Glyphicon,
+  Panel,
+  Radio,
+  Row
+} from 'react-bootstrap'
 import update from 'react-addons-update'
 import {shallowEqual} from 'react-pure-render'
 import {withRouter} from 'react-router'
@@ -25,6 +37,7 @@ type Props = {
 }
 
 type State = {
+  autoDeploy?: boolean,
   buildConfig: Object,
   routerConfig: Object,
   useCustomOsmBounds?: boolean
@@ -34,27 +47,29 @@ class DeploymentSettings extends Component<Props, State> {
   messages = getComponentMessages('DeploymentSettings')
 
   state = {
-    buildConfig: objectPath.get(this.props, 'project.buildConfig') || {},
-    routerConfig: objectPath.get(this.props, 'project.routerConfig') || {}
+    buildConfig: get(this.props, 'project.buildConfig') || {},
+    routerConfig: get(this.props, 'project.routerConfig') || {}
   }
 
   componentWillReceiveProps (nextProps) {
     if (nextProps.project.lastUpdated !== this.props.project.lastUpdated) {
       // Reset state using project data if it is updated.
       this.setState({
-        buildConfig: objectPath.get(nextProps, 'project.buildConfig') || {},
-        routerConfig: objectPath.get(nextProps, 'project.routerConfig') || {}
+        buildConfig: get(nextProps, 'project.buildConfig') || {},
+        routerConfig: get(nextProps, 'project.routerConfig') || {}
       })
     }
   }
 
   componentDidMount () {
-    // FIXME: This is broken. Check for edits does not always return correct value.
-    // this.props.router.setRouteLeaveHook(this.props.route, () => {
-    //   if (!this._noEdits()) {
-    //     return 'You have unsaved information, are you sure you want to leave this page?'
-    //   }
-    // })
+    // $FlowFixMe react-router 3.x is not available in flow-typed.
+    const {routes, router} = this.props
+    // Check for unsaved edits and warn user if they attempt to navigate away.
+    router.setRouteLeaveHook(routes[0], () => {
+      if (!this._noEdits()) {
+        return 'You have unsaved information, are you sure you want to leave this page?'
+      }
+    })
   }
 
   _clearBuildConfig = () => {
@@ -72,7 +87,7 @@ class DeploymentSettings extends Component<Props, State> {
     if (item) {
       const stateUpdate = {}
       item.effects && item.effects.forEach(e => {
-        objectPath.set(stateUpdate, `${e.key}.$set`, e.value)
+        set(stateUpdate, `${e.key}.$set`, e.value)
       })
       switch (item.type) {
         case 'checkbox':
@@ -96,19 +111,19 @@ class DeploymentSettings extends Component<Props, State> {
 
   _onChangeCheckbox = (evt, stateUpdate = {}, index = null) => {
     const name = index !== null ? evt.target.name.replace('$index', `${index}`) : evt.target.name
-    objectPath.set(stateUpdate, `${name}.$set`, evt.target.checked)
+    set(stateUpdate, `${name}.$set`, evt.target.checked)
     this.setState(update(this.state, stateUpdate))
   }
 
   _onChangeSplit = (evt, stateUpdate = {}, index = null) => {
     const name = index !== null ? evt.target.name.replace('$index', `${index}`) : evt.target.name
-    objectPath.set(stateUpdate, `${name}.$set`, evt.target.value.split(','))
+    set(stateUpdate, `${name}.$set`, evt.target.value.split(','))
     this.setState(update(this.state, stateUpdate))
   }
 
   _onAddUpdater = () => {
     const stateUpdate = {}
-    objectPath.set(stateUpdate,
+    set(stateUpdate,
       `routerConfig.updaters.$${this.state.routerConfig.updaters ? 'push' : 'set'}`,
       [{type: '', url: '', frequencySec: 30, sourceType: '', defaultAgencyId: ''}]
     )
@@ -117,27 +132,27 @@ class DeploymentSettings extends Component<Props, State> {
 
   _onRemoveUpdater = (index) => {
     const stateUpdate = {}
-    objectPath.set(stateUpdate, `routerConfig.updaters.$splice`, [[index, 1]])
+    set(stateUpdate, `routerConfig.updaters.$splice`, [[index, 1]])
     this.setState(update(this.state, stateUpdate))
   }
 
   _onChange = (evt, stateUpdate = {}, index = null) => {
     const name = index !== null ? evt.target.name.replace('$index', `${index}`) : evt.target.name
     // If value is empty string or undefined, set to null in settings object.
     // Otherwise, certain fields (such as 'fares') would cause issues with OTP.
-    objectPath.set(stateUpdate, `${name}.$set`, evt.target.value || null)
+    set(stateUpdate, `${name}.$set`, evt.target.value || null)
     this.setState(update(this.state, stateUpdate))
   }
 
   _onChangeNumber = (evt, stateUpdate = {}, index = null) => {
     const name = index !== null ? evt.target.name.replace('$index', `${index}`) : evt.target.name
-    objectPath.set(stateUpdate, `${name}.$set`, +evt.target.value)
+    set(stateUpdate, `${name}.$set`, +evt.target.value)
     this.setState(update(this.state, stateUpdate))
   }
 
   _onSelectBool = (evt, stateUpdate = {}, index = null) => {
     const name = index !== null ? evt.target.name.replace('$index', `${index}`) : evt.target.name
-    objectPath.set(stateUpdate, `${name}.$set`, (evt.target.value === 'true'))
+    set(stateUpdate, `${name}.$set`, (evt.target.value === 'true'))
     this.setState(update(this.state, stateUpdate))
   }
 
@@ -149,15 +164,15 @@ class DeploymentSettings extends Component<Props, State> {
           // check for conditional render, e.g. elevationBucket is dependent on fetchElevationUS
           if (f.condition) {
             const {key, value} = f.condition
-            const val = objectPath.get(state, `${key}`)
+            const val = get(state, `${key}`)
             if (val !== value) return false
           }
           return true
         }
         return (
           <FormInput
             key={`${index}`}
-            value={objectPath.get(state, `${f.name}`)}
+            value={get(state, `${f.name}`)}
             field={f}
             onChange={this._getOnChange}
             data={state}
@@ -166,7 +181,13 @@ class DeploymentSettings extends Component<Props, State> {
       })
   }
 
-  _onSave = (evt) => this.props.updateProject(this.props.project.id, this.state)
+  _onSave = (evt) => this.props.updateProject(this.props.project.id, this.state, true)
+
+  _onToggleAutoDeploy = (evt) => {
+    console.log(evt.target.checked)
+    const stateUpdate = { autoDeploy: { $set: evt.target.checked } }
+    this.setState(update(this.state, stateUpdate))
+  }
 
   _onToggleCustomBounds = (evt) => {
     const stateUpdate = { useCustomOsmBounds: { $set: (evt.target.value === 'true') } }
@@ -189,6 +210,12 @@ class DeploymentSettings extends Component<Props, State> {
     }
   }
 
+  /**
+   * Get value for key from state or, if undefined, default to project property
+   * from props.
+   */
+  _getValue = (key) => coalesce(this.state, [key], this.props.project[key])
+
   /**
    * Determine if deployment settings have been modified by checking that every
    * item in the state matches the original object found in the project object.
@@ -198,22 +225,55 @@ class DeploymentSettings extends Component<Props, State> {
     .every(key => shallowEqual(this.state[key], this.props.project[key]))
 
   render () {
-    const updaters = objectPath.get(this.state, 'routerConfig.updaters') || []
+    const updaters = get(this.state, 'routerConfig.updaters') || []
     const {project, editDisabled} = this.props
+    const {pinnedDeploymentId} = project
+    const pinnedDeployment = pinnedDeploymentId && project.deployments && project.deployments.find(d => d.id === pinnedDeploymentId)
     return (
       <div key={project.lastUpdated} className='deployment-settings-panel'>
         <LinkContainer to={`/admin/servers`} style={{marginBottom: '20px'}}>
           <Button block bsStyle='primary' bsSize='large'>
-            <Icon type='server' /> Manage deployment servers
+            <Icon type='server' /> {this.messages('manageServers')}
           </Button>
         </LinkContainer>
+        {/* Auto-deploy settings */}
+        <Panel header={
+          <h4>
+            <Icon type='rocket' />{' '}
+            {this.messages('autoDeploy.title')}
+          </h4>
+        }>
+          <p>{this.messages('autoDeploy.description')}</p>
+          <p>
+            Pinned Deployment:{' '}
+            {pinnedDeployment
+              ? pinnedDeployment.name
+              : <span className='text-muted'>
+                {this.messages('autoDeploy.noPinnedDeployment')}
+              </span>
+            }
+          </p>
+          {!pinnedDeployment &&
+            <small className='text-danger'>
+              {this.messages('autoDeploy.pinnedDeploymentHelp')}
+            </small>
+          }
+          <Checkbox
+            checked={this._getValue('autoDeploy')}
+            disabled={!pinnedDeployment}
+            name={'autoDeploy'}
+            onChange={this._onToggleAutoDeploy}
+          >
+            {this.messages('autoDeploy.label')}
+          </Checkbox>
+        </Panel>
         {/* Build config settings */}
         <Panel header={
           <h4>
             <Button
               bsSize='xsmall'
               onClick={this._clearBuildConfig}
-              className='pull-right'>Clear
+              className='pull-right'>{this.messages('clear')}
             </Button>
             <Icon type='cog' />{' '}
             {this.messages('buildConfig.title')}
@@ -227,7 +287,7 @@ class DeploymentSettings extends Component<Props, State> {
             <Button
               bsSize='xsmall'
               onClick={this._clearRouterConfig}
-              className='pull-right'>Clear
+              className='pull-right'>{this.messages('clear')}
             </Button>
             <Icon type='cog' />{' '}
             {this.messages('routerConfig.title')}
@@ -278,14 +338,14 @@ class DeploymentSettings extends Component<Props, State> {
           <FormGroup
             onChange={this._onToggleCustomBounds}>
             <Radio
+              checked={!this._getValue('useCustomOsmBounds')}
               name='osm-extract'
-              checked={typeof this.state.useCustomOsmBounds !== 'undefined' ? !this.state.useCustomOsmBounds : !project.useCustomOsmBounds}
               value={false}>
               {this.messages('osm.gtfs')}
             </Radio>
             <Radio
+              checked={this._getValue('useCustomOsmBounds')}
               name='osm-extract'
-              checked={typeof this.state.useCustomOsmBounds !== 'undefined' ? this.state.useCustomOsmBounds : project.useCustomOsmBounds}
               value>
               {this.messages('osm.custom')}
             </Radio>
diff --git a/lib/types/index.js b/lib/types/index.js
@@ -690,6 +690,7 @@ export type RouterConfig = {
 }
 
 export type Project = {
+  autoDeploy: boolean,
   autoFetchFeeds: boolean,
   autoFetchHour: number,
   autoFetchMinute: number,
diff --git a/package.json b/package.json
@@ -61,7 +61,7 @@
     "lodash": "^4.17.10",
     "moment": "^2.11.2",
     "numeral": "2.0.4",
-    "object-path": "^0.11.1",
+    "object-path": "^0.11.5",
     "polyline": "^0.2.0",
     "prop-types": "^15.6.0",
     "qs": "^6.2.1",
diff --git a/yarn.lock b/yarn.lock
@@ -9695,7 +9695,6 @@ npm@^6.14.8:
     cmd-shim "^3.0.3"
     columnify "~1.5.4"
     config-chain "^1.1.12"
-    debuglog "*"
     detect-indent "~5.0.0"
     detect-newline "^2.1.0"
     dezalgo "~1.0.3"
@@ -9710,7 +9709,6 @@ npm@^6.14.8:
     has-unicode "~2.0.1"
     hosted-git-info "^2.8.8"
     iferr "^1.0.2"
-    imurmurhash "*"
     infer-owner "^1.0.4"
     inflight "~1.0.6"
     inherits "^2.0.4"
@@ -9729,14 +9727,8 @@ npm@^6.14.8:
     libnpx "^10.2.4"
     lock-verify "^2.1.0"
     lockfile "^1.0.4"
-    lodash._baseindexof "*"
     lodash._baseuniq "~4.6.0"
-    lodash._bindcallback "*"
-    lodash._cacheindexof "*"
-    lodash._createcache "*"
-    lodash._getnative "*"
     lodash.clonedeep "~4.5.0"
-    lodash.restparam "*"
     lodash.union "~4.6.0"
     lodash.uniq "~4.5.0"
     lodash.without "~4.4.0"
@@ -9872,7 +9864,7 @@ object-keys@^1.0.11, object-keys@^1.0.12:
   resolved "https://registry.yarnpkg.com/object-keys/-/object-keys-1.1.1.tgz#1c47f272df277f3b1daf061677d9c82e2322c60e"
   integrity sha512-NuAESUOUMrlIXOfHKzD6bpPu3tYt3xvjNdRIQ+FeT0lNb4K8WR70CaDxhuNguS2XG+GjkyMwOzsN5ZktImfhLA==
 
-object-path@^0.11.1:
+object-path@^0.11.5:
   version "0.11.5"
   resolved "https://registry.yarnpkg.com/object-path/-/object-path-0.11.5.tgz#d4e3cf19601a5140a55a16ad712019a9c50b577a"
   integrity sha512-jgSbThcoR/s+XumvGMTMf81QVBmah+/Q7K7YduKeKVWL7N111unR2d6pZZarSk6kY/caeNxUDyxOvMWyzoU2eg==

Original file line number	Diff line number	Diff line change
`@@ -690,6 +690,7 @@ export type RouterConfig = {`
`690`	`690`	`}`
`691`	`691`
`692`	`692`	`export type Project = {`
	`693`	`+ autoDeploy: boolean,`
`693`	`694`	`autoFetchFeeds: boolean,`
`694`	`695`	`autoFetchHour: number,`
`695`	`696`	`autoFetchMinute: number,`