Merge pull request 'added error handling when requesting to join non existing room' (#41) from bugfix/unhandled-error-when-trying-to-join-non-existing-room into develop

Reviewed-on: https://gitea.e5tv.hu/esoko/mapguesser/pulls/41
Reviewed-by: Pőcze Bence <bence@pocze.ch>

.env.example

@@ -7,6 +7,7 @@ DB_NAME=mapguesser
 GOOGLE_MAPS_SERVER_API_KEY=your_google_maps_server_api_key
 GOOGLE_MAPS_JS_API_KEY=your_google_maps_js_api_key
 LEAFLET_TILESERVER_URL=a_leaflet_compatible_tileserver_url
+LEAFLET_TILESERVER_SUBDOMAINS=list_of_subdomains_for_the_tileserver_without_separators
 LEAFLET_TILESERVER_ATTRIBUTION=attribution_to_be_shown_for_tiles
 STATIC_ROOT=/static
 MAIL_FROM=mapguesser@mapguesser-dev.ch

README.md

@@ -65,7 +65,12 @@ Required API keys:
 * **GOOGLE_MAPS_SERVER_API_KEY**: this it used by the backend and should have access to **Street View Static API**
 * **GOOGLE_MAPS_JS_API_KEY**: this is used by the frontend and should have access to **Maps JavaScript API** and **Maps Static API**
 
-Additionally, a tile provider is also needed for map editor. This should be configured by `LEAFLET_TILESERVER_URL` and `LEAFLET_TILESERVER_ATTRIBUTION`. You can find some providers here: https://wiki.openstreetmap.org/wiki/Tile_servers. OpenStreetMap's tile server is fine for testing.
+Additionally, a tile provider is also needed for map editor. This should be configured by `LEAFLET_TILESERVER_URL`, `LEAFLET_TILESERVER_SUBDOMAINS` and `LEAFLET_TILESERVER_ATTRIBUTION`. You can find some providers here: https://wiki.openstreetmap.org/wiki/Tile_servers. OpenStreetMap's tile server is fine for testing.
+Example:
+```
+LEAFLET_TILESERVER_URL=https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png
+LEAFLET_TILESERVER_SUBDOMAINS=abc
+```
 
 ### (Production only) Create cron job
 

public/static/js/game.js

@@ -410,6 +410,10 @@
                     MapGuesser.showModalWithContent('Error', 'This game is already started, you cannot join.');
                     break;
 
+                case 'game_not_found':
+                    MapGuesser.showModalWithContent('Error', 'The game room was not found by this ID. Please check the link.');
+                    break;
+
                 default:
                     MapGuesser.showModalWithContent('Error', 'Error code: \'' + error + '\'');
                     break

public/static/js/map_editor.js

@@ -80,22 +80,16 @@
             MapEditor.panorama.setPano(panoLocationData.pano);
         },
 
