Adding 'ErrorMessage' for handling error messages that can be user facing.

Author: ashgti

lldb/tools/lldb-dap/Protocol.cpp

@@ -96,7 +96,7 @@ bool fromJSON(json::Value const &Params, Request &R, json::Path P) {
 
 json::Value toJSON(const Response &R) {
   json::Object Result{{"type", "response"},
-                      {"req", 0},
+                      {"seq", 0},
                       {"command", R.command},
                       {"request_seq", R.request_seq},
                       {"success", R.success}};
@@ -145,6 +145,36 @@ bool fromJSON(json::Value const &Params, Response &R, json::Path P) {
          mapRaw(Params, "body", R.rawBody, P);
 }
 
+json::Value toJSON(const ErrorMessage &EM) {
+  json::Object Result{{"id", EM.id}, {"format", EM.format}};
+
+  if (EM.variables) {
+    json::Object variables;
+    for (auto &var : *EM.variables)
+      variables[var.first] = var.second;
+    Result.insert({"variables", std::move(variables)});
+  }
+  if (EM.sendTelemetry && *EM.sendTelemetry)
+    Result.insert({"sendTelemetry", *EM.sendTelemetry});
+  if (EM.showUser && *EM.showUser)
+    Result.insert({"showUser", *EM.showUser});
+  if (EM.url)
+    Result.insert({"url", EM.url});
+  if (EM.urlLabel)
+    Result.insert({"urlLabel", EM.urlLabel});
+
+  return std::move(Result);
+}
+
+bool fromJSON(json::Value const &Params, ErrorMessage &EM, json::Path P) {
+  json::ObjectMapper O(Params, P);
+  return O && O.map("id", EM.id) && O.map("format", EM.format) &&
+         O.map("variables", EM.variables) &&
+         O.map("sendTelemetry", EM.sendTelemetry) &&
+         O.map("showUser", EM.showUser) && O.map("url", EM.url) &&
+         O.map("urlLabel", EM.urlLabel);
+}
+
 json::Value toJSON(const Event &E) {
   json::Object Result{
       {"type", "event"},
@@ -155,9 +185,6 @@ json::Value toJSON(const Event &E) {
   if (E.rawBody)
     Result.insert({"body", E.rawBody});
 
-  if (E.statistics)
-    Result.insert({"statistics", E.statistics});
-
   return std::move(Result);
 }
 
@@ -186,8 +213,7 @@ bool fromJSON(json::Value const &Params, Event &E, json::Path P) {
     return false;
   }
 
-  return mapRaw(Params, "body", E.rawBody, P) &&
-         mapRaw(Params, "statistics", E.statistics, P);
+  return mapRaw(Params, "body", E.rawBody, P);
 }
 
 bool fromJSON(const json::Value &Params, Message &PM, json::Path P) {

lldb/tools/lldb-dap/Protocol.h

@@ -21,7 +21,6 @@
 #define LLDB_TOOLS_LLDB_DAP_PROTOCOL_H
 
 #include "llvm/Support/JSON.h"
-#include <cstddef>
 #include <cstdint>
 #include <optional>
 #include <string>
@@ -85,9 +84,6 @@ bool fromJSON(const llvm::json::Value &, Request &, llvm::json::Path);
 struct Event {
   std::string event;
   std::optional<llvm::json::Value> rawBody;
-
-  /// lldb-dap specific extension on the 'terminated' event specifically.
-  std::optional<llvm::json::Value> statistics;
 };
 llvm::json::Value toJSON(const Event &);
 bool fromJSON(const llvm::json::Value &, Event &, llvm::json::Path);
@@ -122,9 +118,9 @@ bool fromJSON(const llvm::json::Value &, Event &, llvm::json::Path);
 //               " "is not shown in the UI.\nSome predefined values exist.",
 //           "_enum" : [ "cancelled", "notStopped" ],
 //           "enumDescriptions" : [
-//             "the request was cancelled.", "the request may be retried once
-//             the "
-//                                           "adapter is in a 'stopped' state."
+//             "the request was cancelled.",
+//             "the request may be retried once the adapter is in a 'stopped'
+//             state."
 //           ]
 //         },
 //         "body" : {
@@ -142,14 +138,75 @@ bool fromJSON(const llvm::json::Value &, Event &, llvm::json::Path);
 // }
 struct Response {
   int64_t request_seq;
-  bool success;
   std::string command;
+  bool success;
   std::optional<std::string> message;
   std::optional<llvm::json::Value> rawBody;
 };
 bool fromJSON(const llvm::json::Value &, Response &, llvm::json::Path);
 llvm::json::Value toJSON(const Response &);
 
+// "Message": {
+//   "type": "object",
+//   "description": "A structured message object. Used to return errors from
+//   requests.", "properties": {
+//     "id": {
+//       "type": "integer",
+//       "description": "Unique (within a debug adapter implementation)
+//       identifier for the message. The purpose of these error IDs is to help
+//       extension authors that have the 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."
+//     },
+//     "format": {
+//       "type": "string",
+//       "description": "A format string for the message. Embedded variables
+//       have the form `{name}`.\nIf variable name starts with an underscore
+//       character, the variable does not contain user data (PII) and can be
+//       safely used for telemetry purposes."
+//     },
+//     "variables": {
+//       "type": "object",
+//       "description": "An object used as a dictionary for looking up the
+//       variables in the format string.", "additionalProperties": {
+//         "type": "string",
+//         "description": "All dictionary values must be strings."
+//       }
+//     },
+//     "sendTelemetry": {
+//       "type": "boolean",
+//       "description": "If true send to telemetry."
+//     },
+//     "showUser": {
+//       "type": "boolean",
+//       "description": "If true show user."
+//     },
+//     "url": {
+//       "type": "string",
+//       "description": "A url where additional information about this message
+//       can be found."
+//     },
+//     "urlLabel": {
+//       "type": "string",
+//       "description": "A label that is presented to the user as the UI for
+//       opening the url."
+//     }
+//   },
+//   "required": [ "id", "format" ]
+// },
+struct ErrorMessage {
+  uint64_t id;
+  std::string format;
+  std::optional<std::map<std::string, std::string>> variables;
+  std::optional<bool> sendTelemetry;
+  std::optional<bool> showUser;
+  std::optional<std::string> url;
+  std::optional<std::string> urlLabel;
+};
+bool fromJSON(const llvm::json::Value &, ErrorMessage &, llvm::json::Path);
+llvm::json::Value toJSON(const ErrorMessage &);
+
 // "ProtocolMessage": {
 //   "type": "object",
 //   "title": "Base Protocol",