Merge branch master into protocol_changes

HifiExperiments committed 2 years ago

Commit ee705d21 parent f9e729b370 files · +11827 −6045Browse files

Showing the changes to libraries/script-engine/src/ScriptManager.cpp (1 of 370 files). Show all

Unified · Split

libraries/script-engine/src/ScriptManager.cpp+132−25

 QString ScriptManager::logException(const ScriptValue& exception) {
     auto message = formatException(exception, _enableExtendedJSExceptions.get());
-    scriptErrorMessage(message);
+    auto context = _engine->currentContext();
+    if (context) {
+        scriptErrorMessage(message, context->currentFileName(), context->currentLineNumber());
+    } else {
+        scriptErrorMessage(message, "", -1);
+    }
     return message;
 }
         });
     }
+    //Gather entity script messages for transmission when running server side.
+    if (_type == Type::ENTITY_SERVER) {
+        ;
+    }
     if (!_areMetaTypesInitialized) {
         initMetaTypes();
     }
             }
         }
 #else
-        auto startedWaiting = usecTimestampNow();
+        //auto startedWaiting = usecTimestampNow();
         while (!_isDoneRunning) {
             // If the final evaluation takes too long, then tell the script engine to stop running
-            auto elapsedUsecs = usecTimestampNow() - startedWaiting;
+            //auto elapsedUsecs = usecTimestampNow() - startedWaiting;
             // TODO: This part was very unsafe and was causing crashes all the time.
             //  I disabled it for now until we find a safer solution.
             //  With it disabled now we get clean shutdowns and restarts.
         }
 #endif
-        scriptInfoMessage("Script Engine has stopped:" + getFilename());
+        scriptInfoMessage("Script Engine has stopped:" + getFilename(), "", -1);
     }
 }
     return lastPart;
 }
+QString ScriptManager::getAbsoluteFilename() const {
+    return _fileNameString;
+}
 bool ScriptManager::hasValidScriptSuffix(const QString& scriptFileName) {
     QFileInfo fileInfo(scriptFileName);
     QString scriptSuffixToLower = fileInfo.completeSuffix().toLower();
     // Check that script has a supported file extension
     if (!hasValidScriptSuffix(_fileNameString)) {
-        scriptErrorMessage("File extension of file: " + _fileNameString + " is not a currently supported script type");
+        scriptErrorMessage("File extension of file: " + _fileNameString + " is not a currently supported script type", _fileNameString, -1);
         emit errorLoadingScript(_fileNameString);
         return;
     }
     scriptCache->getScriptContents(url.toString(), [this](const QString& url, const QString& scriptContents, bool isURL, bool success, const QString&status) {
         qCDebug(scriptengine) << "loadURL" << url << status << QThread::currentThread();
         if (!success) {
-            scriptErrorMessage("ERROR Loading file (" + status + "):" + url);
+            scriptErrorMessage("ERROR Loading file (" + status + "):" + url, url, -1);
             emit errorLoadingScript(_fileNameString);
             return;
         }
     }, reload, maxRetries);
 }
