Adjusting 'showUser' to default to true for a DAPError and adding a missing ErrorResponseBody.

ashgti · ashgti · commit b437151b9dd5 · 2025-03-20T12:15:30.000-07:00
diff --git a/lldb/tools/lldb-dap/Handler/RequestHandler.h b/lldb/tools/lldb-dap/Handler/RequestHandler.h
@@ -121,31 +121,37 @@ class RequestHandler : public BaseRequestHandler {
       llvm::raw_string_ostream OS(parse_failure);
       root.printErrorContext(request.arguments, OS);
 
-      protocol::ErrorMessage error;
-      error.format = parse_failure;
+      protocol::ErrorMessage error_message;
+      error_message.format = parse_failure;
+
+      protocol::ErrorResponseBody body;
+      body.error = error_message;
 
       response.success = false;
-      response.body = std::move(error);
+      response.body = std::move(body);
 
       dap.Send(response);
       return;
     }
 
     llvm::Expected<Body> body = Run(arguments);
     if (auto Err = body.takeError()) {
-      protocol::ErrorMessage error;
+      protocol::ErrorMessage error_message;
+      error_message.sendTelemetry = false;
       if (llvm::Error unhandled = llvm::handleErrors(
               std::move(Err), [&](const DAPError &E) -> llvm::Error {
-                error.format = E.getMessage();
-                error.showUser = E.getShowUser();
-                error.id = E.convertToErrorCode().value();
+                error_message.format = E.getMessage();
+                error_message.showUser = E.getShowUser();
+                error_message.id = E.convertToErrorCode().value();
                 // TODO: We could add url/urlLabel to the error message for more
                 // information for users.
                 return llvm::Error::success();
               }))
-        error.format = llvm::toString(std::move(unhandled));
+        error_message.format = llvm::toString(std::move(unhandled));
+      protocol::ErrorResponseBody body;
+      body.error = error_message;
       response.success = false;
-      response.body = std::move(error);
+      response.body = std::move(body);
     } else {
       response.success = true;
       if constexpr (!std::is_same_v<Body, std::monostate>)
diff --git a/lldb/tools/lldb-dap/Protocol/ProtocolBase.cpp b/lldb/tools/lldb-dap/Protocol/ProtocolBase.cpp
@@ -286,4 +286,13 @@ json::Value toJSON(const Message &M) {
   return std::visit([](auto &M) { return toJSON(M); }, M);
 }
 
+json::Value toJSON(const ErrorResponseBody &E) {
+  json::Object result{};
+
+  if (E.error)
+    result.insert({"error", *E.error});
+
+  return result;
+}
+
 } // namespace lldb_dap::protocol
diff --git a/lldb/tools/lldb-dap/Protocol/ProtocolBase.h b/lldb/tools/lldb-dap/Protocol/ProtocolBase.h
@@ -109,7 +109,7 @@ struct ErrorMessage {
   /// requirement that every user visible error message needs a corresponding
   /// error number, so that users or customer support can find information about
   /// the specific error more easily.
-  uint64_t id;
+  uint64_t id = 0;
 
   /// A format string for the message. Embedded variables have the form
   /// `{name}`. If variable name starts with an underscore character, the
@@ -122,10 +122,10 @@ struct ErrorMessage {
   std::optional<std::map<std::string, std::string>> variables;
 
   /// If true send to telemetry.
-  bool sendTelemetry;
+  bool sendTelemetry = false;
 
   /// If true show user.
-  bool showUser;
+  bool showUser = false;
 
   /// A url where additional information about this message can be found.
   std::optional<std::string> url;
@@ -141,6 +141,13 @@ using Message = std::variant<Request, Response, Event>;
 bool fromJSON(const llvm::json::Value &, Message &, llvm::json::Path);
 llvm::json::Value toJSON(const Message &);
 
+/// On error (whenever `success` is false), the body can provide more details.
+struct ErrorResponseBody {
+  /// A structured error message.
+  std::optional<ErrorMessage> error;
+};
+llvm::json::Value toJSON(const ErrorResponseBody &);
+
 /// This is just an acknowledgement, so no body field is required.
 using VoidResponse = std::monostate;
 
