Skip to content

Commit

Permalink
Add progress bar and minor UX changes
Browse files Browse the repository at this point in the history
  • Loading branch information
@elpaso
elpaso committed Jul 6, 2021
1 parent 537670a commit 357fa9c
Show file tree
Hide file tree
Showing 4 changed files with 48 additions and 35 deletions.
1 change: 0 additions & 1 deletion python/gui/auto_generated/qgsqueryresultwidget.sip.in
View file
Expand Up @@ -88,7 +88,6 @@ Emitted when the first batch of results has been fetched.
If the query returns no results this signal is not emitted.
%End


};

/************************************************************************
Expand Down
55 changes: 30 additions & 25 deletions src/gui/qgsqueryresultwidget.cpp
View file
Expand Up @@ -19,8 +19,6 @@
#include "qgsmessagelog.h"
#include "qgsquerybuilder.h"
#include "qgsvectorlayer.h"
#include <QStandardItem>



QgsQueryResultWidget::QgsQueryResultWidget( QWidget *parent, QgsAbstractDatabaseProviderConnection *connection )
Expand All @@ -31,6 +29,9 @@ QgsQueryResultWidget::QgsQueryResultWidget( QWidget *parent, QgsAbstractDatabase
// Unsure :/
// mSqlEditor->setLineNumbersVisible( true );

mQueryResultsTableView->hide();
mProgressBar->hide();

connect( mExecuteButton, &QPushButton::pressed, this, &QgsQueryResultWidget::executeQuery );
connect( mClearButton, &QPushButton::pressed, this, [ = ]
{
Expand Down Expand Up @@ -98,13 +99,7 @@ QgsQueryResultWidget::QgsQueryResultWidget( QWidget *parent, QgsAbstractDatabase

QgsQueryResultWidget::~QgsQueryResultWidget()
{
if ( mApiFetcher )
{
mApiFetcher->stopFetching();
mWorkerThread.quit();
mWorkerThread.wait();
mWorkerThread.deleteLater();
}
cancelApiFetcher();
cancelRunningQuery();
}

Expand All @@ -125,12 +120,15 @@ void QgsQueryResultWidget::executeQuery()
mStopButton->setEnabled( true );
mStatusLabel->show();
mStatusLabel->setText( tr( "Running⋯" ) );
mProgressBar->show();
mProgressBar->setRange( 0, 0 );
mSqlErrorMessage.clear();

connect( mStopButton, &QPushButton::pressed, mFeedback.get(), [ = ]
{
mStatusLabel->setText( tr( "Stopped" ) );
mFeedback->cancel();
mProgressBar->hide();
mWasCanceled = true;
} );

Expand Down Expand Up @@ -214,6 +212,17 @@ void QgsQueryResultWidget::cancelRunningQuery()
}
}

void QgsQueryResultWidget::cancelApiFetcher()
{
if ( mApiFetcher )
{
mApiFetcher->stopFetching();
mApiFetcherWorkerThread.quit();
mApiFetcherWorkerThread.wait();
mApiFetcherWorkerThread.deleteLater();
}
}

void QgsQueryResultWidget::startFetching()
{
if ( ! mWasCanceled )
Expand Down Expand Up @@ -242,7 +251,7 @@ void QgsQueryResultWidget::startFetching()
updateButtons();
updateSqlLayerColumns( );
}
mStatusLabel->setText( tr( "Fetched rows: %1 %2." )
mStatusLabel->setText( tr( "Fetched rows: %1 %2" )
.arg( mModel->rowCount( mModel->index( -1, -1 ) ) )
.arg( mWasCanceled ? tr( "(stopped)" ) : QString() ) );
} );
Expand All @@ -256,20 +265,23 @@ void QgsQueryResultWidget::startFetching()
if ( ! mWasCanceled )
{
mStatusLabel->setText( "Query executed successfully." );
mProgressBar->hide();
}
} );
}
}
else
{
mStatusLabel->setText( tr( "SQL command aborted." ) );
mProgressBar->hide();
}
}

void QgsQueryResultWidget::showError( const QString &title, const QString &message, bool isSqlError )
{
mStatusLabel->show();
mStatusLabel->setText( tr( "There was an error executing the query." ) );
mProgressBar->hide();
mQueryResultsTableView->hide();
if ( isSqlError )
{
Expand Down Expand Up @@ -317,14 +329,7 @@ void QgsQueryResultWidget::setConnection( QgsAbstractDatabaseProviderConnection
{
mConnection.reset( connection );

if ( mApiFetcher )
{
mApiFetcher->stopFetching();
mWorkerThread.quit();
mWorkerThread.wait();
mApiFetcher->deleteLater();
mApiFetcher = nullptr;
}
cancelApiFetcher();

if ( connection )
{
Expand All @@ -343,15 +348,15 @@ void QgsQueryResultWidget::setConnection( QgsAbstractDatabaseProviderConnection

// Add dynamic keywords in a separate thread
mApiFetcher = new QgsConnectionsApiFetcher( connection );
mApiFetcher->moveToThread( &mWorkerThread );
connect( &mWorkerThread, &QThread::started, mApiFetcher, &QgsConnectionsApiFetcher::fetchTokens );
connect( &mWorkerThread, &QThread::finished, mApiFetcher, [ = ]
mApiFetcher->moveToThread( &mApiFetcherWorkerThread );
connect( &mApiFetcherWorkerThread, &QThread::started, mApiFetcher, &QgsConnectionsApiFetcher::fetchTokens );
connect( &mApiFetcherWorkerThread, &QThread::finished, mApiFetcher, [ = ]
{
mApiFetcher->deleteLater();
mApiFetcher = nullptr;
} );
connect( mApiFetcher, &QgsConnectionsApiFetcher::tokensReady, this, &QgsQueryResultWidget::tokensReady );
mWorkerThread.start();
mApiFetcherWorkerThread.start();
}

updateButtons();
Expand Down Expand Up @@ -380,7 +385,7 @@ void QgsConnectionsApiFetcher::fetchTokens()
}
catch ( QgsProviderConnectionException &ex )
{
QgsMessageLog::logMessage( tr( "Error retrieving schemas: %1" ).arg( ex.what() ) );
QgsMessageLog::logMessage( tr( "Error retrieving schemas: %1" ).arg( ex.what() ), QStringLiteral( "QGIS" ), Qgis::MessageLevel::Warning );
}
}
else
Expand All @@ -404,7 +409,7 @@ void QgsConnectionsApiFetcher::fetchTokens()
}
catch ( QgsProviderConnectionException &ex )
{
QgsMessageLog::logMessage( tr( "Error retrieving tables: %1" ).arg( ex.what() ) );
QgsMessageLog::logMessage( tr( "Error retrieving tables: %1" ).arg( ex.what() ), QStringLiteral( "QGIS" ), Qgis::MessageLevel::Warning );
}

// Get fields
Expand All @@ -425,7 +430,7 @@ void QgsConnectionsApiFetcher::fetchTokens()
}
catch ( QgsProviderConnectionException &ex )
{
QgsMessageLog::logMessage( tr( "Error retrieving fields for table %1: %2" ).arg( table, ex.what() ) );
QgsMessageLog::logMessage( tr( "Error retrieving fields for table %1: %2" ).arg( table, ex.what() ), QStringLiteral( "QGIS" ), Qgis::MessageLevel::Warning );
}
}
}
Expand Down
16 changes: 9 additions & 7 deletions src/gui/qgsqueryresultwidget.h
View file
Expand Up @@ -32,7 +32,7 @@
#ifndef SIP_RUN

/**
* \brief The QgsConnectionsApiFetcher class fetches tokens (table and field names) of a connection from a separate thread.
* \brief The QgsConnectionsApiFetcher class fetches tokens (schema, table and field names) of a connection from a separate thread.
*/
class GUI_EXPORT QgsConnectionsApiFetcher: public QObject
{
Expand Down Expand Up @@ -123,10 +123,6 @@ class GUI_EXPORT QgsQueryResultWidget: public QWidget, private Ui::QgsQueryResul
*/
void tokensReady( const QStringList &tokens );

private slots:

void syncSqlOptions();

signals:

/**
Expand All @@ -143,14 +139,17 @@ class GUI_EXPORT QgsQueryResultWidget: public QWidget, private Ui::QgsQueryResul
*/
void firstResultBatchFetched();

private slots:

void syncSqlOptions();

private:

std::unique_ptr<QgsAbstractDatabaseProviderConnection> mConnection;
std::unique_ptr<QgsQueryResultModel> mModel;
std::unique_ptr<QgsFeedback> mFeedback;
QgsConnectionsApiFetcher *mApiFetcher = nullptr;
QThread mWorkerThread;
QThread mApiFetcherWorkerThread;
bool mWasCanceled = false;
QgsAbstractDatabaseProviderConnection::SqlVectorLayerOptions mSqlVectorLayerOptions;
bool mFirstRowFetched = false;
Expand All @@ -172,6 +171,10 @@ class GUI_EXPORT QgsQueryResultWidget: public QWidget, private Ui::QgsQueryResul
*/
void cancelRunningQuery();

/**
* Cancel API fetching.
*/
void cancelApiFetcher();

/**
* Starts the model population after initial query run.
Expand All @@ -183,7 +186,6 @@ class GUI_EXPORT QgsQueryResultWidget: public QWidget, private Ui::QgsQueryResul
*/
QgsAbstractDatabaseProviderConnection::SqlVectorLayerOptions sqlVectorLayerOptions() const;


friend class TestQgsQueryResultWidget;

};
Expand Down
11 changes: 9 additions & 2 deletions src/ui/qgsqueryresultwidgetbase.ui
View file
Expand Up @@ -21,7 +21,7 @@
<widget class="QgsCodeEditorSQL" name="mSqlEditor" native="true"/>
</item>
<item>
<layout class="QHBoxLayout" name="horizontalLayout">
<layout class="QHBoxLayout" name="horizontalLayout" stretch="1,1,2,0,1,1">
<item>
<widget class="QPushButton" name="mClearButton">
<property name="text">
Expand All @@ -36,6 +36,13 @@
</property>
</widget>
</item>
<item>
<widget class="QProgressBar" name="mProgressBar">
<property name="value">
<number>24</number>
</property>
</widget>
</item>
<item>
<spacer name="horizontalSpacer">
<property name="orientation">
Expand Down Expand Up @@ -127,7 +134,7 @@
<string/>
</property>
<property name="placeholderText">
<string>Enter the optional SQL filter ro click on the button to open the query builder tool</string>
<string>Enter the optional SQL filter or click on the button to open the query builder tool</string>
</property>
</widget>
</item>
Expand Down

0 comments on commit 357fa9c

Please sign in to comment.