Ticket #5636: TryPersistentRooted.patch

source/lobby/IXmppClient.h

@@ -53 +53 @@
     virtual void GUIGetPlayerList(const ScriptInterface& scriptInterface, JS::MutableHandleValue ret) = 0;
     virtual void GUIGetGameList(const ScriptInterface& scriptInterface, JS::MutableHandleValue ret) = 0;
     virtual void GUIGetBoardList(const ScriptInterface& scriptInterface, JS::MutableHandleValue ret) = 0;
     virtual void GUIGetProfile(const ScriptInterface& scriptInterface, JS::MutableHandleValue ret) = 0;
 
-    virtual JS::Value GuiPollNewMessage(const ScriptInterface& scriptInterface) = 0;
+    virtual void GuiPollNewMessage(const ScriptInterface& scriptInterface, JS::MutableHandleValue value) = 0;
     virtual JS::Value GuiPollHistoricMessages(const ScriptInterface& scriptInterface) = 0;
     virtual bool GuiPollHasPlayerListUpdate() = 0;
 
     virtual void SendMUCMessage(const std::string& message) = 0;
     virtual void SendStunEndpointToHost(const StunClient::StunEndpoint& stunEndpoint, const std::string& hostJID) = 0;

source/lobby/XmppClient.cpp

@@ -91 +91 @@
       m_isConnected(false),
       m_sessionManager(nullptr),
       m_certStatus(gloox::CertStatus::CertOk),
       m_PlayerMapUpdate(false)
 {
-    if (m_ScriptInterface)
-        JS_AddExtraGCRootsTracer(m_ScriptInterface->GetJSRuntime(), XmppClient::Trace, this);
-
     // Read lobby configuration from default.cfg
     std::string sXpartamupp;
     std::string sEchelon;
     CFG_GET_VAL("lobby.server", m_server);
     CFG_GET_VAL("lobby.xpartamupp", sXpartamupp);
@@ -188 +185 @@
         glooxwrapper::Tag::free(t);
     for (const glooxwrapper::Tag* const& t : m_BoardList)
         glooxwrapper::Tag::free(t);
     for (const glooxwrapper::Tag* const& t : m_Profile)
         glooxwrapper::Tag::free(t);
-
-    if (m_ScriptInterface)
-        JS_RemoveExtraGCRootsTracer(m_ScriptInterface->GetJSRuntime(), XmppClient::Trace, this);
-}
-
-void XmppClient::TraceMember(JSTracer* trc)
-{
-    for (JS::Heap<JS::Value>& guiMessage : m_GuiMessageQueue)
-        JS_CallValueTracer(trc, &guiMessage, "m_GuiMessageQueue");
-
-    for (JS::Heap<JS::Value>& guiMessage : m_HistoricGuiMessages)
-        JS_CallValueTracer(trc, &guiMessage, "m_HistoricGuiMessages");
 }
 
 /// Network
 void XmppClient::connect()
 {
@@ -680 +665 @@
         "time", static_cast<double>(time));
 
     JS::RootedObject messageObj(cx, message.toObjectOrNull());
     SetGUIMessageProperty(cx, messageObj, args...);
     m_ScriptInterface->FreezeObject(message, true);
-    m_GuiMessageQueue.push_back(JS::Heap<JS::Value>(message));
+    m_GuiMessageQueue.push_back(JS::PersistentRootedValue(cx, message));
 }
 
 bool XmppClient::GuiPollHasPlayerListUpdate()
 {
     bool hasUpdate = m_PlayerMapUpdate;
     m_PlayerMapUpdate = false;
     return hasUpdate;
 }
 