-void ScriptManager::scriptErrorMessage(const QString& message) {
+void ScriptManager::scriptErrorMessage(const QString& message, const QString& fileName, int lineNumber) {
     qCCritical(scriptengine, "[%s] %s", qUtf8Printable(getFilename()), qUtf8Printable(message));
     emit errorMessage(message, getFilename());
+    if (!currentEntityIdentifier.isInvalidID()) {
+        emit errorEntityMessage(message, fileName, lineNumber, currentEntityIdentifier, isEntityServerScript());
+    } else {
+        if (isEntityServerScript()) {
+            emit errorEntityMessage(message, fileName, lineNumber, EntityItemID(), isEntityServerScript());
+        }
+    }
 }
-void ScriptManager::scriptWarningMessage(const QString& message) {
+void ScriptManager::scriptWarningMessage(const QString& message, const QString& fileName, int lineNumber) {
     qCWarning(scriptengine, "[%s] %s", qUtf8Printable(getFilename()), qUtf8Printable(message));
     emit warningMessage(message, getFilename());
+    if (!currentEntityIdentifier.isInvalidID()) {
+        emit warningEntityMessage(message, fileName, lineNumber, currentEntityIdentifier, isEntityServerScript());
+    } else {
+        if (isEntityServerScript()) {
+            emit warningEntityMessage(message, fileName, lineNumber, EntityItemID(), isEntityServerScript());
+        }
+    }
 }
-void ScriptManager::scriptInfoMessage(const QString& message) {
+void ScriptManager::scriptInfoMessage(const QString& message, const QString& fileName, int lineNumber) {
     qCInfo(scriptengine, "[%s] %s", qUtf8Printable(getFilename()), qUtf8Printable(message));
     emit infoMessage(message, getFilename());
+    if (!currentEntityIdentifier.isInvalidID()) {
+        emit infoEntityMessage(message, fileName, lineNumber, currentEntityIdentifier, isEntityServerScript());
+    } else {
+        if (isEntityServerScript()) {
+            emit infoEntityMessage(message, fileName, lineNumber, EntityItemID(), isEntityServerScript());
+        }
+    }
 }
-void ScriptManager::scriptPrintedMessage(const QString& message) {
+void ScriptManager::scriptPrintedMessage(const QString& message, const QString& fileName, int lineNumber) {
     qCDebug(scriptengine, "[%s] %s", qUtf8Printable(getFilename()), qUtf8Printable(message));
     emit printedMessage(message, getFilename());
+    if (!currentEntityIdentifier.isInvalidID()) {
+        emit printedEntityMessage(message, fileName, lineNumber, currentEntityIdentifier, isEntityServerScript());
+    } else {
+        if (isEntityServerScript()) {
+            // TODO: Some callbacks like for example websockets one right now
+            // don't set currentEntityIdentifier and there doesn't seem to be easy way to add it currently
+            emit printedEntityMessage(message, fileName, lineNumber, EntityItemID(), isEntityServerScript());
+        }
+    }
 }
 void ScriptManager::clearDebugLogWindow() {
         return; // bail early - avoid setting state in init(), as evaluate() will bail too
     }
-    scriptInfoMessage("Script Engine starting:" + getFilename());
+    scriptInfoMessage("Script Engine starting:" + getFilename(), getFilename(), -1);
     if (!_isInitialized) {
         init();
             _engine->clearExceptions();
         }
     }
-    scriptInfoMessage("Script Engine stopping:" + getFilename());
+    scriptInfoMessage("Script Engine stopping:" + getFilename(), getFilename(), -1);
     stopAllTimers(); // make sure all our timers are stopped if the script is ending
     emit scriptEnding();
 void ScriptManager::timerFired() {
     if (isStopped()) {
-        scriptWarningMessage("Script.timerFired() while shutting down is ignored... parent script:" + getFilename());
+        scriptWarningMessage("Script.timerFired() while shutting down is ignored... parent script:" + getFilename(), getFilename(), -1);
         return; // bail early
     }
 QTimer* ScriptManager::setInterval(const ScriptValue& function, int intervalMS) {
     if (isStopped()) {
-        scriptWarningMessage("Script.setInterval() while shutting down is ignored... parent script:" + getFilename());
+        int lineNumber = -1;
+        QString fileName = getFilename();
+        auto context = _engine->currentContext();
+        if (context) {
+            lineNumber = context->currentLineNumber();
+            fileName = context->currentFileName();
+        }
+        scriptWarningMessage("Script.setInterval() while shutting down is ignored... parent script:" + getFilename(), fileName, lineNumber);
         return NULL; // bail early
     }
 QTimer* ScriptManager::setTimeout(const ScriptValue& function, int timeoutMS) {
     if (isStopped()) {
-        scriptWarningMessage("Script.setTimeout() while shutting down is ignored... parent script:" + getFilename());
+        int lineNumber = -1;
+        QString fileName = getFilename();
+        auto context = _engine->currentContext();
+        if (context) {
+            lineNumber = context->currentLineNumber();
+            fileName = context->currentFileName();
+        }
+        scriptWarningMessage("Script.setTimeout() while shutting down is ignored... parent script:" + getFilename(), fileName, lineNumber);
         return NULL; // bail early
     }
 }
 void ScriptManager::print(const QString& message) {
-    emit printedMessage(message, getFilename());
+    emit scriptPrintedMessage(message, getFilename(), engine()->currentContext()->currentLineNumber());
 }
         return;
     }
     if (isStopped()) {
+        int lineNumber = -1;
+        QString fileName = getFilename();
+        auto context = _engine->currentContext();
+        if (context) {
+            lineNumber = context->currentLineNumber();
+            fileName = context->currentFileName();
+        }
         scriptWarningMessage("Script.include() while shutting down is ignored... includeFiles:"
-                + includeFiles.join(",") + "parent script:" + getFilename());
+                + includeFiles.join(",") + "parent script:" + getFilename(), fileName, lineNumber);
         return; // bail early
     }
     QList<QUrl> urls;
             thisURL = expandScriptUrl(QUrl::fromLocalFile(expandScriptPath(file)));
             QUrl defaultScriptsLoc = PathUtils::defaultScriptsLocation();
             if (!defaultScriptsLoc.isParentOf(thisURL)) {
+                int lineNumber = -1;
+                QString fileName = getFilename();
+                auto context = _engine->currentContext();
+                if (context) {
+                    lineNumber = context->currentLineNumber();
+                    fileName = context->currentFileName();
+                }
                 //V8TODO this probably needs to be done per context, otherwise file cannot be included again in a module
-                scriptWarningMessage("Script.include() -- skipping" + file + "-- outside of standard libraries");
+                scriptWarningMessage("Script.include() -- skipping" + file + "-- outside of standard libraries", fileName, lineNumber);
                 continue;
             }
             isStandardLibrary = true;
         bool disallowOutsideFiles = thisURL.isLocalFile() && !isStandardLibrary && !currentSandboxURL.isLocalFile();
         if (disallowOutsideFiles && !PathUtils::isDescendantOf(thisURL, currentSandboxURL)) {
+            int lineNumber = -1;
+            QString fileName = currentSandboxURL.toString();
+            auto context = _engine->currentContext();
+            if (context) {
+                lineNumber = context->currentLineNumber();
+                fileName = context->currentFileName();
+            }
             scriptWarningMessage("Script.include() ignoring file path" + thisURL.toString()
-                                + "outside of original entity script" + currentSandboxURL.toString());
+                                + "outside of original entity script" + currentSandboxURL.toString(), fileName, lineNumber);
         } else {
             // We could also check here for CORS, but we don't yet.
             // It turns out that QUrl.resolve will not change hosts and copy authority, so we don't need to check that here.
         for (QUrl url : urls) {
             QString contents = data[url];
             if (contents.isNull()) {
-                scriptErrorMessage("Error loading file (" + status[url] +"): " + url.toString());
+                int lineNumber = -1;
+                QString fileName = url.toString();
+                auto context = _engine->currentContext();
+                if (context) {
+                    lineNumber = context->currentLineNumber();
+                    fileName = context->currentFileName();
+                }
+                scriptErrorMessage("Error loading file (" + status[url] +"): " + url.toString(), fileName, lineNumber);
             } else {
                 std::lock_guard<std::recursive_mutex> lock(_lock);
                 if (!_includedURLs.contains(url)) {
                         _engine->clearExceptions();
                     }
                 } else {
-                    scriptPrintedMessage("Script.include() skipping evaluation of previously included url:" + url.toString());
+                    int lineNumber = -1;
+                    QString fileName = url.toString();
+                    auto context = _engine->currentContext();
+                    if (context) {
+                        lineNumber = context->currentLineNumber();
+                        fileName = context->currentFileName();
+                    }
+                    scriptPrintedMessage("Script.include() skipping evaluation of previously included url:" + url.toString(), fileName, lineNumber);
                 }
             }
         }
 void ScriptManager::include(const QString& includeFile, const ScriptValue& callback) {
     if (isStopped()) {
+        int lineNumber = -1;
+        QString fileName = currentSandboxURL.toString();
+        auto context = _engine->currentContext();
+        if (context) {
+            lineNumber = context->currentLineNumber();
+            fileName = context->currentFileName();
+        }
         scriptWarningMessage("Script.include() while shutting down is ignored...  includeFile:"
-                    + includeFile + "parent script:" + getFilename());
+                    + includeFile + "parent script:" + getFilename(), fileName, lineNumber);
         return; // bail early
     }
     if (!_engine->IS_THREADSAFE_INVOCATION(__FUNCTION__)) {
         return;
     }
+    int lineNumber = -1;
+    QString fileName = getFilename();
+    auto context = _engine->currentContext();
+    if (context) {
+        lineNumber = context->currentLineNumber();
+        fileName = context->currentFileName();
+    }
     if (isStopped()) {
         scriptWarningMessage("Script.load() while shutting down is ignored... loadFile:"
-                + loadFile + "parent script:" + getFilename());
+                + loadFile + "parent script:" + getFilename(), fileName, lineNumber);
         return; // bail early
     }
     if (!currentEntityIdentifier.isInvalidID()) {
         scriptWarningMessage("Script.load() from entity script is ignored...  loadFile:"
-                + loadFile + "parent script:" + getFilename() + "entity: " + currentEntityIdentifier.toString());
+                + loadFile + "parent script:" + getFilename() + "entity: " + currentEntityIdentifier.toString(), fileName, lineNumber);
         return; // bail early
     }
         QString filePath = QUrl(details.scriptText).toLocalFile();
         auto lastModified = QFileInfo(filePath).lastModified().toMSecsSinceEpoch();
         if (lastModified > details.lastModified) {
-            scriptInfoMessage("Reloading modified script " + details.scriptText);
+            scriptInfoMessage("Reloading modified script " + details.scriptText, filePath, -1);
             loadEntityScript(entityID, details.scriptText, true);
         }
     }