Implemented travelTime Data Functionality #376

CasperL1218 · 2024-10-27T23:09:53Z

Summary

This pull request implements travel time data functionality for apartment pages, providing users with distance information from apartments to major campus locations.

Key implementations:

Created new travelTimes collection and corresponding data types
Implemented Google Maps Matrix API integration for travel time calculations
Added backend endpoints for travel time data retrieval
Enhanced frontend map functionality with travel time display
Improved mobile map experience and map interaction behavior

Test Plan

Backend Testing:

Google Maps Matrix API integration validation
Single building travel time document creation

Full travel time collection initialization
Backend endpoint functionality for data retrieval

Frontend Testing:

Travel time data display in MapInfo component

Travel time data display in MapModal component

Mobile map modal functionality

Map auto-recentering behavior

map.auto-recenter.mov

School location icons alignment with travel time data points

Notes

Database Schema Changes:

New collection: travelTimes
Schema structure:
- Id: building id (matching building collection)
- Fields:
  - walking_arts_quad
  - walking_duffield
  - walking_ctb
  - driving_arts_quad
  - driving_duffield
  - driving_ctb

API Integration:

Added Google Maps Matrix API integration
Note: API calls only required during new apartment addition

Frontend Enhancements:

Implemented mobile-responsive map modal
Added auto-recentering functionality for MapInfo component
Updated school location icons to match travel time data points

Breaking Changes

Database Updates:

Added new travelTimes collection
Created new LocationTravelTimes type in db-types
Modified database schema to include travel time data

Future Considerations

Update "add_buildings" script to automatically generate corresponding travelTimes documents
Optimize API usage for batch apartment additions
Consider caching strategies for frequently accessed travel time data

- Created travelTime collection - Implemented POST endpoint to calculate travel distances using Google Map Matrix API - Implemented testing POST endpoint to create single building document

dti-github-bot · 2024-10-27T23:10:06Z

[diff-counting] Significant lines: 531.

kea-roy

Early PR Review

Overall, this is a great start on this PR. For the code you have implemented so far, I have suggested some minor things you could do to make it better. I hope that the rest of your work on this PR will be of the same splendid quality :)

backend/src/app.ts

- Implemented travel documents document batch creation endpoint - Tested on smaller batches (size 10) - Created building travel time documents for all buildings

- Created endpoint for frontend travel time retrieval - Improved documentation for helper function

- Implemented frontend travel time display - Mofified ApartmentWithId type to include travelTimes attribute

- Modified TravelTimes type (isolated from Apartments type) - Implemented map recenter feature upon map modal closure - Implemented mobile map modal

ggsawatyanon

Great job on this map backend PR! The map feature is definitely nearing completion and the travel time info will be very useful for users. I'm requesting changes for you to implement the small frontend change that David had mentioned (increasing the space between the location name and the map on the mobile modal) as well as adjusting the minimum font size of the location names in the mobile ver. of map modal to match the figma (13px, right now it's 10px and quite difficult to read on mobile) . Once the spacing and font size is fixed, you'll be fully finished with the map feature!

- Added spacing between address and map - Increased location and traveltime font size for better visibility

CasperL1218 · 2024-11-17T06:09:55Z

Great job on this map backend PR! The map feature is definitely nearing completion and the travel time info will be very useful for users. I'm requesting changes for you to implement the small frontend change that David had mentioned (increasing the space between the location name and the map on the mobile modal) as well as adjusting the minimum font size of the location names in the mobile ver. of map modal to match the figma (13px, right now it's 10px and quite difficult to read on mobile) . Once the spacing and font size is fixed, you'll be fully finished with the map feature!

Thanks for catching that! I have implemented the frontend improvement regarding the mobile map modal.

kea-roy

PR Review

This is an excellent PR. Your implementation is responsive and correctly adapts the figma design. Your API endpoints seem mostly correct, however I suggested a few minor changes just to make sure it works when the API is not run locally. There are a couple of minor things you can do to further improve your code, such as fixing some documentation, so I've also suggested those changes with my comments :) Overall, great PR!

kea-roy · 2024-11-17T16:36:19Z

backend/src/app.ts

@@ -960,4 +964,269 @@ app.post('/api/add-contact-question', authenticate, async (req, res) => {
  }
 });

