ported from UXP: Issue #2306: Add pref-gated WeakRef with safe stub when disabled (5895253f)

dom/workers/RuntimeService.cpp

@@ -303,6 +303,7 @@ LoadContextOptions(const char* aPrefName, void* /* aClosure */)
                 .setAsyncStack(GetWorkerPref<bool>(NS_LITERAL_CSTRING("asyncstack")))
                 .setWerror(GetWorkerPref<bool>(NS_LITERAL_CSTRING("werror")))
                 .setStreams(GetWorkerPref<bool>(NS_LITERAL_CSTRING("streams")))
+                .setWeakRefs(GetWorkerPref<bool>(NS_LITERAL_CSTRING("weakrefs")))
                 .setExtraWarnings(GetWorkerPref<bool>(NS_LITERAL_CSTRING("strict")))
                 .setArrayProtoValues(GetWorkerPref<bool>(
                       NS_LITERAL_CSTRING("array_prototype_values")));

dom/workers/WorkerPrefs.h

@@ -36,6 +36,7 @@ WORKER_SIMPLE_PREF("dom.serviceWorkers.openWindow.enabled", OpenWindowEnabled, O
 WORKER_SIMPLE_PREF("dom.storageManager.enabled", StorageManagerEnabled, STORAGEMANAGER_ENABLED)
 WORKER_SIMPLE_PREF("dom.push.enabled", PushEnabled, PUSH_ENABLED)
 WORKER_SIMPLE_PREF("dom.streams.enabled", StreamsEnabled, STREAMS_ENABLED)
+WORKER_SIMPLE_PREF("javascript.options.weakrefs", WeakRefsEnabled, WEAKREFS_ENABLED)
 WORKER_SIMPLE_PREF("dom.requestcontext.enabled", RequestContextEnabled, REQUESTCONTEXT_ENABLED)
 WORKER_SIMPLE_PREF("gfx.offscreencanvas.enabled", OffscreenCanvasEnabled, OFFSCREENCANVAS_ENABLED)
 WORKER_SIMPLE_PREF("dom.webkitBlink.dirPicker.enabled", WebkitBlinkDirectoryPickerEnabled, DOM_WEBKITBLINK_DIRPICKER_WEBKITBLINK)

js/src/builtin/WeakRefObject.cpp

@@ -89,7 +89,7 @@ WeakRefObject::create(JSContext* cx, HandleObject target, HandleObject proto /*
     if (!obj)
         return nullptr;
 
-    Referent* data = cx->new_<Referent>(target);
+    Referent* data = cx->new_<Referent>(target, cx->options().weakRefs());
     if (!data)
         return nullptr;
 
@@ -146,12 +146,16 @@ WeakRefObject::trace(JSTracer* trc, JSObject* obj)
         if (!target)
             return;
 
-        // Weak edges must be tenured; fall back to a strong trace while the
-        // referent is still in the nursery to avoid crashing the GC.
-        if (IsInsideNursery(target))
+        // When pref-disabled, keep referent alive via strong trace so deref()
+        // stays usable as a stub without touching GC internals.
+        if (!data->enabled) {
+            TraceManuallyBarrieredEdge(trc, data->target.unsafeGet(), "WeakRef stub referent");
+        } else if (IsInsideNursery(target)) {
+            // Weak edges must be tenured; trace strongly while referent is in the nursery.
             TraceManuallyBarrieredEdge(trc, data->target.unsafeGet(), "WeakRef nursery referent");
-        else
+        } else {
             TraceWeakEdge(trc, &data->target, "WeakRef referent");
+        }
     }
 }
 

js/src/builtin/WeakRefObject.h

@@ -15,8 +15,10 @@ class WeakRefObject : public NativeObject
 {
   public:
     struct Referent {
-        explicit Referent(JSObject* obj) : target(obj) {}
+        explicit Referent(JSObject* obj, bool enabled)
+          : target(obj), enabled(enabled) {}
         WeakRef<JSObject*> target;
+        bool enabled;
     };
 
     static const Class class_;

js/src/jsapi.h

@@ -1012,6 +1012,8 @@ class JS_PUBLIC_API(ContextOptions) {
         strictMode_(false),
         extraWarnings_(false),
         arrayProtoValues_(true),
+        streams_(true),
+        weakRefs_(false),
 #ifdef NIGHTLY_BUILD
         forEachStatement_(false)
 #else
@@ -1167,6 +1169,16 @@ class JS_PUBLIC_API(ContextOptions) {
         return *this;
     }
 
+    bool weakRefs() const { return weakRefs_; }
+    ContextOptions& setWeakRefs(bool flag) {
+        weakRefs_ = flag;
+        return *this;
+    }
+    ContextOptions& toggleWeakRefs() {
+        weakRefs_ = !weakRefs_;
+        return *this;
+    }
+
   private:
     bool baseline_ : 1;
     bool ion_ : 1;
@@ -1185,6 +1197,7 @@ class JS_PUBLIC_API(ContextOptions) {
     bool extraWarnings_ : 1;
     bool arrayProtoValues_ : 1;
     bool streams_ : 1;
+    bool weakRefs_ : 1;
     bool forEachStatement_: 1;
 };
 

js/xpconnect/src/XPCJSContext.cpp

@@ -1509,6 +1509,7 @@ ReloadPrefsCallback(const char* pref, void* data)
     bool extraWarnings = Preferences::GetBool(JS_OPTIONS_DOT_STR "strict");
 
     bool streams = Preferences::GetBool(JS_OPTIONS_DOT_STR "streams");
+    bool weakRefs = Preferences::GetBool(JS_OPTIONS_DOT_STR "weakrefs");
 
     bool inlining = Preferences::GetBool(JS_OPTIONS_DOT_STR "ion.inlining");
 
@@ -1533,7 +1534,8 @@ ReloadPrefsCallback(const char* pref, void* data)
                              .setWerror(werror)
                              .setExtraWarnings(extraWarnings)
                              .setArrayProtoValues(arrayProtoValues)
-                             .setStreams(streams);
+                             .setStreams(streams)
+                             .setWeakRefs(weakRefs);
 
     JS_SetParallelParsingEnabled(cx, parallelParsing);
     JS_SetOffthreadIonCompilationEnabled(cx, offthreadIonCompilation);

modules/libpref/init/all.js

@@ -1411,6 +1411,7 @@ pref("javascript.options.dynamicImport", true);
 
 // Streams API
 pref("javascript.options.streams", true);
+pref("javascript.options.weakrefs", false);
 
 // advanced prefs
 pref("advanced.mailftp",                    false);