official feed in add feed form

MobilityData · Nov 12, 2024 · 0357784 · 0357784
1 parent 276fbe6
commit 0357784
Show file tree

Hide file tree

Showing 9 changed files with 86 additions and 13 deletions.
diff --git a/functions/packages/feed-form/src/__tests__/feed-form.spec.ts b/functions/packages/feed-form/src/__tests__/feed-form.spec.ts
@@ -8,6 +8,7 @@ import {type FeedSubmissionFormRequestBody} from "../impl/types";
 const sampleRequestBodyGTFS: FeedSubmissionFormRequestBody = {
   name: "Sample Feed",
   isOfficialProducer: "yes",
+  isOfficialFeed: "yes",
   dataType: "gtfs",
   transitProviderName: "Sample Transit Provider",
   feedLink: "https://example.com/feed",
@@ -137,6 +138,7 @@ describe("Feed Form Implementation", () => {
       [SheetCol.LinkToAssociatedGTFS]:
         sampleRequestBodyGTFS.gtfsRelatedScheduleLink,
       [SheetCol.LogoPermission]: sampleRequestBodyGTFS.hasLogoPermission,
+      [SheetCol.OfficialFeedSource]: sampleRequestBodyGTFS.isOfficialFeed,
     });
   });
 });
diff --git a/functions/packages/feed-form/src/__tests__/github-issue-builder.spec.ts b/functions/packages/feed-form/src/__tests__/github-issue-builder.spec.ts
@@ -7,6 +7,7 @@ describe("buildGithubIssueBody", () => {
   it("should generate content for basic form data with GTFS feed", () => {
     const formData: FeedSubmissionFormRequestBody = {
       isOfficialProducer: "yes",
+      isOfficialFeed: "yes",
       dataType: "gtfs",
       transitProviderName: "Test Agency",
       name: "Test Agency",
@@ -64,6 +65,7 @@ describe("buildGithubIssueBody", () => {
   it("should handle optional location fields gracefully", () => {
     const formData: FeedSubmissionFormRequestBody = {
       isOfficialProducer: "no",
+      isOfficialFeed: "yes",
       dataType: "gtfs",
       transitProviderName: "Test Agency",
       name: "Test Agency",
@@ -111,6 +113,7 @@ describe("buildGithubIssueBody", () => {
   it("should handle non-GTFS data types (tu, vp, sa)", () => {
     const formData: FeedSubmissionFormRequestBody = {
       isOfficialProducer: "yes",
+      isOfficialFeed: "yes",
       dataType: "gtfs_rt",
       transitProviderName: "Test Agency",
       name: "Test Agency",
@@ -159,6 +162,7 @@ describe("buildGithubIssueBody", () => {
   it("should handle missing authentication details", () => {
     const formData: FeedSubmissionFormRequestBody = {
       isOfficialProducer: "",
+      isOfficialFeed: "yes",
       dataType: "gtfs",
       transitProviderName: "Test Agency",
       name: "Test Agency",

diff --git a/functions/packages/feed-form/src/impl/feed-form-impl.ts b/functions/packages/feed-form/src/impl/feed-form-impl.ts
@@ -43,7 +43,11 @@ export const writeToSheet = async (
         process.env.GITHUB_TOKEN
       );
     }
-    await sendSlackWebhook(sheetId, githubIssueUrl);
+    await sendSlackWebhook(
+      sheetId,
+      githubIssueUrl,
+      formData.isOfficialFeed === "yes"
+    );
     return {message: "Data written to the new sheet successfully!"};
   } catch (error) {
     logger.error("Error writing to sheet:", error);
@@ -81,6 +85,7 @@ export enum SheetCol {
   UserInterview = "User interview email",
   DataProducerEmail = "Data producer email",
   OfficialProducer = "Are you the official producer or transit agency responsible for this data?",
+  OfficialFeedSource = "Is Official Feed Source",
   ToolsAndSupport = "What tools and support do you use to create your GTFS data?",
   LinkToAssociatedGTFS = "Link to associated GTFS Schedule feed",
   LogoPermission = "Do we have permission to share your logo on https://mobilitydatabase.org/contribute?",
@@ -186,6 +191,7 @@ export function buildFeedRow(
     [SheetCol.UserInterview]: formData.userInterviewEmail ?? "",
     [SheetCol.DataProducerEmail]: formData.dataProducerEmail ?? "",
     [SheetCol.OfficialProducer]: formData.isOfficialProducer,
+    [SheetCol.OfficialFeedSource]: formData.isOfficialFeed ?? "",
     [SheetCol.ToolsAndSupport]: formData.whatToolsUsedText ?? "",
     [SheetCol.LinkToAssociatedGTFS]: formData.gtfsRelatedScheduleLink ?? "",
     [SheetCol.LogoPermission]: formData.hasLogoPermission,
@@ -196,11 +202,20 @@ export function buildFeedRow(
  * Sends a Slack webhook message to the configured Slack webhook URL
  * @param {string} spreadsheetId The ID of the Google Sheet
  * @param {string} githubIssueUrl The URL of the created GitHub issue
+ * @param {boolean} isOfficialSource Whether the feed is an official source
  */
-async function sendSlackWebhook(spreadsheetId: string, githubIssueUrl: string) {
+async function sendSlackWebhook(
+  spreadsheetId: string,
+  githubIssueUrl: string,
+  isOfficialSource: boolean
+) {
   const slackWebhookUrl = process.env.SLACK_WEBHOOK_URL;
   const sheetUrl = `https://docs.google.com/spreadsheets/d/${spreadsheetId}/edit`;
   if (slackWebhookUrl !== undefined && slackWebhookUrl !== "") {
+    let headerText = "New Feed Added";
+    if (isOfficialSource) {
+      headerText += " 🔹 Official Source";
+    }
     const linksElement = [
       {
         type: "emoji",
@@ -237,7 +252,8 @@ async function sendSlackWebhook(spreadsheetId: string, githubIssueUrl: string) {
           type: "header",
           text: {
             type: "plain_text",
-            text: "New Feed Added",
+            text: headerText,
+            emoji: true,
           },
         },
         {
@@ -259,11 +275,11 @@ async function sendSlackWebhook(spreadsheetId: string, githubIssueUrl: string) {
           ],
         },
         {
-          "type": "rich_text",
-          "elements": [
+          type: "rich_text",
+          elements: [
             {
-              "type": "rich_text_section",
-              "elements": linksElement,
+              type: "rich_text_section",
+              elements: linksElement,
             },
           ],
         },
@@ -292,9 +308,12 @@ async function createGithubIssue(
 ): Promise<string> {
   const githubRepoUrlIssue =
     "https://api.github.com/repos/MobilityData/mobility-database-catalogs/issues";
-  const issueTitle =
+  let issueTitle =
     "New Feed Added" +
     (formData.transitProviderName ? `: ${formData.transitProviderName}` : "");
+  if (formData.isOfficialFeed === "yes") {
+    issueTitle += " - Official Feed";
+  }
   const issueBody = buildGithubIssueBody(formData, spreadsheetId);
   try {
     const response = await axios.post(
@@ -353,7 +372,7 @@ export function buildGithubIssueBody(
   ${formData.isUpdatingFeed === "yes" ? "Feed update" : "New feed"}`;
 
   if (formData.name) {
-  content += `
+    content += `
 
   #### Name
   ${formData.name}`;

diff --git a/functions/packages/feed-form/src/impl/types.ts b/functions/packages/feed-form/src/impl/types.ts
@@ -7,6 +7,7 @@ export type AuthTypes =
 
 export interface FeedSubmissionFormRequestBody {
   isOfficialProducer: YesNoFormInput;
+  isOfficialFeed: "yes" | "no" | "unsure" | undefined;
   dataType: "gtfs" | "gtfs_rt";
   transitProviderName?: string;
   feedLink?: string;

diff --git a/web-app/cypress/e2e/addFeedForm.cy.ts b/web-app/cypress/e2e/addFeedForm.cy.ts
@@ -23,6 +23,7 @@ describe('Add Feed Form', () => {
       cy.get('[data-cy=isOfficialProducerYes]').click({
         force: true,
       });
+      cy.muiDropdownSelect('[data-cy=isOfficialFeed]', 'yes');
       cy.get('[data-cy=feedLink] input').type('https://example.com/feed', {
         force: true,
       });
@@ -49,6 +50,7 @@ describe('Add Feed Form', () => {
 
     it('should submit a new gtfs realtime feed as not official producer', () => {
       cy.get('[data-cy=isOfficialProducerNo]').click();
+      cy.muiDropdownSelect('[data-cy=isOfficialFeed]', 'no');
       cy.muiDropdownSelect('[data-cy=dataType]', 'gtfs_rt');
       cy.get('[data-cy=submitFirstStep]').click();
       cy.url().should('include', '/contribute?step=2');
@@ -70,12 +72,14 @@ describe('Add Feed Form', () => {
     it('should display errors for gtfs feed', () => {
       cy.muiDropdownSelect('[data-cy=isUpdatingFeed]', 'yes');
       cy.get('[data-cy=submitFirstStep]').click();
+      cy.assetMuiError('[data-cy=isOfficialFeedLabel]');
       cy.assetMuiError('[data-cy=isOfficialProducerLabel]');
       cy.assetMuiError('[data-cy=feedLinkLabel]');
       cy.assetMuiError('[data-cy=oldFeedLabel]');
       cy.location('pathname').should('eq', '/contribute');
       // Step 1 values
       cy.get('[data-cy=isOfficialProducerYes]').click();
+      cy.muiDropdownSelect('[data-cy=isOfficialFeed]', 'yes');
       cy.get('[data-cy=feedLink] input').type('https://example.com/feed', {
         force: true,
       });
@@ -106,9 +110,11 @@ describe('Add Feed Form', () => {
       cy.muiDropdownSelect('[data-cy=dataType]', 'gtfs_rt');
       cy.get('[data-cy=submitFirstStep]').click();
       cy.assetMuiError('[data-cy=isOfficialProducerLabel]');
+      cy.assetMuiError('[data-cy=isOfficialFeedLabel]');
       cy.location('pathname').should('eq', '/contribute');
       // Step 1 values
       cy.get('[data-cy=isOfficialProducerYes]').click();
+      cy.muiDropdownSelect('[data-cy=isOfficialFeed]', 'yes');
       cy.muiDropdownSelect('[data-cy=isUpdatingFeed]', 'yes');
       cy.get('[data-cy=submitFirstStep]').click();
       // Step 2

diff --git a/web-app/public/locales/en/common.json b/web-app/public/locales/en/common.json
@@ -30,7 +30,8 @@
         "no": "No",
         "required": "This field is required",
         "submit": "Submit",
-        "select": "Select"
+        "select": "Select",
+        "notSure": "Not sure"
     },
     "country": "Country",
     "chooseCountry": "Choose a country",

diff --git a/web-app/public/locales/en/feeds.json b/web-app/public/locales/en/feeds.json
@@ -24,6 +24,7 @@
     "signUpAction": "Sign up for an account",
     "loginSuccess": "You were successfully logged in, you can now add or update a feed.",
     "dataTypeRequired": "Data format required",
+    "isOfficialFeedRequired": "Official feed required",
     "feedLinkRequired": "Feed link required",
     "oldFeedLinkRequired": "Old feed link required",
     "dataProducerEmailRequired": "Data producer email required",
@@ -59,6 +60,8 @@
   "boundingBoxTitle": "Bounding box from stops.txt",
   "unableToGenerateBoundingBox": "Unable to generate bounding box.",
   "areYouOfficialProducer": "Are you the official producer or transit agency responsible for this data ?",
+  "isOfficialSource": "Is the Official Source",
+  "isOfficialSourceDetails": "Select \"Yes\" if the inputed feed is the official source of information by the transit provider and should be used to display to riders",
   "feedLink": "Feed Link",
   "areYouUpdatingFeed": "Are you updating a feed?",
   "oldFeedLink": "Old Feed Link",

diff --git a/web-app/src/app/screens/FeedSubmission/Form/FirstStep.tsx b/web-app/src/app/screens/FeedSubmission/Form/FirstStep.tsx
@@ -22,9 +22,11 @@ import { type YesNoFormInput, type FeedSubmissionFormFormInput } from '.';
 import { useEffect } from 'react';
 import { useTranslation } from 'react-i18next';
 import { isValidFeedLink } from '../../../services/feeds/utils';
+import FormLabelDescription from './components/FormLabelDescription';
 
 export interface FeedSubmissionFormFormInputFirstStep {
   isOfficialProducer: YesNoFormInput;
+  isOfficialFeed: 'yes' | 'no' | 'unsure' | undefined;
   dataType: 'gtfs' | 'gtfs_rt';
   transitProviderName?: string;
   feedLink?: string;
@@ -51,6 +53,7 @@ export default function FormFirstStep({
   } = useForm<FeedSubmissionFormFormInputFirstStep>({
     defaultValues: {
       isOfficialProducer: initialValues.isOfficialProducer,
+      isOfficialFeed: initialValues.isOfficialFeed,
       dataType: initialValues.dataType,
       transitProviderName: initialValues.transitProviderName,
       feedLink: initialValues.feedLink,
@@ -136,15 +139,47 @@ export default function FormFirstStep({
           <Grid item sx={{ '&.MuiGrid-item': { pt: '4px' } }}>
             <FormControl
               component='fieldset'
-              error={errors.dataType !== undefined}
+              error={errors.isOfficialFeed !== undefined}
             >
+              <FormLabel required data-cy='isOfficialFeedLabel'>
+                {t('isOfficialSource')}
+              </FormLabel>
+              <FormLabelDescription>
+                {t('isOfficialSourceDetails')}
+              </FormLabelDescription>
+              <Controller
+                rules={{ required: t('form.isOfficialFeedRequired') }}
+                control={control}
+                name='isOfficialFeed'
+                render={({ field }) => (
+                  <>
+                    <Select
+                      {...field}
+                      data-cy='isOfficialFeed'
+                      sx={{ width: '200px' }}
+                    >
+                      <MenuItem value={'yes'}>{t('common:form.yes')}</MenuItem>
+                      <MenuItem value={'no'}>{t('common:form.no')}</MenuItem>
+                      <MenuItem value={'unsure'}>
+                        {t('common:form.notSure')}
+                      </MenuItem>
+                    </Select>
+                    <FormHelperText>
+                      {errors.isOfficialFeed?.message ?? ''}
+                    </FormHelperText>
+                  </>
+                )}
+              />
+            </FormControl>
+          </Grid>
+          <Grid item>
+            <FormControl component='fieldset'>
               <FormLabel required>{t('dataType')}</FormLabel>
               <Controller
-                rules={{ required: t('dataTypeRequired') }}
                 control={control}
                 name='dataType'
                 render={({ field }) => (
-                  <Select {...field} data-cy='dataType'>
+                  <Select {...field} data-cy='dataType' sx={{ width: '200px' }}>
                     <MenuItem value={'gtfs'}>
                       {t('common:gtfsSchedule')}
                     </MenuItem>

diff --git a/web-app/src/app/screens/FeedSubmission/Form/index.tsx b/web-app/src/app/screens/FeedSubmission/Form/index.tsx
@@ -25,6 +25,7 @@ export type AuthTypes =
 
 export interface FeedSubmissionFormFormInput {
   isOfficialProducer: YesNoFormInput;
+  isOfficialFeed: 'yes' | 'no' | 'unsure' | undefined;
   dataType: 'gtfs' | 'gtfs_rt';
   transitProviderName: string;
   feedLink?: string;
@@ -54,6 +55,7 @@ export interface FeedSubmissionFormFormInput {
 
 const defaultFormValues: FeedSubmissionFormFormInput = {
   isOfficialProducer: '',
+  isOfficialFeed: undefined,
   dataType: 'gtfs',
   transitProviderName: '',
   feedLink: '',