+interface TravelTimes {


Since you already imported LocationTravelTimes, you can delete TravelTimes and use the imported type.

kea-roy · 2024-11-17T16:38:31Z

backend/src/app.ts

+    }
+
+    // Calculate travel times using the main endpoint
+    const response = await axios.post(`http://localhost:3000/api/calculate-travel-times`, {


You can delete http://localhost:3000 from the axios post request. Keeping this part in the request means it will only work if you run the backend locally, but not on prod. I believe replacing it with axios.post('/api/calculate-travel-times') may do the trick, but I didn't test this modification.

kea-roy · 2024-11-17T16:44:06Z

backend/src/app.ts

+          return;
+        }
+
+        const response = await axios.post(`http://localhost:3000/api/calculate-travel-times`, {


Similarly, you can delete http://localhost:3000 from the axios post request.

kea-roy · 2024-11-17T16:45:03Z

backend/src/app.ts

+ * Looks up the travel times document for the given building ID and returns the stored walking and driving
+ * times to Cornell landmarks: Engineering Quad, Agriculture Quad, and Ho Plaza.
+ *
+ * @route GET /api/travel-times/:buildingId


adjust to /api/travel-times-by-id/:buildingId

kea-roy · 2024-11-17T16:58:45Z

frontend/src/pages/ApartmentPage.tsx

@@ -150,6 +156,17 @@ const ApartmentPage = ({ user, setUser }: Props): ReactElement => {
  const saved = savedIcon;
  const unsaved = unsavedIcon;
  const [isSaved, setIsSaved] = useState(false);
+  const mapInfoRef = useRef<MapInfoRef>(null);


Remember to clean up unused variables! Just look at the check warnings from lint to see what is unused.

kea-roy · 2024-11-17T17:00:26Z

frontend/src/pages/ApartmentPage.tsx

  const Modals = landlordData && apt && (
    <>
      <MapModal
        aptName={apt!.name}
        open={mapOpen}
-        onClose={() => setMapOpen(false)}
+        onClose={handleMapModalClose}
        setOpen={setMapOpen}


Your setOpen parameter is no longer being used, so maybe remove setOpen as a parameter?

Implemented travelTime Firebase Data

fe1e1fe

- Created travelTime collection - Implemented POST endpoint to calculate travel distances using Google Map Matrix API - Implemented testing POST endpoint to create single building document

CasperL1218 requested review from kea-roy and ggsawatyanon October 27, 2024 23:11

kea-roy requested changes Oct 27, 2024

View reviewed changes

backend/src/app.ts Outdated Show resolved Hide resolved

backend/src/app.ts Outdated Show resolved Hide resolved

backend/src/app.ts Outdated Show resolved Hide resolved

CasperL1218 added 4 commits October 29, 2024 17:28

Implemented travel time documents creation

28bb1e3

- Implemented travel documents document batch creation endpoint - Tested on smaller batches (size 10) - Created building travel time documents for all buildings

Implemented Endpoint for Frontend Travel Time Retrieval

a58bc1a

- Created endpoint for frontend travel time retrieval - Improved documentation for helper function

Implemented Frontend Display of Travel Time Data

76c933d

- Implemented frontend travel time display - Mofified ApartmentWithId type to include travelTimes attribute

Improved Traveltimes Data Display & Frontend Map Feature

09b3fe0

- Modified TravelTimes type (isolated from Apartments type) - Implemented map recenter feature upon map modal closure - Implemented mobile map modal

CasperL1218 changed the title ~~WIP: Implemented travelTime Firebase Data~~ Implemented travelTime Firebase Data Nov 16, 2024

CasperL1218 changed the title ~~Implemented travelTime Firebase Data~~ Implemented travelTime Data Functionality Nov 16, 2024

CasperL1218 requested a review from kea-roy November 16, 2024 23:55

Merge branch 'main' into map-backend

3ff24c7

ggsawatyanon requested changes Nov 17, 2024

View reviewed changes

Improved Frontend Mobile Map Modal

bbb2930

- Added spacing between address and map - Increased location and traveltime font size for better visibility

CasperL1218 requested a review from ggsawatyanon November 17, 2024 06:07

kea-roy requested changes Nov 17, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implemented travelTime Data Functionality #376

Implemented travelTime Data Functionality #376

CasperL1218 commented Oct 27, 2024 •

edited

Loading

dti-github-bot commented Oct 27, 2024 •

edited

Loading

kea-roy left a comment

ggsawatyanon left a comment

CasperL1218 commented Nov 17, 2024

kea-roy left a comment

kea-roy Nov 17, 2024

kea-roy Nov 17, 2024

kea-roy Nov 17, 2024

kea-roy Nov 17, 2024

kea-roy Nov 17, 2024

kea-roy Nov 17, 2024

Implemented travelTime Data Functionality #376

Are you sure you want to change the base?

Implemented travelTime Data Functionality #376

Conversation

CasperL1218 commented Oct 27, 2024 • edited Loading

Summary

Test Plan

Notes

Breaking Changes

Future Considerations

dti-github-bot commented Oct 27, 2024 • edited Loading

kea-roy left a comment

Choose a reason for hiding this comment

Early PR Review

ggsawatyanon left a comment

Choose a reason for hiding this comment

CasperL1218 commented Nov 17, 2024

kea-roy left a comment

Choose a reason for hiding this comment

PR Review

kea-roy Nov 17, 2024

Choose a reason for hiding this comment

kea-roy Nov 17, 2024

Choose a reason for hiding this comment

kea-roy Nov 17, 2024

Choose a reason for hiding this comment

kea-roy Nov 17, 2024

Choose a reason for hiding this comment

kea-roy Nov 17, 2024

Choose a reason for hiding this comment

kea-roy Nov 17, 2024

Choose a reason for hiding this comment

CasperL1218 commented Oct 27, 2024 •

edited

Loading

dti-github-bot commented Oct 27, 2024 •

edited

Loading