Feature/wf sust

README.md

@@ -1,5 +1,16 @@
 # AdvancedSoftwareEngineering-Group3
 
-Download Expo Go on the playstore or appstore 
+## Run through the Expo  
 
-See instructions within `client/README.md` and `server/README.md` for more information on how to run the project.
+Download Expo Go on the playstore or appstore then follow the instructions within `client/README.md` and `server/README.md` for more information on how to run the project.
+
+## Package and deployment instructions
+- To package the client, it must first be prebuilt using the command `npx expo prebuild`.
+- Next, the client can be packaged using the command `eas build -p android --profile preview`.
+- This will present a QR code and link, using which you can download and install the app to your device.
+- The process is essentially the same for IOS but for it to work, an Apple Developer Account is required. We did not explore this route as it would have been an additional cost. We did however ensure that all functionality was cross platform.
+
+## Notes
+- Running the server locally will not be possible as you will not be able to connect to the Database without our input.
+- After the demo our servers on Digital Ocean will be taken down as it is a payed service. All functionality will be displayed in the demo.
+- An EAS account is required to package the app.

client/README.md

@@ -34,6 +34,8 @@ npx expo start
 
 **Here's an example: `EXPO_PUBLIC_API_URL=http://192.168.13.1:8000`**
 
+If you are running the server on the Digital Ocean Droplet, the above instructions stand, but the IP address should be that of the droplet: `134.199.188.243`
+
 ## Linting and Formatting Scripts
 
 This project uses ESLint and Prettier to maintain code quality and consistency. Below are the scripts defined in the `package.json` for linting and formatting:

client/src/DisplayRoute.js

@@ -49,11 +49,11 @@
 
   const handleIncidentSubmit = async (incidentData) => {
     // Here you would process the incident data
     console.log('Incident reported:', incidentData);
 
     // Example: Send to your API
     const data = await postIncident(incidentData);
     console.log('Response:', data);
 
     // Example: Update local state to show on map
     // setMapIncidents(prev => [...prev, incidentData]);
@@ -100,7 +100,10 @@
   }, [currentInstruction]);
 
   function removeHtmlTags(instruction) {
-    return instruction.replace(/<\/?[^>]+(>|$)/g, '');
+    if (instruction) {
+      return instruction.replace(/<\/?[^>]+(>|$)/g, '');
+    }
+    return instruction;
   }
 
   // Creating a dictionary of step data for each step in the route
