Changeset 21823 for ps

Timestamp:

05/24/18 20:08:56 (7 years ago)

Author:

elexis

Message:

Alpha 23 "lobby lag" release fix.

Caches the loaded mod versions, so that GetEngineInfo doesn't read the zip and json files everytime and returns about 1000 times faster.
Adds two missing includes.

The lobby froze multiple times every few seconds on updateGameList().
The gamesetup page was slowed down with every stanza sent and the
load savegame selection page was slowed down per savegame selection,
proportional to the number of installed zipped mods.

Introduced by: rP21239 and rP21301
Differential Revision: ​https://code.wildfiregames.com/D1518
Reviewed By: wraitii
Comments By: Imarok (in D1512, P121), leper (in the lobby)

Location:

ps/trunk/source/ps

Files:

• GameSetup/GameSetup.cpp (modified) (2 diffs)
• GameSetup/GameSetup.h (modified) (2 diffs)
• Mod.cpp (modified) (3 diffs)
• Mod.h (modified) (2 diffs)
• Replay.cpp (modified) (2 diffs)

ps/trunk/source/ps/GameSetup/GameSetup.cpp

@@ -81 +81 @@
 #include "scriptinterface/ScriptStats.h"
 #include "scriptinterface/ScriptConversions.h"
+#include "scriptinterface/ScriptRuntime.h"
 #include "simulation2/Simulation2.h"
 #include "lobby/IXmppClient.h"
@@ -922 +923 @@
     const int heapGrowthBytesGCTrigger = 20 * 1024 * 1024;
     g_ScriptRuntime = ScriptInterface::CreateRuntime(shared_ptr<ScriptRuntime>(), runtimeSize, heapGrowthBytesGCTrigger);
+
+    Mod::CacheEnabledModVersions(g_ScriptRuntime);
 
     // Special command-line mode to dump the entity schemas instead of running the game.

ps/trunk/source/ps/GameSetup/GameSetup.h

@@ -1 @@
-/* Copyright (C) 2017 Wildfire Games.
+/* Copyright (C) 2018 Wildfire Games.
  * This file is part of 0 A.D.
  *
@@ -80 +80 @@
 class Paths;
 extern const std::vector<CStr>& GetMods(const CmdLineArgs& args, int flags);
+
+/**
+ * Mounts all files of the given mods in the global VFS.
+ * Make sure to call CacheEnabledModVersions after every call to this.
+ */
 extern void MountMods(const Paths& paths, const std::vector<CStr>& mods);
 /**

ps/trunk/source/ps/Mod.cpp

@@ -29 +29 @@
 #include "ps/GameSetup/Paths.h"
 #include "scriptinterface/ScriptInterface.h"
+#include "scriptinterface/ScriptRuntime.h"
 
 std::vector<CStr> g_modsLoaded;
+
+std::vector<std::vector<CStr>> g_LoadedModVersions;
 
 CmdLineArgs g_args;
@@ -102 +105 @@
 }
 
-JS::Value Mod::GetLoadedModsWithVersions(const ScriptInterface& scriptInterface)
+void Mod::CacheEnabledModVersions(const shared_ptr<ScriptRuntime>& scriptRuntime)
 {
+    ScriptInterface scriptInterface("Engine", "CacheEnabledModVersions", scriptRuntime);
     JSContext* cx = scriptInterface.GetContext();
     JSAutoRequest rq(cx);
@@ -109 +113 @@
     JS::RootedValue availableMods(cx, GetAvailableMods(scriptInterface));
 
-    JS::RootedValue ret(cx, JS::ObjectValue(*JS_NewArrayObject(cx, 0)));
+    g_LoadedModVersions.clear();
 
-    // Index of the created array
-    size_t j = 0;
-    for (size_t i = 0; i < g_modsLoaded.size(); ++i)
+    for (const CStr& mod : g_modsLoaded)
     {
         // Ignore user and mod mod as they are irrelevant for compatibility checks
-        if (g_modsLoaded[i] == "mod" || g_modsLoaded[i] == "user")
+        if (mod == "mod" || mod == "user")
             continue;
+
         CStr version;
         JS::RootedValue modData(cx);
-        if (scriptInterface.GetProperty(availableMods, g_modsLoaded[i].c_str(), &modData))
+        if (scriptInterface.GetProperty(availableMods, mod.c_str(), &modData))
             scriptInterface.GetProperty(modData, "version", version);
-        scriptInterface.SetPropertyInt(ret, j++, std::vector<CStr>{g_modsLoaded[i], version});
+
+        g_LoadedModVersions.push_back({mod, version});
     }
-    return ret;
+}
+
+JS::Value Mod::GetLoadedModsWithVersions(const ScriptInterface& scriptInterface)
+{
+    JSContext* cx = scriptInterface.GetContext();
+    JSAutoRequest rq(cx);
+    JS::RootedValue returnValue(cx);
+    scriptInterface.ToJSVal(cx, &returnValue, g_LoadedModVersions);
+    return returnValue;
 }
 

ps/trunk/source/ps/Mod.h

@@ -23 +23 @@
 #include "scriptinterface/ScriptInterface.h"
 
+class ScriptRuntime;
+
 extern std::vector<CStr> g_modsLoaded;
 extern CmdLineArgs g_args;
@@ -29 +31 @@
 {
     JS::Value GetAvailableMods(const ScriptInterface& scriptInterface);
+
+    /**
+     * This reads the version numbers from the launched mods.
+     * It caches the result, since the reading of zip files is slow and
+     * JS pages can request the version numbers too often easily.
+     * Make sure this is called after each MountMods call.
+     */
+    void CacheEnabledModVersions(const shared_ptr<ScriptRuntime>& scriptRuntime);
 
     /**

ps/trunk/source/ps/Replay.cpp

@@ -36 +36 @@
 #include "ps/VisualReplay.h"
 #include "scriptinterface/ScriptInterface.h"
+#include "scriptinterface/ScriptRuntime.h"
 #include "scriptinterface/ScriptStats.h"
 #include "simulation2/Simulation2.h"
@@ -179 +180 @@
     const int heapGrowthBytesGCTrigger = 20 * 1024 * 1024;
     g_ScriptRuntime = ScriptInterface::CreateRuntime(shared_ptr<ScriptRuntime>(), runtimeSize, heapGrowthBytesGCTrigger);
+
+    Mod::CacheEnabledModVersions(g_ScriptRuntime);
 
     g_Game = new CGame(true, false);