summaryrefslogtreecommitdiffstats
path: root/toolkit/components/glean/bindings/Glean.cpp
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-19 00:47:55 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-19 00:47:55 +0000
commit26a029d407be480d791972afb5975cf62c9360a6 (patch)
treef435a8308119effd964b339f76abb83a57c29483 /toolkit/components/glean/bindings/Glean.cpp
parentInitial commit. (diff)
downloadfirefox-26a029d407be480d791972afb5975cf62c9360a6.tar.xz
firefox-26a029d407be480d791972afb5975cf62c9360a6.zip
Adding upstream version 124.0.1.upstream/124.0.1
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'toolkit/components/glean/bindings/Glean.cpp')
-rw-r--r--toolkit/components/glean/bindings/Glean.cpp111
1 files changed, 111 insertions, 0 deletions
diff --git a/toolkit/components/glean/bindings/Glean.cpp b/toolkit/components/glean/bindings/Glean.cpp
new file mode 100644
index 0000000000..4f77f3a775
--- /dev/null
+++ b/toolkit/components/glean/bindings/Glean.cpp
@@ -0,0 +1,111 @@
+/* -*- 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/dom/DOMJSClass.h"
+#include "mozilla/dom/GleanBinding.h"
+#include "mozilla/dom/BindingUtils.h"
+#include "mozilla/glean/bindings/Glean.h"
+#include "mozilla/glean/bindings/Category.h"
+#include "mozilla/glean/bindings/GleanJSMetricsLookup.h"
+#include "mozilla/glean/bindings/jog/jog_ffi_generated.h"
+#include "mozilla/glean/bindings/jog/JOG.h"
+#include "MainThreadUtils.h"
+#include "js/PropertyAndElement.h" // JS_DefineProperty
+
+namespace mozilla::glean {
+
+// Whether the runtime-registered metrics should be treated as comprehensive,
+// or additive. If comprehensive, a metric not registered at runtime is a
+// metric that doesn't exist. If additive, a metric not registered at runtime
+// may still exist if it was registered at compile time.
+// If we're supporting Artefact Builds, we treat them as comprehensive.
+// Threading: Must only be read or written to on the main thread.
+static bool gRuntimeMetricsComprehensive = false;
+
+NS_IMPL_CYCLE_COLLECTION_WRAPPERCACHE(Glean, mParent)
+
+NS_IMPL_CYCLE_COLLECTING_ADDREF(Glean)
+NS_IMPL_CYCLE_COLLECTING_RELEASE(Glean)
+NS_INTERFACE_MAP_BEGIN_CYCLE_COLLECTION(Glean)
+ NS_WRAPPERCACHE_INTERFACE_MAP_ENTRY
+ NS_INTERFACE_MAP_ENTRY(nsISupports)
+NS_INTERFACE_MAP_END
+
+JSObject* Glean::WrapObject(JSContext* aCx, JS::Handle<JSObject*> aGivenProto) {
+ return dom::GleanImpl_Binding::Wrap(aCx, this, aGivenProto);
+}
+
+// static
+bool Glean::DefineGlean(JSContext* aCx, JS::Handle<JSObject*> aGlobal) {
+ MOZ_ASSERT(NS_IsMainThread());
+ MOZ_ASSERT(JS::GetClass(aGlobal)->flags & JSCLASS_DOM_GLOBAL,
+ "Passed object is not a global object!");
+
+ nsIGlobalObject* global = xpc::CurrentNativeGlobal(aCx);
+ if (NS_WARN_IF(!global)) {
+ return false;
+ }
+
+ JS::Rooted<JS::Value> glean(aCx);
+ js::AssertSameCompartment(aCx, aGlobal);
+
+ auto impl = MakeRefPtr<Glean>(global);
+ if (!dom::GetOrCreateDOMReflector(aCx, impl.get(), &glean)) {
+ return false;
+ }
+
+ return JS_DefineProperty(aCx, aGlobal, "Glean", glean, JSPROP_ENUMERATE);
+}
+
+already_AddRefed<Category> Glean::NamedGetter(const nsAString& aName,
+ bool& aFound) {
+ MOZ_ASSERT(NS_IsMainThread());
+
+ JOG::EnsureRuntimeMetricsRegistered();
+
+ NS_ConvertUTF16toUTF8 categoryName(aName);
+ if (JOG::HasCategory(categoryName)) {
+ aFound = true;
+ return MakeAndAddRef<Category>(std::move(categoryName), mParent);
+ }
+
+ if (gRuntimeMetricsComprehensive) {
+ // This category might be built-in, but since the runtime metrics are
+ // comprehensive, that just signals that the category was removed locally.
+ aFound = false;
+ return nullptr;
+ }
+
+ Maybe<uint32_t> categoryIdx = CategoryByNameLookup(categoryName);
+ if (categoryIdx.isNothing()) {
+ aFound = false;
+ return nullptr;
+ }
+
+ aFound = true;
+ nsDependentCString name(GetCategoryName(categoryIdx.value()));
+ return MakeAndAddRef<Category>(std::move(name), mParent);
+}
+
+bool Glean::NameIsEnumerable(const nsAString& aName) { return false; }
+
+void Glean::GetSupportedNames(nsTArray<nsString>& aNames) {
+ JOG::GetCategoryNames(aNames);
+ if (!JOG::AreRuntimeMetricsComprehensive()) {
+ for (category_entry_t entry : sCategoryByNameLookupEntries) {
+ const char* categoryName = GetCategoryName(entry);
+ aNames.AppendElement()->AssignASCII(categoryName);
+ }
+ }
+}
+
+// static
+void Glean::TestSetRuntimeMetricsComprehensive(bool aIsComprehensive) {
+ MOZ_ASSERT(NS_IsMainThread());
+ gRuntimeMetricsComprehensive = aIsComprehensive;
+}
+
+} // namespace mozilla::glean