-        requestPanoData: function (location, canBeIndoor) {
+        requestPanoData: function (location) {
             var sv = new google.maps.StreetViewService();
 
             sv.getPanorama({
                 location: location,
                 preference: google.maps.StreetViewPreference.NEAREST,
-                radius: 100,
-                source: canBeIndoor ? google.maps.StreetViewSource.DEFAULT : google.maps.StreetViewSource.OUTDOOR
+                radius: MapEditor.map.getSearchRadius(location),
             }, function (data, status) {
                 var panoLocationData = status === google.maps.StreetViewStatus.OK ? data.location : null;
 
-                if (panoLocationData === null && !canBeIndoor) {
-                    MapEditor.requestPanoData(location, true);
-                    return;
-                }
-
                 document.getElementById('loading').style.visibility = 'hidden';
 
                 MapEditor.loadPanoForNewPlace(panoLocationData);
@@ -388,7 +382,7 @@
 
                 L.tileLayer(tileUrl, {
                     attribution: tileAttribution,
-                    subdomains: '1234',
+                    subdomains: tileSubdomains,
                     ppi: highResData.ppi,
                     tileSize: highResData.tileSize,
                     zoomOffset: highResData.zoomOffset,
@@ -473,7 +467,11 @@
             LMapWrapper.markers.removeLayer(marker);
         },
 
-        toggleStreetViewCover: function () { }
+        toggleStreetViewCover: function () { },
+
+        getSearchRadius: function (location) {
+            return 100;
+        }
     };
 
     var GMapWrapper = {
@@ -626,6 +624,20 @@
                 GMapWrapper.streetViewCover.setMap(GMapWrapper.map);
                 GMapWrapper.streetViewCoverOn = true;
             }
+        },
+
+        getSearchRadius: function (location) {
+            // source: https://www.yorku.ca/mack/CHI01.htm
+            var movementOffset = 4;
+
+            // source: https://groups.google.com/g/google-maps-js-api-v3/c/hDRO4oHVSeM/m/osOYQYXg2oUJ?pli=1
+            var metersPerPixel = 156543.03392 * Math.cos(location.lat * Math.PI / 180) / Math.pow(2, GMapWrapper.map.getZoom());
+
+            var minSearchRadius = 5;
+
+            var searchRadius = Math.max(minSearchRadius, Math.round(movementOffset * metersPerPixel));
+
+            return searchRadius;
         }
     };
 

src/Cli/AddUserCommand.php

@@ -27,7 +27,7 @@ class AddUserCommand extends Command
         $user->setActive(true);
         $user->setCreatedDate(new DateTime());
 
-        if ($input->hasArgument('type')) {
+        if ($input->hasArgument('type') && $input->getArgument('type') !== null) {
             $user->setType($input->getArgument('type'));
         }
 

src/Controller/GameController.php

@@ -114,6 +114,11 @@ class GameController
         }
 
         $room = $this->multiRoomRepository->getByRoomId($roomId);
+
+        if(!isset($room)) {
+            return new JsonContent(['error' => 'game_not_found']);
+        }
+
         $state = $room->getStateArray();
         $map = $this->mapRepository->getById($state['mapId']);
         $token = $this->getMultiToken($roomId);

src/Controller/UserController.php

@@ -210,7 +210,7 @@ class UserController implements ISecured
         return new JsonContent(['success' => true]);
     }
 
-    private function confirmUserIdentity(User $user, ?DateTime $authenticatedWithGoogleUntil, ?string $password, string &$error): bool
+    private function confirmUserIdentity(User $user, ?DateTime $authenticatedWithGoogleUntil, ?string $password, ?string &$error): bool
     {
         if ($authenticatedWithGoogleUntil !== null && $authenticatedWithGoogleUntil > new DateTime()) {
             return true;

src/PersistentData/Model/Place.php

@@ -140,7 +140,7 @@ class Place extends Model
         return $this->pov->getZoom();
     }
 
-    public function getFreshPanoId(bool $canBeIndoor = false): ?string
+    public function getFreshPanoId(): ?string
     {
         if (
             $this->panoIdCachedTimestamp !== null &&
@@ -152,19 +152,13 @@ class Place extends Model
         $request = new Request('https://maps.googleapis.com/maps/api/streetview/metadata', Request::HTTP_GET);
         $request->setQuery([
             'key' => $_ENV['GOOGLE_MAPS_SERVER_API_KEY'],
-            'location' => $this->position->getLat() . ',' . $this->position->getLng(),
-            'source' => $canBeIndoor ? 'default' : 'outdoor'
+            'location' => $this->position->getLat() . ',' . $this->position->getLng()
         ]);
 
         $response = $request->send();
         $panoData = json_decode($response->getBody(), true);
         $panoId = $panoData['status'] === 'OK' ? $panoData['pano_id'] : null;
 
-        // enable indoor panos if no outdoor found
-        if ($panoId === null && !$canBeIndoor) {
-            return $this->getFreshPanoId(true);
-        }
-
         $this->panoIdCached = $panoId;
         $this->panoIdCachedTimestamp = new DateTime();
 

views/admin/map_editor.php

@@ -94,6 +94,7 @@
 @section(pageScript)
 <script>
     var tileUrl = '<?= $_ENV['LEAFLET_TILESERVER_URL'] ?>';
+    var tileSubdomains = '<?= $_ENV['LEAFLET_TILESERVER_SUBDOMAINS'] ?>';
     var tileAttribution = '<?= $_ENV['LEAFLET_TILESERVER_ATTRIBUTION'] ?>';
     var mapId = <?= $mapId ?>;
     var mapBounds = <?= json_encode($bounds) ?>;