feat(auto-publish): Add auto-publish support (MTC ext. req'd)

ibi-group · Nov 30, 2021 · d188125 · d188125
1 parent a65c863
commit d188125
Show file tree

Hide file tree

Showing 5 changed files with 96 additions and 22 deletions.
diff --git a/lib/manager/actions/versions.js b/lib/manager/actions/versions.js
@@ -12,12 +12,12 @@ import {ENTITY} from '../../editor/constants'
 import {getKeyForId} from '../../editor/util/gtfs'
 import {getEntityGraphQLRoot, getEntityIdField, getGraphQLFieldsForEntity} from '../../gtfs/util'
 import {validateGtfsPlusFeed} from '../../gtfsplus/actions/gtfsplus'
-import {handleJobResponse, setErrorMessage, startJobMonitor} from './status'
-import {fetchFeedSource} from './feeds'
-
 import type {Feed, FeedVersion, ShapefileExportType} from '../../types'
 import type {dispatchFn, getStateFn, ValidationIssueCount} from '../../types/reducers'
 
+import {handleJobResponse, setErrorMessage, startJobMonitor} from './status'
+import {fetchFeedSource} from './feeds'
+
 const deletingFeedVersion = createVoidPayloadAction('DELETING_FEEDVERSION')
 const publishedFeedVersion = createAction(
   'PUBLISHED_FEEDVERSION',
@@ -160,6 +160,13 @@ export function fetchFeedVersion (feedVersionId: string) {
  */
 export function publishFeedVersion (feedVersion: FeedVersion) {
   return function (dispatch: dispatchFn, getState: getStateFn) {
+    if (
+      feedVersion.feedSource.autoPublish &&
+      !window.confirm('Are you sure you want publish this feed version again?')
+    ) {
+      // For feed set to auto-publish, if the user does not confirm, do nothing.
+      return
+    }
     const url = `${SECURE_API_PREFIX}feedversion/${feedVersion.id}/publish`
     return dispatch(secureFetch(url, 'post'))
       .then(response => response.json())

diff --git a/lib/manager/components/CreateFeedSource.js b/lib/manager/components/CreateFeedSource.js
@@ -21,11 +21,12 @@ import validator from 'validator'
 import {createFeedSource} from '../actions/feeds'
 import Loading from '../../common/components/Loading'
 import {FREQUENCY_INTERVALS} from '../../common/constants'
-import FeedFetchFrequency from './FeedFetchFrequency'
+import {isExtensionEnabled} from '../../common/util/config'
 import {validationState} from '../util'
-
 import type {FetchFrequency, NewFeed} from '../../types'
 
+import FeedFetchFrequency from './FeedFetchFrequency'
+
 type Props = {
   createFeedSource: typeof createFeedSource,
   onCancel: () => void,
@@ -235,6 +236,26 @@ export default class CreateFeedSource extends Component<Props, State> {
               </ListGroupItem>
             </ListGroup>
           </Panel>
+          {isExtensionEnabled('mtc') && (
+            <Panel header={<h3>Automatic publishing</h3>}>
+              <ListGroup fill>
+                <ListGroupItem>
+                  <FormGroup>
+                    <Checkbox
+                      checked={model.autoPublish}
+                      onChange={this._toggleCheckBox('autoPublish')}
+                    >
+                      <strong>Auto-publish this feed</strong>
+                    </Checkbox>
+                    <small>
+                      Set this feed source to be automatically published
+                      when a new version is created.
+                    </small>
+                  </FormGroup>
+                </ListGroupItem>
+              </ListGroup>
+            </Panel>
+          )}
         </Col>
         <Col xs={12}>
           <Button

diff --git a/lib/manager/components/GeneralSettings.js b/lib/manager/components/GeneralSettings.js
@@ -17,9 +17,10 @@ import {
 
 import * as feedsActions from '../actions/feeds'
 import { FREQUENCY_INTERVALS } from '../../common/constants'
+import { isExtensionEnabled } from '../../common/util/config'
+import LabelAssigner from '../components/LabelAssigner'
 import type { Feed, FetchFrequency, Project } from '../../types'
 import type { ManagerUserState } from '../../types/reducers'
-import LabelAssigner from '../components/LabelAssigner'
 
 import FeedFetchFrequency from './FeedFetchFrequency'
 
@@ -69,6 +70,12 @@ export default class GeneralSettings extends Component<Props, State> {
     updateFeedSource(feedSource, {retrievalMethod: value})
   }
 
+  // FIXME_QBD: refactor similar code (See CreateFeedSource).
+  _onToggleAutoPublish = () => {
+    const {feedSource, updateFeedSource} = this.props
+    updateFeedSource(feedSource, {autoPublish: !feedSource.autoPublish})
+  }
+
   _onSelectFetchInterval = (fetchInterval: number) => {
     const {feedSource, updateFeedSource} = this.props
     updateFeedSource(feedSource, {fetchInterval})
@@ -201,6 +208,28 @@ export default class GeneralSettings extends Component<Props, State> {
             </ListGroupItem>
           </ListGroup>
         </Panel>
+        {isExtensionEnabled('mtc') && (
+          <Panel header={<h3>Automatic publishing</h3>}>
+            <ListGroup fill>
+              <ListGroupItem>
+                <FormGroup>
+                  <Checkbox
+                    checked={feedSource.autoPublish}
+                    disabled={disabled}
+                    onChange={this._onToggleAutoPublish}
+                    bsStyle='danger'
+                  >
+                    <strong>Auto-publish this feed</strong>
+                  </Checkbox>
+                  <small>
+                    Set this feed source to be automatically published
+                    when a new version is created.
+                  </small>
+                </FormGroup>
+              </ListGroupItem>
+            </ListGroup>
+          </Panel>
+        )}
         <Panel header={<h3>Labels</h3>}>
           <LabelAssigner feedSource={feedSource} project={project} />
         </Panel>

diff --git a/lib/manager/components/version/FeedVersionDetails.js b/lib/manager/components/version/FeedVersionDetails.js
@@ -15,13 +15,13 @@ 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 type {FeedVersion, GtfsPlusValidation, Bounds, Feed} from '../../../types'
+import type {ManagerUserState} from '../../../types/reducers'
+
 import FeedVersionSpanChart from './FeedVersionSpanChart'
 import VersionRetrievalBadge from './VersionRetrievalBadge'
 import VersionSelectorDropdown from './VersionSelectorDropdown'
 
-import type {FeedVersion, GtfsPlusValidation, Bounds, Feed} from '../../../types'
-import type {ManagerUserState} from '../../../types/reducers'
-
 type Props = {
   comparedVersion: ?FeedVersion,
   feedSource: Feed,
@@ -111,6 +111,28 @@ export default class FeedVersionDetails extends Component<Props> {
     const mergeButtonLabel = isMergedServicePeriods
       ? 'Cannot re-merge feed'
       : 'Merge with version'
+
+    const hasMtcExtension = isExtensionEnabled('mtc')
+    let publishWarningMessage
+    if (hasMtcExtension) {
+      if (hasBlockingIssue || hasGtfsPlusBlockingIssue) {
+        publishWarningMessage = (
+          <span>
+            Cannot publish version because it has a{' '}
+            {hasGtfsPlusBlockingIssue ? 'GTFS+ ' : ''}
+            blocking issue.
+            (See{' '}
+            <Link
+              to={`/feed/${feedSource.id}/version/${version.version}/${hasGtfsPlusBlockingIssue ? 'gtfsplus' : 'issues'}`}>
+              {hasGtfsPlusBlockingIssue ? 'GTFS+' : 'validation'} issues
+            </Link>.)
+          </span>
+        )
+      } else if (feedSource.autoPublish) {
+        publishWarningMessage = 'Reminder: this feed is already set to be auto-published!'
+      }
+    }
+
     return (
       <ListGroupItem>
         <h4 className='pull-left' style={{ marginBottom: '2px' }}>
@@ -119,7 +141,7 @@ export default class FeedVersionDetails extends Component<Props> {
             Feed validity dates
           </span>
         </h4>
-        {isExtensionEnabled('mtc') &&
+        {hasMtcExtension &&
           <ButtonToolbar className='pull-right' style={{ marginTop: '2px' }}>
             <VersionSelectorDropdown
               dropdownProps={{
@@ -155,8 +177,7 @@ export default class FeedVersionDetails extends Component<Props> {
             </Button>
           </ButtonToolbar>
         }
-        {(hasBlockingIssue || hasGtfsPlusBlockingIssue) &&
-          isExtensionEnabled('mtc') &&
+        {hasMtcExtension && (
           <div
             className='pull-right text-danger'
             style={{
@@ -165,17 +186,11 @@ export default class FeedVersionDetails extends Component<Props> {
               marginLeft: '5px',
               textAlign: 'right',
               width: '180px'
-            }}>
-            Cannot publish version because it has a{' '}
-            {hasGtfsPlusBlockingIssue ? 'GTFS+ ' : ''}
-            blocking issue.
-            (See{' '}
-            <Link
-              to={`/feed/${feedSource.id}/version/${version.version}/${hasGtfsPlusBlockingIssue ? 'gtfsplus' : 'issues'}`}>
-              {hasGtfsPlusBlockingIssue ? 'GTFS+' : 'validation'} issues
-            </Link>.)
+            }}
+          >
+            {publishWarningMessage}
           </div>
-        }
+        )}
 
         <FeedVersionSpanChart
           activeVersion={version}

diff --git a/lib/types/index.js b/lib/types/index.js
@@ -378,6 +378,7 @@ export type FeedTransformRules = {
 }
 
 export type Feed = {
+  autoPublish?: boolean,
   dateCreated: number,
   deployable: boolean,
   deployments?: Array<Deployment>,
@@ -413,6 +414,7 @@ export type Feed = {
 
 export type NewFeed = {
   autoFetchFeed?: boolean,
+  autoPublish?: boolean,
   deployable?: boolean,
   fetchFrequency: FetchFrequency,
   fetchInterval: number,