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
|
/* -*- 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 "mozilla/glean/bindings/jog/JOG.h"
#include <locale>
#include "mozilla/ClearOnShutdown.h"
#include "mozilla/DataMutex.h"
#include "mozilla/glean/bindings/jog/jog_ffi_generated.h"
#include "mozilla/Omnijar.h"
#include "mozilla/Tuple.h"
#include "nsDirectoryServiceDefs.h"
#include "nsDirectoryServiceUtils.h"
#include "nsThreadUtils.h"
#include "nsTHashMap.h"
#include "nsTHashSet.h"
namespace mozilla::glean {
// Storage
// Thread Safety: Only used on the main thread.
StaticAutoPtr<nsTHashSet<nsCString>> gCategories;
StaticAutoPtr<nsTHashMap<nsCString, uint32_t>> gMetrics;
StaticAutoPtr<nsTHashMap<nsCString, uint32_t>> gPings;
// static
bool JOG::HasCategory(const nsACString& aCategoryName) {
MOZ_ASSERT(NS_IsMainThread());
return gCategories && gCategories->Contains(aCategoryName);
}
static Maybe<bool> sFoundAndLoadedJogfile;
// static
bool JOG::EnsureRuntimeMetricsRegistered(bool aForce) {
MOZ_ASSERT(NS_IsMainThread());
#ifdef MOZILLA_OFFICIAL
// In the event we're an official build we want there to be no chance we might
// accidentally perform I/O on the main thread.
return false;
#endif
if (sFoundAndLoadedJogfile) {
return sFoundAndLoadedJogfile.value();
}
sFoundAndLoadedJogfile.emplace(false);
if (!mozilla::IsDevelopmentBuild()) {
// Supporting Artifact Builds is a developer-only thing.
// We're on the main thread here.
// Let's not spend any more time than we need to.
return false;
}
// The metrics we need to process were placed in GreD in jogfile.json
// That file was generated by
// toolkit/components/glean/build_scripts/glean_parser_ext/jog.py
nsCOMPtr<nsIFile> jogfile;
if (NS_WARN_IF(NS_FAILED(
NS_GetSpecialDirectory(NS_GRE_DIR, getter_AddRefs(jogfile))))) {
return false;
}
if (NS_WARN_IF(NS_FAILED(jogfile->Append(u"jogfile.json"_ns)))) {
return false;
}
bool jogfileExists = false;
if (NS_WARN_IF(NS_FAILED(jogfile->Exists(&jogfileExists))) ||
!jogfileExists) {
return false;
}
// We _could_ register everything here in C++ land,
// but let's use Rust because (among other reasons) it's more fun.
nsAutoString jogfileString;
if (NS_WARN_IF(NS_FAILED(jogfile->GetPath(jogfileString)))) {
return false;
}
sFoundAndLoadedJogfile.emplace(jog::jog_load_jogfile(&jogfileString));
return sFoundAndLoadedJogfile.value();
}
// static
bool JOG::AreRuntimeMetricsComprehensive() {
MOZ_ASSERT(NS_IsMainThread());
return sFoundAndLoadedJogfile && sFoundAndLoadedJogfile.value();
}
// static
void JOG::GetCategoryNames(nsTArray<nsString>& aNames) {
MOZ_ASSERT(NS_IsMainThread());
if (!gCategories) {
return;
}
for (const auto& category : *gCategories) {
aNames.EmplaceBack(NS_ConvertUTF8toUTF16(category));
}
}
// static
Maybe<uint32_t> JOG::GetMetric(const nsACString& aMetricName) {
MOZ_ASSERT(NS_IsMainThread());
return !gMetrics ? Nothing() : gMetrics->MaybeGet(aMetricName);
}
// static
Maybe<uint32_t> JOG::GetPing(const nsACString& aPingName) {
MOZ_ASSERT(NS_IsMainThread());
return !gPings ? Nothing() : gPings->MaybeGet(aPingName);
}
} // namespace mozilla::glean
// static
nsCString dottedSnakeToCamel(const nsACString& aSnake) {
nsCString camel;
bool first = true;
for (const nsACString& segment : aSnake.Split('_')) {
for (const nsACString& part : segment.Split('.')) {
if (first) {
first = false;
camel.Append(part);
} else if (part.Length()) {
char lower = part.CharAt(0);
if ('a' <= lower && lower <= 'z') {
camel.Append(
std::toupper(lower, std::locale())); // append the Capital.
camel.Append(part.BeginReading() + 1,
part.Length() - 1); // append the rest.
} else {
// Not gonna try to capitalize anything outside a->z.
camel.Append(part);
}
}
}
}
return camel;
}
// static
nsCString kebabToCamel(const nsACString& aKebab) {
nsCString camel;
bool first = true;
for (const nsACString& segment : aKebab.Split('-')) {
if (first) {
first = false;
camel.Append(segment);
} else if (segment.Length()) {
char lower = segment.CharAt(0);
if ('a' <= lower && lower <= 'z') {
camel.Append(
std::toupper(lower, std::locale())); // append the Capital.
camel.Append(segment.BeginReading() + 1,
segment.Length() - 1); // append the rest.
} else {
// Not gonna try to capitalize anything outside a->z.
camel.Append(segment);
}
}
}
return camel;
}
using mozilla::AppShutdown;
using mozilla::ShutdownPhase;
using mozilla::glean::gCategories;
using mozilla::glean::gMetrics;
using mozilla::glean::gPings;
extern "C" NS_EXPORT void JOG_RegisterMetric(const nsACString& aCategory,
const nsACString& aName,
uint32_t aMetric) {
MOZ_ASSERT(NS_IsMainThread());
if (AppShutdown::IsInOrBeyond(ShutdownPhase::XPCOMWillShutdown)) {
return;
}
// aCategory is dotted.snake_case. aName is snake_case.
auto categoryCamel = dottedSnakeToCamel(aCategory);
auto nameCamel = dottedSnakeToCamel(aName);
// Register the category
if (!gCategories) {
gCategories = new nsTHashSet<nsCString>();
RunOnShutdown([&] { gCategories = nullptr; },
ShutdownPhase::XPCOMWillShutdown);
}
gCategories->Insert(categoryCamel);
// Register the metric
if (!gMetrics) {
gMetrics = new nsTHashMap<nsCString, uint32_t>();
RunOnShutdown([&] { gMetrics = nullptr; },
ShutdownPhase::XPCOMWillShutdown);
}
gMetrics->InsertOrUpdate(categoryCamel + "."_ns + nameCamel, aMetric);
}
extern "C" NS_EXPORT void JOG_RegisterPing(const nsACString& aPingName,
uint32_t aPingId) {
MOZ_ASSERT(NS_IsMainThread());
if (AppShutdown::IsInOrBeyond(ShutdownPhase::XPCOMWillShutdown)) {
return;
}
// aPingName is kebab-case. JS expects camelCase.
auto pingCamel = kebabToCamel(aPingName);
// Register the ping
if (!gPings) {
gPings = new nsTHashMap<nsCString, uint32_t>();
RunOnShutdown([&] { gPings = nullptr; }, ShutdownPhase::XPCOMWillShutdown);
}
gPings->InsertOrUpdate(pingCamel, aPingId);
}
|