-JS::Value XmppClient::GuiPollNewMessage(const ScriptInterface& scriptInterface)
+void XmppClient::GuiPollNewMessage(const ScriptInterface& scriptInterface, JS::MutableHandleValue value)
 {
     if (m_GuiMessageQueue.empty())
-        return JS::UndefinedValue();
+    {
+        value.setUndefined();
+        return;
+    }
 
     JSContext* cx = scriptInterface.GetContext();
     JSAutoRequest rq(cx);
 
     JS::RootedValue message(cx, m_GuiMessageQueue.front());
@@ -706 +694 @@
     JS::RootedValue messageCopy(cx);
     if (JS_StructuredClone(cx, message, &messageCopy, nullptr, nullptr))
     {
         scriptInterface.SetProperty(messageCopy, "historic", true);
         scriptInterface.FreezeObject(messageCopy, true);
-        m_HistoricGuiMessages.push_back(JS::Heap<JS::Value>(messageCopy));
+        m_HistoricGuiMessages.push_back(JS::PersistentRootedValue(cx, messageCopy));
     }
     else
         LOGERROR("Could not clone historic lobby GUI message!");
 
-    return message;
+    value.set(message);
 }
 
 JS::Value XmppClient::GuiPollHistoricMessages(const ScriptInterface& scriptInterface)
 {
     JSContext* cx = scriptInterface.GetContext();
@@ -723 +711 @@
 
     JS::RootedValue ret(cx);
     ScriptInterface::CreateArray(cx, &ret);
 
     int j = 0;
-    for (const JS::Heap<JS::Value>& message : m_HistoricGuiMessages)
-        scriptInterface.SetPropertyInt(ret, j++, message);
+    for (const JS::PersistentRootedValue& message : m_HistoricGuiMessages)
+    {
+        JS::RootedValue messageVal(cx, message);
+        scriptInterface.SetPropertyInt(ret, j++, messageVal);
+    }
 
     return ret;
 }
 
 /**

source/lobby/XmppClient.h

@@ -61 +61 @@
 public:
     // Basic
     XmppClient(const ScriptInterface* scriptInterface, const std::string& sUsername, const std::string& sPassword, const std::string& sRoom, const std::string& sNick, const int historyRequestSize = 0, const bool regOpt = false);
     virtual ~XmppClient();
 
-    // JS::Heap is better for GC performance than JS::PersistentRooted
-    static void Trace(JSTracer *trc, void *data)
-    {
-        static_cast<XmppClient*>(data)->TraceMember(trc);
-    }
-
-    void TraceMember(JSTracer *trc);
-
     // Network
     void connect();
     void disconnect();
     bool isConnected();
     void recv();
@@ -148 +140 @@
     /* Session Handler */
     virtual void handleSessionAction(gloox::Jingle::Action action, glooxwrapper::Jingle::Session& session, const glooxwrapper::Jingle::Session::Jingle& jingle);
     virtual void handleSessionInitiation(glooxwrapper::Jingle::Session& session, const glooxwrapper::Jingle::Session::Jingle& jingle);
 
 public:
-    JS::Value GuiPollNewMessage(const ScriptInterface& scriptInterface);
+    void GuiPollNewMessage(const ScriptInterface& scriptInterface, JS::MutableHandleValue value);
     JS::Value GuiPollHistoricMessages(const ScriptInterface& scriptInterface);
     bool GuiPollHasPlayerListUpdate();
     void SendMUCMessage(const std::string& message);
 
 protected:
@@ -186 +178 @@
     /// Profile data
     std::vector<const glooxwrapper::Tag*> m_Profile;
     /// ScriptInterface to root the values
     const ScriptInterface* m_ScriptInterface;
     /// Queue of messages for the GUI
-    std::deque<JS::Heap<JS::Value> > m_GuiMessageQueue;
+    std::deque<JS::PersistentRootedValue > m_GuiMessageQueue;
     /// Cache of all GUI messages received since the login
-    std::vector<JS::Heap<JS::Value> > m_HistoricGuiMessages;
+    std::vector<JS::PersistentRootedValue > m_HistoricGuiMessages;
     /// Current room subject/topic.
     std::wstring m_Subject;
 };
 
 #endif // XMPPCLIENT_H

source/lobby/scripting/JSInterface_Lobby.cpp

@@ -246 +246 @@
 JS::Value JSI_Lobby::LobbyGuiPollNewMessage(ScriptInterface::CxPrivate* pCxPrivate)
 {
     if (!g_XmppClient)
         return JS::UndefinedValue();
 
-    return g_XmppClient->GuiPollNewMessage(*(pCxPrivate->pScriptInterface));
+    JSContext* cx = pCxPrivate->pScriptInterface->GetContext();
+    JSAutoRequest rq(cx);
+
+    JS::RootedValue message(cx);
+    g_XmppClient->GuiPollNewMessage(*(pCxPrivate->pScriptInterface), &message);
+
+    return message;
 }
 
 JS::Value JSI_Lobby::LobbyGuiPollHistoricMessages(ScriptInterface::CxPrivate* pCxPrivate)
 {
     if (!g_XmppClient)