@@ -149,9 +152,9 @@
     try {
       const baseUrl =
         Platform.OS === 'web'
-          ? 'http://localhost:8000'
+          ? 'http://localhost'
           : process.env.EXPO_PUBLIC_API_URL;
       console.log(`Sending request to ${baseUrl}/check_incidents`);
 
       const response = await fetch(`${baseUrl}/check_incidents`, {
         method: 'POST',
@@ -164,7 +167,7 @@
       if (response.ok) {
         // Parse the response as JSON
         const serverMessage = await response.json();
         console.log('Response from Server: ', serverMessage.message);
 
         // process the return incidents object, which contains multiple incidents
         setIncidentInfo(serverMessage.message);
@@ -172,7 +175,7 @@
         // Log the raw response text for debugging
         const responseText = await response.text();
         console.error('Failed to get crowd sourced incidents:', responseText);
         alert('Server Error: ', responseText);
       }
     } catch (error) {
       console.error('Error getting crowd sourced incidents:', error);

client/src/FindRoute.js

@@ -50,7 +50,7 @@
       if (isCurrentLocation) {
         const initialLocation = await getCurrentLocation();
         if (!initialLocation) {
           alert('Unable to fetch current location.');
           return;
         }
 
@@ -67,9 +67,9 @@
 
       const baseUrl =
         Platform.OS === 'web'
-          ? 'http://localhost:8000'
+          ? 'http://localhost'
           : process.env.EXPO_PUBLIC_API_URL;
       console.log(
         `Sending request to ${baseUrl}/wayfinding/preferences/get_routes`,
       );
 
@@ -91,7 +91,7 @@
       const data = await response.json();
 
       if (data.error) {
         alert(`Error finding route: ${response.message || response.status}`);
         return;
       }
       navigation.navigate('SelectRouteScreen', {
@@ -144,7 +144,7 @@
           placeholder="Enter destination point"
           value={destination}
           onChangeText={setDestinationPoint}
           onSubmitEditing={() => alert(`Route Entered`)}
         />
 
         <Text style={findRouteStyles.label}>Mode of Transport:</Text>

client/src/FriendsScreen.js

@@ -97,9 +97,9 @@
 
       const baseUrl =
         Platform.OS === 'web'
-          ? 'http://localhost:8000'
+          ? 'http://localhost'
           : process.env.EXPO_PUBLIC_API_URL;
       console.log(`Sending request to ${baseUrl}/send_request`);
 
       const response = await fetch(`${baseUrl}/send_request`, {
         method: 'POST',
@@ -133,7 +133,7 @@
     try {
       const baseUrl =
         Platform.OS === 'web'
-          ? 'http://localhost:8000'
+          ? 'http://localhost'
           : process.env.EXPO_PUBLIC_API_URL;
       console.log(
         `Sending request to ${baseUrl}/check_requests?sender=${senderName}`,
@@ -200,7 +200,7 @@
 
       const baseUrl =
         Platform.OS === 'web'
-          ? 'http://localhost:8000'
+          ? 'http://localhost'
           : process.env.EXPO_PUBLIC_API_URL;
       console.log(`Sending request to ${baseUrl}/request_response`);
 
@@ -245,7 +245,7 @@
 
       const baseUrl =
         Platform.OS === 'web'
-          ? 'http://localhost:8000'
+          ? 'http://localhost'
           : process.env.EXPO_PUBLIC_API_URL;
       console.log(`Sending request to ${baseUrl}/cancel_friend_request`);
 
@@ -287,7 +287,7 @@
 
       const baseUrl =
         Platform.OS === 'web'
-          ? 'http://localhost:8000'
+          ? 'http://localhost'
           : process.env.EXPO_PUBLIC_API_URL;
       console.log(`Sending request to ${baseUrl}/remove_friend`);
 
@@ -373,31 +373,31 @@
             />
           </View>
 
-        {/* Pending Friends List */}
-        <View style={styles.listContainer}>
-          <Text style={styles.sectionTitle}>Pending Friend Requests</Text>
-          <FlatList
-            data={pendingFriends}
-            keyExtractor={(item, index) => index.toString()}
-            renderItem={({ item }) => (
-              <View style={styles.pendingItem}>
-                <Text style={styles.friendRequestName}>{item}</Text>
-                <TouchableOpacity
-                  onPress={() => processFriendRequest(item, true)}
-                  style={styles.acceptButton}
-                >
-                  <Text style={styles.buttonText}>Accept</Text>
-                </TouchableOpacity>
-                <TouchableOpacity
-                  onPress={() => processFriendRequest(item, false)}
-                  style={styles.rejectButton}
-                >
-                  <Text style={styles.buttonText}>Reject</Text>
-                </TouchableOpacity>
-              </View>
-            )}
-          />
-        </View>
+          {/* Pending Friends List */}
+          <View style={styles.listContainer}>
+            <Text style={styles.sectionTitle}>Pending Friend Requests</Text>
+            <FlatList
+              data={pendingFriends}
+              keyExtractor={(item, index) => index.toString()}
+              renderItem={({ item }) => (
+                <View style={styles.pendingItem}>
+                  <Text style={styles.friendRequestName}>{item}</Text>
+                  <TouchableOpacity
+                    onPress={() => processFriendRequest(item, true)}
+                    style={styles.acceptButton}
+                  >
+                    <Text style={styles.buttonText}>Accept</Text>
+                  </TouchableOpacity>
+                  <TouchableOpacity
+                    onPress={() => processFriendRequest(item, false)}
+                    style={styles.rejectButton}
+                  >
+                    <Text style={styles.buttonText}>Reject</Text>
+                  </TouchableOpacity>
+                </View>
+              )}
+            />
+          </View>
 
           {/* Current Friends List */}
           <View style={styles.listContainer}>

client/src/Map.js

@@ -37,7 +37,7 @@ export default function MapScreen({ navigation }) {
     try {
       const baseUrl =
         Platform.OS === 'web'
-          ? 'http://localhost:8000'
+          ? 'http://localhost'
           : process.env.EXPO_PUBLIC_API_URL;
       console.log(`Sending request to ${baseUrl}/check_incidents`);
 
@@ -83,19 +83,19 @@ export default function MapScreen({ navigation }) {
     }
   };
 
-  const fetchWeather = async () => {
+  const fetchWeather = async (initialLocation) => {
     try {
       const baseUrl =
         Platform.OS === 'web'
-          ? 'http://localhost:8000'
+          ? 'http://localhost'
           : process.env.EXPO_PUBLIC_API_URL;
 
       console.log(
-        `Sending request to ${baseUrl}/weather?longitude=${location.longitude}&latitude=${location.latitude}`,
+        `Sending request to ${baseUrl}/weather?longitude=${initialLocation.longitude}&latitude=${initialLocation.latitude}`,
       );
 
       const response = await fetch(
-        `${baseUrl}/weather?longitude=${location.longitude}&latitude=${location.latitude}`,
+        `${baseUrl}/weather?longitude=${initialLocation.longitude}&latitude=${initialLocation.latitude}`,
         {
           method: 'GET',
           headers: {
@@ -123,19 +123,19 @@ export default function MapScreen({ navigation }) {
     }
   };
 
-  const fetchBikeApi = async () => {
+  const fetchBikeApi = async (initialLocation) => {
     try {
       const baseUrl =
         Platform.OS === 'web'
-          ? 'http://localhost:8000'
+          ? 'http://localhost'
           : process.env.EXPO_PUBLIC_API_URL;
 
       console.log(
-        `Sending request to ${baseUrl}/BikeStand?longitude=${location.longitude}&latitude=${location.latitude}`,
+        `Sending request to ${baseUrl}/BikeStand?longitude=${initialLocation.longitude}&latitude=${initialLocation.latitude}`,
       );
 
       const response = await fetch(
-        `${baseUrl}/BikeStand?longitude=${location.longitude}&latitude=${location.latitude}`,
+        `${baseUrl}/BikeStand?longitude=${initialLocation.longitude}&latitude=${initialLocation.latitude}`,
         {
           method: 'GET',
           headers: {
@@ -169,6 +169,11 @@ export default function MapScreen({ navigation }) {
       try {
         const initialLocation = await getCurrentLocation();
         setLocation(initialLocation);
+        // weatherBikePollIncident(initialLocation);
+
+        fetchWeather(initialLocation);
+        fetchBikeApi(initialLocation);
+        pollIncident();
 
         const locationSubscription = await startLocationTracking(setLocation);
 
@@ -181,19 +186,6 @@ export default function MapScreen({ navigation }) {
     fetchLocation();
   }, []);
 
-  useEffect(() => {
-    const pollOnce = async () => {
-      if (location) {
-        fetchWeather();
-        fetchBikeApi();
-        pollIncident();
-      }
-    };
-
-    pollOnce();
-    // eslint-disable-next-line react-hooks/exhaustive-deps
-  }, [location]); // Empty dependency array ensures this runs only once when the component mounts
-
   const renderContent = () => {
     if (errorMessage) {
       return <Text style={MapStyles.error}>{errorMessage}</Text>;

client/src/Preferences.js

@@ -47,7 +47,7 @@ export default function PreferencesScreen({ navigation }) {
     try {
       const baseUrl =
         Platform.OS === 'web'
-          ? 'http://localhost:8000'
+          ? 'http://localhost'
           : process.env.EXPO_PUBLIC_API_URL;
       console.log(`Sending request to ${baseUrl}/setPreferences`);
 

client/src/SelectRoute.js

@@ -1,5 +1,5 @@
 import React, { useEffect, useState } from 'react';
-import { View, Text, TouchableOpacity } from 'react-native';
+import { View, Text, TouchableOpacity, Platform } from 'react-native';
 import MapView, { Polyline, Marker } from 'react-native-maps';
 import {
   decodeRoute,
@@ -8,6 +8,7 @@ import {
 } from './utils/mapUtils';
 import locationCircleIcon from './assets/location-circle.png';
 import selectRouteStyles from './components/styles/SelectRoute.styles';
+import { retrieveData } from './caching';
 
 export default function SelectRouteScreen({ navigation, route }) {
   const { origin, destination, routeData } = route.params;
@@ -16,6 +17,7 @@ export default function SelectRouteScreen({ navigation, route }) {
   const [errorMessage, setErrorMessage] = useState('');
   const [polylineCoordinates, setPolylineCoordinates] = useState([]);
   const [currentRoute, setCurrentRoute] = useState(routeData.routes[0]);
+  const [scores, setScores] = useState([]);
 
   // Get current location
   useEffect(() => {
@@ -54,6 +56,86 @@ export default function SelectRouteScreen({ navigation, route }) {
     setPolylineCoordinates(decodedPath);
   };
 
+  const sendSustainabilityScore = async (
+    startRouteFlag,
+    sustainabilityScore,
+    // eslint-disable-next-line consistent-return
+  ) => {
+    try {
+      const baseUrl =
+        Platform.OS === 'web'
+          ? 'http://localhost'
+          : process.env.EXPO_PUBLIC_API_URL;
+      console.log(`Sending request to ${baseUrl}/update_sus_stats`);
+
+      const response = await fetch(`${baseUrl}/update_sus_stats`, {
+        method: 'POST',
+        headers: {
+          'Content-Type': 'application/json',
+        },
+        body: JSON.stringify({
+          username: await retrieveData('username'),
+          flag: startRouteFlag,
+          modeDistances: sustainabilityScore,
+        }),
+      });
+
+      const data = await response.json();
+      console.log('response (transport score): ', data);
+      return data;
+    } catch (error) {
+      console.log('Error sending sustainability scores and distances:', error);
+    }
+  };
+
+  const getSustainabilityScore = async (index, startRouteFlag) => {
+    const sustainabilityScore = {
+      Bus: 0,
+      Train: 0,
+      WALKING: 0,
+      Tram: 0,
+      DRIVING: 0,
+      BICYCLING: 0,
+    };
+    routeData.routes[index].legs[0].steps.forEach((step) => {
+      let key = '';
+      if (step.travel_mode === 'TRANSIT') {
+        // eslint-disable-next-line prefer-destructuring
+        key = step.html_instructions.trim().split(' ')[0];
+        console.log('key: ', key);
+      } else {
+        key = step.travel_mode;
+      }
+      sustainabilityScore[key] += step.distance.value / 1000;
+    });
+    console.log('sustainability score: ', sustainabilityScore);
+    const transportScore = await sendSustainabilityScore(
+      startRouteFlag,
+      sustainabilityScore,
+    );
+    return transportScore;
+  };
+
+  useEffect(() => {
+    for (let i = 0; i < routeData.routes.length; i += 1) {
+      setScores((prevScores) => [
+        ...prevScores,
+        getSustainabilityScore(i, false),
+      ]);
+    }
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, []);
+
+  const startJourney = (index, routeOption) => {
+    getSustainabilityScore(index, true);
+    navigation.navigate('DisplayRouteScreen', {
+      origin,
+      destination,
+      routeData: routeOption,
+      polylineCoordinates,
+    });
+  };
+
   return (
     <View style={selectRouteStyles.container}>
       {errorMessage && (
@@ -110,17 +192,13 @@ export default function SelectRouteScreen({ navigation, route }) {
                   <Text>Route {index + 1}</Text>
                   <Text>Distance: {routeOption.legs[0].distance.text}</Text>
                   <Text>Duration: {routeOption.legs[0].duration.text}</Text>
+                  <Text>Sustainability score: {scores[index]}</Text>
                 </TouchableOpacity>
                 {/* routeData needs to rename the route variable because that is what react navigator calls its properties */}
                 <TouchableOpacity
-                  onPress={() =>
-                    navigation.navigate('DisplayRouteScreen', {
-                      origin,
-                      destination,
-                      routeData: routeOption,
-                      polylineCoordinates,
-                    })
-                  }
+                  onPress={() => {
+                    startJourney(index, routeOption);
+                  }}
                   style={selectRouteStyles.startButton}
                 >
                   <Text>Start Journey</Text>