Request meta cell data once every 5 seconds (#2171)

This solve the Niantic "scan for pokemon" throttling without
making the bot very slow.

CONTRIBUTORS.md

@@ -46,3 +46,4 @@
  * kbinani
  * MFizz
  * NamPNQ
+ * matheussampaio

configs/config.json.example

@@ -58,6 +58,7 @@
         "type": "FollowSpiral"
       }
     ],
+    "map_object_cache_time": 5,
     "max_steps": 5,
     "forts": {
       "avoid_circles": true,

configs/config.json.path.example

@@ -59,6 +59,7 @@
         }
       }
     ],
+    "map_object_cache_time": 5,
     "max_steps": 5,
     "forts": {
       "avoid_circles": true,

configs/config.json.pokemon.example

@@ -58,6 +58,7 @@
         "type": "FollowSpiral"
       }
     ],
+    "map_object_cache_time": 5,
     "max_steps": 5,
     "forts": {
       "avoid_circles": true,

pokecli.py

@@ -324,6 +324,14 @@ def init_config():
         type=float,
         default=1.0
     )
+    add_config(
+        parser,
+        load,
+        long_flag="--map_object_cache_time",
+        help="Amount of seconds to keep the map object in cache (bypass Niantic throttling)",
+        type=float,
+        default=5.0
+    )
 
     # Start to parse other attrs
     config = parser.parse_args()
@@ -338,6 +346,11 @@ def init_config():
     config.action_wait_min = load.get('action_wait_min', 1)
     config.raw_tasks = load.get('tasks', [])
     config.vips = load.get('vips',{})
+    config.map_object_cache_time = load.get('map_object_cache_time')
+
+    if config.map_object_cache_time < 0.0:
+        parser.error("--map_object_cache_time is out of range! (should be >= 0.0)")
+        return None
 
     if len(config.raw_tasks) == 0:
         logging.error("No tasks are configured. Did you mean to configure some behaviors? Read https://github.com/PokemonGoF/PokemonGo-Bot/wiki/Configuration-files#configuring-tasks for more information")

pokemongo_bot/__init__.py

@@ -46,6 +46,8 @@ def __init__(self, config):
         self.tick_count = 0
         self.softban = False
         self.start_position = None
+        self.last_map_object = None
+        self.last_time_map_object = 0
 
         # Make our own copy of the workers for this instance
         self.workers = []
@@ -121,13 +123,7 @@ def update_web_location(self, cells=[], lat=None, lng=None, alt=None):
         if cells == []:
             cellid = get_cell_ids(lat, lng)
             timestamp = [0, ] * len(cellid)
-            self.api.get_map_objects(
-                latitude=f2i(lat),
-                longitude=f2i(lng),
-                since_timestamp_ms=timestamp,
-                cell_id=cellid
-            )
-            response_dict = self.api.call()
+            response_dict = self.get_map_objects(lat, lng, timestamp, cellid)
             map_objects = response_dict.get(
                 'responses', {}
             ).get('GET_MAP_OBJECTS', {})
@@ -182,14 +178,7 @@ def update_web_location(self, cells=[], lat=None, lng=None, alt=None):
     def find_close_cells(self, lat, lng):
         cellid = get_cell_ids(lat, lng)
         timestamp = [0, ] * len(cellid)
-
-        self.api.get_map_objects(
-            latitude=f2i(lat),
-            longitude=f2i(lng),
-            since_timestamp_ms=timestamp,
-            cell_id=cellid
-        )
-        response_dict = self.api.call()
+        response_dict = self.get_map_objects(lat, lng, timestamp, cellid)
         map_objects = response_dict.get(
             'responses', {}
         ).get('GET_MAP_OBJECTS', {})
@@ -625,3 +614,19 @@ def get_forts(self, order_by_distance=False):
             ))
 
         return forts
+
+    def get_map_objects(self, lat, lng, timestamp, cellid):
+        if time.time() - self.last_time_map_object < self.config.map_object_cache_time:
+            return self.last_map_object
+
+        self.api.get_map_objects(
+            latitude=f2i(lat),
+            longitude=f2i(lng),
+            since_timestamp_ms=timestamp,
+            cell_id=cellid
+        )
+
+        self.last_map_object = self.api.call()
+        self.last_time_map_object = time.time()
+
+        return self.last_map_object

pokemongo_bot/cell_workers/catch_visible_pokemon.py

@@ -21,15 +21,15 @@ def work(self):
                 with open(user_web_catchable, 'w') as outfile:
                     json.dump(pokemon, outfile)
 
-            return self.catch_pokemon(self.bot.cell['catchable_pokemons'][0])
+            return self.catch_pokemon(self.bot.cell['catchable_pokemons'].pop(0))
 
         if 'wild_pokemons' in self.bot.cell and len(self.bot.cell['wild_pokemons']) > 0:
             # Sort all by distance from current pos- eventually this should
             # build graph & A* it
             self.bot.cell['wild_pokemons'].sort(
                 key=
                 lambda x: distance(self.bot.position[0], self.bot.position[1], x['latitude'], x['longitude']))
-            return self.catch_pokemon(self.bot.cell['wild_pokemons'][0])
+            return self.catch_pokemon(self.bot.cell['wild_pokemons'].pop(0))
 
     def catch_pokemon(self, pokemon):
         worker = PokemonCatchWorker(pokemon, self.bot)