Fixed bugs.

Author: Adrien4193

Diff for: Dockerfile

@@ -74,4 +74,3 @@ ENV PATH ${DIST_PATH}/bin:$PATH
 # Default entrypoint and exposed port
 EXPOSE 5000
 ENTRYPOINT ["braynsService"]
-CMD ["--uri", "0.0.0.0:5000"]

Diff for: src/brayns/core/Launcher.cpp

@@ -32,11 +32,39 @@ namespace
 {
 using namespace brayns;
 
+WebSocketServerSettings extractServerSettings(const ServiceSettings &settings)
+{
+    auto ssl = std::optional<SslSettings>();
+
+    if (settings.ssl)
+    {
+        ssl = SslSettings{
+            .privateKeyFile = settings.privateKeyFile,
+            .certificateFile = settings.certificateFile,
+            .caLocation = settings.caLocation,
+            .privateKeyPassphrase = settings.privateKeyPassphrase,
+        };
+    }
+
+    return {
+        .host = settings.host,
+        .port = settings.port,
+        .maxThreadCount = settings.maxThreadCount,
+        .maxQueueSize = settings.maxQueueSize,
+        .maxFrameSize = settings.maxFrameSize,
+        .ssl = std::move(ssl),
+    };
+}
+
 void startServerAndRunService(const ServiceSettings &settings, Logger &logger)
 {
     auto level = getEnumValue<LogLevel>(settings.logLevel);
     logger.setLevel(level);
 
+    logger.info("{}", getCopyright());
+
+    logger.debug("Service options:{}", stringifyArgvSettings(settings));
+
     auto token = StopToken();
 
     logger.info("Building JSON-RPC API");
@@ -56,33 +84,12 @@ void startServerAndRunService(const ServiceSettings &settings, Logger &logger)
 
     logger.info("Starting websocket server on {}:{}", settings.host, settings.port);
 
-    auto ssl = std::optional<SslSettings>();
-
-    if (settings.ssl)
-    {
-        ssl = SslSettings{
-            .privateKeyFile = settings.privateKeyFile,
-            .certificateFile = settings.certificateFile,
-            .caLocation = settings.caLocation,
-            .privateKeyPassphrase = settings.privateKeyPassphrase,
-        };
-    }
-
-    auto serverSettings = WebSocketServerSettings{
-        .host = settings.host,
-        .port = settings.port,
-        .maxThreadCount = settings.maxThreadCount,
-        .maxQueueSize = settings.maxQueueSize,
-        .maxFrameSize = settings.maxFrameSize,
-        .ssl = std::move(ssl),
-    };
-
+    auto serverSettings = extractServerSettings(settings);
     auto server = startServer(serverSettings, logger);
 
     logger.info("Websocket server started");
 
     logger.info("Service running");
-
     runService(server, api, token, logger);
 }
 }
@@ -109,10 +116,6 @@ int runServiceFromArgv(int argc, const char **argv)
             return 0;
         }
 
-        logger.info("{}", getCopyright());
-
-        logger.debug("Service options:{}", stringifyArgvSettings(settings));
-
         startServerAndRunService(settings, logger);
 
         return 0;

Diff for: src/brayns/core/api/Endpoint.h

@@ -46,11 +46,18 @@ struct JsonObjectReflector<EndpointSchema>
     static auto reflect()
     {
         auto builder = JsonBuilder<EndpointSchema>();
-        builder.field("method", [](auto &object) { return &object.method; }).description("Endpoint method");
-        builder.field("description", [](auto &object) { return &object.method; }).description("Endpoint description");
-        builder.field("params", [](auto &object) { return &object.params; }).description("Endpoint params JSON schema");
-        builder.field("result", [](auto &object) { return &object.result; }).description("Endpoint result JSON schema");
-        builder.field("async", [](auto &object) { return &object.async; }).description("Wether the endpoint is async");
+        builder.field("method", [](auto &object) { return &object.method; })
+            .description("JSON-RPC method that has to be specified to reach the endpoint");
+        builder.field("description", [](auto &object) { return &object.description; })
+            .description("Short description of what the method does");
+        builder.field("params", [](auto &object) { return &object.params; })
+            .description("JSON schema of the method params");
+        builder.field("result", [](auto &object) { return &object.result; })
+            .description("JSON schema of the method result");
+        builder.field("async", [](auto &object) { return &object.async; })
+            .description(
+                "If true, the endpoint does not return its result directly but instead an object {\"task_id\": ID}. "
+                "This ID can be used to get the method result, cancel it or get its progress");
         return builder.build();
     }
 };

Diff for: src/brayns/core/endpoints/CoreEndpoints.cpp

@@ -138,7 +138,7 @@ void addCoreEndpoints(ApiBuilder &builder, Api &api, StopToken &token)
     builder.endpoint("get-methods", [&](NullJson) { return MethodsResult{api.getMethods()}; })
         .description("Get available JSON-RPC methods");
     builder.endpoint("get-schema", [&](SchemaParams params) { return api.getSchema(params.method); })
-        .description("Get the schema of the given JSON-RCP method");
+        .description("Get the schema of the given JSON-RPC method");
 
     builder.endpoint("get-tasks", [&](NullJson) { return TasksResult{api.getTasks()}; })
         .description("Get tasks that are currently running");

Diff for: src/brayns/core/service/Service.cpp

@@ -29,6 +29,12 @@ namespace
 {
 using namespace brayns;
 
+struct ResponseData
+{
+    std::string data;
+    bool binary = false;
+};
+
 JsonRpcRequest parseRequest(const RawRequest &request)
 {
     if (request.binary)
@@ -39,7 +45,7 @@ JsonRpcRequest parseRequest(const RawRequest &request)
     return parseJsonRpcRequest(request.data);
 }
 
-RawResponse composeResponse(const JsonRpcId &id, RawResult result)
+ResponseData composeResponse(const JsonRpcId &id, RawResult result)
 {
     if (result.binary.empty())
     {
@@ -80,14 +86,20 @@ std::optional<JsonRpcRequest> tryParseRequest(const RawRequest &request, Logger
     return std::nullopt;
 }
 
-RawResponse executeRequest(JsonRpcRequest request, Api &api, Logger &logger)
+ResponseData executeRequest(JsonRpcRequest request, Api &api, Logger &logger)
 {
     auto params = RawParams{std::move(request.params), std::move(request.binary)};
 
     logger.info("Calling endpoint for request {}", request.id);
     auto result = api.execute(request.method, std::move(params));
     logger.info("Successfully called endpoint");
 
+    if (std::holds_alternative<NullJson>(request.id))
+    {
+        logger.info("No ID in request, skipping response");
+        return {};
+    }
+
     logger.info("Composing response");
     auto response = composeResponse(request.id, std::move(result));
     logger.info("Successfully composed response");
@@ -99,8 +111,12 @@ void tryExecuteRequest(JsonRpcRequest request, const ResponseHandler &respond, A
 {
     try
     {
-        auto response = executeRequest(std::move(request), api, logger);
-        respond(response);
+        auto [data, binary] = executeRequest(std::move(request), api, logger);
+
+        if (!data.empty())
+        {
+            respond({data, binary});
+        }
     }
     catch (const JsonRpcException &e)
     {