1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
|
/******************************************************************************
* Copyright (C) 2015 Felix Rohrbach <kde@fxrh.de>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
#include "basejob.h"
#include "connectiondata.h"
#include <QtNetwork/QNetworkAccessManager>
#include <QtNetwork/QNetworkRequest>
#include <QtNetwork/QNetworkReply>
#include <QtCore/QTimer>
#include <QtCore/QRegularExpression>
#include <array>
using namespace QMatrixClient;
struct NetworkReplyDeleter : public QScopedPointerDeleteLater
{
static inline void cleanup(QNetworkReply* reply)
{
if (reply && reply->isRunning())
reply->abort();
QScopedPointerDeleteLater::cleanup(reply);
}
};
class BaseJob::Private
{
public:
// Using an idiom from clang-tidy:
// http://clang.llvm.org/extra/clang-tidy/checks/modernize-pass-by-value.html
Private(HttpVerb v, QString endpoint, QUrlQuery q, Data data, bool nt)
: verb(v), apiEndpoint(std::move(endpoint))
, requestQuery(std::move(q)), requestData(std::move(data))
, needsToken(nt)
{ }
void sendRequest();
const JobTimeoutConfig& getCurrentTimeoutConfig() const;
const ConnectionData* connection = nullptr;
// Contents for the network request
HttpVerb verb;
QString apiEndpoint;
QUrlQuery requestQuery;
Data requestData;
bool needsToken;
QScopedPointer<QNetworkReply, NetworkReplyDeleter> reply;
Status status = NoError;
QTimer timer;
QTimer retryTimer;
QVector<JobTimeoutConfig> errorStrategy =
{ { 90, 5 }, { 90, 10 }, { 120, 30 } };
int maxRetries = errorStrategy.size();
int retriesTaken = 0;
LoggingCategory logCat = JOBS;
};
inline QDebug operator<<(QDebug dbg, const BaseJob* j)
{
return dbg << j->objectName();
}
QDebug QMatrixClient::operator<<(QDebug dbg, const BaseJob::Status& s)
{
QRegularExpression filter { "(access_token)(=|: )[-_A-Za-z0-9]+" };
return dbg << s.code << ':'
<< QString(s.message).replace(filter, "\\1 HIDDEN");
}
BaseJob::BaseJob(HttpVerb verb, const QString& name, const QString& endpoint,
const Query& query, const Data& data, bool needsToken)
: d(new Private(verb, endpoint, query, data, needsToken))
{
setObjectName(name);
d->timer.setSingleShot(true);
connect (&d->timer, &QTimer::timeout, this, &BaseJob::timeout);
d->retryTimer.setSingleShot(true);
connect (&d->retryTimer, &QTimer::timeout, this, &BaseJob::sendRequest);
}
BaseJob::~BaseJob()
{
stop();
qCDebug(d->logCat) << this << "destroyed";
}
const QString& BaseJob::apiEndpoint() const
{
return d->apiEndpoint;
}
void BaseJob::setApiEndpoint(const QString& apiEndpoint)
{
d->apiEndpoint = apiEndpoint;
}
const QUrlQuery& BaseJob::query() const
{
return d->requestQuery;
}
void BaseJob::setRequestQuery(const QUrlQuery& query)
{
d->requestQuery = query;
}
const BaseJob::Data& BaseJob::requestData() const
{
return d->requestData;
}
void BaseJob::setRequestData(const BaseJob::Data& data)
{
d->requestData = data;
}
void BaseJob::Private::sendRequest()
{
QUrl url = connection->baseUrl();
QString path = url.path();
if (!path.endsWith('/') && !apiEndpoint.startsWith('/'))
path.push_back('/');
url.setPath( path + apiEndpoint );
url.setQuery(requestQuery);
QNetworkRequest req {url};
req.setHeader(QNetworkRequest::ContentTypeHeader, "application/json");
req.setRawHeader(QByteArray("Authorization"),
QByteArray("Bearer ") + connection->accessToken());
#if (QT_VERSION >= QT_VERSION_CHECK(5, 6, 0))
req.setAttribute(QNetworkRequest::FollowRedirectsAttribute, true);
req.setMaximumRedirectsAllowed(10);
#endif
switch( verb )
{
case HttpVerb::Get:
reply.reset( connection->nam()->get(req) );
break;
case HttpVerb::Post:
reply.reset( connection->nam()->post(req, requestData.serialize()) );
break;
case HttpVerb::Put:
reply.reset( connection->nam()->put(req, requestData.serialize()) );
break;
case HttpVerb::Delete:
reply.reset( connection->nam()->deleteResource(req) );
break;
}
}
void BaseJob::beforeStart(const ConnectionData* connData)
{
}
void BaseJob::start(const ConnectionData* connData)
{
d->connection = connData;
beforeStart(connData);
sendRequest();
}
void BaseJob::sendRequest()
{
emit aboutToStart();
d->retryTimer.stop(); // In case we were counting down at the moment
qCDebug(d->logCat) << this << "sending request to" << d->apiEndpoint;
if (!d->requestQuery.isEmpty())
qCDebug(d->logCat) << " query:" << d->requestQuery.toString();
d->sendRequest();
connect( d->reply.data(), &QNetworkReply::finished, this, &BaseJob::gotReply );
if (d->reply->isRunning())
{
d->timer.start(getCurrentTimeout());
qCDebug(d->logCat) << this << "request has been sent";
emit started();
}
else
qCWarning(d->logCat) << this << "request could not start";
}
void BaseJob::gotReply()
{
setStatus(checkReply(d->reply.data()));
if (status().good())
setStatus(parseReply(d->reply->readAll()));
finishJob();
}
BaseJob::Status BaseJob::checkReply(QNetworkReply* reply) const
{
qCDebug(d->logCat) << this << "returned from" << reply->url().toDisplayString();
if (reply->error() != QNetworkReply::NoError)
qCDebug(d->logCat) << this << "returned" << reply->error();
switch( reply->error() )
{
case QNetworkReply::NoError:
return NoError;
case QNetworkReply::AuthenticationRequiredError:
case QNetworkReply::ContentAccessDenied:
case QNetworkReply::ContentOperationNotPermittedError:
return { ContentAccessError, reply->errorString() };
case QNetworkReply::ProtocolInvalidOperationError:
case QNetworkReply::UnknownContentError:
return { IncorrectRequestError, reply->errorString() };
case QNetworkReply::ContentNotFoundError:
return { NotFoundError, reply->errorString() };
default:
return { NetworkError, reply->errorString() };
}
}
BaseJob::Status BaseJob::parseReply(QByteArray data)
{
QJsonParseError error;
QJsonDocument json = QJsonDocument::fromJson(data, &error);
if( error.error == QJsonParseError::NoError )
return parseJson(json);
else
return { JsonParseError, error.errorString() };
}
BaseJob::Status BaseJob::parseJson(const QJsonDocument&)
{
return Success;
}
void BaseJob::stop()
{
d->timer.stop();
if (d->reply)
{
d->reply->disconnect(this); // Ignore whatever comes from the reply
if (d->reply->isRunning())
{
qCWarning(d->logCat) << this << "stopped without ready network reply";
d->reply->abort();
}
}
else
qCWarning(d->logCat) << this << "stopped with empty network reply";
}
void BaseJob::finishJob()
{
stop();
if ((error() == NetworkError || error() == TimeoutError)
&& d->retriesTaken < d->maxRetries)
{
// TODO: The whole retrying thing should be put to ConnectionManager
// otherwise independently retrying jobs make a bit of notification
// storm towards the UI.
const auto retryInterval = getNextRetryInterval();
++d->retriesTaken;
qCWarning(d->logCat) << this << "will take retry" << d->retriesTaken
<< "in" << retryInterval/1000 << "s";
d->retryTimer.start(retryInterval);
emit retryScheduled(d->retriesTaken, retryInterval);
return;
}
// Notify those interested in any completion of the job (including killing)
emit finished(this);
emit result(this);
if (error())
emit failure(this);
else
emit success(this);
deleteLater();
}
const JobTimeoutConfig& BaseJob::Private::getCurrentTimeoutConfig() const
{
return errorStrategy[std::min(retriesTaken, errorStrategy.size() - 1)];
}
BaseJob::duration_t BaseJob::getCurrentTimeout() const
{
return d->getCurrentTimeoutConfig().jobTimeout * 1000;
}
BaseJob::duration_t BaseJob::getNextRetryInterval() const
{
return d->getCurrentTimeoutConfig().nextRetryInterval * 1000;
}
BaseJob::duration_t BaseJob::millisToRetry() const
{
return d->retryTimer.isActive() ? d->retryTimer.remainingTime() : 0;
}
size_t BaseJob::maxRetries() const
{
return d->maxRetries;
}
void BaseJob::setMaxRetries(size_t newMaxRetries)
{
d->maxRetries = newMaxRetries;
}
BaseJob::Status BaseJob::status() const
{
return d->status;
}
int BaseJob::error() const
{
return d->status.code;
}
QString BaseJob::errorString() const
{
return d->status.message;
}
void BaseJob::setStatus(Status s)
{
d->status = s;
if (!s.good())
qCWarning(d->logCat) << this << "status" << s;
}
void BaseJob::setStatus(int code, QString message)
{
setStatus({ code, message });
}
void BaseJob::abandon()
{
this->disconnect();
if (d->reply)
d->reply->disconnect(this);
deleteLater();
}
void BaseJob::timeout()
{
setStatus( TimeoutError, "The job has timed out" );
finishJob();
}
void BaseJob::setLoggingCategory(LoggingCategory lcf)
{
d->logCat = lcf;
}
|