Improve gRPC error handling, improve client UX

src/exceptions.py

@@ -0,0 +1,7 @@
+class Error(Exception):
+    """Base class for other exceptions"""
+    pass
+
+class ExperimentNotFoundError(Error):
+    """Raised when the input value is too small"""
+    pass

src/gRPC/hpo_pb2_grpc.py

@@ -32,7 +32,7 @@ def __init__(self, channel):
                 )
         self.GetExperimentDetails = channel.unary_unary(
                 '/helloworld.HpoService/GetExperimentDetails',
-                request_serializer=hpo__pb2.ExperimentNameParams.SerializeToString,
+                request_serializer=hpo__pb2.ExperimentIdParams.SerializeToString,
                 response_deserializer=hpo__pb2.ExperimentDetails.FromString,
                 )
         self.GetTrialConfig = channel.unary_unary(
@@ -47,7 +47,7 @@ def __init__(self, channel):
                 )
         self.GenerateNextConfig = channel.unary_unary(
                 '/helloworld.HpoService/GenerateNextConfig',
-                request_serializer=hpo__pb2.ExperimentNameParams.SerializeToString,
+                request_serializer=hpo__pb2.ExperimentIdParams.SerializeToString,
                 response_deserializer=hpo__pb2.NewExperimentsReply.FromString,
                 )
 
@@ -118,7 +118,7 @@ def add_HpoServiceServicer_to_server(servicer, server):
             ),
             'GetExperimentDetails': grpc.unary_unary_rpc_method_handler(
                     servicer.GetExperimentDetails,
-                    request_deserializer=hpo__pb2.ExperimentNameParams.FromString,
+                    request_deserializer=hpo__pb2.ExperimentIdParams.FromString,
                     response_serializer=hpo__pb2.ExperimentDetails.SerializeToString,
             ),
             'GetTrialConfig': grpc.unary_unary_rpc_method_handler(
@@ -133,7 +133,7 @@ def add_HpoServiceServicer_to_server(servicer, server):
             ),
             'GenerateNextConfig': grpc.unary_unary_rpc_method_handler(
                     servicer.GenerateNextConfig,
-                    request_deserializer=hpo__pb2.ExperimentNameParams.FromString,
+                    request_deserializer=hpo__pb2.ExperimentIdParams.FromString,
                     response_serializer=hpo__pb2.NewExperimentsReply.SerializeToString,
             ),
     }
