VPN-5290 - Add a 'never' option to reccomended serverlist (#11261)

Author: strseb

scripts/utils/generate_strings.py

@@ -94,6 +94,15 @@ def parseYAMLTranslationStrings(yamlfile):
                     value = [obj]
 
                 elif type(obj) is dict:
+                    allowed_keys = {"value", "comment"}
+                    unknown_keys = set(obj.keys()) - allowed_keys
+                    if unknown_keys:
+                        exit(
+                            f"The key {string_id} contains unknown field(s) "
+                            f"{sorted(unknown_keys)}. Allowed fields: "
+                            f"{sorted(allowed_keys)}"
+                        )
+
                     if not ("value" in obj):
                         exit(
                             f"The key {string_id} must contain a `value` string or an array of strings"

src/models/recommendedlocationmodel.cpp

@@ -159,7 +159,8 @@ QVariant RecommendedLocationModel::data(const QModelIndex& index,
 }
 
 void RecommendedLocationModel::maybeRefreshModel() {
-  if (!MozillaVPN::instance()->serverLatency()->isActive()) {
+  if (MozillaVPN::instance()->serverLatency()->state() !=
+      ServerLatency::Loading) {
     if (m_timer.isActive()) {
       m_timer.stop();
       refreshModel();

src/qmlengineholder.cpp

@@ -4,6 +4,7 @@
 
 #include "qmlengineholder.h"
 
+#include <QApplication>
 #include <QNetworkAccessManager>
 #include <QQmlApplicationEngine>
 #include <QQmlNetworkAccessManagerFactory>

src/serverlatency.h

@@ -21,7 +21,7 @@ class ServerLatency final : public QObject {
   Q_PROPERTY(
       QDateTime lastUpdateTime READ lastUpdateTime NOTIFY progressChanged)
   Q_PROPERTY(qint64 avgLatency READ avgLatency NOTIFY progressChanged)
-  Q_PROPERTY(bool isActive READ isActive NOTIFY progressChanged)
+  Q_PROPERTY(State state READ state NOTIFY progressChanged)
   Q_PROPERTY(double progress READ progress NOTIFY progressChanged)
 
  public:
@@ -38,8 +38,19 @@ class ServerLatency final : public QObject {
   };
   Q_ENUM(ConnectionScores);
 
+  enum State {
+    Initial,
+    Loading,
+    Loaded,
+  };
+  Q_ENUM(State);
+
   const QDateTime& lastUpdateTime() const { return m_lastUpdateTime; }
-  bool isActive() const { return m_pingSender != nullptr; }
+  State state() const {
+    if (m_pingSender != nullptr) return Loading;
+    if (m_lastUpdateTime.isValid()) return Loaded;
+    return Initial;
+  }
   double progress() const;
 
   qint64 avgLatency() const;

src/translations/strings.yaml

@@ -94,6 +94,12 @@ serversView:
     value: "Last updated: %1. To update this list please disconnect from the VPN."
     comment: The time (or in extremely rare circumstances, the date, day of the week, or "yesterday") which the recommended servers list was last updated and instructions to re-enable the refresh button. Argument is the time or date/day
   recommendedRefreshLastUpdatedLabelYesterday: yesterday
+  recommendedRefreshNoUpdateLabel:
+    value: Tap to update
+    comment: Label next to the refresh button shown when the recommended list has never been updated yet. The whole row is clickable and tapping triggers an update.
+  recommendedRefreshNoUpdateDisabledLabel:
+    value: Disconnect from the VPN to update this list.
+    comment: Label next to the refresh button shown when the recommended list has never been updated yet but the user is connected to the VPN, so cannot update yet.
   serverCityWithGoodConnection:
     value: "%1. Good connectivity"
     comment: Button label that reads out a city name whose connection is good. Argument is the city name.
@@ -463,7 +469,7 @@ connectionInfo:
     comment: Label for the upload benchmark shown in the speed test view.
   unitPing:
     value: ms
-    commnent: milliseconds
+    comment: milliseconds
   loadingIndicatorLabel:
     value: Testing speed…
     comment: Shown to the user while waiting for the connection speed test results

src/ui/screens/home/servers/ServerList.qml

@@ -112,7 +112,7 @@ FocusScope {
             Loader {
                 id: serverListRecommendedEmptyLoader
 
-                active: VPNRecommendedLocationModel.rowCount() === 0 && !VPNServerLatency.isActive
+                active: VPNRecommendedLocationModel.rowCount() === 0 && VPNServerLatency.state !== VPNServerLatency.Loading
                 anchors.fill: parent
                 sourceComponent: ColumnLayout {
 
@@ -157,7 +157,7 @@ FocusScope {
 
                 anchors.fill: parent
 
-                active: VPNRecommendedLocationModel.rowCount() > 0 || VPNServerLatency.isActive
+                active: VPNRecommendedLocationModel.rowCount() > 0 || VPNServerLatency.state === VPNServerLatency.Loading
                 sourceComponent: Column {
                     objectName: "serverListRecommended"
 
@@ -183,7 +183,7 @@ FocusScope {
                         accessibleName: statusTitle.text + '. ' + MZI18n.ServersViewRecommendedRefreshLabel
                         canGrowVertical: true
                         height: statusTitle.implicitHeight + MZTheme.theme.vSpacingSmall
-                        rowShouldBeDisabled: !(VPNController.state === VPNController.StateOff) || VPNServerLatency.isActive
+                        rowShouldBeDisabled: !(VPNController.state === VPNController.StateOff) || VPNServerLatency.state === VPNServerLatency.Loading
                         opacity: 1.0
 
                         onClicked: {
@@ -214,13 +214,29 @@ FocusScope {
                                 Layout.maximumWidth: parent.width
 
                                 horizontalAlignment: Text.AlignLeft
-                                // TODO: Replace placeholder strings and generate
-                                // values that will be set instead of `%1`
-                                text: VPNServerLatency.isActive
-                                      ? MZI18n.ServersViewRecommendedRefreshlLoadingLabel.arg(Math.round(VPNServerLatency.progress * 100))
-                                      : (VPNController.state === VPNController.StateOff)
-                                        ? MZI18n.ServersViewRecommendedRefreshLastUpdatedLabel.arg(MZLocalizer.formatDate(new Date(), VPNServerLatency.lastUpdateTime, MZI18n.ServersViewRecommendedRefreshLastUpdatedLabelYesterday))
-                                        : MZI18n.ServersViewRecommendedRefreshLastUpdatedDisabledLabel.arg(MZLocalizer.formatDate(new Date(), VPNServerLatency.lastUpdateTime, MZI18n.ServersViewRecommendedRefreshLastUpdatedLabelYesterday))
+                                text: {
+                                    switch (VPNServerLatency.state) {
+                                    case VPNServerLatency.Loading:
+                                        return MZI18n.ServersViewRecommendedRefreshlLoadingLabel.arg(
+                                            Math.round(VPNServerLatency.progress * 100));
+
+                                    case VPNServerLatency.Initial:
+                                        return (VPNController.state === VPNController.StateOff)
+                                            ? MZI18n.ServersViewRecommendedRefreshNoUpdateLabel
+                                            : MZI18n.ServersViewRecommendedRefreshNoUpdateDisabledLabel;
+
+                                    case VPNServerLatency.Loaded:
+                                    default:
+                                        const formatted = MZLocalizer.formatDate(
+                                            new Date(),
+                                            VPNServerLatency.lastUpdateTime,
+                                            MZI18n.ServersViewRecommendedRefreshLastUpdatedLabelYesterday);
+                                        const template = (VPNController.state === VPNController.StateOff)
+                                            ? MZI18n.ServersViewRecommendedRefreshLastUpdatedLabel
+                                            : MZI18n.ServersViewRecommendedRefreshLastUpdatedDisabledLabel;
+                                        return template.arg(formatted);
+                                    }
+                                }
                                 wrapMode: Text.WordWrap
                             }