Qt: cache home screen state (#20395)

* cache drive stats

* don't parse response if it's the same as previous

* remove blank line

* cleanup

* update stats in place

* validate json

* add DriveStats to params.pyx

* cleanup

* cleanup

* remove //#include

* simplify

* add cache to RequestRepeater

* rename CachedDriveStats to ApiCacheDriveStats

* rename ApiCacheDriveStats to ApiCache_DriveStats

Co-authored-by: Willem Melching <willem.melching@gmail.com>
old-commit-hash: 80ae6a7e1b

common/params_pyx.pyx

@@ -15,6 +15,7 @@ cdef enum TxType:
 
 keys = {
   b"AccessToken": [TxType.CLEAR_ON_MANAGER_START],
+  b"ApiCache_DriveStats": [TxType.PERSISTENT],
   b"AthenadPid": [TxType.PERSISTENT],
   b"CalibrationParams": [TxType.PERSISTENT],
   b"CarBatteryCapacity": [TxType.PERSISTENT],

selfdrive/ui/qt/api.cc

@@ -76,8 +76,8 @@ QString CommaApi::create_jwt() {
   return create_jwt(*(new QVector<QPair<QString, QJsonValue>>()));
 }
 
-RequestRepeater::RequestRepeater(QWidget* parent, QString requestURL, int period_seconds, QVector<QPair<QString, QJsonValue>> payloads, bool disableWithScreen)
+RequestRepeater::RequestRepeater(QWidget* parent, QString requestURL, int period_seconds, const QString &cache_key, QVector<QPair<QString, QJsonValue>> payloads, bool disableWithScreen)
-  : disableWithScreen(disableWithScreen), QObject(parent)  {
+  : disableWithScreen(disableWithScreen), cache_key(cache_key), QObject(parent)  {
   networkAccessManager = new QNetworkAccessManager(this);
 
   reply = NULL;
@@ -90,6 +90,12 @@ RequestRepeater::RequestRepeater(QWidget* parent, QString requestURL, int period
   networkTimer->setSingleShot(true);
   networkTimer->setInterval(20000);
   connect(networkTimer, SIGNAL(timeout()), this, SLOT(requestTimeout()));
+
+  if (!cache_key.isEmpty()) {
+    if (std::string cached_resp = Params().get(cache_key.toStdString()); !cached_resp.empty()) {
+      QTimer::singleShot(0, [=]() { emit receivedResponse(QString::fromStdString(cached_resp)); });
+    }
+  }
 }
 
 void RequestRepeater::sendRequest(QString requestURL, QVector<QPair<QString, QJsonValue>> payloads){
@@ -126,6 +132,10 @@ void RequestRepeater::requestFinished(){
     networkTimer->stop();
     QString response = reply->readAll();
     if (reply->error() == QNetworkReply::NoError) {
+      // save to cache
+      if (!cache_key.isEmpty()) { 
+        Params().write_db_value(cache_key.toStdString(), response.toStdString()); 
+      }
       emit receivedResponse(response);
     } else {
       qDebug() << reply->errorString();

selfdrive/ui/qt/api.hpp

@@ -33,7 +33,7 @@ class RequestRepeater : public QObject {
   Q_OBJECT
 
 public:
-  explicit RequestRepeater(QWidget* parent, QString requestURL, int period = 10, QVector<QPair<QString, QJsonValue>> payloads = *(new QVector<QPair<QString, QJsonValue>>()), bool disableWithScreen = true);
+  explicit RequestRepeater(QWidget* parent, QString requestURL, int period = 10, const QString &cache_key = "", QVector<QPair<QString, QJsonValue>> payloads = *(new QVector<QPair<QString, QJsonValue>>()), bool disableWithScreen = true);
   bool active = true;
 
 private:
@@ -41,6 +41,7 @@ private:
   QNetworkReply* reply;
   QNetworkAccessManager* networkAccessManager;
   QTimer* networkTimer;
+  QString cache_key;
   void sendRequest(QString requestURL, QVector<QPair<QString, QJsonValue>> payloads);
 
 private slots:

selfdrive/ui/qt/widgets/drive_stats.cc

@@ -1,8 +1,6 @@
 #include <QDebug>
 #include <QJsonDocument>
 #include <QJsonObject>
-#include <QLabel>
-#include <QStackedLayout>
 #include <QVBoxLayout>
 
 #include "api.hpp"
@@ -11,94 +9,62 @@
 
 const double MILE_TO_KM = 1.60934;
 
-void clearLayouts(QLayout* layout) {
+static QLayout* build_stat_layout(QLabel** metric, const QString& name) {
-  while (QLayoutItem* item = layout->takeAt(0)) {
-    if (QWidget* widget = item->widget()) {
-      widget->deleteLater();
-    }
-    if (QLayout* childLayout = item->layout()) {
-      clearLayouts(childLayout);
-    }
-    delete item;
-  }
-}
-
-QLayout* build_stat(QString name, int stat) {
   QVBoxLayout* layout = new QVBoxLayout;
   layout->setMargin(0);
-
+  *metric = new QLabel("0");
-  QLabel* metric = new QLabel(QString("%1").arg(stat));
+  (*metric)->setStyleSheet("font-size: 80px; font-weight: 600;");
-  metric->setStyleSheet(R"(
+  layout->addWidget(*metric, 0, Qt::AlignLeft);
-    font-size: 80px;
-    font-weight: 600;
-  )");
-  layout->addWidget(metric, 0, Qt::AlignLeft);
 
   QLabel* label = new QLabel(name);
-  label->setStyleSheet(R"(
+  label->setStyleSheet("font-size: 45px; font-weight: 500;");
-    font-size: 45px;
-    font-weight: 500;
-  )");
   layout->addWidget(label, 0, Qt::AlignLeft);
-
   return layout;
 }
 
-void DriveStats::parseError(QString response) {
-  clearLayouts(vlayout);
-  vlayout->addWidget(new QLabel("No Internet connection"), 0, Qt::AlignCenter);
-}
-
 void DriveStats::parseResponse(QString response) {
-  response.chop(1);
+  response = response.trimmed();
-  clearLayouts(vlayout);
   QJsonDocument doc = QJsonDocument::fromJson(response.toUtf8());
   if (doc.isNull()) {
     qDebug() << "JSON Parse failed on getting past drives statistics";
     return;
   }
 
-  bool metric = Params().read_db_bool("IsMetric");
+  auto update = [](const QJsonObject &obj, StatsLabels& labels, bool metric) {
+    labels.routes->setText(QString::number((int)obj["routes"].toDouble()));
+    labels.distance->setText(QString::number(obj["distance"].toDouble() * (metric ? MILE_TO_KM : 1)));
+    labels.hours->setText(QString::number((int)(obj["minutes"].toDouble() / 60)));
+  };
 
+  bool metric = Params().read_db_bool("IsMetric");
   QJsonObject json = doc.object();
-  auto all = json["all"].toObject();
+  update(json["all"].toObject(), all_, metric);
-  auto week = json["week"].toObject();
+  update(json["week"].toObject(), week_, metric);
+}
+
+DriveStats::DriveStats(QWidget* parent) : QWidget(parent) {
+  setStyleSheet("QLabel {font-size: 48px; font-weight: 500;}");
 
+  auto add_stats_layouts = [&](QGridLayout* gl, StatsLabels& labels, int row, const char* distance_unit) {
+    gl->addLayout(build_stat_layout(&labels.routes, "DRIVES"), row, 0, 3, 1);
+    gl->addLayout(build_stat_layout(&labels.distance, distance_unit), row, 1, 3, 1);
+    gl->addLayout(build_stat_layout(&labels.hours, "HOURS"), row, 2, 3, 1);
+  };
+
+  const char* distance_unit = Params().read_db_bool("IsMetric") ? "KM" : "MILES";
   QGridLayout* gl = new QGridLayout();
   gl->setMargin(0);
-
-  int all_distance = all["distance"].toDouble() * (metric ? MILE_TO_KM : 1);
   gl->addWidget(new QLabel("ALL TIME"), 0, 0, 1, 3);
-  gl->addLayout(build_stat("DRIVES", all["routes"].toDouble()), 1, 0, 3, 1);
+  add_stats_layouts(gl, all_, 1, distance_unit);
-  gl->addLayout(build_stat(metric ? "KM" : "MILES", all_distance), 1, 1, 3, 1);
-  gl->addLayout(build_stat("HOURS", all["minutes"].toDouble() / 60), 1, 2, 3, 1);
-
-  int week_distance = week["distance"].toDouble() * (metric ? MILE_TO_KM : 1);
   gl->addWidget(new QLabel("PAST WEEK"), 6, 0, 1, 3);
-  gl->addLayout(build_stat("DRIVES", week["routes"].toDouble()), 7, 0, 3, 1);
+  add_stats_layouts(gl, week_, 7, distance_unit);
-  gl->addLayout(build_stat(metric ? "KM" : "MILES", week_distance), 7, 1, 3, 1);
-  gl->addLayout(build_stat("HOURS", week["minutes"].toDouble() / 60), 7, 2, 3, 1);
-
-  QWidget* q = new QWidget;
-  q->setLayout(gl);
-  vlayout->addWidget(q);
-}
 
-DriveStats::DriveStats(QWidget* parent) : QWidget(parent) {
+  QVBoxLayout* vlayout = new QVBoxLayout(this);
-  vlayout = new QVBoxLayout(this);
+  vlayout->addLayout(gl);
-  vlayout->setMargin(0);
-  setLayout(vlayout);
-  setStyleSheet(R"(
-    QLabel {
-      font-size: 48px;
-      font-weight: 500;
-    }
-  )");
 
   // TODO: do we really need to update this frequently?
   QString dongleId = QString::fromStdString(Params().get("DongleId"));
   QString url = "https://api.commadotai.com/v1.1/devices/" + dongleId + "/stats";
-  RequestRepeater* repeater = new RequestRepeater(this, url, 13);
+  RequestRepeater* repeater = new RequestRepeater(this, url, 13, "ApiCache_DriveStats");
   QObject::connect(repeater, SIGNAL(receivedResponse(QString)), this, SLOT(parseResponse(QString)));
-  QObject::connect(repeater, SIGNAL(failedResponse(QString)), this, SLOT(parseError(QString)));
 }

selfdrive/ui/qt/widgets/drive_stats.hpp

@@ -1,7 +1,6 @@
 #pragma once
 
-#include <QVBoxLayout>
+#include <QLabel>
-#include <QWidget>
 
 class DriveStats : public QWidget {
   Q_OBJECT
@@ -10,9 +9,10 @@ public:
   explicit DriveStats(QWidget* parent = 0);
 
 private:
-  QVBoxLayout* vlayout;
+  struct StatsLabels {
+    QLabel *routes, *distance, *hours;
+  } all_, week_;
 
 private slots:
-  void parseError(QString response);
   void parseResponse(QString response);
 };