VPN-5472: Merge Mozilla.Shared.qmlcomponents into Mozilla.VPN module (#…

…8843) * QML: Merge Mozilla.Share.qmlcomponents into Mozilla.VPN modules * Move MZFilterProxyModel into nebula * Create Mozilla.VPN.ui qml module and move composer classes into it * Merge Mozilla.VPN and Mozilla.VPN.ui and use QML_FOREIGN for singletons * Register MZAddonMessage type through UI module * Add VPNAndroidUtils singleton too * Move MZComposerView back into nebula * Make VPNProducts a singleton too
mozilla-mobile · Jan 30, 2024 · 2d45b94 · 2d45b94
1 parent 4c93a66
commit 2d45b94
Show file tree

Hide file tree

Showing 68 changed files with 731 additions and 182 deletions.
diff --git a/nebula/ui/components/CMakeLists.txt b/nebula/ui/components/CMakeLists.txt
@@ -25,6 +25,7 @@ qt_add_qml_module(components
          MZChevron.qml
          MZClickableRow.qml
          MZCollapsibleCard.qml
+         MZComposerView.qml
          MZDropShadowWithStates.qml
          MZExternalLinkListItem.qml
          MZFlickable.qml
@@ -82,7 +83,6 @@ qt_add_qml_module(components
          MZSwipeDelegate.qml
          MZSwipeAction.qml
          MZBadge.qml
-         MZComposerView.qml
          MZPasteButton.qml
          MZInformationCard.qml
          MZStepProgressBar.qml
@@ -92,6 +92,9 @@ qt_add_qml_module(components
          navigationBar/MZBottomNavigationBarButton.qml
          navigator/MZNavigatorLoader.qml
          navigator/navigatorLoaderInternal.qml
+    SOURCES
+        filterproxymodel.cpp
+        filterproxymodel.h
 )
 
 add_subdirectory(forms)

diff --git a/nebula/ui/components/MZComposerView.qml b/nebula/ui/components/MZComposerView.qml
@@ -6,7 +6,7 @@ import QtQuick 2.15
 import QtQuick.Layouts 1.15
 
 import Mozilla.Shared 1.0
-import Mozilla.Shared.qmlcomponents 1.0
+import Mozilla.VPN 1.0
 import components 0.1
 
 ColumnLayout {

diff --git a/nebula/ui/components/MZGuideList.qml b/nebula/ui/components/MZGuideList.qml
@@ -6,7 +6,7 @@ import QtQuick 2.15
 import QtQuick.Layouts 1.15
 
 import Mozilla.Shared 1.0
-import Mozilla.Shared.qmlcomponents 1.0
+import Mozilla.VPN 1.0
 import components 0.1
 
 GridLayout {

diff --git a/src/filterproxymodel.cpp → nebula/ui/components/filterproxymodel.cpp b/src/filterproxymodel.cpp → nebula/ui/components/filterproxymodel.cpp
@@ -4,12 +4,9 @@
 
 #include "filterproxymodel.h"
 
-#include "logger.h"
-#include "qmlengineholder.h"
-
-namespace {
-Logger logger("FilterProxyModel");
-}
+#include <QDebug>
+#include <QQmlEngine>
+#include <QtQml>
 
 FilterProxyModel::FilterProxyModel(QObject* parent)
     : QSortFilterProxyModel(parent) {}
@@ -18,8 +15,7 @@ QJSValue FilterProxyModel::filterCallback() const { return m_filterCallback; }
 
 void FilterProxyModel::setFilterCallback(QJSValue filterCallback) {
   if (!filterCallback.isCallable()) {
-    logger.error()
-        << "FilterProxyModel.filterCallback must be a JS callable value";
+    qWarning() << "FilterProxyModel.filterCallback must be a JS callable value";
     return;
   }
 
@@ -33,8 +29,7 @@ QJSValue FilterProxyModel::sortCallback() const { return m_sortCallback; }
 
 void FilterProxyModel::setSortCallback(QJSValue sortCallback) {
   if (!sortCallback.isCallable()) {
-    logger.error()
-        << "FilterProxyModel.sortCallback must be a JS callable value";
+    qWarning() << "FilterProxyModel.sortCallback must be a JS callable value";
     return;
   }
 
@@ -81,7 +76,7 @@ bool FilterProxyModel::filterAcceptsRow(
   }
 
   if (m_filterCallback.isNull() || m_filterCallback.isUndefined()) {
-    logger.debug() << "No filter callback set!";
+    qDebug() << "No filter callback set!";
     return true;
   }
 
@@ -92,19 +87,14 @@ bool FilterProxyModel::filterAcceptsRow(
     return false;
   }
 
-  if (!QmlEngineHolder::exists()) {
-    logger.error() << "Something bad is happening. Are we shutting down?";
-    return false;
-  }
-
   QJSValue value = dataToJSValue(sourceModel(), index);
 
   QJSValueList arguments;
   arguments.append(value);
 
   QJSValue retValue = m_filterCallback.call(arguments);
   if (retValue.isError()) {
-    logger.debug() << "Execution throws an error:" << retValue.toString();
+    qDebug() << "Execution throws an error:" << retValue.toString();
     return false;
   }
 
@@ -123,11 +113,6 @@ bool FilterProxyModel::lessThan(const QModelIndex& left,
 
   Q_ASSERT(m_sortCallback.isCallable());
 
-  if (!QmlEngineHolder::exists()) {
-    logger.error() << "Something bad is happening. Are we shutting down?";
-    return false;
-  }
-
   QJSValue valueA = dataToJSValue(sourceModel(), left);
   QJSValue valueB = dataToJSValue(sourceModel(), right);
 
@@ -137,7 +122,7 @@ bool FilterProxyModel::lessThan(const QModelIndex& left,
 
   QJSValue retValue = m_sortCallback.call(arguments);
   if (retValue.isError()) {
-    logger.debug() << "Execution throws an error:" << retValue.toString();
+    qDebug() << "Execution throws an error:" << retValue.toString();
     return false;
   }
 
@@ -157,8 +142,10 @@ void FilterProxyModel::componentComplete() {
 
 QJSValue FilterProxyModel::dataToJSValue(const QAbstractItemModel* model,
                                          const QModelIndex& index) const {
-  QJSEngine* engine = QmlEngineHolder::instance()->engine();
-  Q_ASSERT(engine);
+  QQmlEngine* engine = qmlEngine(this);
+  if (engine == nullptr) {
+    return QJSValue(QJSValue::UndefinedValue);
+  }
 
   QJSValue value = engine->newObject();
   Q_ASSERT(value.isObject());

diff --git a/src/filterproxymodel.h → nebula/ui/components/filterproxymodel.h b/src/filterproxymodel.h → nebula/ui/components/filterproxymodel.h
diff --git a/nebula/ui/components/forms/MZSearchBar.qml b/nebula/ui/components/forms/MZSearchBar.qml
@@ -6,7 +6,7 @@ import QtQuick 2.0
 import QtQuick.Layouts 1.14
 
 import Mozilla.Shared 1.0
-import Mozilla.Shared.qmlcomponents 1.0
+import Mozilla.VPN 1.0
 import components 0.1
 import components.forms 0.1
 

diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt
@@ -61,9 +61,7 @@ if(NOT CMAKE_CROSSCOMPILING)
     target_compile_definitions(mozillavpn PUBLIC MVPN_WEBEXTENSION)
 endif()
 
-qt6_add_qml_module(mozillavpn
-  URI Mozilla.Shared.qmlcomponents
-  VERSION 1.0
-)
+add_subdirectory(ui)
+target_link_libraries(mozillavpn PRIVATE mozillavpn-ui mozillavpn-uiplugin)
 
 qt_finalize_target(mozillavpn)
diff --git a/src/addons/addon.h b/src/addons/addon.h
@@ -9,14 +9,13 @@
 #include <QObject>
 #include <QTranslator>
 
-#include "settings/settinggroup.h"
-#include "settingsholder.h"
 #include "state/addonstate.h"
 
 class AddonConditionWatcher;
 class QJsonObject;
 
 class AddonApi;
+class SettingGroup;
 
 // A settings group that will contain all settings related to individual addons.
 constexpr const char* ADDON_SETTINGS_GROUP = "addon";

diff --git a/src/addons/addonguide.h b/src/addons/addonguide.h
@@ -5,9 +5,9 @@
 #ifndef ADDONGUIDE_H
 #define ADDONGUIDE_H
 
-#include "../composer/composer.h"
 #include "addon.h"
 #include "addonproperty.h"
+#include "composer.h"
 
 class QJsonObject;
 

diff --git a/src/addons/addonmessage.h b/src/addons/addonmessage.h
@@ -5,12 +5,12 @@
 #ifndef ADDONMESSAGE_H
 #define ADDONMESSAGE_H
 
-#include "../composer/composer.h"
 #include "addon.h"
 #include "addonproperty.h"
-#include "settingsholder.h"
+#include "composer.h"
 
 class QJsonObject;
+class SettingGroup;
 
 #ifdef UNIT_TEST
 class TestAddon;
@@ -22,8 +22,6 @@ constexpr const char* ADDON_MESSAGE_SETTINGS_STATUS_KEY = "state";
 class AddonMessage final : public Addon {
   Q_OBJECT
   Q_DISABLE_COPY_MOVE(AddonMessage)
-  QML_NAMED_ELEMENT(MZAddonMessage)
-  QML_UNCREATABLE("")
 
  public:
   ADDON_PROPERTY(title, m_title, getTitle, setTitle, retranslationCompleted)

diff --git a/src/cmake/sentry.cmake b/src/cmake/sentry.cmake
@@ -26,6 +26,8 @@ if( ${_SUPPORTED} GREATER -1 )
     target_compile_definitions(shared-sources INTERFACE SENTRY_ENABLED)
     # Let's the app know we need to provide the upload client
     target_compile_definitions(shared-sources INTERFACE SENTRY_NONE_TRANSPORT)
+    # We need QML private headers for QML backtracing.
+    target_link_libraries(shared-sources INTERFACE Qt6::QmlPrivate)
 
     # Sentry support is given
     target_sources(shared-sources INTERFACE

diff --git a/src/cmake/shared-sources.cmake b/src/cmake/shared-sources.cmake
@@ -83,20 +83,6 @@ target_sources(shared-sources INTERFACE
     ${CMAKE_SOURCE_DIR}/src/authenticationlistener.h
     ${CMAKE_SOURCE_DIR}/src/collator.cpp
     ${CMAKE_SOURCE_DIR}/src/collator.h
-    ${CMAKE_SOURCE_DIR}/src/composer/composer.cpp
-    ${CMAKE_SOURCE_DIR}/src/composer/composer.h
-    ${CMAKE_SOURCE_DIR}/src/composer/composerblock.cpp
-    ${CMAKE_SOURCE_DIR}/src/composer/composerblock.h
-    ${CMAKE_SOURCE_DIR}/src/composer/composerblockbutton.cpp
-    ${CMAKE_SOURCE_DIR}/src/composer/composerblockbutton.h
-    ${CMAKE_SOURCE_DIR}/src/composer/composerblockorderedlist.cpp
-    ${CMAKE_SOURCE_DIR}/src/composer/composerblockorderedlist.h
-    ${CMAKE_SOURCE_DIR}/src/composer/composerblocktext.cpp
-    ${CMAKE_SOURCE_DIR}/src/composer/composerblocktext.h
-    ${CMAKE_SOURCE_DIR}/src/composer/composerblocktitle.cpp
-    ${CMAKE_SOURCE_DIR}/src/composer/composerblocktitle.h
-    ${CMAKE_SOURCE_DIR}/src/composer/composerblockunorderedlist.cpp
-    ${CMAKE_SOURCE_DIR}/src/composer/composerblockunorderedlist.h
     ${CMAKE_SOURCE_DIR}/src/cryptosettings.cpp
     ${CMAKE_SOURCE_DIR}/src/cryptosettings.h
     ${CMAKE_SOURCE_DIR}/src/curve25519.cpp
@@ -107,8 +93,6 @@ target_sources(shared-sources INTERFACE
     ${CMAKE_SOURCE_DIR}/src/errorhandler.h
     ${CMAKE_SOURCE_DIR}/src/feature/feature.cpp
     ${CMAKE_SOURCE_DIR}/src/feature/feature.h
-    ${CMAKE_SOURCE_DIR}/src/filterproxymodel.cpp
-    ${CMAKE_SOURCE_DIR}/src/filterproxymodel.h
     ${CMAKE_SOURCE_DIR}/src/fontloader.cpp
     ${CMAKE_SOURCE_DIR}/src/fontloader.h
     ${CMAKE_SOURCE_DIR}/src/frontend/navigator.cpp

diff --git a/src/commands/commandui.cpp b/src/commands/commandui.cpp
@@ -309,61 +309,6 @@ int CommandUI::run(QStringList& tokens) {
       engine->addImageProvider(QString("app"), provider);
     }
 
-    qmlRegisterSingletonInstance("Mozilla.VPN", 1, 0, "VPN",
-                                 MozillaVPN::instance());
-    qmlRegisterSingletonInstance(
-        "Mozilla.VPN", 1, 0, "VPNCaptivePortal",
-        MozillaVPN::instance()->captivePortalDetection());
-    qmlRegisterSingletonInstance("Mozilla.VPN", 1, 0, "VPNController",
-                                 MozillaVPN::instance()->controller());
-    qmlRegisterSingletonInstance("Mozilla.VPN", 1, 0, "VPNUser",
-                                 MozillaVPN::instance()->user());
-    qmlRegisterSingletonInstance("Mozilla.VPN", 1, 0, "VPNDeviceModel",
-                                 MozillaVPN::instance()->deviceModel());
-
-    qmlRegisterSingletonInstance("Mozilla.VPN", 1, 0,
-                                 "VPNRecentConnectionsModel",
-                                 RecentConnections::instance());
-    qmlRegisterSingletonInstance("Mozilla.VPN", 1, 0,
-                                 "VPNRecommendedLocationModel",
-                                 RecommendedLocationModel::instance());
-    qmlRegisterSingletonInstance(
-        "Mozilla.VPN", 1, 0, "VPNSupportCategoryModel",
-        MozillaVPN::instance()->supportCategoryModel());
-    qmlRegisterSingletonInstance("Mozilla.VPN", 1, 0, "VPNServerCountryModel",
-                                 MozillaVPN::instance()->serverCountryModel());
-    qmlRegisterSingletonInstance("Mozilla.VPN", 1, 0, "VPNSubscriptionData",
-                                 MozillaVPN::instance()->subscriptionData());
-    qmlRegisterSingletonInstance("Mozilla.VPN", 1, 0, "VPNProfileFlow",
-                                 MozillaVPN::instance()->profileFlow());
-    qmlRegisterSingletonInstance("Mozilla.VPN", 1, 0, "VPNCurrentServer",
-                                 MozillaVPN::instance()->serverData());
-    qmlRegisterSingletonInstance("Mozilla.VPN", 1, 0, "VPNServerLatency",
-                                 MozillaVPN::instance()->serverLatency());
-    qmlRegisterSingletonInstance("Mozilla.VPN", 1, 0, "VPNConnectionHealth",
-                                 MozillaVPN::instance()->connectionHealth());
-    qmlRegisterSingletonInstance("Mozilla.VPN", 1, 0, "VPNReleaseMonitor",
-                                 MozillaVPN::instance()->releaseMonitor());
-    qmlRegisterSingletonInstance("Mozilla.VPN", 1, 0, "VPNAppPermissions",
-                                 AppPermission::instance());
-    qmlRegisterSingletonInstance("Mozilla.VPN", 1, 0, "VPNConnectionBenchmark",
-                                 MozillaVPN::instance()->connectionBenchmark());
-    qmlRegisterSingletonInstance("Mozilla.VPN", 1, 0, "VPNIPAddressLookup",
-                                 MozillaVPN::instance()->ipAddressLookup());
-
-#ifdef MZ_ANDROID
-    qmlRegisterSingletonInstance("Mozilla.VPN", 1, 0, "VPNAndroidUtils",
-                                 AndroidUtils::instance());
-#endif
-
-    qmlRegisterSingletonInstance("Mozilla.VPN", 1, 0, "VPNPurchase",
-                                 PurchaseHandler::instance());
-
-    if (!Feature::get(Feature::Feature_webPurchase)->isSupported()) {
-      qmlRegisterSingletonInstance("Mozilla.VPN", 1, 0, "VPNProducts",
-                                   ProductsHandler::instance());
-    }
-
     qmlRegisterSingletonInstance("Mozilla.Shared", 1, 0,
                                  "MZAccessibleNotification",
                                  AccessibleNotification::instance());

diff --git a/src/connectionhealth.cpp b/src/connectionhealth.cpp
@@ -8,6 +8,7 @@
 #include <QDateTime>
 #include <QRandomGenerator>
 
+#include "constants.h"
 #include "controller.h"
 #include "glean/generated/metrics.h"
 #include "leakdetector.h"
@@ -262,3 +263,15 @@ void ConnectionHealth::applicationStateChanged(Qt::ApplicationState state) {
   }
 #endif
 }
+
+void ConnectionHealth::overwriteStabilityForInspector(
+    ConnectionStability stability) {
+  if (Constants::inProduction()) {
+    qFatal(
+        "Connection health stability mode can only be overwritten in Dev "
+        "mode!");
+  }
+  m_stabilityOverwritten = true;
+  m_stability = stability;
+  emit stabilityChanged();
+}
diff --git a/src/connectionhealth.h b/src/connectionhealth.h
@@ -5,7 +5,6 @@
 #ifndef CONNECTIONHEALTH_H
 #define CONNECTIONHEALTH_H
 
-#include "constants.h"
 #include "dnspingsender.h"
 #include "pinghelper.h"
 
@@ -58,16 +57,7 @@ class ConnectionHealth final : public QObject {
 
   ConnectionStability stability() const { return m_stability; }
 
-  void overwriteStabilityForInspector(ConnectionStability stability) {
-    if (Constants::inProduction()) {
-      qFatal(
-          "Connection health stability mode can only be overwritten in Dev "
-          "mode!");
-    }
-    m_stabilityOverwritten = true;
-    m_stability = stability;
-    emit stabilityChanged();
-  }
+  void overwriteStabilityForInspector(ConnectionStability stability);
 
   uint latency() const { return m_pingHelper.latency(); }
   double loss() const { return m_pingHelper.loss(); }

diff --git a/src/mozillavpn.cpp b/src/mozillavpn.cpp
@@ -191,9 +191,7 @@ MozillaVPN::MozillaVPN() : App(nullptr), m_private(new MozillaVPNPrivate()) {
           &m_private->m_connectionHealth,
           &ConnectionHealth::connectionStateChanged);
 
-  if (!Feature::get(Feature::Feature_webPurchase)->isSupported()) {
-    ProductsHandler::createInstance();
-  }
+  ProductsHandler::createInstance();
   PurchaseHandler* purchaseHandler = PurchaseHandler::createInstance();
   connect(purchaseHandler, &PurchaseHandler::subscriptionStarted, this,
           &MozillaVPN::subscriptionStarted);

diff --git a/src/productshandler.cpp b/src/productshandler.cpp
@@ -44,6 +44,11 @@ ProductsHandler::ProductsHandler(QObject* parent) : QAbstractListModel(parent) {
   Q_ASSERT(!s_instance);
   s_instance = this;
 
+  // If web purchases are supported, then we don't need to do anything.
+  if (Feature::get(Feature::Feature_webPurchase)->isSupported()) {
+    return;
+  }
+
   // On iAP make sure the Products are loaded in time.
   // If we Move into any State adjecent to iAP - load the
   // products if we don't have that already.