From 36657c94733008a3b7dfb09d6a0631363ef095da Mon Sep 17 00:00:00 2001
From: ZappoMan <bradh@konamoxt.com>
Date: Mon, 30 Mar 2015 14:36:48 -0700
Subject: [PATCH 1/4] first cut at script caching

---
 interface/src/Application.cpp                 |   6 +-
 .../src/EntityTreeRenderer.cpp                |   5 +
 libraries/script-engine/src/Script.cpp        |  49 ++++++
 libraries/script-engine/src/Script.h          |  37 +++++
 libraries/script-engine/src/ScriptCache.cpp   | 146 ++++++++++++++++++
 libraries/script-engine/src/ScriptCache.h     |  46 ++++++
 libraries/script-engine/src/ScriptEngine.cpp  |  18 +++
 libraries/script-engine/src/ScriptEngine.h    |   6 +-
 8 files changed, 309 insertions(+), 4 deletions(-)
 create mode 100644 libraries/script-engine/src/Script.cpp
 create mode 100644 libraries/script-engine/src/Script.h
 create mode 100644 libraries/script-engine/src/ScriptCache.cpp
 create mode 100644 libraries/script-engine/src/ScriptCache.h

diff --git a/interface/src/Application.cpp b/interface/src/Application.cpp
index 97d132508a..c2ac472b9f 100644
--- a/interface/src/Application.cpp
+++ b/interface/src/Application.cpp
@@ -76,7 +76,7 @@
 #include <PhysicsEngine.h>
 #include <ProgramObject.h>
 #include <ResourceCache.h>
-//#include <ScriptCache.h>
+#include <ScriptCache.h>
 #include <SettingHandle.h>
 #include <SoundCache.h>
 #include <TextRenderer.h>
@@ -221,7 +221,7 @@ bool setupEssentials(int& argc, char** argv) {
     auto addressManager = DependencyManager::set<AddressManager>();
     auto nodeList = DependencyManager::set<NodeList>(NodeType::Agent, listenPort);
     auto geometryCache = DependencyManager::set<GeometryCache>();
-    //auto scriptCache = DependencyManager::set<ScriptCache>();
+    auto scriptCache = DependencyManager::set<ScriptCache>();
     auto soundCache = DependencyManager::set<SoundCache>();
     auto glowEffect = DependencyManager::set<GlowEffect>();
     auto faceshift = DependencyManager::set<Faceshift>();
@@ -612,7 +612,7 @@ Application::~Application() {
     DependencyManager::destroy<AnimationCache>();
     DependencyManager::destroy<TextureCache>();
     DependencyManager::destroy<GeometryCache>();
-    //DependencyManager::destroy<ScriptCache>();
+    DependencyManager::destroy<ScriptCache>();
     DependencyManager::destroy<SoundCache>();
     
     QThread* nodeThread = DependencyManager::get<NodeList>()->thread();
diff --git a/libraries/entities-renderer/src/EntityTreeRenderer.cpp b/libraries/entities-renderer/src/EntityTreeRenderer.cpp
index 3faa06fc53..f98a13878d 100644
--- a/libraries/entities-renderer/src/EntityTreeRenderer.cpp
+++ b/libraries/entities-renderer/src/EntityTreeRenderer.cpp
@@ -148,6 +148,7 @@ QString EntityTreeRenderer::loadScriptContents(const QString& scriptMaybeURLorTe
                 qDebug() << "ERROR Loading file:" << fileName;
             }
         } else {
+            /*
             QNetworkAccessManager& networkAccessManager = NetworkAccessManager::getInstance();
             QNetworkRequest networkRequest = QNetworkRequest(url);
             networkRequest.setHeader(QNetworkRequest::UserAgentHeader, HIGH_FIDELITY_USER_AGENT);
@@ -162,6 +163,10 @@ QString EntityTreeRenderer::loadScriptContents(const QString& scriptMaybeURLorTe
                 qDebug() << "ERROR Loading file:" << url.toString();
             }
             delete reply;
+            */
+            auto scriptCache = DependencyManager::get<ScriptCache>();
+            scriptContents = scriptCache->getScript(url);
+            
         }
     }
     
