qtdeclarative/tests/auto/qml/qquickworkerscript/tst_qquickworkerscript.cpp

// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only

#include <private/qmlutils_p.h>
#include <private/qqmlengine_p.h>
#include <private/qquickworkerscript_p.h>

#include <QtTest/qtest.h>

#include <QtQml/qjsengine.h>
#include <QtQml/qqmlcomponent.h>
#include <QtQml/qqmlengine.h>
#include <QtQml/qqmlnetworkaccessmanagerfactory.h>

#include <QtCore/qdebug.h>
#include <QtCore/qdir.h>
#include <QtCore/qfileinfo.h>
#include <QtCore/qregularexpression.h>
#include <QtCore/qtimer.h>

class tst_QQuickWorkerScript : public QQmlDataTest
{
    Q_OBJECT
public:
    tst_QQuickWorkerScript() : QQmlDataTest(QT_QMLTEST_DATADIR) {}
private slots:
    void source();
    void ready();
    void messaging();
    void messaging_data();
    void messaging_sendQObjectList();
    void messaging_sendJsObject();
    void messaging_sendExternalObject();
    void script_with_pragma();
    void script_included();
    void scriptError_onLoad();
    void scriptError_onCall();
    void script_function();
    void script_var();
    void stressDispose();
    void xmlHttpRequest();
    void remoteScript();

private:
    void waitForEchoMessage(QQuickWorkerScript *worker) {
        QEventLoop loop;
        QVERIFY(connect(worker, SIGNAL(done()), &loop, SLOT(quit())));
        QTimer timer;
        timer.setSingleShot(true);
        connect(&timer, SIGNAL(timeout()), &loop, SLOT(quit()));
        timer.start(10000);
        loop.exec();
        QVERIFY(timer.isActive());
    }

    QQmlEngine m_engine;
};

void tst_QQuickWorkerScript::source()
{
    QQmlComponent component(&m_engine, testFileUrl("worker.qml"));
    QScopedPointer<QQuickWorkerScript>worker(qobject_cast<QQuickWorkerScript*>(component.create()));
    QVERIFY(worker != nullptr);
    const QMetaObject *mo = worker->metaObject();

    QVariant value(100);
    QVERIFY(QMetaObject::invokeMethod(worker.data(), "testSend", Q_ARG(QVariant, value)));
    waitForEchoMessage(worker.data());
    QCOMPARE(mo->property(mo->indexOfProperty("response")).read(worker.data()).value<QVariant>(), value);

    QUrl source = testFileUrl("script_fixed_return.js");
    worker->setSource(source);
    QCOMPARE(worker->source(), source);
    QVERIFY(QMetaObject::invokeMethod(worker.data(), "testSend", Q_ARG(QVariant, value)));
    waitForEchoMessage(worker.data());
    QCOMPARE(mo->property(mo->indexOfProperty("response")).read(worker.data()).value<QVariant>(), QVariant::fromValue(QString("Hello_World")));

    source = testFileUrl("script_module.mjs");
    worker->setSource(source);
    QCOMPARE(worker->source(), source);
    QVERIFY(QMetaObject::invokeMethod(worker.data(), "testSend", Q_ARG(QVariant, value)));
    waitForEchoMessage(worker.data());
    QCOMPARE(mo->property(mo->indexOfProperty("response")).read(worker.data()).value<QVariant>(), QVariant::fromValue(QString("Hello from the module")));

    qApp->processEvents();
}

void tst_QQuickWorkerScript::ready()
{
    QQmlComponent component(&m_engine, testFileUrl("worker.qml"));
    QScopedPointer<QQuickWorkerScript>worker(qobject_cast<QQuickWorkerScript*>(component.create()));
    QVERIFY(worker != nullptr);

    const QMetaObject *mo = worker->metaObject();

    QTRY_VERIFY(worker->ready());

    QVariant readyChangedCalled = mo->property(mo->indexOfProperty("readyChangedCalled")).read(worker.data()).value<QVariant>();

    QVERIFY(!readyChangedCalled.isNull());
    QVERIFY(readyChangedCalled.toBool());
}

