refactor(Update to fix pattern name bug): Applies the correct pattern…

… id and name when generating fi

src/main/java/com/conveyal/gtfs/PatternBuilder.java

@@ -40,7 +40,7 @@ public PatternBuilder(Feed feed) throws SQLException {
         connection = feed.getConnection();
     }
 
-    public void create(Map<TripPatternKey, Pattern> patterns, Set<String> patternIdsLoadedFromFile) {
+    public void create(Map<TripPatternKey, Pattern> patterns, boolean usePatternsFromFeed) {
         String patternsTableName = feed.getTableNameWithSchemaPrefix("patterns");
         String tripsTableName = feed.getTableNameWithSchemaPrefix("trips");
         String patternStopsTableName = feed.getTableNameWithSchemaPrefix("pattern_stops");
@@ -53,13 +53,13 @@ public void create(Map<TripPatternKey, Pattern> patterns, Set<String> patternIds
             LOG.info("Creating pattern and pattern stops tables.");
             Statement statement = connection.createStatement();
             statement.execute(String.format("alter table %s add column pattern_id varchar", tripsTableName));
-            if (patternIdsLoadedFromFile.isEmpty()) {
+            if (!usePatternsFromFeed) {
                 // No patterns were loaded from file so the pattern table has not previously been created.
                 patternsTable.createSqlTable(connection, null, true);
             }
             patternStopsTable.createSqlTable(connection, null, true);
             try (PrintStream patternForTripsFileStream = createTempPatternForTripsTable(tempPatternForTripsTextFile, statement)) {
-                processPatternAndPatternStops(patternsTable, patternStopsTable, patternForTripsFileStream, patterns, patternIdsLoadedFromFile);
+                processPatternAndPatternStops(patternsTable, patternStopsTable, patternForTripsFileStream, patterns, usePatternsFromFeed);
             }
             updateTripPatternIds(tempPatternForTripsTextFile, statement, tripsTableName);
             createIndexes(statement, patternsTableName, patternStopsTableName, tripsTableName);
@@ -80,7 +80,7 @@ private void processPatternAndPatternStops(
         Table patternStopsTable,
         PrintStream patternForTripsFileStream,
         Map<TripPatternKey, Pattern> patterns,
-        Set<String> patternIdsLoadedFromFile
+        boolean usePatternsFromFeed
     ) throws SQLException {
         // Generate prepared statements for inserts.
         String insertPatternSql = patternsTable.generateInsertSql(true);
@@ -90,7 +90,7 @@ private void processPatternAndPatternStops(
         for (Map.Entry<TripPatternKey, Pattern> entry : patterns.entrySet()) {
             Pattern pattern = entry.getValue();
             LOG.debug("Batching pattern {}", pattern.pattern_id);
-            if (!patternIdsLoadedFromFile.contains(pattern.pattern_id)) {
+            if (!usePatternsFromFeed) {
                 // Only insert the pattern if it has not already been imported from file.
                 pattern.setStatementParameters(insertPatternStatement, true);
                 patternTracker.addBatch();

src/main/java/com/conveyal/gtfs/PatternFinder.java

@@ -61,19 +61,34 @@ public void processTrip(Trip trip, Iterable<StopTime> orderedStopTimes) {
      * Once all trips have been processed, call this method to produce the final Pattern objects representing all the
      * unique sequences of stops encountered. Returns map of patterns to their keys so that downstream functions can
      * make use of trip pattern keys for constructing pattern stops or other derivative objects.
+     *
+     * There is no viable relationship between patterns that are loaded from a feed (patternsFromFeed) and patterns
+     * generated here. Process ordering is used to update the pattern id and name if patterns from a feed are available.
+     * E.g. The first pattern loaded from a feed will be used to updated the first pattern created here.
      */
-    public Map<TripPatternKey, Pattern> createPatternObjects(Map<String, Stop> stopById, SQLErrorStorage errorStorage) {
+    public Map<TripPatternKey, Pattern> createPatternObjects(
+        Map<String, Stop> stopById,
+        List<Pattern> patternsFromFeed,
+        SQLErrorStorage errorStorage
+    ) {
         // Make pattern ID one-based to avoid any JS type confusion between an ID of zero vs. null value.
         int nextPatternId = 1;
+        int patternsFromFeedIndex = 0;
+        boolean usePatternsFromFeed = canUsePatternsFromFeed(patternsFromFeed);
         // Create an in-memory list of Patterns because we will later rename them before inserting them into storage.
         // Use a LinkedHashMap so we can retrieve the entrySets later in the order of insertion.
         Map<TripPatternKey, Pattern> patterns = new LinkedHashMap<>();
         // TODO assign patterns sequential small integer IDs (may include route)
         for (TripPatternKey key : tripsForPattern.keySet()) {
             Collection<Trip> trips = tripsForPattern.get(key);
             Pattern pattern = new Pattern(key.stops, trips, null);
-            // Overwrite long UUID with sequential integer pattern ID
-            pattern.pattern_id = Integer.toString(nextPatternId++);
+            if (usePatternsFromFeed) {
+                pattern.pattern_id = patternsFromFeed.get(patternsFromFeedIndex).pattern_id;
+                pattern.name = patternsFromFeed.get(patternsFromFeedIndex).name;
+            } else {
+                // Overwrite long UUID with sequential integer pattern ID
+                pattern.pattern_id = Integer.toString(nextPatternId++);
+            }
             // FIXME: Should associated shapes be a single entry?
             pattern.associatedShapes = new HashSet<>();
             trips.stream().forEach(trip -> pattern.associatedShapes.add(trip.shape_id));
@@ -87,13 +102,26 @@ public Map<TripPatternKey, Pattern> createPatternObjects(Map<String, Stop> stopB
                             .setBadValue(pattern.associatedShapes.toString()));
             }
             patterns.put(key, pattern);
+            patternsFromFeedIndex++;
+        }
+        if (!usePatternsFromFeed) {
+            // Name patterns before storing in SQL database if they have not already been provided by via a feed.
+            renamePatterns(patterns.values(), stopById);
         }
-        // Name patterns before storing in SQL database.
-        renamePatterns(patterns.values(), stopById);
         LOG.info("Total patterns: {}", tripsForPattern.keySet().size());
         return patterns;
     }
 
+    /**
+     * If there is a difference in the number of patterns provided by a feed and the number of patterns generated here,
+     * the patterns provided by the feed are rejected.
+     */
+    private boolean canUsePatternsFromFeed(List<Pattern> patternsFromFeed) {
+        boolean usePatternsFromFeed = patternsFromFeed.size() == tripsForPattern.keySet().size();
+        LOG.info("Using patterns from feed: {}",  usePatternsFromFeed);
+        return usePatternsFromFeed;
+    }
+
     /**
      * Destructively rename the supplied collection of patterns.
      * This process requires access to all the stops in the feed.

src/main/java/com/conveyal/gtfs/validator/PatternFinderValidator.java

@@ -27,6 +27,7 @@
 import java.sql.PreparedStatement;
 import java.sql.SQLException;
 import java.sql.Statement;
+import java.util.ArrayList;
 import java.util.Collections;
 import java.util.HashMap;
 import java.util.HashSet;
@@ -72,19 +73,18 @@ public void validateTrip (Trip trip, Route route, List<StopTime> stopTimes, List
      */
     @Override
     public void complete(ValidationResult validationResult) {
-        Set<String> patternIds = new HashSet<>();
+        List<Pattern> patternsFromFeed = new ArrayList<>();
         for(Pattern pattern :  feed.patterns) {
-            patternIds.add(pattern.pattern_id);
+            patternsFromFeed.add(pattern);
         }
         LOG.info("Finding patterns...");
         Map<String, Stop> stopById = new HashMap<>();
         for (Stop stop : feed.stops) {
             stopById.put(stop.stop_id, stop);
         }
         // Although patterns may have already been loaded from file, the trip patterns are still required.
-        Map<TripPatternKey, Pattern> patterns = patternFinder.createPatternObjects(stopById, errorStorage);
-        patternBuilder.create(patterns, patternIds);
+        Map<TripPatternKey, Pattern> patterns = patternFinder.createPatternObjects(stopById, patternsFromFeed, errorStorage);
+        patternBuilder.create(patterns, !patternsFromFeed.isEmpty());
     }
-
 }
 

src/test/java/com/conveyal/gtfs/validator/PatternFinderValidatorTest.java

@@ -0,0 +1,85 @@
+package com.conveyal.gtfs.validator;
+
+import com.conveyal.gtfs.GTFSFeed;
+import com.conveyal.gtfs.TestUtils;
+import com.conveyal.gtfs.loader.FeedLoadResult;
+import com.conveyal.gtfs.loader.Table;
+import com.conveyal.gtfs.model.Pattern;
+import org.junit.jupiter.api.AfterAll;
+import org.junit.jupiter.api.BeforeAll;
+import org.junit.jupiter.api.Test;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import javax.sql.DataSource;
+
+import java.io.IOException;
+import java.sql.ResultSet;
+import java.sql.SQLException;
+
+import static com.conveyal.gtfs.GTFS.load;
+import static com.conveyal.gtfs.GTFS.validate;
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.Matchers.greaterThan;
+
+
+class PatternFinderValidatorTest {
+
+    private static final Logger LOG = LoggerFactory.getLogger(PatternFinderValidatorTest.class);
+
+    private static String testDBName;
+
+    private static DataSource testDataSource;
+
+    @BeforeAll
+    public static void setUpClass() throws Exception {
+        // create a new database
+        testDBName = TestUtils.generateNewDB();
+        String dbConnectionUrl = String.format("jdbc:postgresql://localhost/%s", testDBName);
+        testDataSource = TestUtils.createTestDataSource(dbConnectionUrl);
+    }
+
+    @AfterAll
+    public static void tearDownClass() {
+        TestUtils.dropDB(testDBName);
+    }
+
+    @Test
+    void canUseFeedPatterns() throws SQLException, IOException {
+        String zipFileName = TestUtils.zipFolderFiles("real-world-gtfs-feeds/RABA", true);
+        FeedLoadResult feedLoadResult = load(zipFileName, testDataSource);
+        String testNamespace = feedLoadResult.uniqueIdentifier;
+        validate(testNamespace, testDataSource);
+        checkPatternStops(zipFileName, testNamespace);
+    }
+
+    @Test
+    void canRevertToGeneratedPatterns() throws SQLException, IOException {
+        String zipFileName = TestUtils.zipFolderFiles("fake-agency", true);
+        FeedLoadResult feedLoadResult = load(zipFileName, testDataSource);
+        String testNamespace = feedLoadResult.uniqueIdentifier;
+        validate(testNamespace, testDataSource);
+        checkPatternStops(zipFileName, testNamespace);
+    }
+
+    private void checkPatternStops(String zipFileName, String testNamespace) throws SQLException {
+        GTFSFeed feed = GTFSFeed.fromFile(zipFileName);
+        for (String key : feed.patterns.keySet()) {
+            Pattern pattern = feed.patterns.get(key);
+            assertThatSqlQueryYieldsRowCountGreaterThanZero(
+                String.format(
+                    "select * from %s where pattern_id = '%s'",
+                    String.format("%s.%s", testNamespace, Table.PATTERN_STOP.name),
+                    pattern.pattern_id
+                )
+            );
+        }
+    }
+
+    private void assertThatSqlQueryYieldsRowCountGreaterThanZero(String sql) throws SQLException {
+        int recordCount = 0;
+        ResultSet rs = testDataSource.getConnection().prepareStatement(sql).executeQuery();
+        while (rs.next()) recordCount++;
+        assertThat(recordCount, greaterThan(0));
+    }
+}

src/test/resources/real-world-gtfs-feeds/RABA/agency.txt

@@ -0,0 +1,2 @@
+agency_id,agency_name,agency_url,agency_timezone,agency_lang,agency_phone,agency_branding_url,agency_fare_url,agency_email
+25,Redding Area Bus Authority,http://www.rabaride.com/,America/Los_Angeles,en,530-241-2877,,,

src/test/resources/real-world-gtfs-feeds/RABA/calendar.txt

@@ -0,0 +1,11 @@
+service_id,monday,tuesday,wednesday,thursday,friday,saturday,sunday,start_date,end_date
+c_2713_b_80332_d_56,0,0,0,1,1,1,0,20230525,20230902
+c_1658_b_18260_d_63,1,1,1,1,1,1,0,20190101,20240101
+c_1658_b_18260_d_32,0,0,0,0,0,1,0,20190101,20240101
+c_868_b_79978_d_31,1,1,1,1,1,0,0,20230110,20230407
+c_868_b_79978_d_30,0,1,1,1,1,0,0,20230110,20230407
+c_868_b_79978_d_1,1,0,0,0,0,0,0,20230110,20230407
+c_868_b_79977_d_31,1,1,1,1,1,0,0,20230418,20230526
+c_868_b_79977_d_30,0,1,1,1,1,0,0,20230418,20230526
+c_868_b_79977_d_1,1,0,0,0,0,0,0,20230418,20230526
+c_1658_b_18260_d_31,1,1,1,1,1,0,0,20190101,20240101

src/test/resources/real-world-gtfs-feeds/RABA/calendar_dates.txt

@@ -0,0 +1,7 @@
+service_id,date,exception_type
+c_1658_b_18260_d_31,20230529,2
+c_1658_b_18260_d_31,20230904,2
+c_1658_b_18260_d_31,20230704,2
+c_1658_b_18260_d_63,20230529,2
+c_1658_b_18260_d_63,20230904,2
+c_1658_b_18260_d_63,20230704,2

src/test/resources/real-world-gtfs-feeds/RABA/datatools_patterns.txt

@@ -0,0 +1,39 @@
+pattern_id,route_id,name,direction_id,use_frequency,shape_id
+2,151,52 stops from Masonic Transfer Center to Masonic Transfer Center (25 trips),0,,p_899986
+4,3779,10 stops from Downtown Transit Center to Downtown Transit Center (5 trips),0,,p_9209
+5,161,6 stops from Burney (@ Burney Sporting Goods) to Downtown Transit Center (3 trips),1,,p_2671
+6,161,6 stops from Downtown Transit Center to Burney (@ Burney Sporting Goods) (3 trips),0,,p_2639
+9,1887,15 stops from Downtown Transit Center to Downtown Transit Center (23 trips),1,,p_2631
+10,160,31 stops from Downtown Transit Center to Downtown Transit Center (23 trips),0,,p_2637
+11,159,26 stops from Canby Transfer Center to Canby Transfer Center (23 trips),1,,p_2644
+12,1886,24 stops from Downtown Transit Center to Downtown Transit Center via 2510 Airpark Dr (11 trips),1,,p_2638
+13,1886,24 stops from Downtown Transit Center to Downtown Transit Center via Court St at Butte St (12 trips),0,,p_2628
+14,153,25 stops from Downtown Transit Center to SR 273 (frontage rd) at Happy Valley Rd (23 trips),1,,p_787964
+15,153,16 stops from SR 273 (frontage rd) at Happy Valley Rd to Downtown Transit Center (23 trips),0,,p_787963
+16,154,23 stops from Canby Transfer Center to Bechelli Ln at Knollcrest Dr (23 trips),1,,p_788072
+17,154,21 stops from Bechelli Ln at Knollcrest Dr to Canby Transfer Center (23 trips),0,,p_788073
+18,155,17 stops from Downtown Transit Center to Hartnell Ave at Shasta View Dr (23 trips),0,,p_788074
+19,155,22 stops from Hartnell Ave at Shasta View Dr to Downtown Transit Center (23 trips),1,,p_788075
+20,1889,12 stops from Canby Transfer Center to Victor Ave at El Vista St (23 trips),1,,p_788078
+21,1889,13 stops from Victor Ave at El Vista St to Canby Transfer Center (23 trips),0,,p_788079
+22,1888,13 stops from Canby Transfer Center to Shasta College (21 trips),0,,p_788076
+23,1888,12 stops from Shasta College to Canby Transfer Center (21 trips),1,,p_788077
+24,157,9 stops from Downtown Transit Center to Shasta College (21 trips),0,,p_788080
+25,157,16 stops from Shasta College to Downtown Transit Center (21 trips),1,,p_788081
+28,6460,3 stops from SR 273 (frontage rd) at Happy Valley Rd to Downtown Transit Center (1 trips),0,,p_788093
+29,6460,25 stops from Downtown Transit Center to 5000 Rhonda Rd (1 trips),1,,p_788094
+1,6446,21 stops from 5000 Rhonda Rd to SR 273 (frontage rd) at Happy Valley Rd (8 trips),0,,p_110998
+2k3j,15,Southbound-5stops,,0,c69d
+sfe0,15,Northbound-5:07pm,,0,80g2
+ir25,15,Southbound-6:37pm,,0,y7ol
+v7wd,6790,Westbound-6:02am,,0,s30y
+3,6446,18 stops from SR 273 (frontage rd) at Happy Valley Rd to 5000 Rhonda Rd (7 trips),1,,p_111010
+27,6790,3 stops from Downtown Transit Center to Canby Transfer Center (16 trips),0,,p_788089
+aioj,6790,Eastbound-4:58am,,0,ce8e
+26,6790,3 stops from Canby Transfer Center to Downtown Transit Center (16 trips),1,,p_788088
+fm1k,15,Southbound-5:10am,,0,ygd9
+0smf,15,Southbound-5:37pm,,0,lt05
+mo18,15,Northbound-5stops,,0,nk8m
+xadh,15,Northbound-5:35am,,0,qy7v
+8,1885,Westbound to Downtown Passenger Terminal,1,,p_4556
+5ske,1885,Eastbound to Shasta College,0,,c2ml

src/test/resources/real-world-gtfs-feeds/RABA/fare_attributes.txt

@@ -0,0 +1,8 @@
+fare_id,price,currency_type,payment_method,transfers,agency_id,transfer_duration
+60,1.50,USD,0,,25,10000
+61,2.25,USD,0,,25,10000
+62,3.00,USD,0,,25,10000
+106,4.50,USD,0,,25,10000
+1505,2.00,USD,0,,25,10800
+1506,3.50,USD,0,,25,10800
+1507,5.00,USD,0,,25,10800

src/test/resources/real-world-gtfs-feeds/RABA/fare_rules.txt

@@ -0,0 +1,20 @@
+fare_id,route_id,origin_id,destination_id,contains_id
+60,,24,24,
+60,,25,25,
+60,,26,26,
+61,,24,25,
+61,,25,24,
+61,,25,26,
+61,,26,25,
+62,,24,26,
+62,,26,24,
+1505,161,25,878,
+1505,161,876,877,
+1505,161,877,876,
+1505,161,878,25,
+1506,161,25,877,
+1506,161,876,878,
+1506,161,877,25,
+1506,161,878,876,
+1507,161,25,876,
+1507,161,876,25,

src/test/resources/real-world-gtfs-feeds/RABA/feed_info.txt

@@ -0,0 +1,2 @@
+feed_publisher_name,feed_id,feed_publisher_url,feed_lang,feed_start_date,feed_end_date,feed_version,default_lang,feed_contact_email,feed_contact_url
+"Trillium Solutions, Inc.",redding-ca-us,http://www.trilliumtransit.com,en,20230328,20231001,UTC: 28-Mar-2023 16:35,,[email protected],http://support.trilliumtransit.com

src/test/resources/real-world-gtfs-feeds/RABA/routes.txt

@@ -0,0 +1,19 @@
+route_id,agency_id,route_short_name,route_long_name,route_desc,route_type,route_url,route_branding_url,route_color,route_text_color,route_sort_order,continuous_pickup,continuous_drop_off
+151,25,1,Route 1,,3,http://www.cityofredding.org/home/showdocument?id=9868,,55d1b0,000000,0,1,1
+1887,25,2E,Route 2 East,,3,http://www.cityofredding.org/home/showdocument?id=9874,,f7cf82,000000,1,1,1
+159,25,11,Route 11,,3,http://www.cityofredding.org/home/showdocument?id=9870,,93ea5f,000000,10,1,1
+160,25,14,Route 14,,3,http://www.cityofredding.org/home/showdocument?id=9872,,8c08b1,ffffff,11,1,1
+161,25,299X,Route 299X,,3,http://www.rabaride.com/routes/burneyexpress.html,,00dffb,ffffff,13,1,1
+15,25,15,Churn Creek/Knightson/Airport,,3,,,bf4aea,FFFFFF,,,
+6790,25,18,Crosstown,,3,http://www.cityofredding.org/home/showdocument?id=9866,,049919,ffffff,14,1,1
+1885,25,17,Shasta View/Shasta College,,3,http://www.cityofredding.org/home/showdocument?id=10306,,fbef00,0e0e0e,15,1,1
+1886,25,2W,Route 2 West,,3,http://www.cityofredding.org/home/showdocument?id=9874,,f3732a,000000,2,1,1
+153,25,3,Route 3,,3,http://www.cityofredding.org/home/showdocument?id=9876,,1bb1f6,ffffff,3,1,1
+154,25,4,Route 4,,3,http://www.cityofredding.org/home/showdocument?id=9878,,bdadd1,ffffff,4,1,1
+155,25,5,Route 5,,3,http://www.cityofredding.org/home/showdocument?id=9880,,f7ced5,000000,5,1,1
+1889,25,6S,Route 6 South,,3,http://www.cityofredding.org/home/showdocument?id=9882,,9e5e3d,ffffff,6,1,1
+1888,25,6N,Route 6 North,,3,http://www.cityofredding.org/home/showdocument?id=9882,,d0c5ac,000000,7,1,1
+157,25,7,Route 7,,3,http://www.cityofredding.org/home/showdocument?id=9884,,1886c7,ffffff,8,1,1
+6446,25,9,Route 9,,3,http://www.cityofredding.org/home/showdocument?id=11007,,ec191c,000000,9,1,1
+6460,25,12X,Anderson Commuter,,3,http://www.cityofredding.org/home/showdocument?id=11052,,204315,ffffff,12,1,1
+3779,25,19,Route 19,,3,,,2738ec,ffffff,16,1,1