Added notes to what has been tried.

Author: eireland

src/utils/location-utils.ts

@@ -38,6 +38,8 @@ const haversineDistance = (lat1: number, lon1: number, lat2: number, lon2: numbe
     return R * c;
 };
 
+// find the nearest location nearest the lat/long. We need this if using the citiesJSON service
+// because this service returns all the cities in the bounding box, not just the nearest
 const findNearestCity = (targetLat: number, targetLon: number, citiesArray: any) => {
     let nearestCity = null;
     let minDistance = Infinity;
@@ -57,36 +59,41 @@ const findNearestCity = (targetLat: number, targetLon: number, citiesArray: any)
 export const geoLocSearch = async (lat: number, long: number, bounds: IBounds) => {
   const userClause = `username=${kGeonamesUser}`;
   const locClause = `lat=${lat}&lng=${long}`;
-  const boundsClause = `north=${bounds.north}&south=${bounds.south}&east=${bounds.east}&west=${bounds.west}`;
   const maxRowsClause = `maxRows=50`;
   const radiusClause = `radius=25`;
   const populationLimitClause = "city15000";
+  // boundsClause is used if using citiesJSON service
+  const boundsClause = `north=${bounds.north}&south=${bounds.south}&east=${bounds.east}&west=${bounds.west}`;
   // const url = `${kGeolocCitiesService}?${[locClause, userClause, boundsClause, maxRowsClause].join("&")}`;
   const url = `${kGeolocService}?${[locClause, userClause, maxRowsClause, radiusClause, populationLimitClause ]
                   .join("&")}`;
   try {
     const response = await fetch(url);
     if (response.ok) {
       const data = await response.json();
-      // filter out geonames where population is 0
+      // There is a bug in the findNearbyPlaceNameJSON service that returns 0 population places
+      // even when city15000 population filter is set. So we filter out geonames where population is 0
       const geonames = data.geonames.filter((geoname: any) => {
         return geoname.population > 0;
       });
       console.log("GeoLocSearch geonames", JSON.parse(JSON.stringify(geonames)));
       console.log("data size", geonames.length);
+      // Sort geonames by population in descending order to try to get the nearest most populated city
       const sortedGeonamesByPopulation = geonames.sort((a: any, b: any) => {
         const populationA = parseInt(a.population, 10);
         const populationB = parseInt(b.population, 10);
         return populationB - populationA; // Sort in descending order
       });
       console.log("sorted geonames", JSON.parse(JSON.stringify(sortedGeonamesByPopulation)));
 
-      // find the nearest location nearest the lat/long
+      // find the nearest location nearest the lat/long. We use the commented out code if using the citiesJSON service
       // const nearest = findNearestCity(lat, long, data.geonames);
       const nearest = sortedGeonamesByPopulation[0];
       console.log("nearest location", JSON.parse(JSON.stringify(nearest)));
       return nearest
         ? {success: true, values: {location:`${nearest.name}, ${nearest.adminCode1}`}}
+        // Return this value if using the citiesJSON service.
+        // citiesJSON service does not have adminCode1 (state name), se we use countrycode
         // ? {success: true, values: {location:`${nearest.name}, ${nearest.countrycode}`}}
         : {success: false, values: {location: "Unknown Location"}};
     } else {