void tst_QQuickWorkerScript::messaging()
{
    QFETCH(QVariant, value);

    QQmlComponent component(&m_engine, testFileUrl("worker.qml"));
    std::unique_ptr<QQuickWorkerScript> worker { qobject_cast<QQuickWorkerScript*>(component.create()) };
    QVERIFY(worker);

    QVERIFY(QMetaObject::invokeMethod(worker.get(), "testSend", Q_ARG(QVariant, value)));
    waitForEchoMessage(worker.get());

    const QMetaObject *mo = worker->metaObject();
    QVariant response = mo->property(mo->indexOfProperty("response")).read(worker.get()).value<QVariant>();
    if (response.userType() == qMetaTypeId<QJSValue>())
        response = response.value<QJSValue>().toVariant();

    QCOMPARE(response, value);

    qApp->processEvents();
}

void tst_QQuickWorkerScript::messaging_data()
{
    QTest::addColumn<QVariant>("value");

    QTest::newRow("invalid") << QVariant();
    QTest::newRow("bool") << QVariant::fromValue(true);
    QTest::newRow("int") << QVariant::fromValue(1001);
    QTest::newRow("real") << QVariant::fromValue(10334.375);
    QTest::newRow("string") << QVariant::fromValue(QString("More cheeeese, Gromit!"));
    QTest::newRow("variant list") << QVariant::fromValue((QVariantList() << "a" << "b" << "c"));
    QTest::newRow("date time") << QVariant::fromValue(QDateTime::currentDateTime());
    QTest::newRow("regularexpression") << QVariant::fromValue(QRegularExpression(
            "^\\d\\d?$", QRegularExpression::CaseInsensitiveOption));
    QTest::newRow("url") << QVariant::fromValue(QUrl("http://example.com/foo/bar"));
}

void tst_QQuickWorkerScript::messaging_sendQObjectList()
{
    // Not allowed to send QObjects other than QQmlListModelWorkerAgent
    // instances. If objects are sent in a list, they will be sent as 'undefined'
    // js values.

    QQmlComponent component(&m_engine, testFileUrl("worker.qml"));
    std::unique_ptr<QQuickWorkerScript> worker { qobject_cast<QQuickWorkerScript*>(component.create()) };
    QVERIFY(worker);

    QVariantList objects;
    for (int i=0; i<3; i++)
        objects << QVariant::fromValue(new QObject(this));

    QVERIFY(QMetaObject::invokeMethod(worker.get(), "testSend", Q_ARG(QVariant, QVariant::fromValue(objects))));
    waitForEchoMessage(worker.get());

    const QMetaObject *mo = worker->metaObject();
    QVariantList result = mo->property(mo->indexOfProperty("response")).read(worker.get()).value<QVariantList>();
    QCOMPARE(result, (QVariantList() << QVariant() << QVariant() << QVariant()));

    qApp->processEvents();
}

void tst_QQuickWorkerScript::messaging_sendJsObject()
{
    QQmlComponent component(&m_engine, testFileUrl("worker.qml"));
    std::unique_ptr<QQuickWorkerScript> worker { qobject_cast<QQuickWorkerScript*>(component.create()) };
    QVERIFY(worker);

    // Properties are in alphabetical order to enable string-based comparison after
    // QVariant roundtrip, since the properties will be stored in a QVariantMap.
    QString jsObject = "{'haste': 1125, 'name': 'zyz', 'spell power': 3101}";

    QVariantMap map;
    map.insert("haste", 1125);
    map.insert("name", "zyz");
    map.insert("spell power", 3101);

    QVERIFY(QMetaObject::invokeMethod(worker.get(), "testSend", Q_ARG(QVariant, QVariant::fromValue(map))));
    waitForEchoMessage(worker.get());

    QVariant result = QVariant::fromValue(false);
    QVERIFY(QMetaObject::invokeMethod(worker.get(), "compareLiteralResponse", Qt::DirectConnection,
            Q_RETURN_ARG(QVariant, result), Q_ARG(QVariant, jsObject)));
    QVERIFY(result.toBool());

    qApp->processEvents();
}

void tst_QQuickWorkerScript::messaging_sendExternalObject()
{
    QQmlComponent component(&m_engine, testFileUrl("externalObjectWorker.qml"));
    std::unique_ptr<QObject> obj { component.create() };
    QVERIFY(obj.get());
    QMetaObject::invokeMethod(obj.get(), "testExternalObject");
    QTest::qWait(100); // shouldn't crash.
}

void tst_QQuickWorkerScript::script_with_pragma()
{
    QVariant value(100);

    QQmlComponent component(&m_engine, testFileUrl("worker_pragma.qml"));
    std::unique_ptr<QQuickWorkerScript> worker { qobject_cast<QQuickWorkerScript*>(component.create()) };
    QVERIFY(worker);

    QVERIFY(QMetaObject::invokeMethod(worker.get(), "testSend", Q_ARG(QVariant, value)));
    waitForEchoMessage(worker.get());

    const QMetaObject *mo = worker->metaObject();
    QCOMPARE(mo->property(mo->indexOfProperty("response")).read(worker.get()).value<QVariant>(), value);

    qApp->processEvents();
}

void tst_QQuickWorkerScript::script_included()
{
    QQmlComponent component(&m_engine, testFileUrl("worker_include.qml"));
    std::unique_ptr<QQuickWorkerScript> worker { qobject_cast<QQuickWorkerScript*>(component.create()) };
    QVERIFY(worker);

    QString value("Hello");

    QVERIFY(QMetaObject::invokeMethod(worker.get(), "testSend", Q_ARG(QVariant, value)));
    waitForEchoMessage(worker.get());

    const QMetaObject *mo = worker->metaObject();
    QCOMPARE(mo->property(mo->indexOfProperty("response")).read(worker.get()).toString(), value + " World");

    qApp->processEvents();
}

static QString qquickworkerscript_lastWarning;
static void qquickworkerscript_warningsHandler(QtMsgType type, const QMessageLogContext &, const QString &msg)
{
    if (type == QtWarningMsg)
         qquickworkerscript_lastWarning = msg;
}

void tst_QQuickWorkerScript::scriptError_onLoad()
{
    QQmlComponent component(&m_engine, testFileUrl("worker_error_onLoad.qml"));

    QtMessageHandler previousMsgHandler = qInstallMessageHandler(qquickworkerscript_warningsHandler);
    std::unique_ptr<QQuickWorkerScript> worker { qobject_cast<QQuickWorkerScript*>(component.create()) };
    QVERIFY(worker);

    QTRY_COMPARE(qquickworkerscript_lastWarning,
            testFileUrl("script_error_onLoad.js").toString() + QLatin1String(":3:10: SyntaxError: Expected token `,'"));

    qInstallMessageHandler(previousMsgHandler);
    qApp->processEvents();
}

void tst_QQuickWorkerScript::scriptError_onCall()
{
    QQmlComponent component(&m_engine, testFileUrl("worker_error_onCall.qml"));
    std::unique_ptr<QQuickWorkerScript> worker { qobject_cast<QQuickWorkerScript*>(component.create()) };
    QVERIFY(worker);

    QtMessageHandler previousMsgHandler = qInstallMessageHandler(qquickworkerscript_warningsHandler);
    QVariant value;
    QVERIFY(QMetaObject::invokeMethod(worker.get(), "testSend", Q_ARG(QVariant, value)));

    QTRY_COMPARE(qquickworkerscript_lastWarning,
            testFileUrl("script_error_onCall.js").toString() + QLatin1String(":4: ReferenceError: getData is not defined"));

    qInstallMessageHandler(previousMsgHandler);
    qApp->processEvents();
}

