Implement environment variables in requests

theCheeseboard · Sep 10, 2023 · ce3663a · ce3663a
1 parent 4c4ff9c
commit ce3663a
Show file tree

Hide file tree

Showing 8 changed files with 122 additions and 12 deletions.
diff --git a/libthezzz/providers/endpointprovider.cpp b/libthezzz/providers/endpointprovider.cpp
@@ -34,8 +34,8 @@ void EndpointProvider::setEndpoint(QString endpoint) {
     emit this->workspace()->dataChanged();
 }
 
-QUrl EndpointProvider::calculateUrl() {
-    return d->endpoint;
+QUrl EndpointProvider::calculateUrl(QList<ZzzVariable>* missingEnvironmentVariables) {
+    return this->workspace()->substituteEnvironment(d->endpoint, missingEnvironmentVariables);
 }
 
 QString EndpointProvider::jsonKey() {

diff --git a/libthezzz/providers/endpointprovider.h b/libthezzz/providers/endpointprovider.h
@@ -1,6 +1,7 @@
 #ifndef ENDPOINTPROVIDER_H
 #define ENDPOINTPROVIDER_H
 
+#include "environmentprovider.h"
 #include "zzzprovider.h"
 #include <QString>
 
@@ -17,7 +18,7 @@ class EndpointProvider : public ZzzProvider<EndpointProvider> {
         QString endpoint();
         void setEndpoint(QString endpoint);
 
-        QUrl calculateUrl();
+        QUrl calculateUrl(QList<ZzzVariable>* missingEnvironmentVariables = nullptr);
 
     private:
         EndpointProviderPrivate* d;

diff --git a/libthezzz/providers/environmentprovider.cpp b/libthezzz/providers/environmentprovider.cpp
@@ -42,6 +42,9 @@ void EnvironmentProvider::removeEnvironment(QUuid uuid) {
     d->environments.removeIf([uuid](ZzzEnvironment env) {
         return env.first == uuid;
     });
+    d->envVars.removeIf([uuid](ZzzEnvironmentVariable envVar) {
+        return std::get<0>(envVar) == uuid;
+    });
     emit this->workspace()->dataChanged();
 }
 
@@ -58,9 +61,20 @@ QList<ZzzVariable> EnvironmentProvider::variables() {
 
 void EnvironmentProvider::setVariables(QList<ZzzVariable> variables) {
     d->variables = variables;
+    d->envVars.removeIf([variables](ZzzEnvironmentVariable envVar) {
+        return !tRange(variables).some([envVar](ZzzVariable var) {
+            return std::get<0>(var) == std::get<1>(envVar);
+        });
+    });
     emit this->workspace()->dataChanged();
 }
 
+QString EnvironmentProvider::variableName(QUuid variable) {
+    return std::get<1>(tRange(d->variables).first([variable](ZzzVariable var) {
+        return std::get<0>(var) == variable;
+    }));
+}
+
 QList<ZzzEnvironmentVariable> EnvironmentProvider::environmentVariables() {
     return d->envVars;
 }
@@ -74,6 +88,33 @@ QUuid EnvironmentProvider::currentEnvironment() {
     return d->currentEnvironment;
 }
 
+QString EnvironmentProvider::substituteEnvironment(QString string, QList<ZzzVariable>* missingEnvironmentVariables) {
+    for (const auto& envVar : d->envVars) {
+        auto [envUuid, varUuid, value] = envVar;
+        try {
+            auto variable = tRange(d->variables).first([envVar](ZzzVariable var) {
+                auto [envUuid, varUuid, value] = envVar;
+                return std::get<0>(var) == varUuid;
+            });
+            auto [varUuid2, varName, varIsSecret] = variable;
+
+            auto searchTerm = QStringLiteral("{{%1}}").arg(varName);
+            if (string.contains(searchTerm)) {
+                if (value.isEmpty()) {
+                    if (missingEnvironmentVariables) missingEnvironmentVariables->append(variable);
+                    string = string.replace(searchTerm, "");
+                } else {
+                    string = string.replace(searchTerm, value);
+                }
+            }
+        } catch (tRangeException& ex) {
+            // ignore
+        }
+    }
+
+    return string;
+}
+
 QString EnvironmentProvider::jsonKey() {
     return QStringLiteral("env");
 }

diff --git a/libthezzz/providers/environmentprovider.h b/libthezzz/providers/environmentprovider.h
@@ -3,6 +3,7 @@
 
 #include "zzzprovider.h"
 #include <QCoreApplication>
+#include <texception.h>
 
 typedef std::pair<QUuid, QString> ZzzEnvironment;
 typedef std::tuple<QUuid, QString, bool> ZzzVariable;
@@ -23,11 +24,13 @@ class EnvironmentProvider : public ZzzProvider<EnvironmentProvider> {
 
         QList<ZzzVariable> variables();
         void setVariables(QList<ZzzVariable> variables);
+        QString variableName(QUuid variable);
 
         QList<ZzzEnvironmentVariable> environmentVariables();
         void setEnvironmentVariables(QList<ZzzEnvironmentVariable> environmentVariables);
 
         QUuid currentEnvironment();
+        QString substituteEnvironment(QString string, QList<ZzzVariable>* missingEnvironmentVariables = nullptr);
 
     private:
         EnvironmentProviderPrivate* d;

diff --git a/libthezzz/translations/en_US.ts b/libthezzz/translations/en_US.ts
@@ -97,7 +97,7 @@
     <name>EnvironmentProvider</name>
     <message>
         <location filename="../providers/environmentprovider.cpp" line="20"/>
-        <location filename="../providers/environmentprovider.cpp" line="123"/>
+        <location filename="../providers/environmentprovider.cpp" line="164"/>
         <source>Production</source>
         <translation type="unfinished"></translation>
     </message>
@@ -401,8 +401,8 @@
 <context>
     <name>ZzzRequest</name>
     <message>
-        <location filename="../zzzrequest.cpp" line="16"/>
-        <location filename="../zzzrequest.cpp" line="20"/>
+        <location filename="../zzzrequest.cpp" line="17"/>
+        <location filename="../zzzrequest.cpp" line="21"/>
         <source>Untitled Request</source>
         <translation type="unfinished"></translation>
     </message>
@@ -414,6 +414,23 @@
         <source>Form</source>
         <translation type="unfinished"></translation>
     </message>
+    <message>
+        <location filename="../widgets/zzzrequesteditor.cpp" line="75"/>
+        <source>Environment Incomplete</source>
+        <translation type="unfinished"></translation>
+    </message>
+    <message>
+        <location filename="../widgets/zzzrequesteditor.cpp" line="76"/>
+        <source>The request cannot be sent because some environment variables used by this request are not set.</source>
+        <translation type="unfinished"></translation>
+    </message>
+    <message numerus="yes">
+        <location filename="../widgets/zzzrequesteditor.cpp" line="77"/>
+        <source>The environment variable(s) %1 need to be set before the request can be sent.</source>
+        <translation type="unfinished">
+            <numerusform></numerusform>
+        </translation>
+    </message>
 </context>
 <context>
     <name>ZzzRequestFolder</name>

diff --git a/libthezzz/widgets/zzzrequesteditor.cpp b/libthezzz/widgets/zzzrequesteditor.cpp
@@ -5,6 +5,8 @@
 #include "providers/endpointprovider.h"
 #include "zzzrequest.h"
 #include <QToolButton>
+#include <ranges/trange.h>
+#include <tmessagebox.h>
 
 struct ZzzRequestEditorPrivate {
         ZzzRequestTreeItemPtr request;
@@ -60,6 +62,21 @@ void ZzzRequestEditor::executeRequest() {
     auto request = d->request.dynamicCast<ZzzRequest>();
     if (!request) return;
 
-    auto reply = request->execute();
-    emit addReply(reply);
+    try {
+        auto reply = request->execute();
+        emit addReply(reply);
+    } catch (EnvironmentIncompleteException& ex) {
+        ([this, &ex]() -> QCoro::Task<> {
+            auto missingVariables = tRange(ex.missingVariables()).map<QString>([](ZzzVariable variable) {
+                                                                     return QLocale().quoteString(std::get<1>(variable));
+                                                                 })
+                                        .toList();
+            tMessageBox box(this->window());
+            box.setTitleBarText(tr("Environment Incomplete"));
+            box.setMessageText(tr("The request cannot be sent because some environment variables used by this request are not set."));
+            box.setInformativeText(tr("The environment variable(s) %1 need to be set before the request can be sent.", nullptr, missingVariables.length()).arg(QLocale().createSeparatedList(missingVariables)));
+            box.setIcon(QMessageBox::Information);
+            co_await box.presentAsync();
+        })();
+    }
 }
diff --git a/libthezzz/zzzrequest.cpp b/libthezzz/zzzrequest.cpp
@@ -3,6 +3,7 @@
 #include "workspacefile.h"
 #include "zzzreply.h"
 #include <QNetworkAccessManager>
+#include <ranges/trange.h>
 
 struct ZzzRequestPrivate {
         WorkspaceFilePtr workspace;
@@ -28,23 +29,24 @@ ZzzRequest::~ZzzRequest() {
 }
 
 ZzzReplyPtr ZzzRequest::execute() {
+    QList<ZzzVariable> missingEnvironmentVariables;
     auto mgr = d->workspace->networkAccessManager();
 
     QNetworkRequest request;
     request.setAttribute(QNetworkRequest::CacheLoadControlAttribute, QNetworkRequest::AlwaysNetwork);
-    request.setUrl(this->endpoint());
+    request.setUrl(this->calculateUrl(&missingEnvironmentVariables));
 
     for (const auto& header : this->implicitHeadersWithAncestors()) {
-        request.setRawHeader(header.first, header.second);
+        request.setRawHeader(header.first, d->workspace->substituteEnvironment(header.second, &missingEnvironmentVariables).toUtf8());
     }
 
     for (const auto& header : this->ancestorHeaders()) {
-        request.setRawHeader(header.first, header.second);
+        request.setRawHeader(header.first, d->workspace->substituteEnvironment(header.second, &missingEnvironmentVariables).toUtf8());
     }
 
     // TODO: Concatenate multiple headers correctly
     for (const auto& header : this->headers()) {
-        request.setRawHeader(header.first, header.second);
+        request.setRawHeader(header.first, d->workspace->substituteEnvironment(header.second, &missingEnvironmentVariables).toUtf8());
     }
 
     QNetworkReply* networkReply;
@@ -60,6 +62,14 @@ ZzzReplyPtr ZzzRequest::execute() {
         networkReply = mgr->sendCustomRequest(request, this->verb().toUtf8(), this->body());
     }
 
+    missingEnvironmentVariables = tRange(missingEnvironmentVariables).unique<QUuid>([](ZzzVariable variable) {
+                                                                         return std::get<0>(variable);
+                                                                     })
+                                      .toList();
+    if (!missingEnvironmentVariables.isEmpty()) {
+        throw EnvironmentIncompleteException(missingEnvironmentVariables);
+    }
+
     auto reply = new ZzzReply(this->verb(), request, networkReply);
     return reply->sharedFromThis();
 }
@@ -73,3 +83,13 @@ QJsonValue ZzzRequest::toJson() {
     json.insert("type", "request");
     return json;
 }
+
+EnvironmentIncompleteException::EnvironmentIncompleteException(QList<ZzzVariable> missingVariables) {
+    _missingVariables = missingVariables;
+}
+
+QList<ZzzVariable> EnvironmentIncompleteException::missingVariables() {
+    return _missingVariables;
+}
+
+T_EXCEPTION_IMPL(EnvironmentIncompleteException)
diff --git a/libthezzz/zzzrequest.h b/libthezzz/zzzrequest.h
@@ -41,4 +41,15 @@ class LIBTHEZZZ_EXPORT ZzzRequest : public QObject,
 
 typedef QSharedPointer<ZzzRequest> ZzzRequestPtr;
 
+class LIBCONTEMPORARY_EXPORT EnvironmentIncompleteException : public tException {
+        T_EXCEPTION(EnvironmentIncompleteException)
+    public:
+        EnvironmentIncompleteException(QList<ZzzVariable> missingVariables);
+
+        QList<ZzzVariable> missingVariables();
+
+    private:
+        QList<ZzzVariable> _missingVariables;
+};
+
 #endif // ZZZREQUEST_H