diff --git a/libraries/script-engine/src/Script.cpp b/libraries/script-engine/src/Script.cpp
new file mode 100644
index 0000000000..4f5d38a2e1
--- /dev/null
+++ b/libraries/script-engine/src/Script.cpp
@@ -0,0 +1,49 @@
+//
+//  Script.cpp
+//  libraries/script-engine/src
+//
+//  Created by Brad Hefta-Gaub on 2015-03-30
+//  Copyright 2015 High Fidelity, Inc.
+//
+//  Distributed under the Apache License, Version 2.0.
+//  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
+//
+
+/*
+#include <stdint.h>
+
+#include <glm/glm.hpp>
+
+#include <QDataStream>
+#include <QtCore/QDebug>
+#include <QtNetwork/QNetworkRequest>
+#include <QtNetwork/QNetworkReply>
+#include <qendian.h>
+
+#include <LimitedNodeList.h>
+#include <NetworkAccessManager.h>
+#include <SharedUtil.h>
+
+#include "AudioRingBuffer.h"
+#include "AudioFormat.h"
+#include "AudioBuffer.h"
+#include "AudioEditBuffer.h"
+*/
+
+#include "Script.h"
+
+Script::Script(const QUrl& url) :
+    Resource(url),
+    _isReady(false)
+{
+    
+}
+
+void Script::downloadFinished(QNetworkReply* reply) {
+    // replace our byte array with the downloaded data
+    _contents = reply->readAll();
+    qDebug() << "Script downloaded from:" << getURL();
+    _isReady = true;
+    reply->deleteLater();
+}
+
diff --git a/libraries/script-engine/src/Script.h b/libraries/script-engine/src/Script.h
new file mode 100644
index 0000000000..6cca76a8e8
--- /dev/null
+++ b/libraries/script-engine/src/Script.h
@@ -0,0 +1,37 @@
+//
+//  Script.h
+//  libraries/script-engine/src
+//
+//  Created by Brad Hefta-Gaub on 2015-03-30
+//  Copyright 2015 High Fidelity, Inc.
+//
+//  Distributed under the Apache License, Version 2.0.
+//  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
+//
+
+#ifndef hifi_Script_h
+#define hifi_Script_h
+
+#include <QtCore/QObject>
+#include <QtNetwork/QNetworkReply>
+#include <QtScript/qscriptengine.h>
+
+#include <ResourceCache.h>
+
+class Script : public Resource {
+    Q_OBJECT
+public:
+    Script(const QUrl& url);
+    bool isReady() const { return _isReady; }
+    const QString& getContents() { return _contents; }
+
+private:
+    QString _contents;
+    bool _isReady;
+    
+    virtual void downloadFinished(QNetworkReply* reply);
+};
+
+typedef QSharedPointer<Script> SharedScriptPointer;
+
+#endif // hifi_Script_h
diff --git a/libraries/script-engine/src/ScriptCache.cpp b/libraries/script-engine/src/ScriptCache.cpp
new file mode 100644
index 0000000000..63f2e27ffe
--- /dev/null
+++ b/libraries/script-engine/src/ScriptCache.cpp
@@ -0,0 +1,146 @@
+//
+//  ScriptCache.cpp
+//  libraries/script-engine/src
+//
+//  Created by Brad Hefta-Gaub on 2015-03-30
+//  Copyright 2015 High Fidelity, Inc.
+//
+//  Distributed under the Apache License, Version 2.0.
+//  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
+//
+
+#include <QCoreApplication>
+#include <QEventLoop>
+#include <QNetworkAccessManager>
+#include <QNetworkReply>
+#include <QObject>
+
+#include <NetworkAccessManager.h>
+#include <SharedUtil.h>
+
+#include "ScriptCache.h"
+
+ScriptCache::ScriptCache(QObject* parent) {
+    // nothing to do here...
+}
+
+// QHash<QUrl, QString> _scriptCache;
+
+void ScriptCache::getScript(const QUrl& url, ScriptUser* scriptUser) {
+    if (_scriptCache.contains(url)) {
+        scriptUser->scriptContentsAvailable(url, _scriptCache[url]);
+        return;
+    }
+    _scriptUsers.insert(url, scriptUser);
+    QNetworkAccessManager& networkAccessManager = NetworkAccessManager::getInstance();
+    QNetworkRequest networkRequest = QNetworkRequest(url);
+    networkRequest.setHeader(QNetworkRequest::UserAgentHeader, HIGH_FIDELITY_USER_AGENT);
+    QNetworkReply* reply = networkAccessManager.get(networkRequest);
+    connect(reply, &QNetworkReply::finished, this, &ScriptCache::scriptDownloaded);
+}
+
+void ScriptCache::scriptDownloaded() {
+    QNetworkReply* reply = qobject_cast<QNetworkReply*>(sender());
+    QUrl url = reply->url();
+    QList<ScriptUser*> scriptUsers = _scriptUsers.values(url);
+    _scriptUsers.remove(url);
+    
+    if (reply->error() == QNetworkReply::NoError && reply->attribute(QNetworkRequest::HttpStatusCodeAttribute) == 200) {
+        _scriptCache[url] = reply->readAll();
+        qDebug() << "_scriptCache.size:" << _scriptCache.size();
+        
+        foreach(ScriptUser* user, scriptUsers) {
+            user->scriptContentsAvailable(url, _scriptCache[url]);
+        }
+    } else {
+        qDebug() << "ERROR Loading file:" << reply->url().toString();
+        foreach(ScriptUser* user, scriptUsers) {
+            user->errorInLoadingScript(url);
+        }
+    }
+    reply->deleteLater();
+}
+
+QString ScriptCache::getScript(const QUrl& url) {
+    qDebug() << "Script requested: " << url.toString();
+    QString scriptContents;
+    if (_scriptCache.contains(url)) {
+        qDebug() << "Script found in cache: " << url.toString();
+        scriptContents = _scriptCache[url];
+    } else {
+        qDebug() << "Script not found in cache: " << url.toString();
+        
+        if (_blockingScriptsPending.contains(url)) {
+            // if we're already downloading this script, wait for it to complete...
+            qDebug() << "Already downloading script: " << url.toString();
+            while (_blockingScriptsPending.contains(url)) {
+                QEventLoop loop;
+                qDebug() << "about to call loop.processEvents()....";
+                loop.processEvents(QEventLoop::AllEvents, 1);
+                qDebug() << "AFTER loop.processEvents()....";
+            }
+            qDebug() << "Done waiting on downloading script: " << url.toString();
+            scriptContents = _scriptCache[url];
+        } else {
+            _blockingScriptsPending.insert(url);
+            qDebug() << "_blockingScriptsPending: " << _blockingScriptsPending;
+            
+            QNetworkAccessManager& networkAccessManager = NetworkAccessManager::getInstance();
+            QNetworkRequest networkRequest = QNetworkRequest(url);
+            networkRequest.setHeader(QNetworkRequest::UserAgentHeader, HIGH_FIDELITY_USER_AGENT);
+            QNetworkReply* reply = networkAccessManager.get(networkRequest);
+
+
+            connect(reply, &QNetworkReply::finished, this, &ScriptCache::scriptDownloadedSyncronously);
+            qDebug() << "Downloading script at" << url.toString();
+            //QEventLoop loop;
+            //QObject::connect(reply, SIGNAL(finished()), &loop, SLOT(quit()));
+            //qDebug() << "starting loop....";
+            //loop.exec();
+            //qDebug() << "after loop....";
+
+            /*
+            if (reply->error() == QNetworkReply::NoError && reply->attribute(QNetworkRequest::HttpStatusCodeAttribute) == 200) {
+                scriptContents = reply->readAll();
+                _scriptCache[url] = scriptContents;
+                qDebug() << "_scriptCache.size:" << _scriptCache.size();
+            } else {
+                qDebug() << "ERROR Loading file:" << url.toString();
+            }
+            delete reply;
+            _blockingScriptsPending.remove(url);
+            qDebug() << "_blockingScriptsPending: " << _blockingScriptsPending;
+            */
+            while (_blockingScriptsPending.contains(url)) {
+                QEventLoop loop;
+                qDebug() << "about to call loop.processEvents()....";
+                loop.processEvents(QEventLoop::AllEvents, 1);
+                qDebug() << "AFTER loop.processEvents()....";
+            }
+            qDebug() << "Done waiting on downloading script: " << url.toString();
+            scriptContents = _scriptCache[url];
+        }
+    }
+    return scriptContents;
+}
+
+void ScriptCache::scriptDownloadedSyncronously() {
+
+    qDebug() << "ScriptCache::scriptDownloadedSyncronously()....";
+    
+    QNetworkReply* reply = qobject_cast<QNetworkReply*>(sender());
+    QUrl url = reply->url();
+    
+    if (reply->error() == QNetworkReply::NoError && reply->attribute(QNetworkRequest::HttpStatusCodeAttribute) == 200) {
+        _scriptCache[url] = reply->readAll();
+        qDebug() << "_scriptCache.size:" << _scriptCache.size();
+    } else {
+        qDebug() << "ERROR Loading file:" << reply->url().toString();
+    }
+    
+    reply->deleteLater();
+
+    _blockingScriptsPending.remove(url);
+    qDebug() << "_blockingScriptsPending: " << _blockingScriptsPending;
+}
+    
diff --git a/libraries/script-engine/src/ScriptCache.h b/libraries/script-engine/src/ScriptCache.h
new file mode 100644
index 0000000000..64a6ded7e8
--- /dev/null
+++ b/libraries/script-engine/src/ScriptCache.h
@@ -0,0 +1,46 @@
+//
+//  ScriptCache.h
+//  libraries/script-engine/src
+//
+//  Created by Brad Hefta-Gaub on 2015-03-30
+//  Copyright 2015 High Fidelity, Inc.
+//
+//  Distributed under the Apache License, Version 2.0.
+//  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
+//
+
+#ifndef hifi_ScriptCache_h
+#define hifi_ScriptCache_h
+
+#include <ResourceCache.h>
+#include "Script.h"
+
+class ScriptUser {
+public:
+    virtual void scriptContentsAvailable(const QUrl& url, const QString& scriptContents) = 0;
+    virtual void errorInLoadingScript(const QUrl& url) = 0;
+};
+
+/// Interface for loading scripts
+class ScriptCache : public QObject, public Dependency {
+    Q_OBJECT
+    SINGLETON_DEPENDENCY
+
+public:
+    void getScript(const QUrl& url, ScriptUser* scriptUser); // asynchronous
+    QString getScript(const QUrl& url); // blocking call
+    
+private slots:
+    void scriptDownloaded();
+    void scriptDownloadedSyncronously();
+
+    
+private:
+    ScriptCache(QObject* parent = NULL);
+    
+    QHash<QUrl, QString> _scriptCache;
+    QMultiMap<QUrl, ScriptUser*> _scriptUsers;
+    QSet<QUrl> _blockingScriptsPending;
+};
+
+#endif // hifi_ScriptCache_h
\ No newline at end of file
diff --git a/libraries/script-engine/src/ScriptEngine.cpp b/libraries/script-engine/src/ScriptEngine.cpp
index 831db73a0a..c939e12284 100644
--- a/libraries/script-engine/src/ScriptEngine.cpp
+++ b/libraries/script-engine/src/ScriptEngine.cpp
@@ -34,6 +34,7 @@
 #include "EventTypes.h"
 #include "MenuItemProperties.h"
 #include "ScriptAudioInjector.h"
