Merge pull request mixxxdj#15214 from acolombier/feat/qml-prevent-user-setting-corruption

feat(QML): add checks to ensure user run with a dedicated test profile

Author: JoergAtGithub

src/main.cpp

@@ -93,6 +93,11 @@ int runMixxx(MixxxApplication* pApp, const CmdlineArgs& args) {
 
         pCoreServices->initialize(pApp);
 
+        if (pCoreServices->getSettings()->getValue(
+                    ConfigKey("[Config]", "did_run_with_unstable"), false)) {
+            qInfo() << "User previously ran the unstable version on this profile";
+        }
+
 #ifdef MIXXX_USE_QOPENGL
         // Will call initialize when the initial wglwidget's
         // qopenglwindow has been exposed

src/preferences/upgrade.cpp

@@ -357,9 +357,20 @@ UserSettingsPointer Upgrade::versionUpgrade(const QString& settingsPath) {
         else {
 #endif
             // This must have been the first run... right? :)
-            qDebug() << "No version number in configuration file. Setting to"
-                     << VersionStore::version();
-            config->set(ConfigKey("[Config]", "Version"), ConfigValue(VersionStore::version()));
+#ifdef MIXXX_USE_QML
+            if (CmdlineArgs::Instance().isQml()) {
+                // If running the QML version (aka 3.0 unstable), we set a dummy
+                // unstable version in the settings. This is used to detect if
+                // the current user profile is being used for testing purpose
+                // and if it is safe for the user to potentially lose their data
+                config->setValue(ConfigKey("[Config]", "Version"), VersionStore::FUTURE_UNSTABLE);
+            } else
+#endif
+            {
+                qDebug() << "No version number in configuration file. Setting to"
+                         << VersionStore::version();
+                config->set(ConfigKey("[Config]", "Version"), ConfigValue(VersionStore::version()));
+            }
             m_bFirstRun = true;
             return config;
 #ifdef __APPLE__

src/qml/qmlapplication.cpp

@@ -1,14 +1,18 @@
 #include "qmlapplication.h"
 
+#include <qtextdocument.h>
+
 #include <QQmlEngineExtensionPlugin>
 #include <QQuickStyle>
 
 #include "controllers/controllermanager.h"
 #include "mixer/playermanager.h"
 #include "moc_qmlapplication.cpp"
+#include "preferences/configobject.h"
 #include "qml/asyncimageprovider.h"
 #include "qml/qmldlgpreferencesproxy.h"
 #include "soundio/soundmanager.h"
+#include "util/versionstore.h"
 #include "waveform/visualsmanager.h"
 #include "waveform/waveformwidgetfactory.h"
 Q_IMPORT_QML_PLUGIN(MixxxPlugin)
@@ -42,6 +46,36 @@ QmlApplication::QmlApplication(
     QQuickStyle::setStyle("Basic");
 
     m_pCoreServices->initialize(app);
+
+    QString configVersion = m_pCoreServices->getSettings()->getValue(
+            ConfigKey("[Config]", "Version"), "");
+    if (configVersion == VersionStore::FUTURE_UNSTABLE) {
+        qDebug() << "Generating a new user profile for safe testing with unstable code";
+    } else if (CmdlineArgs::Instance().isAwareOfRisk()) {
+        qCritical() << "Existing user profile detected from" << configVersion
+                    << "but you said you wanted to play with fire!";
+        m_pCoreServices->getSettings()->setValue(
+                ConfigKey("[Config]", "did_run_with_unstable"), true);
+    } else {
+        QMessageBox msgBox;
+        msgBox.setIcon(QMessageBox::Critical);
+        msgBox.setWindowTitle(tr("Existing user profile detected"));
+        msgBox.setText(
+                tr("Trying to run Mixxx 3.0 with an existing %0 user profile! "
+                   "<br><br>There is <b>serious risks</b> of data loss and "
+                   "corruption.<br>We recommend using a test profile folder "
+                   "with the '--settings-path' argument. <br><br>If you want "
+                   "to continue at your own risk, run Mixxx with the argument "
+                   "'--allow-dangerous-data-corruption-risk'.")
+                        .arg(configVersion));
+
+        QPushButton* continueButton =
+                msgBox.addButton(tr("Ok"), QMessageBox::ActionRole);
+        msgBox.exec();
+        m_pCoreServices.reset();
+        exit(-1);
+    }
+
     SoundDeviceStatus result = m_pCoreServices->getSoundManager()->setupDevices();
     if (result != SoundDeviceStatus::Ok) {
         const int reInt = static_cast<int>(result);

src/util/cmdlineargs.cpp

@@ -285,6 +285,14 @@ bool CmdlineArgs::parse(const QStringList& arguments, CmdlineArgs::ParseMode mod
                                       "Loads experimental QML GUI instead of legacy QWidget skin")
                             : QString());
     parser.addOption(qml);
+    const QCommandLineOption awareOfRisk(
+            QStringLiteral("allow-dangerous-data-corruption-risk"),
+            forUserFeedback
+                    ? QCoreApplication::translate("CmdlineArgs",
+                              "Force Mixxx to load an unstable version with an "
+                              "existing user profile from a stable version")
+                    : QString());
+    parser.addOption(awareOfRisk);
 #endif
     const QCommandLineOption safeMode(QStringLiteral("safe-mode"),
             forUserFeedback ? QCoreApplication::translate("CmdlineArgs",
@@ -459,6 +467,7 @@ bool CmdlineArgs::parse(const QStringList& arguments, CmdlineArgs::ParseMode mod
     m_developer = parser.isSet(developer);
 #ifdef MIXXX_USE_QML
     m_qml = parser.isSet(qml);
+    m_awareOfRisk = parser.isSet(awareOfRisk);
 #endif
     m_safeMode = parser.isSet(safeMode) || parser.isSet(safeModeDeprecated);
     m_debugAssertBreak = parser.isSet(debugAssertBreak) || parser.isSet(debugAssertBreakDeprecated);

src/util/cmdlineargs.h

@@ -50,6 +50,9 @@ class CmdlineArgs final {
     bool isQml() const {
         return m_qml;
     }
+    bool isAwareOfRisk() const {
+        return m_awareOfRisk;
+    }
 #endif
     bool getSafeMode() const { return m_safeMode; }
     bool useColors() const {
@@ -106,6 +109,7 @@ class CmdlineArgs final {
     bool m_developer; // Developer Mode
 #ifdef MIXXX_USE_QML
     bool m_qml;
+    bool m_awareOfRisk;
 #endif
     bool m_safeMode;
     bool m_useLegacyVuMeter;

src/util/versionstore.h

@@ -5,6 +5,9 @@
 #include <QVersionNumber>
 
 namespace VersionStore {
+/// Constant to store the future unreleased Mixxx 3.0
+static QString FUTURE_UNSTABLE = QStringLiteral("3.0-unstable");
+
 /// Returns the current Mixxx version string (e.g. 1.12.0-alpha)
 QString version();