refactor(validation): prevent MTC feed publication on blocking issues

Author: landonreed

lib/manager/actions/status.js

@@ -144,7 +144,7 @@ export function handleFinishedJob (job: ServerJob) {
         if (isExtensionEnabled('mtc')) {
           const firstDate = job.validationResult && job.validationResult.firstCalendarDate
           const now = moment().startOf('day')
-          if (moment(firstDate).isAfter(now)) {
+          if (firstDate && moment(firstDate).isAfter(now)) {
             dispatch(setStatusModal({
               title: 'Warning: Feed contains service for future dates only!',
               body: `Use the 'Merge' button to merge with the currently active feed version.`

lib/manager/actions/versions.js

@@ -97,10 +97,19 @@ const requestingFeedVersionIsochrones = createVoidPayloadAction('REQUESTING_FEED
 const requestingValidationIssueCount = createVoidPayloadAction('REQUESTING_VALIDATION_ISSUE_COUNT')
 
 // setActiveVersion used in components
-export const setActiveVersion = createAction(
+export const settingActiveVersion = createAction(
   'SET_ACTIVE_FEEDVERSION',
   (payload: FeedVersion) => payload
 )
+export function setActiveVersion (version: FeedVersion) {
+  return function (dispatch: dispatchFn, getState: getStateFn) {
+    // Dispatch action to set value in reducer.
+    dispatch(settingActiveVersion(version))
+    // Fetch validation issue count. NOTE: future version-specific data fetching
+    // could also be triggered here.
+    version && dispatch(fetchValidationIssueCount(version))
+  }
+}
 const uploadingFeed = createVoidPayloadAction('UPLOADING_FEED')
 
 export type VersionActions = ActionType<typeof deletingFeedVersion> |

lib/manager/components/validation/GtfsValidationViewer.js

@@ -3,12 +3,22 @@
 import Icon from '@conveyal/woonerf/components/icon'
 import moment from 'moment'
 import React, {Component} from 'react'
-import {Alert, ListGroup, Table, ListGroupItem, Panel, Col, Row} from 'react-bootstrap'
+import {
+  Alert,
+  Label,
+  ListGroup,
+  Table,
+  ListGroupItem,
+  Panel,
+  Col,
+  Row
+} from 'react-bootstrap'
 
 import Loading from '../../../common/components/Loading'
 import OptionButton from '../../../common/components/OptionButton'
+import {isExtensionEnabled} from '../../../common/util/config'
 import toSentenceCase from '../../../common/util/to-sentence-case'
-import {getTableFatalExceptions} from '../../util/version'
+import {BLOCKING_ERROR_TYPES, getTableFatalExceptions} from '../../util/version'
 
 import ValidationErrorItem from './ValidationErrorItem'
 
@@ -34,10 +44,6 @@ export default class GtfsValidationViewer extends Component<Props, State> {
     limit: DEFAULT_LIMIT
   }
 
-  componentWillMount () {
-    this.props.fetchValidationIssueCount(this.props.version)
-  }
-
   componentWillReceiveProps (nextProps: Props) {
     if (
       this._validationHasErrors(this.props.validationResult) &&
@@ -127,6 +133,10 @@ export default class GtfsValidationViewer extends Component<Props, State> {
           if (e.entity_type !== firstError.entity_type) multiTyped = true
         })
         const tableType = category.type.indexOf('TABLE') !== -1
+        // Check to see if this is a blocking issue (MTC-only) preventing
+        // the version from being published.
+        const isBlockingIssue = isExtensionEnabled('mtc') &&
+          BLOCKING_ERROR_TYPES.indexOf(category.type) !== -1
         const includeEntityType = tableType || multiTyped
         return (
           <ListGroup key={index} fill>
@@ -140,6 +150,8 @@ export default class GtfsValidationViewer extends Component<Props, State> {
                   <h4>
                     <Icon type={errorTypeIsActive ? 'caret-down' : 'caret-right'} />
                     {toSentenceCase(category.type.replace(/_/g, ' '))}
+                    {' '}
+                    {isBlockingIssue && <Label bsStyle='danger'>BLOCKING</Label>}
                     <span className='pull-right text-warning'>
                       <Icon type='exclamation-triangle' /> {category.count}
                     </span>

lib/manager/components/version/FeedVersionDetails.js

@@ -3,12 +3,20 @@
 import Icon from '@conveyal/woonerf/components/icon'
 import moment from 'moment'
 import React, {Component} from 'react'
-import {Button, ButtonToolbar, DropdownButton, ListGroupItem, MenuItem} from 'react-bootstrap'
+import {
+  Button,
+  ButtonToolbar,
+  DropdownButton,
+  ListGroupItem,
+  MenuItem
+} from 'react-bootstrap'
+import {Link} from 'react-router'
 import area from 'turf-area'
 import bboxPoly from 'turf-bbox-polygon'
 
 import * as versionsActions from '../../actions/versions'
 import {getConfigProperty, isExtensionEnabled} from '../../../common/util/config'
+import {BLOCKING_ERROR_TYPES} from '../../util/version'
 import VersionDateLabel from './VersionDateLabel'
 
 import type {FeedVersion, Bounds, Feed} from '../../../types'
@@ -31,6 +39,16 @@ export default class FeedVersionDetails extends Component<Props> {
     return poly ? area(poly) : 0
   }
 
+  /**
+   * Prevent publication if the error_counts object is missing (bad validation)
+   * or if a blocking error type was found.
+   */
+  _checkBlockingIssue = (version: FeedVersion) => {
+    return !version.validationResult.error_counts ||
+      !!(version.validationResult.error_counts
+        .find(ec => BLOCKING_ERROR_TYPES.indexOf(ec.type) !== -1))
+  }
+
   _handleMergeVersion = (versionId: string) => {
     // For now, merging feeds only works for the MTC extension. It will fail
     // when the 'none' merge type is used.
@@ -59,7 +77,7 @@ export default class FeedVersionDetails extends Component<Props> {
         version.feedSource.id,
         'manage-feed'
       )
-
+    const hasBlockingIssue = this._checkBlockingIssue(version)
     return (
       <ListGroupItem>
         <h4>
@@ -85,7 +103,7 @@ export default class FeedVersionDetails extends Component<Props> {
                 </DropdownButton>
               }
               <Button
-                disabled={isPublished || processing || !userCanManageFeed}
+                disabled={hasBlockingIssue || isPublished || processing || !userCanManageFeed}
                 bsStyle={isPublished ? 'success' : 'warning'}
                 onClick={this._onClickPublish}>
                 {isPublished
@@ -105,6 +123,23 @@ export default class FeedVersionDetails extends Component<Props> {
           </span>
           {' '}
           <VersionDateLabel version={version} />
+          {hasBlockingIssue &&
+            <div
+            className='text-danger'
+            style={{
+              position: 'absolute',
+              bottom: '1px',
+              right: '5px',
+              fontSize: 'x-small'
+            }}>
+              Cannot publish version because it has a blocking issue.
+              (See{' '}
+              <Link
+                to={`/feed/${feedSource.id}/version/${version.version}/issues`}>
+                validation issues
+              </Link>.)
+            </div>
+          }
         </h4>
         <p>
           {summary && summary.avgDailyRevenueTime

lib/manager/components/version/FeedVersionViewer.js

@@ -51,6 +51,11 @@ export type Props = {
 export default class FeedVersionViewer extends Component<Props> {
   messages = getComponentMessages('FeedVersionViewer')
 
+  componentWillMount () {
+    const {fetchValidationIssueCount, version} = this.props
+    version && fetchValidationIssueCount(version)
+  }
+
   render () {
     const {
       feedVersionIndex,

lib/manager/util/version.js

@@ -35,3 +35,15 @@ export function versionHasExpired (version: FeedVersion): boolean {
 export function versionHasNotBegun (version: FeedVersion): boolean {
   return moment(version.validationResult.startDate).isAfter(moment())
 }
+
+// Error types that should prevent publishing a feed version to MTC. These types
+// must correspond to those found at:
+// https://github.com/conveyal/gtfs-lib/blob/dev/src/main/java/com/conveyal/gtfs/error/NewGTFSErrorType.java
+export const BLOCKING_ERROR_TYPES = [
+  'ILLEGAL_FIELD_VALUE',
+  'TABLE_IN_SUBDIRECTORY',
+  'WRONG_NUMBER_OF_FIELDS',
+  'MISSING_COLUMN',
+  'TABLE_MISSING_COLUMN_HEADERS',
+  'REFERENTIAL_INTEGRITY'
+]

lib/types/index.js

@@ -57,7 +57,7 @@ export type Route = {
   routeShortName: ?string,
   routeTextColor: string,
   routeUrl: string,
-  status: string,
+  status: string, 
   wheelchairBoarding: string
 }