+#include "ScriptCache.h"
 #include "ScriptEngine.h"
 #include "TypedArrays.h"
 #include "XMLHttpRequestClass.h"
@@ -279,16 +280,22 @@ void ScriptEngine::loadURL(const QUrl& scriptURL) {
                 emit errorLoadingScript(_fileNameString);
             }
         } else {
+            /*
             QNetworkAccessManager& networkAccessManager = NetworkAccessManager::getInstance();
             QNetworkRequest networkRequest = QNetworkRequest(url);
             networkRequest.setHeader(QNetworkRequest::UserAgentHeader, HIGH_FIDELITY_USER_AGENT);
             QNetworkReply* reply = networkAccessManager.get(networkRequest);
             connect(reply, &QNetworkReply::finished, this, &ScriptEngine::handleScriptDownload);
+            */
+            auto scriptCache = DependencyManager::get<ScriptCache>();
+            scriptCache->getScript(url, this);
+            
         }
     }
 }
 
 void ScriptEngine::handleScriptDownload() {
+    /*
     QNetworkReply* reply = qobject_cast<QNetworkReply*>(sender());
     
     if (reply->error() == QNetworkReply::NoError && reply->attribute(QNetworkRequest::HttpStatusCodeAttribute) == 200) {
@@ -300,6 +307,17 @@ void ScriptEngine::handleScriptDownload() {
     }
     
     reply->deleteLater();
+    */
+}
+
+void ScriptEngine::scriptContentsAvailable(const QUrl& url, const QString& scriptContents) {
+    _scriptContents = scriptContents;
+    emit scriptLoaded(_fileNameString);
+}
+
+void ScriptEngine::errorInLoadingScript(const QUrl& url) {
+    qDebug() << "ERROR Loading file:" << url.toString();
+    emit errorLoadingScript(_fileNameString); // ??
 }
 
 void ScriptEngine::init() {
diff --git a/libraries/script-engine/src/ScriptEngine.h b/libraries/script-engine/src/ScriptEngine.h
index 84d2527bd0..ab3fdabb82 100644
--- a/libraries/script-engine/src/ScriptEngine.h
+++ b/libraries/script-engine/src/ScriptEngine.h
@@ -28,6 +28,7 @@
 #include "ArrayBufferClass.h"
 #include "AudioScriptingInterface.h"
 #include "Quat.h"
+#include "ScriptCache.h"
 #include "ScriptUUID.h"
 #include "Vec3.h"
 
@@ -35,7 +36,7 @@ const QString NO_SCRIPT("");
 
 const unsigned int SCRIPT_DATA_CALLBACK_USECS = floor(((1.0 / 60.0f) * 1000 * 1000) + 0.5);
 
-class ScriptEngine : public QScriptEngine {
+class ScriptEngine : public QScriptEngine, public ScriptUser {
     Q_OBJECT
 public:
     ScriptEngine(const QString& scriptContents = NO_SCRIPT,
@@ -94,6 +95,9 @@ public:
     
     void waitTillDoneRunning();
 
+    virtual void scriptContentsAvailable(const QUrl& url, const QString& scriptContents);
+    virtual void errorInLoadingScript(const QUrl& url);
+
 public slots:
     void loadURL(const QUrl& scriptURL);
     void stop();

From 74d50a9250e825df8eb0cd9edba9542aefddb9ff Mon Sep 17 00:00:00 2001
From: ZappoMan <bradh@konamoxt.com>
Date: Mon, 30 Mar 2015 16:21:47 -0700
Subject: [PATCH 2/4] more work on improving script caching

---
 .../src/EntityTreeRenderer.cpp                | 41 +++++++++++++++----
 .../src/EntityTreeRenderer.h                  | 14 +++++--
 libraries/script-engine/src/ScriptCache.cpp   | 27 ++++++++----
 libraries/script-engine/src/ScriptCache.h     |  8 ++--
 libraries/script-engine/src/ScriptEngine.cpp  |  3 +-
 5 files changed, 69 insertions(+), 24 deletions(-)

diff --git a/libraries/entities-renderer/src/EntityTreeRenderer.cpp b/libraries/entities-renderer/src/EntityTreeRenderer.cpp
index f98a13878d..39b26e9598 100644
--- a/libraries/entities-renderer/src/EntityTreeRenderer.cpp
+++ b/libraries/entities-renderer/src/EntityTreeRenderer.cpp
@@ -110,14 +110,30 @@ void EntityTreeRenderer::shutdown() {
     _shuttingDown = true;
 }
 
+void EntityTreeRenderer::scriptContentsAvailable(const QUrl& url, const QString& scriptContents) {
+    if (_waitingOnPreload.contains(url)) {
+        QList<EntityItemID> entityIDs = _waitingOnPreload.values(url);
+        _waitingOnPreload.remove(url);
+        foreach(EntityItemID entityID, entityIDs) {
+            checkAndCallPreload(entityID);
+        } 
+    }
+}
 
-QScriptValue EntityTreeRenderer::loadEntityScript(const EntityItemID& entityItemID) {
+void EntityTreeRenderer::errorInLoadingScript(const QUrl& url) {
+    if (_waitingOnPreload.contains(url)) {
+        _waitingOnPreload.remove(url);
+    }
+}
+
+QScriptValue EntityTreeRenderer::loadEntityScript(const EntityItemID& entityItemID, bool isPreload) {
     EntityItem* entity = static_cast<EntityTree*>(_tree)->findEntityByEntityItemID(entityItemID);
-    return loadEntityScript(entity);
+    return loadEntityScript(entity, isPreload);
 }
 
 
-QString EntityTreeRenderer::loadScriptContents(const QString& scriptMaybeURLorText, bool& isURL) {
+QString EntityTreeRenderer::loadScriptContents(const QString& scriptMaybeURLorText, bool& isURL, bool& isPending, QUrl& urlOut) {
+    isPending = false;
     QUrl url(scriptMaybeURLorText);
     
     // If the url is not valid, this must be script text...
@@ -126,6 +142,7 @@ QString EntityTreeRenderer::loadScriptContents(const QString& scriptMaybeURLorTe
         return scriptMaybeURLorText;
     }
     isURL = true;
+    urlOut = url;
 
     QString scriptContents; // assume empty
     
@@ -165,8 +182,7 @@ QString EntityTreeRenderer::loadScriptContents(const QString& scriptMaybeURLorTe
             delete reply;
             */
             auto scriptCache = DependencyManager::get<ScriptCache>();
-            scriptContents = scriptCache->getScript(url);
-            
+            scriptContents = scriptCache->getScript(url, this, isPending);
         }
     }
     
@@ -174,7 +190,7 @@ QString EntityTreeRenderer::loadScriptContents(const QString& scriptMaybeURLorTe
 }
 
 
-QScriptValue EntityTreeRenderer::loadEntityScript(EntityItem* entity) {
+QScriptValue EntityTreeRenderer::loadEntityScript(EntityItem* entity, bool isPreload) {
     if (_shuttingDown) {
         return QScriptValue(); // since we're shutting down, we don't load any more scripts
     }
@@ -208,7 +224,18 @@ QScriptValue EntityTreeRenderer::loadEntityScript(EntityItem* entity) {
     }
     
     bool isURL = false; // loadScriptContents() will tell us if this is a URL or just text.
-    QString scriptContents = loadScriptContents(entityScript, isURL);
+    bool isPending = false;
+    QUrl url;
+    QString scriptContents = loadScriptContents(entityScript, isURL, isPending, url);
+    
+    if (isPending && isPreload && isURL) {
+        _waitingOnPreload.insert(url, entityID);
+        
+    }
+    
+    if (scriptContents.isEmpty()) {
+        return QScriptValue(); // no script contents...
+    }
     
     QScriptSyntaxCheckResult syntaxCheck = QScriptEngine::checkSyntax(scriptContents);
     if (syntaxCheck.state() != QScriptSyntaxCheckResult::Valid) {
diff --git a/libraries/entities-renderer/src/EntityTreeRenderer.h b/libraries/entities-renderer/src/EntityTreeRenderer.h
index c4aa5a42d0..12d5f6e166 100644
--- a/libraries/entities-renderer/src/EntityTreeRenderer.h
+++ b/libraries/entities-renderer/src/EntityTreeRenderer.h
@@ -16,6 +16,7 @@
 #include <EntityScriptingInterface.h> // for RayToEntityIntersectionResult
 #include <MouseEvent.h>
 #include <OctreeRenderer.h>
+#include <ScriptCache.h>
 
 class Model;
 class ScriptEngine;
@@ -31,7 +32,7 @@ public:
 };
 
 // Generic client side Octree renderer class.
-class EntityTreeRenderer : public OctreeRenderer, public EntityItemFBXService {
+class EntityTreeRenderer : public OctreeRenderer, public EntityItemFBXService, public ScriptUser {
     Q_OBJECT
 public:
     EntityTreeRenderer(bool wantScripts, AbstractViewStateInterface* viewState, 
@@ -84,6 +85,9 @@ public:
     /// hovering over, and entering entities
     void connectSignalsToSlots(EntityScriptingInterface* entityScriptingInterface);
 
+    virtual void scriptContentsAvailable(const QUrl& url, const QString& scriptContents);
+    virtual void errorInLoadingScript(const QUrl& url);
+
 signals:
     void mousePressOnEntity(const EntityItemID& entityItemID, const MouseEvent& event);
     void mouseMoveOnEntity(const EntityItemID& entityItemID, const MouseEvent& event);
@@ -138,10 +142,10 @@ private:
     ScriptEngine* _entitiesScriptEngine;
     ScriptEngine* _sandboxScriptEngine;
 
-    QScriptValue loadEntityScript(EntityItem* entity);
-    QScriptValue loadEntityScript(const EntityItemID& entityItemID);
+    QScriptValue loadEntityScript(EntityItem* entity, bool isPreload = false);
+    QScriptValue loadEntityScript(const EntityItemID& entityItemID, bool isPreload = false);
     QScriptValue getPreviouslyLoadedEntityScript(const EntityItemID& entityItemID);
-    QString loadScriptContents(const QString& scriptMaybeURLorText, bool& isURL);
+    QString loadScriptContents(const QString& scriptMaybeURLorText, bool& isURL, bool& isPending, QUrl& url);
     QScriptValueList createMouseEventArgs(const EntityItemID& entityID, QMouseEvent* event, unsigned int deviceID);
     QScriptValueList createMouseEventArgs(const EntityItemID& entityID, const MouseEvent& mouseEvent);
     
@@ -157,6 +161,8 @@ private:
     bool _dontDoPrecisionPicking;
     
     bool _shuttingDown = false;
+
+    QMultiMap<QUrl, EntityItemID> _waitingOnPreload;
     
 };
 
diff --git a/libraries/script-engine/src/ScriptCache.cpp b/libraries/script-engine/src/ScriptCache.cpp
index 63f2e27ffe..aabeec99f8 100644
--- a/libraries/script-engine/src/ScriptCache.cpp
+++ b/libraries/script-engine/src/ScriptCache.cpp
@@ -26,17 +26,22 @@ ScriptCache::ScriptCache(QObject* parent) {
 
 // QHash<QUrl, QString> _scriptCache;
 
-void ScriptCache::getScript(const QUrl& url, ScriptUser* scriptUser) {
+QString ScriptCache::getScript(const QUrl& url, ScriptUser* scriptUser, bool& isPending) {
+    QString scriptContents;
     if (_scriptCache.contains(url)) {
-        scriptUser->scriptContentsAvailable(url, _scriptCache[url]);
-        return;
+        scriptContents = _scriptCache[url];
+        scriptUser->scriptContentsAvailable(url, scriptContents);
+        isPending = false;
+    } else {
+        isPending = true;
+        _scriptUsers.insert(url, scriptUser);
+        QNetworkAccessManager& networkAccessManager = NetworkAccessManager::getInstance();
+        QNetworkRequest networkRequest = QNetworkRequest(url);
+        networkRequest.setHeader(QNetworkRequest::UserAgentHeader, HIGH_FIDELITY_USER_AGENT);
+        QNetworkReply* reply = networkAccessManager.get(networkRequest);
+        connect(reply, &QNetworkReply::finished, this, &ScriptCache::scriptDownloaded);
     }
-    _scriptUsers.insert(url, scriptUser);
-    QNetworkAccessManager& networkAccessManager = NetworkAccessManager::getInstance();
-    QNetworkRequest networkRequest = QNetworkRequest(url);
-    networkRequest.setHeader(QNetworkRequest::UserAgentHeader, HIGH_FIDELITY_USER_AGENT);
-    QNetworkReply* reply = networkAccessManager.get(networkRequest);
-    connect(reply, &QNetworkReply::finished, this, &ScriptCache::scriptDownloaded);
+    return scriptContents;
 }
 
 void ScriptCache::scriptDownloaded() {
@@ -61,6 +66,8 @@ void ScriptCache::scriptDownloaded() {
     reply->deleteLater();
 }
 
+
+#if 0
 QString ScriptCache::getScript(const QUrl& url) {
     qDebug() << "Script requested: " << url.toString();
     QString scriptContents;
@@ -143,4 +150,6 @@ void ScriptCache::scriptDownloadedSyncronously() {
     _blockingScriptsPending.remove(url);
     qDebug() << "_blockingScriptsPending: " << _blockingScriptsPending;
 }
+
+#endif
     
diff --git a/libraries/script-engine/src/ScriptCache.h b/libraries/script-engine/src/ScriptCache.h
index 64a6ded7e8..79aa83b765 100644
--- a/libraries/script-engine/src/ScriptCache.h
+++ b/libraries/script-engine/src/ScriptCache.h
@@ -27,12 +27,14 @@ class ScriptCache : public QObject, public Dependency {
     SINGLETON_DEPENDENCY
 
 public:
-    void getScript(const QUrl& url, ScriptUser* scriptUser); // asynchronous
-    QString getScript(const QUrl& url); // blocking call
+    QString getScript(const QUrl& url, ScriptUser* scriptUser, bool& isPending); // asynchronous
+
+
+    //QString getScript(const QUrl& url); // blocking call
     
 private slots:
     void scriptDownloaded();
-    void scriptDownloadedSyncronously();
+    //void scriptDownloadedSyncronously();
 
     
 private:
diff --git a/libraries/script-engine/src/ScriptEngine.cpp b/libraries/script-engine/src/ScriptEngine.cpp
index c939e12284..3d31d280e7 100644
--- a/libraries/script-engine/src/ScriptEngine.cpp
+++ b/libraries/script-engine/src/ScriptEngine.cpp
@@ -287,8 +287,9 @@ void ScriptEngine::loadURL(const QUrl& scriptURL) {
             QNetworkReply* reply = networkAccessManager.get(networkRequest);
             connect(reply, &QNetworkReply::finished, this, &ScriptEngine::handleScriptDownload);
             */
+            bool isPending;
             auto scriptCache = DependencyManager::get<ScriptCache>();
-            scriptCache->getScript(url, this);
+            scriptCache->getScript(url, this, isPending);
             
         }
     }

From e2d8d820964f39a58f20fc2477a83867e9297209 Mon Sep 17 00:00:00 2001
From: ZappoMan <bradh@konamoxt.com>
Date: Mon, 30 Mar 2015 16:34:04 -0700
Subject: [PATCH 3/4] more script caching cleanup

---
 .../src/EntityTreeRenderer.cpp                | 16 ----
 libraries/script-engine/src/Script.cpp        | 49 ----------
 libraries/script-engine/src/Script.h          | 37 --------
 libraries/script-engine/src/ScriptCache.cpp   | 91 +------------------
 libraries/script-engine/src/ScriptCache.h     |  9 +-
 libraries/script-engine/src/ScriptEngine.cpp  | 23 -----
 libraries/script-engine/src/ScriptEngine.h    |  2 -
 7 files changed, 2 insertions(+), 225 deletions(-)
 delete mode 100644 libraries/script-engine/src/Script.cpp
 delete mode 100644 libraries/script-engine/src/Script.h

diff --git a/libraries/entities-renderer/src/EntityTreeRenderer.cpp b/libraries/entities-renderer/src/EntityTreeRenderer.cpp
index 39b26e9598..251992ffe9 100644
--- a/libraries/entities-renderer/src/EntityTreeRenderer.cpp
+++ b/libraries/entities-renderer/src/EntityTreeRenderer.cpp
@@ -165,22 +165,6 @@ QString EntityTreeRenderer::loadScriptContents(const QString& scriptMaybeURLorTe
                 qDebug() << "ERROR Loading file:" << fileName;
             }
         } else {
-            /*
-            QNetworkAccessManager& networkAccessManager = NetworkAccessManager::getInstance();
-            QNetworkRequest networkRequest = QNetworkRequest(url);
-            networkRequest.setHeader(QNetworkRequest::UserAgentHeader, HIGH_FIDELITY_USER_AGENT);
-            QNetworkReply* reply = networkAccessManager.get(networkRequest);
-            qDebug() << "Downloading script at" << url;
-            QEventLoop loop;
-            QObject::connect(reply, SIGNAL(finished()), &loop, SLOT(quit()));
-            loop.exec();
-            if (reply->error() == QNetworkReply::NoError && reply->attribute(QNetworkRequest::HttpStatusCodeAttribute) == 200) {
-                scriptContents = reply->readAll();
-            } else {
-                qDebug() << "ERROR Loading file:" << url.toString();
-            }
-            delete reply;
-            */
             auto scriptCache = DependencyManager::get<ScriptCache>();
             scriptContents = scriptCache->getScript(url, this, isPending);
         }
diff --git a/libraries/script-engine/src/Script.cpp b/libraries/script-engine/src/Script.cpp
deleted file mode 100644
index 4f5d38a2e1..0000000000
--- a/libraries/script-engine/src/Script.cpp
+++ /dev/null
@@ -1,49 +0,0 @@
-//
-//  Script.cpp
-//  libraries/script-engine/src
-//
-//  Created by Brad Hefta-Gaub on 2015-03-30
-//  Copyright 2015 High Fidelity, Inc.
-//
-//  Distributed under the Apache License, Version 2.0.
-//  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
-//
-
-/*
-#include <stdint.h>
-
-#include <glm/glm.hpp>
-
-#include <QDataStream>
-#include <QtCore/QDebug>
-#include <QtNetwork/QNetworkRequest>
-#include <QtNetwork/QNetworkReply>
-#include <qendian.h>
-
-#include <LimitedNodeList.h>
-#include <NetworkAccessManager.h>
-#include <SharedUtil.h>
-
-#include "AudioRingBuffer.h"
-#include "AudioFormat.h"
-#include "AudioBuffer.h"
-#include "AudioEditBuffer.h"
-*/
-
-#include "Script.h"
-
-Script::Script(const QUrl& url) :
-    Resource(url),
-    _isReady(false)
-{
-    
-}
-
-void Script::downloadFinished(QNetworkReply* reply) {
-    // replace our byte array with the downloaded data
-    _contents = reply->readAll();
-    qDebug() << "Script downloaded from:" << getURL();
-    _isReady = true;
-    reply->deleteLater();
-}
-
diff --git a/libraries/script-engine/src/Script.h b/libraries/script-engine/src/Script.h
deleted file mode 100644
index 6cca76a8e8..0000000000
--- a/libraries/script-engine/src/Script.h
+++ /dev/null
@@ -1,37 +0,0 @@
-//
-//  Script.h
-//  libraries/script-engine/src
-//
-//  Created by Brad Hefta-Gaub on 2015-03-30
-//  Copyright 2015 High Fidelity, Inc.
-//
-//  Distributed under the Apache License, Version 2.0.
-//  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
-//
-
-#ifndef hifi_Script_h
-#define hifi_Script_h
-
-#include <QtCore/QObject>
-#include <QtNetwork/QNetworkReply>
-#include <QtScript/qscriptengine.h>
-
-#include <ResourceCache.h>
-
-class Script : public Resource {
-    Q_OBJECT
-public:
-    Script(const QUrl& url);
-    bool isReady() const { return _isReady; }
-    const QString& getContents() { return _contents; }
-
-private:
-    QString _contents;
-    bool _isReady;
-    
-    virtual void downloadFinished(QNetworkReply* reply);
-};
-
-typedef QSharedPointer<Script> SharedScriptPointer;
-
-#endif // hifi_Script_h
diff --git a/libraries/script-engine/src/ScriptCache.cpp b/libraries/script-engine/src/ScriptCache.cpp
index aabeec99f8..c57a4f069b 100644
--- a/libraries/script-engine/src/ScriptCache.cpp
+++ b/libraries/script-engine/src/ScriptCache.cpp
@@ -24,8 +24,6 @@ ScriptCache::ScriptCache(QObject* parent) {
     // nothing to do here...
 }
 
-// QHash<QUrl, QString> _scriptCache;
-
 QString ScriptCache::getScript(const QUrl& url, ScriptUser* scriptUser, bool& isPending) {
     QString scriptContents;
     if (_scriptCache.contains(url)) {
@@ -52,8 +50,7 @@ void ScriptCache::scriptDownloaded() {
     
     if (reply->error() == QNetworkReply::NoError && reply->attribute(QNetworkRequest::HttpStatusCodeAttribute) == 200) {
         _scriptCache[url] = reply->readAll();
-        qDebug() << "_scriptCache.size:" << _scriptCache.size();
-        
+
         foreach(ScriptUser* user, scriptUsers) {
             user->scriptContentsAvailable(url, _scriptCache[url]);
         }
@@ -66,90 +63,4 @@ void ScriptCache::scriptDownloaded() {
     reply->deleteLater();
 }
 
-
-#if 0
-QString ScriptCache::getScript(const QUrl& url) {
-    qDebug() << "Script requested: " << url.toString();
-    QString scriptContents;
-    if (_scriptCache.contains(url)) {
-        qDebug() << "Script found in cache: " << url.toString();
-        scriptContents = _scriptCache[url];
-    } else {
-        qDebug() << "Script not found in cache: " << url.toString();
-        
-        if (_blockingScriptsPending.contains(url)) {
-            // if we're already downloading this script, wait for it to complete...
-            qDebug() << "Already downloading script: " << url.toString();
-            while (_blockingScriptsPending.contains(url)) {
-                QEventLoop loop;
-                qDebug() << "about to call loop.processEvents()....";
-                loop.processEvents(QEventLoop::AllEvents, 1);
-                qDebug() << "AFTER loop.processEvents()....";
-            }
-            qDebug() << "Done waiting on downloading script: " << url.toString();
-            scriptContents = _scriptCache[url];
-        } else {
-            _blockingScriptsPending.insert(url);
-            qDebug() << "_blockingScriptsPending: " << _blockingScriptsPending;
-            
-            QNetworkAccessManager& networkAccessManager = NetworkAccessManager::getInstance();
-            QNetworkRequest networkRequest = QNetworkRequest(url);
-            networkRequest.setHeader(QNetworkRequest::UserAgentHeader, HIGH_FIDELITY_USER_AGENT);
-            QNetworkReply* reply = networkAccessManager.get(networkRequest);
-
-
-            connect(reply, &QNetworkReply::finished, this, &ScriptCache::scriptDownloadedSyncronously);
-            qDebug() << "Downloading script at" << url.toString();
-            //QEventLoop loop;
-            //QObject::connect(reply, SIGNAL(finished()), &loop, SLOT(quit()));
-            //qDebug() << "starting loop....";
-            //loop.exec();
-            //qDebug() << "after loop....";
-
-            /*
-            if (reply->error() == QNetworkReply::NoError && reply->attribute(QNetworkRequest::HttpStatusCodeAttribute) == 200) {
-                scriptContents = reply->readAll();
-                _scriptCache[url] = scriptContents;
-                qDebug() << "_scriptCache.size:" << _scriptCache.size();
-            } else {
-                qDebug() << "ERROR Loading file:" << url.toString();
-            }
-            delete reply;
-            _blockingScriptsPending.remove(url);
-            qDebug() << "_blockingScriptsPending: " << _blockingScriptsPending;
-            */
-            while (_blockingScriptsPending.contains(url)) {
-                QEventLoop loop;
-                qDebug() << "about to call loop.processEvents()....";
-                loop.processEvents(QEventLoop::AllEvents, 1);
-                qDebug() << "AFTER loop.processEvents()....";
-            }
-            qDebug() << "Done waiting on downloading script: " << url.toString();
-            scriptContents = _scriptCache[url];
-        }
-    }
-    return scriptContents;
-}
-
-void ScriptCache::scriptDownloadedSyncronously() {
-
-    qDebug() << "ScriptCache::scriptDownloadedSyncronously()....";
-    
-    QNetworkReply* reply = qobject_cast<QNetworkReply*>(sender());
-    QUrl url = reply->url();
-    
-    if (reply->error() == QNetworkReply::NoError && reply->attribute(QNetworkRequest::HttpStatusCodeAttribute) == 200) {
-        _scriptCache[url] = reply->readAll();
-        qDebug() << "_scriptCache.size:" << _scriptCache.size();
-    } else {
-        qDebug() << "ERROR Loading file:" << reply->url().toString();
-    }
-    
-    reply->deleteLater();
-
-    _blockingScriptsPending.remove(url);
-    qDebug() << "_blockingScriptsPending: " << _blockingScriptsPending;
-}
-
-#endif
     
diff --git a/libraries/script-engine/src/ScriptCache.h b/libraries/script-engine/src/ScriptCache.h
index 79aa83b765..48556b4793 100644
--- a/libraries/script-engine/src/ScriptCache.h
+++ b/libraries/script-engine/src/ScriptCache.h
@@ -13,7 +13,6 @@
 #define hifi_ScriptCache_h
 
 #include <ResourceCache.h>
-#include "Script.h"
 
 class ScriptUser {
 public:
@@ -27,22 +26,16 @@ class ScriptCache : public QObject, public Dependency {
     SINGLETON_DEPENDENCY
 
 public:
-    QString getScript(const QUrl& url, ScriptUser* scriptUser, bool& isPending); // asynchronous
-
-
-    //QString getScript(const QUrl& url); // blocking call
+    QString getScript(const QUrl& url, ScriptUser* scriptUser, bool& isPending);
     
 private slots:
     void scriptDownloaded();
-    //void scriptDownloadedSyncronously();
-
     
 private:
     ScriptCache(QObject* parent = NULL);
     
     QHash<QUrl, QString> _scriptCache;
     QMultiMap<QUrl, ScriptUser*> _scriptUsers;
-    QSet<QUrl> _blockingScriptsPending;
 };
 
 #endif // hifi_ScriptCache_h
\ No newline at end of file
diff --git a/libraries/script-engine/src/ScriptEngine.cpp b/libraries/script-engine/src/ScriptEngine.cpp
index 3d31d280e7..3a75cd7187 100644
--- a/libraries/script-engine/src/ScriptEngine.cpp
+++ b/libraries/script-engine/src/ScriptEngine.cpp
@@ -280,13 +280,6 @@ void ScriptEngine::loadURL(const QUrl& scriptURL) {
                 emit errorLoadingScript(_fileNameString);
             }
         } else {
-            /*
-            QNetworkAccessManager& networkAccessManager = NetworkAccessManager::getInstance();
-            QNetworkRequest networkRequest = QNetworkRequest(url);
-            networkRequest.setHeader(QNetworkRequest::UserAgentHeader, HIGH_FIDELITY_USER_AGENT);
-            QNetworkReply* reply = networkAccessManager.get(networkRequest);
-            connect(reply, &QNetworkReply::finished, this, &ScriptEngine::handleScriptDownload);
-            */
             bool isPending;
             auto scriptCache = DependencyManager::get<ScriptCache>();
             scriptCache->getScript(url, this, isPending);
@@ -295,22 +288,6 @@ void ScriptEngine::loadURL(const QUrl& scriptURL) {
     }
 }
 
-void ScriptEngine::handleScriptDownload() {
-    /*
-    QNetworkReply* reply = qobject_cast<QNetworkReply*>(sender());
-    
-    if (reply->error() == QNetworkReply::NoError && reply->attribute(QNetworkRequest::HttpStatusCodeAttribute) == 200) {
-        _scriptContents = reply->readAll();
-        emit scriptLoaded(_fileNameString);
-    } else {
-        qDebug() << "ERROR Loading file:" << reply->url().toString();
-        emit errorLoadingScript(_fileNameString);
-    }
-    
-    reply->deleteLater();
-    */
-}
-
 void ScriptEngine::scriptContentsAvailable(const QUrl& url, const QString& scriptContents) {
     _scriptContents = scriptContents;
     emit scriptLoaded(_fileNameString);
diff --git a/libraries/script-engine/src/ScriptEngine.h b/libraries/script-engine/src/ScriptEngine.h
index ab3fdabb82..45e56850a7 100644
--- a/libraries/script-engine/src/ScriptEngine.h
+++ b/libraries/script-engine/src/ScriptEngine.h
@@ -164,8 +164,6 @@ private:
     ArrayBufferClass* _arrayBufferClass;
 
     QHash<QUuid, quint16> _outgoingScriptAudioSequenceNumbers;
-private slots:
-    void handleScriptDownload();
 
 private:
     static QSet<ScriptEngine*> _allKnownScriptEngines;

From 31072b2b2e822c16a4cb8f79bd366e3af34cebe6 Mon Sep 17 00:00:00 2001
From: ZappoMan <bradh@konamoxt.com>
Date: Mon, 30 Mar 2015 16:48:41 -0700
Subject: [PATCH 4/4] only start one download per url even if still pending

---
 .../src/EntityTreeRenderer.cpp                |  2 +-
 libraries/script-engine/src/ScriptCache.cpp   | 20 ++++++++++++++-----
 2 files changed, 16 insertions(+), 6 deletions(-)

diff --git a/libraries/entities-renderer/src/EntityTreeRenderer.cpp b/libraries/entities-renderer/src/EntityTreeRenderer.cpp
index 251992ffe9..62318ece8f 100644
--- a/libraries/entities-renderer/src/EntityTreeRenderer.cpp
+++ b/libraries/entities-renderer/src/EntityTreeRenderer.cpp
@@ -936,7 +936,7 @@ void EntityTreeRenderer::entitySciptChanging(const EntityItemID& entityID) {
 void EntityTreeRenderer::checkAndCallPreload(const EntityItemID& entityID) {
     if (_tree && !_shuttingDown) {
         // load the entity script if needed...
-        QScriptValue entityScript = loadEntityScript(entityID);
+        QScriptValue entityScript = loadEntityScript(entityID, true); // is preload!
         if (entityScript.property("preload").isValid()) {
             QScriptValueList entityArgs = createEntityArgs(entityID);
             entityScript.property("preload").call(entityScript, entityArgs);
diff --git a/libraries/script-engine/src/ScriptCache.cpp b/libraries/script-engine/src/ScriptCache.cpp
index c57a4f069b..c0ffc7b4e7 100644
--- a/libraries/script-engine/src/ScriptCache.cpp
+++ b/libraries/script-engine/src/ScriptCache.cpp
@@ -27,17 +27,26 @@ ScriptCache::ScriptCache(QObject* parent) {
 QString ScriptCache::getScript(const QUrl& url, ScriptUser* scriptUser, bool& isPending) {
     QString scriptContents;
     if (_scriptCache.contains(url)) {
+        qDebug() << "Found script in cache:" << url.toString();
         scriptContents = _scriptCache[url];
         scriptUser->scriptContentsAvailable(url, scriptContents);
         isPending = false;
     } else {
         isPending = true;
+        bool alreadyWaiting = _scriptUsers.contains(url);
         _scriptUsers.insert(url, scriptUser);
-        QNetworkAccessManager& networkAccessManager = NetworkAccessManager::getInstance();
-        QNetworkRequest networkRequest = QNetworkRequest(url);
-        networkRequest.setHeader(QNetworkRequest::UserAgentHeader, HIGH_FIDELITY_USER_AGENT);
-        QNetworkReply* reply = networkAccessManager.get(networkRequest);
-        connect(reply, &QNetworkReply::finished, this, &ScriptCache::scriptDownloaded);
+        
+        if (alreadyWaiting) {
+            qDebug() << "Already downloading script at:" << url.toString();
+        } else {
+            QNetworkAccessManager& networkAccessManager = NetworkAccessManager::getInstance();
+            QNetworkRequest networkRequest = QNetworkRequest(url);
+            networkRequest.setHeader(QNetworkRequest::UserAgentHeader, HIGH_FIDELITY_USER_AGENT);
+
+            qDebug() << "Downloading script at:" << url.toString();
+            QNetworkReply* reply = networkAccessManager.get(networkRequest);
+            connect(reply, &QNetworkReply::finished, this, &ScriptCache::scriptDownloaded);
+        }
     }
     return scriptContents;
 }
@@ -50,6 +59,7 @@ void ScriptCache::scriptDownloaded() {
     
     if (reply->error() == QNetworkReply::NoError && reply->attribute(QNetworkRequest::HttpStatusCodeAttribute) == 200) {
         _scriptCache[url] = reply->readAll();
+        qDebug() << "Done downloading script at:" << url.toString();
 
         foreach(ScriptUser* user, scriptUsers) {
             user->scriptContentsAvailable(url, _scriptCache[url]);