@@ -210,7 +210,7 @@ def GetExperimentDetails(request,
             timeout=None,
             metadata=None):
         return grpc.experimental.unary_unary(request, target, '/helloworld.HpoService/GetExperimentDetails',
-            hpo__pb2.ExperimentNameParams.SerializeToString,
+            hpo__pb2.ExperimentIdParams.SerializeToString,
             hpo__pb2.ExperimentDetails.FromString,
             options, channel_credentials,
             insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
@@ -261,7 +261,7 @@ def GenerateNextConfig(request,
             timeout=None,
             metadata=None):
         return grpc.experimental.unary_unary(request, target, '/helloworld.HpoService/GenerateNextConfig',
-            hpo__pb2.ExperimentNameParams.SerializeToString,
+            hpo__pb2.ExperimentIdParams.SerializeToString,
             hpo__pb2.NewExperimentsReply.FromString,
             options, channel_credentials,
             insecure, call_credentials, compression, wait_for_ready, timeout, metadata)

src/gRPC/protos/hpo.proto

@@ -42,10 +42,10 @@ service HpoService {
   rpc NumberExperiments(NumberExperimentsParams) returns (NumberExperimentsReply) {}
   rpc ExperimentsList(ExperimentsListParams) returns (ExperimentsListReply) {}
   rpc NewExperiment(ExperimentDetails) returns (NewExperimentsReply) {}
-  rpc GetExperimentDetails(ExperimentNameParams) returns (ExperimentDetails) {}
+  rpc GetExperimentDetails(ExperimentIdParams) returns (ExperimentDetails) {}
   rpc GetTrialConfig(ExperimentTrial) returns (TrialConfig) {}
   rpc UpdateTrialResult(ExperimentTrialResult) returns (ExperimentTrialReply) {}
-  rpc GenerateNextConfig(ExperimentNameParams) returns (NewExperimentsReply) {}
+  rpc GenerateNextConfig(ExperimentIdParams) returns (NewExperimentsReply) {}
 }
 
 message NumberExperimentsReply {
@@ -66,12 +66,12 @@ message ExperimentsListParams {}
 
 message ExperimentTrialReply{}
 
-message ExperimentNameParams {
-  string experiment_name = 1;
+message ExperimentIdParams {
+  string experiment_id = 1;
 }
 
 message ExperimentTrial {
-  string experiment_name = 1;
+  string experiment_id = 1;
   int32 trial = 2;
 }
 

src/grpc_client.py

@@ -35,30 +35,30 @@ def main():
 def count():
     """Return a count of experiments currently running"""
     empty = hpo_pb2.NumberExperimentsReply()
-    fun = lambda stub : stub.NumberExperiments(empty)
+    fun = lambda stub: stub.NumberExperiments(empty)
     response = run(fun)
     click.echo(" Number of running experiments: {}".format(response.count))
 
 @main.command()
 def list():
     """List names of all experiments currently running"""
     empty = hpo_pb2.NumberExperimentsReply()
-    fun = lambda stub : stub.ExperimentsList(empty)
+    fun = lambda stub: stub.ExperimentsList(empty)
     experiments: hpo_pb2.ExperimentsListReply = run(fun)
     print("Running Experiments:")
     for experiment in experiments.experiment:
         click.echo(" %s" % experiment)
 
+
 @main.command()
 @click.option("--name", prompt=" Experiment name", type=str)
 def show(name):
     """Show details of running experiment"""
     expr: hpo_pb2.ExperimentNameParams = hpo_pb2.ExperimentNameParams()
     expr.experiment_name = name
-    fun = lambda stub : stub.GetExperimentDetails(expr)
+    fun = lambda stub: stub.GetExperimentDetails(expr)
     experiment: hpo_pb2.ExperimentDetails = run(fun)
     json_obj = MessageToJson(experiment)
-    click.echo("Experiment Details:")
     click.echo(json_obj)
 
 @main.command()
@@ -71,7 +71,7 @@ def new(file):
         # data = file.read().replace('\n', '')
         message: hpo_pb2.ExperimentDetails = ParseDict(data, hpo_pb2.ExperimentDetails())
     click.echo(" Adding new experiment: {}".format(message.experiment_name))
-    fun = lambda stub : stub.NewExperiment(message)
+    fun = lambda stub: stub.NewExperiment(message)
     response: hpo_pb2.NewExperimentsReply = run(fun)
     click.echo("Trial Number: {}".format(response.trial_number))
 
@@ -83,10 +83,9 @@ def config(name, trial):
     expr: hpo_pb2.ExperimentTrial = hpo_pb2.ExperimentTrial()
     expr.experiment_name = name
     expr.trial = trial
-    fun = lambda stub : stub.GetTrialConfig(expr)
+    fun = lambda stub: stub.GetTrialConfig(expr)
     trial_config: hpo_pb2.TrialConfig = run(fun)
     json_obj = MessageToJson(trial_config)
-    click.echo("Trial Config:")
     click.echo(json_obj)
 
 @main.command()
@@ -103,9 +102,9 @@ def result(name, trial, result, value_type, value):
     trialResult.result = hpo_pb2._EXPERIMENTTRIALRESULT_RESULT.values_by_name[result].number
     trialResult.value_type = value_type
     trialResult.value = value
-    fun = lambda stub : stub.UpdateTrialResult(trialResult)
+    fun = lambda stub: stub.UpdateTrialResult(trialResult)
     hpo_pb2.TrialConfig = run(fun)
-    click.echo("Updated Trial Result")
+    click.echo("Success: Updated Trial Result")
 
 @main.command()
 @click.option("--name", prompt=" Enter name", type=str)
@@ -123,12 +122,26 @@ def run(func):
     # of the code.
     with grpc.insecure_channel('localhost:50051') as channel:
         stub = hpo_pb2_grpc.HpoServiceStub(channel)
-        return func(stub)
+        try:
+            response = func(stub)
+        except grpc.RpcError as rpc_error:
+            if rpc_error.code() == grpc.StatusCode.CANCELLED:
+                pass
+            elif rpc_error.code() == grpc.StatusCode.UNAVAILABLE:
+                pass
+            elif rpc_error.code() == grpc.StatusCode.NOT_FOUND:
+                raise click.ClickException(rpc_error.details())
+            elif rpc_error.code() == grpc.StatusCode.INVALID_ARGUMENT:
+                raise click.ClickException(rpc_error.details())
+            else:
+                raise click.ClickException("Received unknown RPC error: code={rpc_error.code()} message={rpc_error.details()}")
+        return response
+
 
 def NewExperiment(stub, **args):
     empty = hpo_pb2.NumberExperimentsReply()
     response = stub.NumberExperiments(empty)
-    print("HpoService client received: %s" % response.count)
+    click.echo("HpoService client received: %s" % response.count)
 
 
 if __name__ == "__main__":

src/grpc_service.py

@@ -23,6 +23,7 @@
 from google.protobuf.json_format import MessageToJson
 from bayes_optuna.optuna_hpo import HpoExperiment
 from gRPC.hpo_pb2 import NewExperimentsReply
+from exceptions import ExperimentNotFoundError
 
 
 class HpoService(hpo_pb2_grpc.HpoServiceServicer):
@@ -39,18 +40,23 @@ def ExperimentsList(self, request, context):
         return reply
 
     def GetExperimentDetails(self, request, context):
-        experiment: HpoExperiment = hpo_service.instance.getExperiment(request.experiment_name)
-        reply = hpo_pb2.ExperimentDetails()
-        reply.experiment_name = experiment.experiment_name
-        reply.direction = experiment.direction
-        reply.hpo_algo_impl = experiment.hpo_algo_impl
-        reply.id_ = experiment.id_
-        reply.objective_function = experiment.objective_function
-        # TODO:: expand tunables message
-        # reply.tunables = experiment.tunables
-        reply.started = experiment.started
-        context.set_code(grpc.StatusCode.OK)
-        return reply
+        try:
+            experiment: HpoExperiment = hpo_service.instance.getExperiment(request.experiment_id)
+            reply = hpo_pb2.ExperimentDetails()
+            reply.experiment_name = experiment.experiment_name
+            reply.direction = experiment.direction
+            reply.hpo_algo_impl = experiment.hpo_algo_impl
+            reply.id_ = experiment.id_
+            reply.objective_function = experiment.objective_function
+            # TODO:: expand tunables message
+            # reply.tunables = experiment.tunables
+            reply.started = experiment.started
+            context.set_code(grpc.StatusCode.OK)
+            return reply
+        except ExperimentNotFoundError:
+            context.set_code(grpc.StatusCode.NOT_FOUND)
+            context.set_details('Could not find experiment: %s' % request.experiment_id)
+            return
 
 
     def NewExperiment(self, request, context):
@@ -70,23 +76,28 @@ def NewExperiment(self, request, context):
             context.set_code(grpc.StatusCode.OK)
             return reply
         else:
-            context.set_code(grpc.StatusCode.ABORTED)
+            context.set_code(grpc.StatusCode.INVALID_ARGUMENT)
             context.set_details('Invalid algorithm: %s' % request.hpo_algo_impl)
             return
 
     def GetTrialConfig(self, request, context):
         # if ("experiment_id" in query and "trial_number" in query and hpo_service.instance.containsExperiment(query["experiment_id"][0]) and
         #         query["trial_number"][0] == str(hpo_service.instance.get_trial_number(query["experiment_id"][0]))):
-        data = json.loads(hpo_service.instance.get_trial_json_object(request.experiment_name))
-        trialConfig : hpo_pb2.TrialConfig = hpo_pb2.TrialConfig()
-        for config in data:
-            tunable: hpo_pb2.TunableConfig = hpo_pb2.TunableConfig()
-            tunable.name = config['tunable_name']
-            tunable.value = config['tunable_value']
-            trialConfig.config.extend([tunable])
+        if hpo_service.instance.containsExperiment(request.experiment_id):
+            data = json.loads(hpo_service.instance.get_trial_json_object(request.experiment_id))
+            trialConfig : hpo_pb2.TrialConfig = hpo_pb2.TrialConfig()
+            for config in data:
+                tunable: hpo_pb2.TunableConfig = hpo_pb2.TunableConfig()
+                tunable.name = config['tunable_name']
+                tunable.value = config['tunable_value']
+                trialConfig.config.extend([tunable])
 
-        context.set_code(grpc.StatusCode.OK)
-        return trialConfig
+            context.set_code(grpc.StatusCode.OK)
+            return trialConfig
+        else:
+            context.set_code(grpc.StatusCode.NOT_FOUND)
+            context.set_details('Could not find experiment: %s' % request.experiment_id)
+            return hpo_pb2.TunableConfig()
 
     def UpdateTrialResult(self, request, context):
         if (hpo_service.instance.containsExperiment(request.experiment_id) and
@@ -98,8 +109,9 @@ def UpdateTrialResult(self, request, context):
             context.set_code(grpc.StatusCode.OK)
             return hpo_pb2.ExperimentTrialReply()
         else:
-            context.set_code(grpc.StatusCode.ABORTED)
+            context.set_code(grpc.StatusCode.NOT_FOUND)
             context.set_details('Experiment not found or invalid trial number!')
+            return hpo_pb2.ExperimentTrialReply()
 
     def GenerateNextConfig(self, request, context):
         trial_number = hpo_service.instance.get_trial_number(request.experiment_name)

src/hpo_service.py

@@ -1,6 +1,7 @@
 import threading
 import json
 from bayes_optuna import optuna_hpo
+from exceptions import ExperimentNotFoundError
 
 class HpoService:
     """
@@ -43,8 +44,8 @@ def getExperimentsList(self):
 
     def getExperiment(self, name) -> optuna_hpo.HpoExperiment:
         if self.doesNotContainExperiment(name):
-            print("Experiment does not exist")
-            return
+            print("Experiment " + name + " does not exist")
+            raise ExperimentNotFoundError
 
         return self.experiments.get(name)