void tst_QQuickWorkerScript::script_function()
{
    QQmlComponent component(&m_engine, testFileUrl("worker_function.qml"));
    std::unique_ptr<QQuickWorkerScript> worker { qobject_cast<QQuickWorkerScript*>(component.create()) };
    QVERIFY(worker);

    QString value("Hello");

    QVERIFY(QMetaObject::invokeMethod(worker.get(), "testSend", Q_ARG(QVariant, value)));
    waitForEchoMessage(worker.get());

    const QMetaObject *mo = worker->metaObject();
    QCOMPARE(mo->property(mo->indexOfProperty("response")).read(worker.get()).toString(), value + " World");

    qApp->processEvents();
}

void tst_QQuickWorkerScript::script_var()
{
    QQmlComponent component(&m_engine, testFileUrl("worker_var.qml"));
    std::unique_ptr<QQuickWorkerScript> worker { qobject_cast<QQuickWorkerScript*>(component.create()) };
    QVERIFY(worker);

    QString value("Hello");

    QVERIFY(QMetaObject::invokeMethod(worker.get(), "testSend", Q_ARG(QVariant, value)));
    waitForEchoMessage(worker.get());

    const QMetaObject *mo = worker->metaObject();
    QCOMPARE(mo->property(mo->indexOfProperty("response")).read(worker.get()).toString(), value + " World");

    qApp->processEvents();
}

// Rapidly create and destroy worker scripts to test resources are being disposed
// in the correct isolate
void tst_QQuickWorkerScript::stressDispose()
{
    for (int ii = 0; ii < 100; ++ii) {
        QQmlEngine engine;
        QQmlComponent component(&engine, testFileUrl("stressDispose.qml"));
        std::unique_ptr<QObject> o { component.create() };
        QVERIFY(o.get());
    }
}

void tst_QQuickWorkerScript::xmlHttpRequest()
{
    QQmlComponent component(&m_engine, testFileUrl("xmlHttpRequest.qml"));
    QScopedPointer<QObject> root{component.create()}; // should not crash
    QVERIFY(root);
}


class DebugStrippingNAM : public QNetworkAccessManager
{
public:
    DebugStrippingNAM(const QString &replacementScheme, QObject *parent = nullptr)
        : QNetworkAccessManager(parent)
        , replacementScheme(replacementScheme)
    {}

protected:
    QNetworkReply *createRequest(
            Operation op, const QNetworkRequest &request, QIODevice *outgoingData) final
    {
        QUrl url = request.url();
        if (request.url().scheme() != "debug")
            return QNetworkAccessManager::createRequest(op, request, outgoingData);

        QNetworkRequest rewritten = request;
        url.setScheme(replacementScheme);
        rewritten.setUrl(url);
        return QNetworkAccessManager::createRequest(op, rewritten, outgoingData);
    }

private:
    QString replacementScheme;
};

class DebugStrippingNAMF : public QQmlNetworkAccessManagerFactory
{
public:
    DebugStrippingNAMF(const QString &replacementScheme)
        : replacementScheme(replacementScheme)
    {}

    QNetworkAccessManager *create(QObject *parent) final
    {
        return new DebugStrippingNAM(replacementScheme, parent);
    }

private:
    QString replacementScheme;
};

void tst_QQuickWorkerScript::remoteScript()
{
    QUrl url = testFileUrl("remoteScript.qml");
    DebugStrippingNAMF factory(url.scheme());

    QQmlEngine engine;
    engine.setNetworkAccessManagerFactory(&factory);

    url.setScheme("debug");
    QQmlComponent c(&engine, url);
    QTRY_VERIFY2(c.isReady(), qPrintable(c.errorString()));

    QTest::ignoreMessage(QtDebugMsg, "received");
    QScopedPointer<QObject> o(c.create());
    QVERIFY(!o.isNull());

    QTRY_VERIFY(o->property("ready").toBool());
    QTRY_COMPARE(o->objectName(), "remote script running");
}

QTEST_MAIN(tst_QQuickWorkerScript)

#include "tst_qquickworkerscript.moc"