1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372
|
/* Any copyright is dedicated to the Public Domain.
* http://creativecommons.org/publicdomain/zero/1.0/
*/
#include "TelemetryTestHelpers.h"
#include "core/TelemetryCommon.h"
#include "gtest/gtest.h"
#include "js/Array.h" // JS::GetArrayLength, JS::IsArrayObject
#include "js/CallAndConstruct.h" // JS_CallFunctionName
#include "js/PropertyAndElement.h" // JS_Enumerate, JS_GetElement, JS_GetProperty
#include "mozilla/CycleCollectedJSContext.h"
#include "mozilla/gtest/MozAssertions.h"
#include "mozilla/Unused.h"
#include "nsTArray.h"
#include "nsPrintfCString.h"
using namespace mozilla;
// Helper methods provided to simplify writing tests and meant to be used in C++
// Gtests.
namespace TelemetryTestHelpers {
void CheckUintScalar(const char* aName, JSContext* aCx,
JS::Handle<JS::Value> aSnapshot, uint32_t expectedValue) {
// Validate the value of the test scalar.
JS::Rooted<JS::Value> value(aCx);
JS::Rooted<JSObject*> scalarObj(aCx, &aSnapshot.toObject());
ASSERT_TRUE(JS_GetProperty(aCx, scalarObj, aName, &value))
<< "The test scalar must be reported.";
JS_GetProperty(aCx, scalarObj, aName, &value);
ASSERT_TRUE(value.isInt32())
<< "The scalar value must be of the correct type.";
ASSERT_TRUE(value.toInt32() >= 0)
<< "The uint scalar type must contain a value >= 0.";
ASSERT_EQ(static_cast<uint32_t>(value.toInt32()), expectedValue)
<< "The scalar value must match the expected value.";
}
void CheckBoolScalar(const char* aName, JSContext* aCx,
JS::Handle<JS::Value> aSnapshot, bool expectedValue) {
// Validate the value of the test scalar.
JS::Rooted<JS::Value> value(aCx);
JS::Rooted<JSObject*> scalarObj(aCx, &aSnapshot.toObject());
ASSERT_TRUE(JS_GetProperty(aCx, scalarObj, aName, &value))
<< "The test scalar must be reported.";
ASSERT_TRUE(value.isBoolean())
<< "The scalar value must be of the correct type.";
ASSERT_EQ(static_cast<bool>(value.toBoolean()), expectedValue)
<< "The scalar value must match the expected value.";
}
void CheckStringScalar(const char* aName, JSContext* aCx,
JS::Handle<JS::Value> aSnapshot,
const char* expectedValue) {
// Validate the value of the test scalar.
JS::Rooted<JS::Value> value(aCx);
JS::Rooted<JSObject*> scalarObj(aCx, &aSnapshot.toObject());
ASSERT_TRUE(JS_GetProperty(aCx, scalarObj, aName, &value))
<< "The test scalar must be reported.";
ASSERT_TRUE(value.isString())
<< "The scalar value must be of the correct type.";
bool sameString;
ASSERT_TRUE(
JS_StringEqualsAscii(aCx, value.toString(), expectedValue, &sameString))
<< "JS String comparison failed";
ASSERT_TRUE(sameString)
<< "The scalar value must match the expected string";
}
void CheckKeyedUintScalar(const char* aName, const char* aKey, JSContext* aCx,
JS::Handle<JS::Value> aSnapshot,
uint32_t expectedValue) {
JS::Rooted<JS::Value> keyedScalar(aCx);
JS::Rooted<JSObject*> scalarObj(aCx, &aSnapshot.toObject());
// Get the aName keyed scalar object from the scalars snapshot.
ASSERT_TRUE(JS_GetProperty(aCx, scalarObj, aName, &keyedScalar))
<< "The keyed scalar must be reported.";
CheckUintScalar(aKey, aCx, keyedScalar, expectedValue);
}
void CheckKeyedBoolScalar(const char* aName, const char* aKey, JSContext* aCx,
JS::Handle<JS::Value> aSnapshot, bool expectedValue) {
JS::Rooted<JS::Value> keyedScalar(aCx);
JS::Rooted<JSObject*> scalarObj(aCx, &aSnapshot.toObject());
// Get the aName keyed scalar object from the scalars snapshot.
ASSERT_TRUE(JS_GetProperty(aCx, scalarObj, aName, &keyedScalar))
<< "The keyed scalar must be reported.";
CheckBoolScalar(aKey, aCx, keyedScalar, expectedValue);
}
void CheckNumberOfProperties(const char* aName, JSContext* aCx,
JS::Handle<JS::Value> aSnapshot,
uint32_t expectedNumProperties) {
JS::Rooted<JS::Value> keyedScalar(aCx);
JS::Rooted<JSObject*> scalarObj(aCx, &aSnapshot.toObject());
// Get the aName keyed scalar object from the scalars snapshot.
ASSERT_TRUE(JS_GetProperty(aCx, scalarObj, aName, &keyedScalar))
<< "The keyed scalar must be reported.";
JS::Rooted<JSObject*> keyedScalarObj(aCx, &keyedScalar.toObject());
JS::Rooted<JS::IdVector> ids(aCx, JS::IdVector(aCx));
ASSERT_TRUE(JS_Enumerate(aCx, keyedScalarObj, &ids))
<< "We must be able to get keyed scalar members.";
ASSERT_EQ(expectedNumProperties, ids.length())
<< "The scalar must report the expected number of properties.";
}
bool EventPresent(JSContext* aCx, const JS::RootedValue& aSnapshot,
const nsACString& aCategory, const nsACString& aMethod,
const nsACString& aObject) {
EXPECT_FALSE(aSnapshot.isNullOrUndefined())
<< "Event snapshot must not be null/undefined.";
bool isArray = false;
EXPECT_TRUE(JS::IsArrayObject(aCx, aSnapshot, &isArray) && isArray)
<< "The snapshot must be an array.";
JS::Rooted<JSObject*> arrayObj(aCx, &aSnapshot.toObject());
uint32_t arrayLength = 0;
EXPECT_TRUE(JS::GetArrayLength(aCx, arrayObj, &arrayLength))
<< "Array must have a length.";
EXPECT_TRUE(arrayLength > 0) << "Array must have at least one element.";
for (uint32_t arrayIdx = 0; arrayIdx < arrayLength; ++arrayIdx) {
JS::Rooted<JS::Value> element(aCx);
EXPECT_TRUE(JS_GetElement(aCx, arrayObj, arrayIdx, &element))
<< "Must be able to get element.";
EXPECT_TRUE(JS::IsArrayObject(aCx, element, &isArray) && isArray)
<< "Element must be an array.";
JS::Rooted<JSObject*> eventArray(aCx, &element.toObject());
uint32_t eventLength;
EXPECT_TRUE(JS::GetArrayLength(aCx, eventArray, &eventLength))
<< "Event array must have a length.";
EXPECT_TRUE(eventLength >= 4)
<< "Event array must have at least 4 elements (timestamp, category, "
"method, object).";
JS::Rooted<JS::Value> str(aCx);
nsAutoJSString jsStr;
EXPECT_TRUE(JS_GetElement(aCx, eventArray, 1, &str))
<< "Must be able to get category.";
EXPECT_TRUE(str.isString()) << "Category must be a string.";
EXPECT_TRUE(jsStr.init(aCx, str))
<< "Category must be able to be init'd to a jsstring.";
if (NS_ConvertUTF16toUTF8(jsStr) != aCategory) {
continue;
}
EXPECT_TRUE(JS_GetElement(aCx, eventArray, 2, &str))
<< "Must be able to get method.";
EXPECT_TRUE(str.isString()) << "Method must be a string.";
EXPECT_TRUE(jsStr.init(aCx, str))
<< "Method must be able to be init'd to a jsstring.";
if (NS_ConvertUTF16toUTF8(jsStr) != aMethod) {
continue;
}
EXPECT_TRUE(JS_GetElement(aCx, eventArray, 3, &str))
<< "Must be able to get object.";
EXPECT_TRUE(str.isString()) << "Object must be a string.";
EXPECT_TRUE(jsStr.init(aCx, str))
<< "Object must be able to be init'd to a jsstring.";
if (NS_ConvertUTF16toUTF8(jsStr) != aObject) {
continue;
}
// We found it!
return true;
}
// We didn't find it!
return false;
}
nsTArray<nsString> EventValuesToArray(JSContext* aCx,
const JS::RootedValue& aSnapshot,
const nsAString& aCategory,
const nsAString& aMethod,
const nsAString& aObject) {
constexpr int kIndexOfCategory = 1;
constexpr int kIndexOfMethod = 2;
constexpr int kIndexOfObject = 3;
constexpr int kIndexOfValueString = 4;
nsTArray<nsString> valueArray;
if (aSnapshot.isNullOrUndefined()) {
return valueArray;
}
bool isArray = false;
EXPECT_TRUE(JS::IsArrayObject(aCx, aSnapshot, &isArray) && isArray)
<< "The snapshot must be an array.";
JS::Rooted<JSObject*> arrayObj(aCx, &aSnapshot.toObject());
uint32_t arrayLength = 0;
EXPECT_TRUE(JS::GetArrayLength(aCx, arrayObj, &arrayLength))
<< "Array must have a length.";
JS::Rooted<JS::Value> jsVal(aCx);
nsAutoJSString jsStr;
for (uint32_t arrayIdx = 0; arrayIdx < arrayLength; ++arrayIdx) {
JS::Rooted<JS::Value> element(aCx);
EXPECT_TRUE(JS_GetElement(aCx, arrayObj, arrayIdx, &element))
<< "Must be able to get element.";
EXPECT_TRUE(JS::IsArrayObject(aCx, element, &isArray) && isArray)
<< "Element must be an array.";
JS::Rooted<JSObject*> eventArray(aCx, &element.toObject());
uint32_t eventLength;
EXPECT_TRUE(JS::GetArrayLength(aCx, eventArray, &eventLength))
<< "Event array must have a length.";
EXPECT_TRUE(eventLength >= kIndexOfValueString)
<< "Event array must have at least 4 elements (timestamp, category, "
"method, object).";
EXPECT_TRUE(JS_GetElement(aCx, eventArray, kIndexOfCategory, &jsVal))
<< "Must be able to get category.";
EXPECT_TRUE(jsVal.isString()) << "Category must be a string.";
EXPECT_TRUE(jsStr.init(aCx, jsVal))
<< "Category must be able to be init'd to a jsstring.";
if (jsStr != aCategory) {
continue;
}
EXPECT_TRUE(JS_GetElement(aCx, eventArray, kIndexOfMethod, &jsVal))
<< "Must be able to get method.";
EXPECT_TRUE(jsVal.isString()) << "Method must be a string.";
EXPECT_TRUE(jsStr.init(aCx, jsVal))
<< "Method must be able to be init'd to a jsstring.";
if (jsStr != aMethod) {
continue;
}
EXPECT_TRUE(JS_GetElement(aCx, eventArray, kIndexOfObject, &jsVal))
<< "Must be able to get object.";
EXPECT_TRUE(jsVal.isString()) << "Object must be a string.";
EXPECT_TRUE(jsStr.init(aCx, jsVal))
<< "Object must be able to be init'd to a jsstring.";
if (jsStr != aObject) {
continue;
}
if (!JS_GetElement(aCx, eventArray, kIndexOfValueString, &jsVal)) {
continue;
}
nsString str;
EXPECT_TRUE(AssignJSString(aCx, str, jsVal.toString()))
<< "Value must be able to be init'd to a string.";
Unused << valueArray.EmplaceBack(std::move(str));
}
return valueArray;
}
void GetEventSnapshot(JSContext* aCx, JS::MutableHandle<JS::Value> aResult,
ProcessID aProcessType) {
nsCOMPtr<nsITelemetry> telemetry =
do_GetService("@mozilla.org/base/telemetry;1");
JS::Rooted<JS::Value> eventSnapshot(aCx);
nsresult rv;
rv = telemetry->SnapshotEvents(1 /* PRERELEASE_CHANNELS */, false /* clear */,
0 /* eventLimit */, aCx, 1 /* argc */,
&eventSnapshot);
ASSERT_EQ(rv, NS_OK) << "Snapshotting events must not fail.";
ASSERT_TRUE(eventSnapshot.isObject())
<< "The snapshot must be an object.";
JS::Rooted<JS::Value> processEvents(aCx);
JS::Rooted<JSObject*> eventObj(aCx, &eventSnapshot.toObject());
Unused << JS_GetProperty(aCx, eventObj,
Telemetry::Common::GetNameForProcessID(aProcessType),
&processEvents);
aResult.set(processEvents);
}
void GetScalarsSnapshot(bool aKeyed, JSContext* aCx,
JS::MutableHandle<JS::Value> aResult,
ProcessID aProcessType) {
nsCOMPtr<nsITelemetry> telemetry =
do_GetService("@mozilla.org/base/telemetry;1");
// Get a snapshot of the scalars.
JS::Rooted<JS::Value> scalarsSnapshot(aCx);
nsresult rv;
if (aKeyed) {
rv = telemetry->GetSnapshotForKeyedScalars(
"main"_ns, false, false /* filter */, aCx, &scalarsSnapshot);
} else {
rv = telemetry->GetSnapshotForScalars("main"_ns, false, false /* filter */,
aCx, &scalarsSnapshot);
}
// Validate the snapshot.
ASSERT_EQ(rv, NS_OK) << "Creating a snapshot of the data must not fail.";
ASSERT_TRUE(scalarsSnapshot.isObject())
<< "The snapshot must be an object.";
JS::Rooted<JS::Value> processScalars(aCx);
JS::Rooted<JSObject*> scalarObj(aCx, &scalarsSnapshot.toObject());
// Don't complain if no scalars for the process can be found. Just
// return an empty object.
Unused << JS_GetProperty(aCx, scalarObj,
Telemetry::Common::GetNameForProcessID(aProcessType),
&processScalars);
aResult.set(processScalars);
}
void GetAndClearHistogram(JSContext* cx, nsCOMPtr<nsITelemetry> mTelemetry,
const nsACString& name, bool is_keyed) {
JS::Rooted<JS::Value> testHistogram(cx);
nsresult rv =
is_keyed ? mTelemetry->GetKeyedHistogramById(name, cx, &testHistogram)
: mTelemetry->GetHistogramById(name, cx, &testHistogram);
ASSERT_EQ(rv, NS_OK) << "Cannot fetch histogram";
// Clear the stored value
JS::Rooted<JSObject*> testHistogramObj(cx, &testHistogram.toObject());
JS::Rooted<JS::Value> rval(cx);
ASSERT_TRUE(JS_CallFunctionName(cx, testHistogramObj, "clear",
JS::HandleValueArray::empty(), &rval))
<< "Cannot clear histogram";
}
void GetProperty(JSContext* cx, const char* name, JS::Handle<JS::Value> valueIn,
JS::MutableHandle<JS::Value> valueOut) {
JS::Rooted<JS::Value> property(cx);
JS::Rooted<JSObject*> valueInObj(cx, &valueIn.toObject());
ASSERT_TRUE(JS_GetProperty(cx, valueInObj, name, &property))
<< "Cannot get property '" << name << "'";
valueOut.set(property);
}
void GetElement(JSContext* cx, uint32_t index, JS::Handle<JS::Value> valueIn,
JS::MutableHandle<JS::Value> valueOut) {
JS::Rooted<JS::Value> element(cx);
JS::Rooted<JSObject*> valueInObj(cx, &valueIn.toObject());
ASSERT_TRUE(JS_GetElement(cx, valueInObj, index, &element))
<< "Cannot get element at index '" << index << "'";
valueOut.set(element);
}
void GetSnapshots(JSContext* cx, nsCOMPtr<nsITelemetry> mTelemetry,
const char* name, JS::MutableHandle<JS::Value> valueOut,
bool is_keyed) {
JS::Rooted<JS::Value> snapshots(cx);
nsresult rv = is_keyed
? mTelemetry->GetSnapshotForKeyedHistograms(
"main"_ns, false, false /* filter */, cx, &snapshots)
: mTelemetry->GetSnapshotForHistograms(
"main"_ns, false, false /* filter */, cx, &snapshots);
JS::Rooted<JS::Value> snapshot(cx);
GetProperty(cx, "parent", snapshots, &snapshot);
ASSERT_EQ(rv, NS_OK) << "Cannot call histogram snapshots";
valueOut.set(snapshot);
}
} // namespace TelemetryTestHelpers
|