IOS: Unify error handling

Instead of using some flags in some struct, we convert the error handling
to use expected_str<ResponseData> to clean up the error handling with
the outside.

Change-Id: I0f8d10c99715989e0069568ebc1d799d412a0600
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
This commit is contained in:
Marcus Tillmanns
2023-10-31 09:58:23 +01:00
parent e562caaff2
commit 32f69227f1
6 changed files with 143 additions and 145 deletions

View File

@@ -74,8 +74,10 @@ static SimulatorInfoList selectedSimulators(const QTreeView *deviceTreeView)
return list;
}
static void onSimOperation(const SimulatorInfo &simInfo, SimulatorOperationDialog* dlg,
const QString &contextStr, const SimulatorControl::ResponseData &response)
static void onSimOperation(const SimulatorInfo &simInfo,
SimulatorOperationDialog *dlg,
const QString &contextStr,
const SimulatorControl::Response &response)
{
dlg->addMessage(simInfo, response, contextStr);
}
@@ -224,13 +226,16 @@ void IosSettingsWidget::onCreate()
statusDialog->setAttribute(Qt::WA_DeleteOnClose);
statusDialog->addMessage(Tr::tr("Creating simulator device..."), Utils::NormalMessageFormat);
const auto onSimulatorCreate = [statusDialog](const QString &name,
const SimulatorControl::ResponseData &response) {
if (response.success) {
const SimulatorControl::Response &response) {
if (response) {
statusDialog->addMessage(Tr::tr("Simulator device (%1) created.\nUDID: %2")
.arg(name).arg(response.simUdid), Utils::StdOutFormat);
.arg(name)
.arg(response->simUdid),
Utils::StdOutFormat);
} else {
statusDialog->addMessage(Tr::tr("Simulator device (%1) creation failed.\nError: %2").
arg(name).arg(response.commandOutput),
statusDialog->addMessage(Tr::tr("Simulator device (%1) creation failed.\nError: %2")
.arg(name)
.arg(response.error()),
Utils::StdErrFormat);
}
};

View File

@@ -738,16 +738,16 @@ void IosSimulatorToolHandlerPrivate::requestTransferApp(const FilePath &appBundl
m_deviceId = deviceIdentifier;
isTransferringApp(m_bundlePath, m_deviceId, 0, 100, "");
auto onSimulatorStart = [this](const SimulatorControl::ResponseData &response) {
if (!isResponseValid(response))
auto onSimulatorStart = [this](const SimulatorControl::Response &response) {
if (response) {
if (!isResponseValid(*response))
return;
if (response.success) {
installAppOnSimulator();
} else {
errorMsg(Tr::tr("Application install on simulator failed. Simulator not running."));
if (!response.commandOutput.isEmpty())
errorMsg(response.commandOutput);
if (!response.error().isEmpty())
errorMsg(response.error());
didTransferApp(m_bundlePath, m_deviceId, IosToolHandler::Failure);
emit q->finished(q);
}
@@ -778,13 +778,15 @@ void IosSimulatorToolHandlerPrivate::requestRunApp(const FilePath &appBundlePath
return;
}
auto onSimulatorStart = [this, extraArgs](const SimulatorControl::ResponseData &response) {
if (!isResponseValid(response))
auto onSimulatorStart = [this, extraArgs](const SimulatorControl::Response &response) {
if (response) {
if (!isResponseValid(*response))
return;
if (response.success) {
launchAppOnSimulator(extraArgs);
} else {
errorMsg(Tr::tr("Application launch on simulator failed. Simulator not running."));
errorMsg(Tr::tr("Application launch on simulator failed. Simulator not running. %1")
.arg(response.error()));
didStartApp(m_bundlePath, m_deviceId, Ios::IosToolHandler::Failure);
}
};
@@ -827,16 +829,14 @@ void IosSimulatorToolHandlerPrivate::stop(int errorCode)
void IosSimulatorToolHandlerPrivate::installAppOnSimulator()
{
auto onResponseAppInstall = [this](const SimulatorControl::ResponseData &response) {
if (!isResponseValid(response))
auto onResponseAppInstall = [this](const SimulatorControl::Response &response) {
if (response) {
if (!isResponseValid(*response))
return;
if (response.success) {
isTransferringApp(m_bundlePath, m_deviceId, 100, 100, "");
didTransferApp(m_bundlePath, m_deviceId, IosToolHandler::Success);
} else {
errorMsg(Tr::tr("Application install on simulator failed. %1")
.arg(response.commandOutput));
errorMsg(Tr::tr("Application install on simulator failed. %1").arg(response.error()));
didTransferApp(m_bundlePath, m_deviceId, IosToolHandler::Failure);
}
emit q->finished(q);
@@ -884,22 +884,21 @@ void IosSimulatorToolHandlerPrivate::launchAppOnSimulator(const QStringList &ext
stop(0);
};
auto onResponseAppLaunch = [=](const SimulatorControl::ResponseData &response) {
if (!isResponseValid(response))
auto onResponseAppLaunch = [=](const SimulatorControl::Response &response) {
if (response) {
if (!isResponseValid(*response))
return;
if (response.success) {
m_pid = response.pID;
gotInferiorPid(m_bundlePath, m_deviceId, response.pID);
m_pid = response->inferiorPid;
gotInferiorPid(m_bundlePath, m_deviceId, response->inferiorPid);
didStartApp(m_bundlePath, m_deviceId, Ios::IosToolHandler::Success);
// Start monitoring app's life signs.
futureSynchronizer.addFuture(Utils::asyncRun(monitorPid, response.pID));
futureSynchronizer.addFuture(Utils::asyncRun(monitorPid, response->inferiorPid));
if (captureConsole)
futureSynchronizer.addFuture(Utils::asyncRun(&LogTailFiles::exec, &outputLogger,
stdoutFile, stderrFile));
} else {
m_pid = -1;
errorMsg(Tr::tr("Application launch on simulator failed. %1")
.arg(response.commandOutput));
errorMsg(Tr::tr("Application launch on simulator failed. %1").arg(response.error()));
didStartApp(m_bundlePath, m_deviceId, Ios::IosToolHandler::Failure);
stop(-1);
emit q->finished(q);

View File

@@ -188,30 +188,27 @@ static SimulatorInfo deviceInfo(const QString &simUdid);
static QString bundleIdentifier(const Utils::FilePath &bundlePath);
static QString bundleExecutable(const Utils::FilePath &bundlePath);
static void startSimulator(QPromise<SimulatorControl::ResponseData> &promise,
const QString &simUdid);
static void installApp(QPromise<SimulatorControl::ResponseData> &promise,
static void startSimulator(QPromise<SimulatorControl::Response> &promise, const QString &simUdid);
static void installApp(QPromise<SimulatorControl::Response> &promise,
const QString &simUdid,
const Utils::FilePath &bundlePath);
static void launchApp(QPromise<SimulatorControl::ResponseData> &promise,
static void launchApp(QPromise<SimulatorControl::Response> &promise,
const QString &simUdid,
const QString &bundleIdentifier,
bool waitForDebugger,
const QStringList &extraArgs,
const QString &stdoutPath,
const QString &stderrPath);
static void deleteSimulator(QPromise<SimulatorControl::ResponseData> &promise,
const QString &simUdid);
static void resetSimulator(QPromise<SimulatorControl::ResponseData> &promise,
const QString &simUdid);
static void renameSimulator(QPromise<SimulatorControl::ResponseData> &promise,
static void deleteSimulator(QPromise<SimulatorControl::Response> &promise, const QString &simUdid);
static void resetSimulator(QPromise<SimulatorControl::Response> &promise, const QString &simUdid);
static void renameSimulator(QPromise<SimulatorControl::Response> &promise,
const QString &simUdid,
const QString &newName);
static void createSimulator(QPromise<SimulatorControl::ResponseData> &promise,
static void createSimulator(QPromise<SimulatorControl::Response> &promise,
const QString &name,
const DeviceTypeInfo &deviceType,
const RuntimeInfo &runtime);
static void takeSceenshot(QPromise<SimulatorControl::ResponseData> &promise,
static void takeSceenshot(QPromise<SimulatorControl::Response> &promise,
const QString &simUdid,
const QString &filePath);
@@ -309,18 +306,18 @@ QString SimulatorControl::bundleExecutable(const Utils::FilePath &bundlePath)
return Internal::bundleExecutable(bundlePath);
}
QFuture<SimulatorControl::ResponseData> SimulatorControl::startSimulator(const QString &simUdid)
QFuture<SimulatorControl::Response> SimulatorControl::startSimulator(const QString &simUdid)
{
return Utils::asyncRun(Internal::startSimulator, simUdid);
}
QFuture<SimulatorControl::ResponseData> SimulatorControl::installApp(
const QString &simUdid, const Utils::FilePath &bundlePath)
QFuture<SimulatorControl::Response> SimulatorControl::installApp(const QString &simUdid,
const Utils::FilePath &bundlePath)
{
return Utils::asyncRun(Internal::installApp, simUdid, bundlePath);
}
QFuture<SimulatorControl::ResponseData> SimulatorControl::launchApp(const QString &simUdid,
QFuture<SimulatorControl::Response> SimulatorControl::launchApp(const QString &simUdid,
const QString &bundleIdentifier,
bool waitForDebugger,
const QStringList &extraArgs,
@@ -336,31 +333,29 @@ QFuture<SimulatorControl::ResponseData> SimulatorControl::launchApp(const QStrin
stderrPath);
}
QFuture<SimulatorControl::ResponseData> SimulatorControl::deleteSimulator(const QString &simUdid)
QFuture<SimulatorControl::Response> SimulatorControl::deleteSimulator(const QString &simUdid)
{
return Utils::asyncRun(Internal::deleteSimulator, simUdid);
}
QFuture<SimulatorControl::ResponseData> SimulatorControl::resetSimulator(const QString &simUdid)
QFuture<SimulatorControl::Response> SimulatorControl::resetSimulator(const QString &simUdid)
{
return Utils::asyncRun(Internal::resetSimulator, simUdid);
}
QFuture<SimulatorControl::ResponseData> SimulatorControl::renameSimulator(const QString &simUdid,
QFuture<SimulatorControl::Response> SimulatorControl::renameSimulator(const QString &simUdid,
const QString &newName)
{
return Utils::asyncRun(Internal::renameSimulator, simUdid, newName);
}
QFuture<SimulatorControl::ResponseData>
SimulatorControl::createSimulator(const QString &name,
const DeviceTypeInfo &deviceType,
const RuntimeInfo &runtime)
QFuture<SimulatorControl::Response> SimulatorControl::createSimulator(
const QString &name, const DeviceTypeInfo &deviceType, const RuntimeInfo &runtime)
{
return Utils::asyncRun(Internal::createSimulator, name, deviceType, runtime);
}
QFuture<SimulatorControl::ResponseData> SimulatorControl::takeSceenshot(const QString &simUdid,
QFuture<SimulatorControl::Response> SimulatorControl::takeSceenshot(const QString &simUdid,
const QString &filePath)
{
return Utils::asyncRun(Internal::takeSceenshot, simUdid, filePath);
@@ -419,14 +414,14 @@ QString bundleExecutable(const Utils::FilePath &bundlePath)
return executable;
}
void startSimulator(QPromise<SimulatorControl::ResponseData> &promise, const QString &simUdid)
void startSimulator(QPromise<SimulatorControl::Response> &promise, const QString &simUdid)
{
SimulatorControl::ResponseData response(simUdid);
SimulatorInfo simInfo = deviceInfo(simUdid);
if (!simInfo.available) {
promise.addResult(
response.withError(Tr::tr("Simulator device is not available. (%1)").arg(simUdid)));
make_unexpected(Tr::tr("Simulator device is not available. (%1)").arg(simUdid)));
return;
}
// Shutting down state checks are for the case when simulator start is called within a short
@@ -436,7 +431,7 @@ void startSimulator(QPromise<SimulatorControl::ResponseData> &promise, const QSt
while (simInfo.isShuttingDown() && !simulatorStartDeadline.hasExpired()) {
// Wait till the simulator shuts down, if doing so.
if (promise.isCanceled()) {
promise.addResult(response.withError(Tr::tr("Simulator start was canceled.")));
promise.addResult(make_unexpected(Tr::tr("Simulator start was canceled.")));
return;
}
@@ -446,14 +441,14 @@ void startSimulator(QPromise<SimulatorControl::ResponseData> &promise, const QSt
if (simInfo.isShuttingDown()) {
promise.addResult(
response.withError(Tr::tr("Cannot start Simulator device. Previous instance taking "
make_unexpected(Tr::tr("Cannot start Simulator device. Previous instance taking "
"too long to shut down. (%1)")
.arg(simInfo.toString())));
return;
}
if (!simInfo.isShutdown()) {
promise.addResult(response.withError(
promise.addResult(make_unexpected(
Tr::tr("Cannot start Simulator device. Simulator not in shutdown state. (%1)")
.arg(simInfo.toString())));
return;
@@ -462,7 +457,7 @@ void startSimulator(QPromise<SimulatorControl::ResponseData> &promise, const QSt
expected_str<void> result = launchSimulator(simUdid,
[&promise] { return promise.isCanceled(); });
if (!result) {
promise.addResult(response.withError(result.error()));
promise.addResult(make_unexpected(result.error()));
return;
}
@@ -475,24 +470,29 @@ void startSimulator(QPromise<SimulatorControl::ResponseData> &promise, const QSt
do {
info = deviceInfo(simUdid);
if (promise.isCanceled()) {
promise.addResult(response.withError(Tr::tr("Simulator start was canceled.")));
promise.addResult(make_unexpected(Tr::tr("Simulator start was canceled.")));
return;
}
} while (!info.isBooted() && !simulatorStartDeadline.hasExpired());
if (info.isBooted())
response.success = true;
promise.addResult(response.withSuccess());
if (!info.isBooted()) {
promise.addResult(make_unexpected(
Tr::tr("Cannot start Simulator device. Simulator not in booted state. (%1)")
.arg(info.toString())));
return;
}
void installApp(QPromise<SimulatorControl::ResponseData> &promise,
const QString &simUdid, const Utils::FilePath &bundlePath)
promise.addResult(response);
}
void installApp(QPromise<SimulatorControl::Response> &promise,
const QString &simUdid,
const Utils::FilePath &bundlePath)
{
SimulatorControl::ResponseData response(simUdid);
if (!bundlePath.exists()) {
promise.addResult(response.withError(Tr::tr("Bundle path does not exist.")));
promise.addResult(make_unexpected(Tr::tr("Bundle path does not exist.")));
return;
}
@@ -501,12 +501,12 @@ void installApp(QPromise<SimulatorControl::ResponseData> &promise,
&response.commandOutput,
[&promise] { return promise.isCanceled(); });
if (!result)
promise.addResult(response.withError(result.error()));
promise.addResult(make_unexpected(result.error()));
else
promise.addResult(response.withSuccess());
promise.addResult(response);
}
void launchApp(QPromise<SimulatorControl::ResponseData> &promise,
void launchApp(QPromise<SimulatorControl::Response> &promise,
const QString &simUdid,
const QString &bundleIdentifier,
bool waitForDebugger,
@@ -517,7 +517,7 @@ void launchApp(QPromise<SimulatorControl::ResponseData> &promise,
SimulatorControl::ResponseData response(simUdid);
if (bundleIdentifier.isEmpty()) {
promise.addResult(response.withError(Tr::tr("Invalid (empty) bundle identifier.")));
promise.addResult(make_unexpected(Tr::tr("Invalid (empty) bundle identifier.")));
return;
}
@@ -545,19 +545,24 @@ void launchApp(QPromise<SimulatorControl::ResponseData> &promise,
[&promise] { return promise.isCanceled(); });
if (!result) {
promise.addResult(response.withError(result.error()));
promise.addResult(make_unexpected(result.error()));
return;
}
const QString pIdStr = stdOutput.trimmed().split(' ').last().trimmed();
bool validPid = false;
response.pID = pIdStr.toLongLong(&validPid);
response.success = validPid;
response.inferiorPid = pIdStr.toLongLong(&validPid);
promise.addResult(response.withSuccess());
if (!validPid) {
promise.addResult(
make_unexpected(Tr::tr("Failed to convert inferior pid. (%1)").arg(pIdStr)));
return;
}
void deleteSimulator(QPromise<SimulatorControl::ResponseData> &promise, const QString &simUdid)
promise.addResult(response);
}
void deleteSimulator(QPromise<SimulatorControl::Response> &promise, const QString &simUdid)
{
SimulatorControl::ResponseData response(simUdid);
expected_str<void> result = runSimCtlCommand({"delete", simUdid},
@@ -566,12 +571,12 @@ void deleteSimulator(QPromise<SimulatorControl::ResponseData> &promise, const QS
[&promise] { return promise.isCanceled(); });
if (!result)
promise.addResult(response.withError(result.error()));
promise.addResult(make_unexpected(result.error()));
else
promise.addResult(response.withSuccess());
promise.addResult(response);
}
void resetSimulator(QPromise<SimulatorControl::ResponseData> &promise, const QString &simUdid)
void resetSimulator(QPromise<SimulatorControl::Response> &promise, const QString &simUdid)
{
SimulatorControl::ResponseData response(simUdid);
expected_str<void> result = runSimCtlCommand({"erase", simUdid},
@@ -580,12 +585,12 @@ void resetSimulator(QPromise<SimulatorControl::ResponseData> &promise, const QSt
[&promise] { return promise.isCanceled(); });
if (!result)
promise.addResult(response.withError(result.error()));
promise.addResult(make_unexpected(result.error()));
else
promise.addResult(response.withSuccess());
promise.addResult(response);
}
void renameSimulator(QPromise<SimulatorControl::ResponseData> &promise,
void renameSimulator(QPromise<SimulatorControl::Response> &promise,
const QString &simUdid,
const QString &newName)
{
@@ -595,12 +600,12 @@ void renameSimulator(QPromise<SimulatorControl::ResponseData> &promise,
&response.commandOutput,
[&promise] { return promise.isCanceled(); });
if (!result)
promise.addResult(response.withError(result.error()));
promise.addResult(make_unexpected(result.error()));
else
promise.addResult(response.withSuccess());
promise.addResult(response);
}
void createSimulator(QPromise<SimulatorControl::ResponseData> &promise,
void createSimulator(QPromise<SimulatorControl::Response> &promise,
const QString &name,
const DeviceTypeInfo &deviceType,
const RuntimeInfo &runtime)
@@ -618,15 +623,17 @@ void createSimulator(QPromise<SimulatorControl::ResponseData> &promise,
&stdOutput,
&response.commandOutput,
[&promise] { return promise.isCanceled(); });
response.simUdid = result ? stdOutput.trimmed() : QString();
if (result)
response.simUdid = stdOutput.trimmed();
if (!result)
promise.addResult(response.withError(result.error()));
promise.addResult(make_unexpected(result.error()));
else
promise.addResult(response.withSuccess());
promise.addResult(response);
}
void takeSceenshot(QPromise<SimulatorControl::ResponseData> &promise,
void takeSceenshot(QPromise<SimulatorControl::Response> &promise,
const QString &simUdid,
const QString &filePath)
{
@@ -637,9 +644,9 @@ void takeSceenshot(QPromise<SimulatorControl::ResponseData> &promise,
[&promise] { return promise.isCanceled(); });
if (!result)
promise.addResult(response.withError(result.error()));
promise.addResult(make_unexpected(result.error()));
else
promise.addResult(response.withSuccess());
promise.addResult(response);
}
QString SimulatorInfo::toString() const

View File

@@ -54,30 +54,17 @@ class SimulatorControl
{
public:
struct ResponseData {
ResponseData(const QString & udid):
simUdid(udid) { }
ResponseData(const QString &udid)
: simUdid(udid)
{}
QString simUdid;
bool success = false;
qint64 pID = -1;
qint64 inferiorPid{-1};
QString commandOutput;
ResponseData withError(const QString errorMsg)
{
ResponseData result = *this;
result.commandOutput = errorMsg;
result.success = false;
return result;
}
ResponseData withSuccess()
{
ResponseData result = std::move(*this);
result.success = true;
return result;
}
};
using Response = Utils::expected_str<ResponseData>;
public:
static QList<DeviceTypeInfo> availableDeviceTypes();
static QFuture<QList<DeviceTypeInfo>> updateDeviceTypes(QObject *context);
@@ -90,22 +77,21 @@ public:
static QString bundleExecutable(const Utils::FilePath &bundlePath);
public:
static QFuture<ResponseData> startSimulator(const QString &simUdid);
static QFuture<ResponseData> installApp(const QString &simUdid,
const Utils::FilePath &bundlePath);
static QFuture<ResponseData> launchApp(const QString &simUdid,
static QFuture<Response> startSimulator(const QString &simUdid);
static QFuture<Response> installApp(const QString &simUdid, const Utils::FilePath &bundlePath);
static QFuture<Response> launchApp(const QString &simUdid,
const QString &bundleIdentifier,
bool waitForDebugger,
const QStringList &extraArgs,
const QString &stdoutPath = QString(),
const QString &stderrPath = QString());
static QFuture<ResponseData> deleteSimulator(const QString &simUdid);
static QFuture<ResponseData> resetSimulator(const QString &simUdid);
static QFuture<ResponseData> renameSimulator(const QString &simUdid, const QString &newName);
static QFuture<ResponseData> createSimulator(const QString &name,
static QFuture<Response> deleteSimulator(const QString &simUdid);
static QFuture<Response> resetSimulator(const QString &simUdid);
static QFuture<Response> renameSimulator(const QString &simUdid, const QString &newName);
static QFuture<Response> createSimulator(const QString &name,
const DeviceTypeInfo &deviceType,
const RuntimeInfo &runtime);
static QFuture<ResponseData> takeSceenshot(const QString &simUdid, const QString &filePath);
static QFuture<Response> takeSceenshot(const QString &simUdid, const QString &filePath);
};
} // Ios::Internal

View File

@@ -94,15 +94,15 @@ void SimulatorOperationDialog::addMessage(const QString &message, Utils::OutputF
}
void SimulatorOperationDialog::addMessage(const SimulatorInfo &siminfo,
const SimulatorControl::ResponseData &response,
const SimulatorControl::Response &response,
const QString &context)
{
QTC_CHECK(siminfo.identifier == response.simUdid);
if (response.success) {
if (response) {
QTC_CHECK(siminfo.identifier == response->simUdid);
addMessage(Tr::tr("%1, %2\nOperation %3 completed successfully.").arg(siminfo.name)
.arg(siminfo.runtimeName).arg(context), Utils::StdOutFormat);
} else {
QString erroMsg = response.commandOutput.trimmed();
QString erroMsg = response.error();
QString message = Tr::tr("%1, %2\nOperation %3 failed.\nUDID: %4\nError: %5").arg(siminfo.name)
.arg(siminfo.runtimeName).arg(context).arg(siminfo.identifier)
.arg(erroMsg.isEmpty() ? Tr::tr("Unknown") : erroMsg);

View File

@@ -30,7 +30,8 @@ public:
public:
void addFutures(const QList<QFuture<void> > &futureList);
void addMessage(const QString &message, Utils::OutputFormat format);
void addMessage(const SimulatorInfo &siminfo, const SimulatorControl::ResponseData &response,
void addMessage(const SimulatorInfo &siminfo,
const SimulatorControl::Response &response,
const QString &context);
private: