-
Notifications
You must be signed in to change notification settings - Fork 2
/
CTSService.ts
1210 lines (1059 loc) · 47.7 KB
/
CTSService.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import { AxiosInstance } from "axios";
import axiosModule from "axios";
const { default: axios } = axiosModule;
import axiosCacheAdapter from "axios-cache-adapter";
const { setupCache } = axiosCacheAdapter;
import fs from "fs";
import FuseModule from "fuse.js"
const Fuse = FuseModule as any;
import * as ConsumableSchedule from "./ConsumableSchedule.js";
import { shouldDisplayMay1stCustomEmoji } from "./utilities.js";
import {
jsonArrayMember,
jsonMapMember,
jsonMember,
jsonObject,
toJson,
TypedJSON,
} from "typedjson";
import { FeatureCollection } from "geojson";
import {
ResponseStopPointsDiscoveryList,
SpecializedStopMonitoringResponse,
SIRILocation,
VehicleMode,
} from "./SIRITypes.js";
import { emojiForStation } from "./station_emojis.js";
// Create and export an enum that stores either tram or bus
export enum TransportType {
tram = "tram",
bus = "bus",
}
export type SearchResult = {
/**
* Means the search engine is confident that the first result matches what the user is looking for
* without any ambiguity. This typically means that the result can be displayed directly to the user.
*/
firstMatchIsHighConfidence: boolean;
/**
* An array of named stations that match the search query, sorted from most to least relevant.
*/
stations: NamedStation[];
};
export type SearchResultNew = {
/**
* Means the search engine is confident that the first result matches what the user is looking for
* without any ambiguity. This typically means that the result can be displayed directly to the user.
*/
firstMatchIsHighConfidence: boolean;
stationsAndIndices: { station: NamedStation, idx: number }[];
};
export type FlattenedMatch = {
logicStations: LogicStation[];
stationName: string;
geoDescription: string | undefined;
isExactMatch: boolean;
path: string;
};
/**
* Represents the visit times of for a lane at a station
*/
export class LaneVisitsSchedule {
/**
* The name of the lane
*/
name: string;
/**
* The type of transport
*/
transportType: VehicleMode;
/**
* An integer representing the direction of the lane
*/
directionRef: number;
/**
* The name of the destination
*/
destinationName: string;
/**
* The name of a place that the vehicle will pass through before reaching the destination, if any.
*/
via: string | undefined;
/**
* An array of dates representing the departure times of the lane
*/
departureDates: Date[];
/**
* Constructs a new LaneVisitsSchedule
* @param name The name of the lane
* @param transportType The type of transport
* @param directionRef An integer representing the direction of the lane
* @param destinationName The name of the destination
* @param via The name of a place that the vehicle will pass through before reaching the destination, if any.
* @param departureDates An array of dates representing the departure times of the lane
*/
constructor(
name: string,
transportType: VehicleMode,
directionRef: number,
destinationName: string,
via: string | undefined,
departureDates: Date[]
) {
this.name = name;
this.transportType = transportType;
this.directionRef = directionRef;
this.destinationName = destinationName;
this.via = via;
this.departureDates = departureDates;
}
}
@jsonObject
export class LogicStation {
constructor(logicStopCode: string, location: SIRILocation) {
this.logicStopCode = logicStopCode;
this.location = location;
}
@jsonMember
logicStopCode: string;
@jsonMember
location: SIRILocation;
@jsonMember
geocodedAddress?: string;
@jsonMember
stopCount: number = 1;
@jsonMember
maxDistance: number = 0;
}
@jsonObject
export class ProbableExtendedStation {
constructor(logicStations: LogicStation[]) {
this.logicStations = logicStations;
}
// All stations that are part of the probable extended station
@jsonArrayMember(LogicStation)
logicStations: LogicStation[];
// A string that enables differentiating between different probable extended stations
@jsonMember
distinctiveLocationDescription?: string;
// Returns the average location of the probable extended station
getAverageLocation(): SIRILocation {
let averageLat = 0;
let averageLon = 0;
for (const logicStation of this.logicStations) {
averageLat += logicStation.location.latitude;
averageLon += logicStation.location.longitude;
}
averageLat /= this.logicStations.length;
averageLon /= this.logicStations.length;
return new SIRILocation(averageLat, averageLon);
}
}
/**
* A NamedStation is one or multiple stations that have a certain name.
*
* This probably isn't the cleanest abstraction, but the codebase has evolved that way
* organically in an attempt to best handle the specifities of the data source.
* See [this blog post](https://blog.popflamingo.fr/public-transit-bot) for more details on this.
*/
@jsonObject
@toJson
export class NamedStation {
@jsonMember
userReadableName: string;
@jsonMember
normalizedName: string;
@jsonArrayMember(ProbableExtendedStation)
extendedStations: ProbableExtendedStation[];
constructor(userReadableName: string, noramalizedName: string) {
this.userReadableName = userReadableName;
this.normalizedName = noramalizedName;
this.extendedStations = [];
}
/**
* Adds a stop to the named station.
*
* - If no extended station exists yet, a new one containing a station with just that stop is created.
* - If an extended station exists:
* - If a station with matching logic stop code exists, the stop is added to that station.
* - If no station with the matching logic stop code exists, but the stop is close enough to an existing station, the stop is added to that station.
* - If no station with the matching logic stop code exists, and the stop is not close enough to any existing station, a new extended station is created.
*
* The reasoning behind this is explained in [this blog post](https://blog.popflamingo.fr/public-transit-bot).
*
* @param logicStopCode The logic stop code of the stop to add
* @param location The location of the stop to add
*/
addStop(logicStopCode: string, location: SIRILocation) {
this.addLogicStation(new LogicStation(logicStopCode, location))
}
private addLogicStation(logicStation: LogicStation) {
// Find the closest probable extended station
let closestProbableExtendedStation: ProbableExtendedStation | undefined = undefined;
let closestProbableExtendedStationDistance = Number.MAX_SAFE_INTEGER;
for (const probableExtendedStation of this.extendedStations) {
let distance = probableExtendedStation
.getAverageLocation()
.distanceTo(logicStation.location);
if (distance < closestProbableExtendedStationDistance) {
closestProbableExtendedStation = probableExtendedStation;
closestProbableExtendedStationDistance = distance;
}
}
let existingStation: LogicStation | undefined = undefined;
if (closestProbableExtendedStation === undefined) {
// If there is probable extended station yet, create one...
closestProbableExtendedStation = new ProbableExtendedStation([
logicStation,
]);
this.extendedStations.push(closestProbableExtendedStation);
} else if (
(existingStation =
closestProbableExtendedStation.logicStations.find(
(otherStation) =>
otherStation.logicStopCode ===
logicStation.logicStopCode
)) !== undefined
) {
// ...otherwise, if the closest probable extended station contains a station with the same logic stop code
// we add this stop to it (which effectively consists in averaging the location of the two stops)...
let currentAverageLatSum =
existingStation.location.latitude * existingStation.stopCount;
let currentAverageLonSum =
existingStation.location.longitude * existingStation.stopCount;
let distance = logicStation.location.distanceTo(
existingStation.location
);
if (distance > existingStation.maxDistance) {
existingStation.maxDistance = distance;
}
let nextAverageLat =
(currentAverageLatSum + logicStation.location.latitude) /
(existingStation.stopCount + 1);
let nextAverageLon =
(currentAverageLonSum + logicStation.location.longitude) /
(existingStation.stopCount + 1);
existingStation.location.latitude = nextAverageLat;
existingStation.location.longitude = nextAverageLon;
existingStation.stopCount += 1;
return;
} else if (closestProbableExtendedStationDistance > 150) {
// ... if there was no match, but the closest probable extended station is too far away, we create a new one
// because we are probably facing two completely different extended stations...
closestProbableExtendedStation = new ProbableExtendedStation([
logicStation,
]);
this.extendedStations.push(closestProbableExtendedStation);
} else {
// ... but if they are close enough, it means two stations with different logic stop codes
// are probably part of the same extended station, so we add the new station to the closest one.
closestProbableExtendedStation.logicStations.push(logicStation);
}
}
}
@jsonObject
class CachedStations {
constructor(map: Map<string, NamedStation>, date: Date) {
this.normalizedNameToStation = map;
this.date = date;
}
@jsonMapMember(String, NamedStation)
normalizedNameToStation: Map<string, NamedStation>;
@jsonMember
date: Date;
}
type AddressDescription = {
street: string;
postalCode: string;
city: string;
};
export class CTSService {
static async make(token: string): Promise<CTSService> {
// Ensure responses are cached for 30 seconds
// to avoid hitting the CTS API too often
const cache = setupCache({ maxAge: 30 * 1000 });
// Create an axios instance to access the CTS API
let ctsAPI = axios.create({
adapter: cache.adapter,
baseURL: "https://api.cts-strasbourg.eu/v1/siri/2.0/",
auth: {
username: token,
password: "",
},
timeout: 8000,
});
let normalizedNameToStation = await CTSService.getNamedStations(ctsAPI);
return new CTSService(ctsAPI, normalizedNameToStation);
}
private static async getNamedStations(ctsAPI: AxiosInstance): Promise<Map<string, NamedStation>> {
let geoGouvAPI = axios.create({
baseURL: "https://api-adresse.data.gouv.fr",
timeout: 8000,
});
let normalizedNameToStation = new Map<string, NamedStation>();
try {
if (process.env.LOAD_STOPS_FROM_CACHE === "YES") {
console.log("\x1b[31m%s\x1b[0m", "LOAD_STOPS_FROM_CACHE=\"YES\", do not use in production");
throw new Error("LOAD_FROM_CACHE");
}
let rawResponse = await ctsAPI.get("stoppoints-discovery");
const serializer = new TypedJSON(ResponseStopPointsDiscoveryList, {
errorHandler: (error: Error) => {
console.log(error);
throw new Error("CTS_PARSING_ERROR");
},
});
let response = serializer.parse(rawResponse.data);
if (response === undefined) {
throw new Error("CTS_PARSING_ERROR");
}
const sortedStops = response.stopPointsDelivery.annotatedStopPointRef.sort((a, b) => {
return a.stopPointRef > b.stopPointRef ? 1 : -1;
});
// Iterate over all stop points and group them by their normalized name
// which effectively creates stations made of multiple stops
// See docs/stop-points-to-stations.md for more information
for (let stop of sortedStops) {
const name = stop.stopName;
const normalizedName = CTSService.normalize(name);
const logicalStopCode = stop.extension.logicalStopCode;
let namedStation = normalizedNameToStation.get(normalizedName);
// If the named station doesn't exist yet, create it
if (namedStation === undefined) {
namedStation = new NamedStation(name, normalizedName);
namedStation.addStop(logicalStopCode, stop.location);
normalizedNameToStation.set(normalizedName, namedStation);
} else {
namedStation.addStop(logicalStopCode, stop.location);
}
}
// Loop through all named stations
for (const [_, namedStation] of normalizedNameToStation) {
// Count the total number of logical stations in the named station
let totalLogicalStations = 0;
for (const probableExtendedStation of namedStation.extendedStations) {
totalLogicalStations +=
probableExtendedStation.logicStations.length;
}
// If there is more than one logical station, loop through all logical stations...
if (totalLogicalStations > 1) {
for (const extendedStation of namedStation.extendedStations) {
for (const logicalStation of extendedStation.logicStations) {
// ...and store their address
const desc = await CTSService.getReverseGeocodedAddress(
geoGouvAPI,
logicalStation.location
);
logicalStation.geocodedAddress = `${desc.street} ${desc.postalCode} ${desc.city}`;
}
}
}
// If the named stations contains more than one probable extended station
// in other terms if multiple stations that are far away from each other
// share the same name...
if (namedStation.extendedStations.length > 1) {
// ...We get inverse geocoding data which includes street name, postal code and city.
const geoFeatures: AddressDescription[] = [];
for (let extendedStation of namedStation.extendedStations) {
const addressDescription =
await CTSService.getReverseGeocodedAddress(
geoGouvAPI,
extendedStation.getAverageLocation()
);
geoFeatures.push(addressDescription);
}
// Detect if postcode + city alone is enough to uniquely identify the station
// and set mustUseStreet to true otherwise
const cityNamePostCodes: Set<string> = new Set();
let mustUseStreet = false;
for (let geoFeature of geoFeatures) {
let combined = `${geoFeature.postalCode} ${geoFeature.city}`;
if (cityNamePostCodes.has(combined)) {
mustUseStreet = true;
break;
} else {
cityNamePostCodes.add(combined);
}
}
// Use the geocoding results to create the distinctiveLocationDescription
for (let i = 0; i < namedStation.extendedStations.length; i++) {
const extendedStation = namedStation.extendedStations[i];
const geoFeature = geoFeatures[i];
extendedStation.distinctiveLocationDescription = "";
if (mustUseStreet) {
extendedStation.distinctiveLocationDescription +=
geoFeature.street + ", ";
}
extendedStation.distinctiveLocationDescription +=
geoFeature.postalCode + " ";
extendedStation.distinctiveLocationDescription +=
geoFeature.city;
}
}
}
const saveData = new CachedStations(normalizedNameToStation, new Date());
const savedResultsSerializer = new TypedJSON(CachedStations);
const savedResults = savedResultsSerializer.stringify(saveData);
// Save to ./data/last-query-results.json
fs.writeFileSync(
"./resources/last-query-results.json",
savedResults
);
process.env.LAST_STOP_UPDATE = CTSService.formatDateFR(saveData.date)
} catch (e) {
if (e instanceof Error && e.message === "LOAD_FROM_CACHE") {
console.log("Loading from cache");
} else {
console.error("Loading from cache because of error:");
console.error(e);
}
// Load the last query results from ./data/last-query-results.json
const savedResultsSerializer = new TypedJSON(CachedStations);
const stringValue = fs.readFileSync("./resources/last-query-results.json", "utf8");
const savedResults = savedResultsSerializer.parse(stringValue);
if (savedResults !== undefined) {
normalizedNameToStation = savedResults.normalizedNameToStation;
console.log(`Loaded ${normalizedNameToStation.size} stations from cache`);
// Same as above but this time store full date + time using the argument of the function
process.env.LAST_STOP_UPDATE = CTSService.formatDateFR(savedResults.date)
} else {
throw new Error(`Couldn't recover from error`);
}
}
return normalizedNameToStation;
}
/**
* Format a date in the "dd/mm/yyyy à hh:mm (heure de Paris)" format
* @param date Date to format
*/
private static formatDateFR(date: Date): string {
const dateString = date.toLocaleDateString("fr-FR", {
year: "numeric",
month: "2-digit",
day: "2-digit",
timeZone: "Europe/Paris"
});
const timeString = date.toLocaleTimeString("fr-FR", {
hour: "2-digit",
minute: "2-digit",
hour12: false,
timeZone: "Europe/Paris"
});
return `${dateString} à ${timeString} (heure de Paris)`;
}
private static async getReverseGeocodedAddress(
axiosInstance: AxiosInstance,
location: SIRILocation
): Promise<AddressDescription> {
const featureCollection: FeatureCollection = (
await axiosInstance.get("reverse", {
params: {
lat: location.latitude,
lon: location.longitude,
},
})
).data;
const firstPoint = featureCollection.features[0].properties;
if (firstPoint !== null) {
const street = firstPoint.name;
const postalCode = firstPoint.postcode;
const city = firstPoint.city;
// If any is undefined, throw an error
if (
street === undefined ||
postalCode === undefined ||
city === undefined
) {
throw new Error(
"Could not find address description for location"
);
}
return {
street: street,
postalCode: postalCode,
city: city,
};
} else {
throw new Error("Could not find address description for location");
}
}
private constructor(
api: AxiosInstance,
normalizedNameToStation: Map<string, NamedStation>,
) {
this.api = api;
this.normalizedNameToStation = normalizedNameToStation;
}
private api: AxiosInstance;
private normalizedNameToStation: Map<string, NamedStation> = new Map();
getExtendedStationFromPath(path: string): { name: string, value: ProbableExtendedStation, locationDescription: string | undefined } {
let normalizedNameStr: string;
let idsStr: string | undefined;
[normalizedNameStr, idsStr] = path.split("|");
if (idsStr === undefined) {
throw new PathBasedRetrievalError(
PathBasedRetrievalErrorType.INVALID_PATH_FORMAT,
`Invalid path ("${path}")`
)
}
const namedStation = this.normalizedNameToStation.get(normalizedNameStr);
const ids = new Set(idsStr.split(",").map((value) => CTSService.base64Decode(value)));
if (namedStation === undefined) {
for (let namedStation of this.normalizedNameToStation.values()) {
for (let extendedStation of namedStation.extendedStations) {
// Now check if the extended station has the same ids as the ones in the path
if (ids.size === extendedStation.logicStations.length &&
extendedStation.logicStations.every((value) => ids.has(value.logicStopCode))) {
throw new NameNotFoundError(namedStation.userReadableName)
}
}
}
throw new NameNotFoundError(null)
}
for (let extendedStation of namedStation.extendedStations) {
// extendedStation.logicStations is an array of objects with a logicStopCode property
// Check if both arrays are equal
if (ids.size === extendedStation.logicStations.length &&
extendedStation.logicStations.every((value) => ids.has(value.logicStopCode))) {
let locationDescription: string | undefined;
if (namedStation.extendedStations.length > 1) {
locationDescription = extendedStation.distinctiveLocationDescription;
} else {
locationDescription = undefined;
}
return {
name: namedStation.userReadableName,
value: extendedStation,
locationDescription: locationDescription
};
}
}
throw new PathBasedRetrievalError(
PathBasedRetrievalErrorType.NO_MATCHING_IDS,
`No matching ids for path "${path}"`
)
}
getStationAndIdxFromNormalizedName(normalizedName: string): { station: NamedStation, idx: number } | undefined {
const station = this.normalizedNameToStation.get(normalizedName);
if (station !== undefined) {
// We find the index of the station whose key is normalizedName
const idx = Array.from(this.normalizedNameToStation.keys()).indexOf(normalizedName);
return { station: station, idx: idx };
} else {
return undefined;
}
}
async updateNormalizedNameToStation() {
const stationsFetchResult = await CTSService.getNamedStations(this.api);
this.normalizedNameToStation = stationsFetchResult;
}
static aggregateRawVisitSchedules(rawSchedule: LaneVisitsSchedule[]): ConsumableSchedule.Lane[] {
rawSchedule.sort((a, b) => {
return a.name.localeCompare(b.name);
});
const lanes: ConsumableSchedule.Lane[] = [];
function add(visitSchedule: LaneVisitsSchedule) {
const lane = lanes.find((lane) => lane.name == visitSchedule.name);
const times = visitSchedule.departureDates.map((date) => new ConsumableSchedule.Visit(date));
const direction = new ConsumableSchedule.Direction(
times,
visitSchedule.name,
visitSchedule.destinationName,
visitSchedule.via ? visitSchedule.via : null,
visitSchedule.directionRef
);
if (lane === undefined) {
lanes.push(new ConsumableSchedule.Lane(visitSchedule.name, [direction]))
} else {
lane.directions.push(direction);
}
}
rawSchedule.forEach(add);
for (let lane of lanes) {
lane.directions.sort((a, b) => {
return a.destination.localeCompare(b.destination);
});
lane.directions.sort((a, b) => {
return b.directionTag - a.directionTag;
});
}
return lanes;
}
async getVisitsStore(userReadableName: string, logicStopCodes: string[]): Promise<ConsumableSchedule.NamedStationVisitsStore> {
const unmerged = await this.getVisitsForStopCodes(logicStopCodes);
const merged = CTSService.mergeVisitsIfAppropriate(unmerged);
merged.sort((a, b) => {
return b[1].length - a[1].length;
});
const stations = merged.map((station) => {
const isMerged = station[0].length > 1;
const busLanes = station[1].filter((lane) => lane.transportType == "bus");
const tramLanes = station[1].filter((lane) => lane.transportType == "tram");
return new ConsumableSchedule.Station(
isMerged,
CTSService.aggregateRawVisitSchedules(busLanes),
CTSService.aggregateRawVisitSchedules(tramLanes)
)
});
return new ConsumableSchedule.NamedStationVisitsStore(userReadableName, emojiForStation(userReadableName), stations);
}
static formatLane(lane: ConsumableSchedule.Lane): string {
let final = "";
for (let direction of lane.directions) {
final += `> **${direction.fullLaneDescription}**: `;
let time: ConsumableSchedule.Visit | undefined;
while ((time = direction.popVisit()) !== undefined) {
final += `${time.formattedOffsetFR}`;
if (direction.peekVisit() !== undefined) {
final += ", ";
}
}
final += "\n";
}
return final;
}
static formatLanes(lanes: ConsumableSchedule.Lane[]): string {
let final = "";
for (let [idx, lane] of lanes.entries()) {
final += CTSService.formatLane(lane);
if (idx < lanes.length - 1) {
final += "\n";
}
}
return final;
}
async getFormattedSchedule(userReadableName: string, logicStopCodes: string[], locale: string | null = null): Promise<string> {
const store = await this.getVisitsStore(userReadableName, logicStopCodes);
let final = "";
const multipleStations = store.length > 1;
if (multipleStations) {
final += `⚠️ Avertissement: Affichage des résultats pour ${store.length} stations potentiellement distinctes. __Voir les détails plus bas.__\n\n`;
}
final += `__**Horaires pour *${store.name}***__`;
if (store.emoji !== null) {
final += ` ${store.emoji}`;
}
final += "\n\n";
let station: ConsumableSchedule.Station | undefined;
let mergedStations = false;
while ((station = store.popStation()) !== undefined) {
if (station.isMerged) {
final += "⚠️ Avertissement: Plusieurs données ont été fusionnées automatiquement. __Voir les détails plus bas.__\n\n";
mergedStations = true;
}
if (!station.hasVisits) {
if (shouldDisplayMay1stCustomEmoji()) {
final += "Il ne semble pas y avoir de passages à cette station actuellement... joyeux 1er mai ! <:lilyofthevalley:1102362759141785610>\n";
} else {
final += "Il ne semble pas y avoir de passages à cette station actuellement.\n";
}
continue;
}
if (station.hasSingleTypeOfLane) {
const all = station.getMergedLanes();
final += CTSService.formatLanes(all);
} else {
final += "**Trams :tram: :**\n";
final += CTSService.formatLanes(station.tramLanes);
final += "\n";
final += "**Bus :bus: :**\n";
final += CTSService.formatLanes(station.busLanes);
}
if (store.peekStation() !== undefined) {
final += "\n====================\n\n";
}
}
if (mergedStations || multipleStations) {
final += "\n====================\n\n";
}
if (multipleStations) {
final +=
'Les données de la CTS définissent plusieurs "stations" pour votre requête. ';
final +=
"Cela peut avoir différentes significations selon les cas : stations se complétant entre elles, ";
final +=
"stations réellement distinctes, ou encore données tout simplement erronées.\n";
final +=
"Notez que comme toujours les différents *arrêts* faisant partie d'une même ";
final +=
"*station* peuvent être relativement éloignés les uns des autres.";
}
if (mergedStations) {
if (multipleStations) {
final += "\n\n";
}
final +=
'Les horaires ci-dessus correspondent à plusieurs "stations" ';
final += "théoriquement distinctes mais que j'ai fusionné ";
final +=
" car je considère qu'elles semblent se compléter entre elles. ";
final +=
"Notez que comme toujours les différents *arrêts* faisant partie d'une même ";
final +=
"*station* peuvent être relativement éloignés les uns des autres. ";
final +=
"**__Je peux toutefois me tromper et les données peuvent également être erronées.__**";
}
final += this.getLocalizedAccuracyWarnings(locale)
return final;
}
// We want to fator out the locale warnings part
getLocalizedAccuracyWarnings(locale: string | null): string {
// TODO: Maybe avoid prepending a newline
let message = "";
if (locale === "fr") {
message += "\n*Certains horaires peuvent être théoriques - Exactitude non garantie ([voir plus](<https://gist.github.com/PopFlamingo/74fe805c9017d81f5f8baa7a880003d0>))*";
} else if (locale === "en-US" || locale === "en-GB") {
message += "\n*Some schedules may be theoretical - Accuracy not guaranteed ([see more](<https://gist.github.com/PopFlamingo/74fe805c9017d81f5f8baa7a880003d0>))*";
} else {
message += "\n*Certains horaires peuvent être théoriques - Exactitude non garantie ([voir plus](<https://gist.github.com/PopFlamingo/74fe805c9017d81f5f8baa7a880003d0>))*";
message += "\n*Some schedules may be theoretical - Accuracy not guaranteed ([see more](<https://gist.github.com/PopFlamingo/74fe805c9017d81f5f8baa7a880003d0>))*";
}
return message;
}
/**
*
* @param stopCodes Logic stop codes (maybe other types of codes too, todo: check)
* @returns An array of [stopCode, schedule] pairs
*/
private async getVisitsForStopCodes(
stopCodes: string[]
): Promise<[string, LaneVisitsSchedule[]][]> {
const result: [string, LaneVisitsSchedule[]][] = [];
for (let stopCode of stopCodes) {
const schedule = await this.getVisitsForStopCode([stopCode]);
result.push([stopCode, schedule]);
}
return result;
}
private static mergeVisitsIfAppropriate(
stationsAndVisits: [string, LaneVisitsSchedule[]][],
): [string[], LaneVisitsSchedule[]][] {
// This is the same as input but converted to the correct shape
// and is useful in some cases where we don't want to actually merge anything...
const unmergedReshaped: [string[], LaneVisitsSchedule[]][] = stationsAndVisits.map(([station, visits]) => {
return [[station], visits];
});
// ... like if there is just one or no element
if (stationsAndVisits.length <= 1) {
return unmergedReshaped;
}
// Make copy of stationsAndVisits array (we need to modify it)
const stationsAndVisitsCopy = stationsAndVisits.slice();
const [firstStation, firstVisits] = stationsAndVisitsCopy.shift()!;
let results: [string[], LaneVisitsSchedule[]][] = [[[firstStation], firstVisits]];
while (stationsAndVisitsCopy.length > 0) {
const [stopCodeToMerge, visitsToMerge] = stationsAndVisitsCopy.shift()!;
for (let i = 0; i < results.length; i++) {
const [_, resultVisits] = results[i];
for (let j = 0; j < visitsToMerge.length; j++) {
let elementToMergeVisit = visitsToMerge[j];
if (
resultVisits.findIndex((resultSchedule) => {
return (
resultSchedule.name ===
elementToMergeVisit.name &&
resultSchedule.transportType ===
elementToMergeVisit.transportType &&
resultSchedule.destinationName ===
elementToMergeVisit.destinationName &&
resultSchedule.via === elementToMergeVisit.via
);
}) != -1
) {
// If we find any element that is in both arrays, we cancel the merge.
// The reason why is that this means instead of completing themselves
// the stations are likely distinct even tho they are part of the same extended station
// (see "Ile de France" station in [the blog post](https://blog.popflamingo.fr/public-transit-bot))
return unmergedReshaped;
}
}
results[i][0].push(stopCodeToMerge);
results[i][1] = results[i][1].concat(visitsToMerge);
}
}
return results;
}
private async getVisitsForStopCode(
stopCodes: string[]
): Promise<LaneVisitsSchedule[]> {
// Note the difference between a stop and a station:
// A stop is a place where a tram or a bus passes in a specific
// direction (for instance there is typically one stop on each side
// of the rails) and you have both tramway stops and bus stops.
// A station is a group of stops that are geographically close.
// In general users refer to stations instead of stops, but they
// still implicitly refer to specific stops by stating their
// destination name, lane and transport type.
// We query the CTS API for all the stop codes for the station
// so we actually need to repeat the MonitoringRef query parameter
// for each stop code.
const params = new URLSearchParams();
for (const code of stopCodes) {
params.append("MonitoringRef", code);
}
const rawResponse = await this.api.get("/stop-monitoring", {
params: params,
});
// We use a strongly typed JSON parser to parse the response
// which eliminates a lot of boilerplate code
const serializer = new TypedJSON(SpecializedStopMonitoringResponse, {
errorHandler: (error: Error) => {
throw new Error("CTS_PARSING_ERROR");
},
});
const response = serializer.parse(rawResponse.data);
if (response === undefined) {
throw new Error("Could not parse response");
}
const stopMonitoringDelivery =
response.serviceDelivery.stopMonitoringDelivery;
// Make sure there is exactly one element in the array
// Currently the CTS API only returns one response per request
// but this may change at some point so this is not future-proof
// However it's hard to understand why there would ever be more than one
// It would be best to check with CTS why that could be the case (if ever)
// and what to do then.
if (stopMonitoringDelivery.length !== 1) {
throw new Error(
"Not exactly one stop monitoring delivery in CTS response"
);
}
// An array that stores all vehicle visits for the stops we requested
const monitoredStopVisits = stopMonitoringDelivery[0].monitoredStopVisit || [];
const collector: {
[key: string]: LaneVisitsSchedule;
} = {};
// This code loops over all the vehicle visits times and groups them
// by their their (lanes / destinations / vehicle kind / [optional] via)
// then we can for instance have a "Tramway lane Z to destination FooCity"
// group that contains all the departure times for this specific lane/destination.
// These lane/destination - times associations are stored in LaneVisitsSchedule
// objects and this is what we return to the caller.
//
// The CTS/SIRI API doesn't provide such as feature so we have to do it ourselves.
monitoredStopVisits.forEach((monitoredStopVisit) => {
const info = monitoredStopVisit.monitoredVehicleJourney;
// Get the departure time (or arrival time if there is no departure date)
// In practice it seems there is always a departure time, but if it was
// to be missing one day, using the arrival time would still be fine
// Note that "arrival date means" date of arrival at the stop
// not at some destination, so this is why its a correct fallback
let stopTime = info.monitoredCall.expectedDepartureTime;
if (stopTime === undefined) {
stopTime = info.monitoredCall.expectedArrivalTime;
}
// If the stop time is more than 1 minute in the past or more than
// 5 hours in the future, we ignore it
// We are doing this to guard against cases where the API may return
// incoherent data, this often happens at night.
if (
stopTime.getTime() < Date.now() - 60000 ||
stopTime.getTime() > Date.now() + 5 * 3600 * 1000
) {
return;
}
// The key is used to group the vehicle visits
const key = `${info.publishedLineName}|${info.destinationName}|${info.vehicleMode}|${info.via}`;
// If the there is already a value for this key add the departure date to the array
if (collector[key] !== undefined) {
collector[key].departureDates.push(stopTime);
} else {
// Otherwise create a new LaneVisitsSchedule object and associate it with the key
collector[key] = new LaneVisitsSchedule(
info.publishedLineName,
info.vehicleMode,
info.directionRef,
info.destinationName,
info.via,
[stopTime]
);
}
});
// Create an array with the values of the collector
let result = Object.values(collector);
// Remove all the lanes that have no visits
result = result.filter((lane) => lane.departureDates.length > 0);
// Return all values in the collector