Bug 1620998 - C++ reader for .extra files containing crash annotations r=afranchuk

Differential Revision: https://phabricator.services.mozilla.com/D231081

toolkit/crashreporter/ExtraFileParser.cpp

@@ -0,0 +1,97 @@
+/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/* vim: set ts=8 sts=2 et sw=2 tw=80: */
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+#include "ExtraFileParser.h"
+
+#include "CrashAnnotations.h"
+#include "mozilla/Maybe.h"
+
+namespace CrashReporter {
+
+using mozilla::Maybe;
+using mozilla::Nothing;
+using mozilla::Some;
+
+bool ExtraFileParser::startObject() {
+  if (mObject) {
+    return false;  // We expect only one top-level object
+  }
+
+  mObject = true;
+  return true;
+}
+
+bool ExtraFileParser::endObject() {
+  return mObject;  // We should end only one object, anything else is wrong.
+}
+
+bool ExtraFileParser::propertyName(const JS::Latin1Char* aName,
+                                   size_t aLength) {
+  nsDependentCSubstring name(reinterpret_cast<const char*>(aName), aLength);
+  mLastAnnotation = AnnotationFromString(name);
+
+  return mLastAnnotation.isSome();
+}
+
+bool ExtraFileParser::propertyName(const char16_t* aName, size_t aLength) {
+  // We only parse UTF-8 text.
+  return false;
+}
+
+bool ExtraFileParser::startArray() {
+  // The .extra file should not contain arrays.
+  return false;
+}
+
+bool ExtraFileParser::endArray() {
+  // The .extra file should not contain arrays.
+  return false;
+}
+
+bool ExtraFileParser::stringValue(const JS::Latin1Char* aStr, size_t aLength) {
+  nsDependentCSubstring value(reinterpret_cast<const char*>(aStr), aLength);
+  mAnnotations[*mLastAnnotation] = value;
+
+  return true;
+}
+
+bool ExtraFileParser::stringValue(const char16_t* aStr, size_t aLength) {
+  // We only parse UTF-8 text.
+  return false;
+}
+
+bool ExtraFileParser::numberValue(double aVal) {
+  // The .extra file should not contain number values.
+  return false;
+}
+
+bool ExtraFileParser::booleanValue(bool aBoolean) {
+  // The .extra file should not contain number values.
+  return false;
+}
+
+bool ExtraFileParser::nullValue() {
+  // The .extra file should not contain null values.
+  return false;
+}
+void ExtraFileParser::error(const char* aMsg, uint32_t aLine,
+                            uint32_t aColumn) {}
+
+Maybe<AnnotationTable> ExtraFileParser::Parse(const nsACString& aJSON) {
+  ExtraFileParser handler;
+  AnnotationTable annotations;
+
+  if (!JS::ParseJSONWithHandler(
+          reinterpret_cast<const JS::Latin1Char*>(aJSON.BeginReading()),
+          aJSON.Length(), &handler)) {
+    return Nothing();
+  }
+
+  handler.getAnnotations(annotations);
+  return Some(annotations);
+}
+
+}  // namespace CrashReporter

toolkit/crashreporter/ExtraFileParser.h

@@ -0,0 +1,56 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+#ifndef ExtraFileParser_h__
+#define ExtraFileParser_h__
+
+#include "js/JSON.h"  // JS::JSONParseHandler
+
+#include "mozilla/EnumeratedArray.h"
+#include "mozilla/Maybe.h"
+#include "nsString.h"
+
+#include "CrashAnnotations.h"
+
+namespace CrashReporter {
+
+using mozilla::Maybe;
+using AnnotationTable =
+    mozilla::EnumeratedArray<Annotation, nsCString, size_t(Annotation::Count)>;
+
+class ExtraFileParser : public JS::JSONParseHandler {
+ public:
+  ExtraFileParser() : mObject(false) {}
+
+  // JSONParseHandler methods.
+  virtual bool startObject() override;
+  virtual bool endObject() override;
+  virtual bool propertyName(const JS::Latin1Char* aName,
+                            size_t aLength) override;
+  virtual bool propertyName(const char16_t* aName, size_t aLength) override;
+  virtual bool startArray() override;
+  virtual bool endArray() override;
+  virtual bool stringValue(const JS::Latin1Char* aStr, size_t aLength) override;
+  virtual bool stringValue(const char16_t* aStr, size_t aLength) override;
+  virtual bool numberValue(double aVal) override;
+  virtual bool booleanValue(bool aBoolean) override;
+  virtual bool nullValue() override;
+  virtual void error(const char* aMsg, uint32_t aLine,
+                     uint32_t aColumn) override;
+
+  void getAnnotations(AnnotationTable& aAnnotations) {
+    aAnnotations = mAnnotations;
+  }
+
+  static mozilla::Maybe<AnnotationTable> Parse(const nsACString& aJSON);
+
+ private:
+  AnnotationTable mAnnotations;
+  Maybe<Annotation> mLastAnnotation;  // Last annotation seen while parsing
+  bool mObject;  // Set to true after we encounter the first object
+};
+
+}  // namespace CrashReporter
+
+#endif  // ExtraFileParser_h__

toolkit/crashreporter/moz.build

@@ -18,6 +18,7 @@ JAR_MANIFESTS += ["jar.mn"]
 
 UNIFIED_SOURCES = [
     "CrashAnnotations.cpp",
+    "ExtraFileParser.cpp",
     "nsExceptionHandlerUtils.cpp",
 ]
 

toolkit/crashreporter/nsExceptionHandler.cpp

@@ -6,6 +6,7 @@
 
 #include "nsExceptionHandler.h"
 #include "nsExceptionHandlerUtils.h"
+#include "ExtraFileParser.h"
 
 #include "json/json.h"
 #include "nsAppDirectoryServiceDefs.h"