Addresses #220 - Implements a version match check between the client and the service

flatland/evaluators/client.py

@@ -10,6 +10,7 @@ import msgpack_numpy as m
 import numpy as np
 import redis
 
+import flatland
 from flatland.envs.observations import TreeObsForRailEnv
 from flatland.envs.predictions import ShortestPathPredictorForRailEnv
 from flatland.envs.rail_env import RailEnv
@@ -146,11 +147,13 @@ class FlatlandRemoteClient(object):
         """
         _request = {}
         _request['type'] = messages.FLATLAND_RL.PING
-        _request['payload'] = {}
+        _request['payload'] = {
+            "version" : flatland.__version__
+        }
         _response = self._blocking_request(_request)
         if _response['type'] != messages.FLATLAND_RL.PONG:
             raise Exception(
-                "Unable to perform handshake with the redis service. \
+                "Unable to perform handshake with the evaluation service. \
                 Expected PONG; received {}".format(json.dumps(_response)))
         else:
             return True

flatland/evaluators/service.py

@@ -8,6 +8,7 @@ import shutil
 import time
 import traceback
 
+import flatland
 import crowdai_api
 import msgpack
 import msgpack_numpy as m
@@ -283,10 +284,26 @@ class FlatlandRemoteEvaluationService:
         """
         Handles PING command from the client.
         """
+        service_version = flatland.__version__
+        if "version" in command["payload"].keys():
+            client_version = command["payload"]["version"]
+        else:
+            # 2.1.4 -> when the version mismatch check was added
+            client_version = "2.1.4"
+
         _command_response = {}
         _command_response['type'] = messages.FLATLAND_RL.PONG
         _command_response['payload'] = {}
 
+        if client_version != service_version:
+            _command_response['type'] = messages.FLATLAND_RL.ERROR
+            _command_response['payload']['message'] = \
+                "Client-Server Version Mismatch => " + \
+                "[ Client Version : {} ] ".format(client_version) + \
+                "[ Server Version : {} ] ".format(service_version)
+            self.send_response(_command_response, command)
+            raise Exception(_command_response['payload']['message'])
+        
         self.send_response(_command_response, command)
 
     def handle_env_create(self, command):