Add middleware abstraction

.vscode/settings.json

@@ -70,6 +70,8 @@
         "typeinfo": "cpp",
         "valarray": "cpp",
         "variant": "cpp",
-        "*.inc": "cpp"
+        "*.inc": "cpp",
+        "regex": "cpp",
+        "shared_mutex": "cpp"
     }
 }

examples/seat-adjuster/src/SeatAdjusterApp.cpp

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) 2022 Robert Bosch GmbH
+ * Copyright (c) 2022-2023 Robert Bosch GmbH
  *
  * This program and the accompanying materials are made available under the
  * terms of the Apache License, Version 2.0 which is available at
@@ -40,7 +40,7 @@ const auto STATUS_FAIL = 1;
 
 SeatAdjusterApp::SeatAdjusterApp()
     : VehicleApp(velocitas::IVehicleDataBrokerClient::createInstance("vehicledatabroker"),
-                 velocitas::IPubSubClient::createInstance("localhost:1883", "SeatAdjusterApp"))
+                 velocitas::IPubSubClient::createInstance("SeatAdjusterApp"))
     , m_vehicleModel(std::make_shared<velocitas::Vehicle>()) {}
 
 void SeatAdjusterApp::onStart() {

examples/set-data-points/src/SetDataPointsApp.cpp

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) 2022 Robert Bosch GmbH
+ * Copyright (c) 2022-2023 Robert Bosch GmbH
  *
  * This program and the accompanying materials are made available under the
  * terms of the Apache License, Version 2.0 which is available at
@@ -30,9 +30,8 @@ namespace example {
 class SetDataPointsApp : public velocitas::VehicleApp {
 public:
     SetDataPointsApp()
-        : VehicleApp(
-              velocitas::IVehicleDataBrokerClient::createInstance("vehicledatabroker"),
-              velocitas::IPubSubClient::createInstance("localhost:1883", "SetDataPointsApp")) {}
+        : VehicleApp(velocitas::IVehicleDataBrokerClient::createInstance("vehicledatabroker"),
+                     velocitas::IPubSubClient::createInstance("SetDataPointsApp")) {}
 
     void onStart() override {
         velocitas::logger().info("Setting data points!");

sdk/include/sdk/Config.h

@@ -0,0 +1,31 @@
+/**
+ * Copyright (c) 2023 Robert Bosch GmbH
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Apache License, Version 2.0 which is available at
+ * https://www.apache.org/licenses/LICENSE-2.0.
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations
+ * under the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#ifndef VEHICLE_APP_SDK_CONFIG_H
+#define VEHICLE_APP_SDK_CONFIG_H
+
+#include "middleware/Middleware.h"
+
+namespace velocitas {
+
+class Config {
+public:
+    static Middleware& getMiddleware() { return Middleware::getInstance(); }
+};
+
+} // namespace velocitas
+
+#endif // VEHICLE_APP_SDK_CONFIG_H

sdk/include/sdk/IPubSubClient.h

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) 2022 Robert Bosch GmbH
+ * Copyright (c) 2022-2023 Robert Bosch GmbH
  *
  * This program and the accompanying materials are made available under the
  * terms of the Apache License, Version 2.0 which is available at
@@ -30,8 +30,9 @@ namespace velocitas {
  */
 class IPubSubClient {
 public:
-    static std::shared_ptr<IPubSubClient> createInstance(const std::string& brokerUri,
-                                                         const std::string& clientId);
+    static std::shared_ptr<IPubSubClient> createInstance(const std::string& clientId);
+    [[deprecated]] static std::shared_ptr<IPubSubClient>
+    createInstance(const std::string& brokerUri, const std::string& clientId);
 
     virtual ~IPubSubClient() = default;
 

sdk/include/sdk/Utils.h

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) 2022 Robert Bosch GmbH
+ * Copyright (c) 2022-2023 Robert Bosch GmbH
  *
  * This program and the accompanying materials are made available under the
  * terms of the Apache License, Version 2.0 which is available at
@@ -22,12 +22,24 @@
 
 namespace velocitas {
 
+/**
+ * @brief Get the value of the specified environment variable
+ *
+ * @param varName  Name of the environment variable
+ * @param defaultValue  Default if variable is not set
+ * @return std::string containing the value of the variable or the default value
+ */
+std::string getEnvVar(const std::string& varName, const std::string& defaultValue = "");
+
 /**
  * @brief Provides utility methods for handling strings.
  *
  */
 class StringUtils final {
 public:
+    static std::string toLower(const std::string& str);
+    static std::string toUpper(const std::string& str);
+
     static std::string join(const std::vector<std::string>& stringVector,
                             const std::string&              separator);
 

sdk/include/sdk/grpc/VehicleDataBrokerClient.h

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) 2022 Robert Bosch GmbH
+ * Copyright (c) 2022-2023 Robert Bosch GmbH
  *
  * This program and the accompanying materials are made available under the
  * terms of the Apache License, Version 2.0 which is available at
@@ -20,6 +20,7 @@
 #include "sdk/vdb/IVehicleDataBrokerClient.h"
 
 #include <memory>
+#include <string>
 #include <vector>
 
 namespace velocitas {
@@ -33,8 +34,8 @@ class BrokerAsyncGrpcFacade;
  */
 class VehicleDataBrokerClient : public IVehicleDataBrokerClient {
 public:
-    explicit VehicleDataBrokerClient(const std::string& vdbAddress, std::string vdbAppId);
-    explicit VehicleDataBrokerClient(const std::string& vdbAppId);
+    explicit VehicleDataBrokerClient(const std::string& vdbAddress, std::string vdbServiceName);
+    explicit VehicleDataBrokerClient(const std::string& vdbserviceName);
 
     ~VehicleDataBrokerClient() override;
 
@@ -52,11 +53,9 @@ class VehicleDataBrokerClient : public IVehicleDataBrokerClient {
     AsyncSubscriptionPtr_t<DataPointReply> subscribe(const std::string& query) override;
 
 private:
-    static std::string getVdbEndpointAddress();
-
     std::shared_ptr<BrokerAsyncGrpcFacade> m_asyncBrokerFacade;
-    std::string                            m_vdbAppId;
 };
+
 } // namespace velocitas
 
 #endif // VEHICLE_APP_SDK_VEHICLEDATABROKERCLIENT_H

sdk/include/sdk/middleware/Middleware.h

@@ -0,0 +1,62 @@
+/**
+ * Copyright (c) 2023 Robert Bosch GmbH
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Apache License, Version 2.0 which is available at
+ * https://www.apache.org/licenses/LICENSE-2.0.
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations
+ * under the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#ifndef VEHICLE_APP_SDK_MIDDLEWARE_MIDDLEWARE_H
+#define VEHICLE_APP_SDK_MIDDLEWARE_MIDDLEWARE_H
+
+#include <memory>
+#include <string>
+#include <unordered_map>
+
+namespace velocitas {
+
+class Middleware {
+public:
+    enum class Type { UNKNOWN, NATIVE, DAPR };
+
+    static Middleware& getInstance() {
+        static std::unique_ptr<Middleware> singleton = instantiate();
+        return *singleton;
+    }
+
+    virtual Type getType() const = 0;
+
+    virtual void start() {}
+    virtual void waitUntilReady() {}
+    virtual void stop() {}
+
+    virtual std::string getServiceLocation(const std::string& serviceName) const = 0;
+    using Metadata = std::unordered_map<std::string, std::string>;
+    virtual Metadata getMetadata(const std::string& serviceName) const {
+        std::ignore = serviceName;
+        return Metadata{};
+    }
+
+protected:
+    Middleware() = default;
+
+private:
+    static std::unique_ptr<Middleware> instantiate();
+
+    Middleware(const Middleware&)            = delete;
+    Middleware(Middleware&&)                 = delete;
+    Middleware& operator=(const Middleware&) = delete;
+    Middleware& operator=(Middleware&&)      = delete;
+};
+
+} // namespace velocitas
+
+#endif // VEHICLE_APP_SDK_MIDDLEWARE_MIDDLEWARE_H

sdk/include/sdk/vdb/IVehicleDataBrokerClient.h

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) 2022 Robert Bosch GmbH
+ * Copyright (c) 2022-2023 Robert Bosch GmbH
  *
  * This program and the accompanying materials are made available under the
  * terms of the Apache License, Version 2.0 which is available at
@@ -77,7 +77,7 @@ class IVehicleDataBrokerClient {
      *
      * @return std::shared_ptr<IVehicleDataBrokerClient>
      */
-    static std::shared_ptr<IVehicleDataBrokerClient> createInstance(const std::string& vdbAppId);
+    static std::shared_ptr<IVehicleDataBrokerClient> createInstance(const std::string& serviceName);
 
 protected:
     IVehicleDataBrokerClient() = default;

sdk/src/CMakeLists.txt

@@ -1,4 +1,4 @@
-# Copyright (c) 2022 Robert Bosch GmbH
+# Copyright (c) 2022-2023 Robert Bosch GmbH
 #
 # This program and the accompanying materials are made available under the
 # terms of the Apache License, Version 2.0 which is available at
@@ -15,10 +15,7 @@
 set(TARGET_NAME "vehicle-app-sdk")
 
 add_library(${TARGET_NAME}
-    sdk/vdb/DataPointBatch.cpp
-
     sdk/VehicleApp.cpp
-    sdk/pubsub/MqttPubSubClient.cpp
     sdk/Node.cpp
     sdk/QueryBuilder.cpp
     sdk/DataPoint.cpp
@@ -28,12 +25,18 @@ add_library(${TARGET_NAME}
     sdk/Utils.cpp
     sdk/Logger.cpp
 
-    sdk/dapr/DaprSupport.cpp
     sdk/grpc/GrpcClient.cpp
     sdk/grpc/AsyncGrpcFacade.cpp
     sdk/grpc/BrokerAsyncGrpcFacade.cpp
     sdk/grpc/GrpcDataPointValueProvider.cpp
     sdk/grpc/VehicleDataBrokerClient.cpp
+
+    sdk/middleware/Middleware.cpp
+    sdk/middleware/DaprMiddleware.cpp
+    sdk/middleware/NativeMiddleware.cpp
+
+    sdk/pubsub/MqttPubSubClient.cpp
+    sdk/vdb/DataPointBatch.cpp
 )
 
 include_directories(

sdk/src/sdk/Utils.cpp

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) 2022 Robert Bosch GmbH
+ * Copyright (c) 2022-2023 Robert Bosch GmbH
  *
  * This program and the accompanying materials are made available under the
  * terms of the Apache License, Version 2.0 which is available at
@@ -17,10 +17,32 @@
 #include "sdk/Utils.h"
 
 #include <algorithm>
+#include <cctype>
+#include <cstdlib>
 #include <sstream>
 
 namespace velocitas {
 
+std::string getEnvVar(const std::string& varName, const std::string& defaultValue) {
+    auto* const value = ::getenv(varName.c_str());
+    if (value != nullptr) {
+        return std::string(value);
+    }
+    return defaultValue;
+}
+
+std::string StringUtils::toLower(const std::string& str) {
+    std::string result{str};
+    std::transform(result.begin(), result.end(), result.begin(), ::tolower);
+    return result;
+}
+
+std::string StringUtils::toUpper(const std::string& str) {
+    std::string result{str};
+    std::transform(result.begin(), result.end(), result.begin(), ::toupper);
+    return result;
+}
+
 std::string StringUtils::join(const std::vector<std::string>& stringVector,
                               const std::string&              separator) {
     std::ostringstream oss;

sdk/src/sdk/VehicleApp.cpp

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) 2022 Robert Bosch GmbH
+ * Copyright (c) 2022-2023 Robert Bosch GmbH
  *
  * This program and the accompanying materials are made available under the
  * terms of the Apache License, Version 2.0 which is available at
@@ -16,10 +16,10 @@
 
 #include "sdk/VehicleApp.h"
 
+#include "sdk/Config.h"
 #include "sdk/IPubSubClient.h"
 #include "sdk/Logger.h"
 #include "sdk/VehicleModelContext.h"
-#include "sdk/dapr/DaprSupport.h"
 #include "sdk/vdb/IVehicleDataBrokerClient.h"
 
 #include <fmt/core.h>
@@ -40,12 +40,11 @@ VehicleApp::VehicleApp(std::shared_ptr<IVehicleDataBrokerClient> vdbClient,
 }
 
 void VehicleApp::run() {
-    m_pubSubClient->connect();
-
     logger().info("Running App...");
+    Config::getMiddleware().start();
+    Config::getMiddleware().waitUntilReady();
 
-    dapr::waitForSidecar();
-
+    m_pubSubClient->connect();
     onStart();
 
     // TODO: Fix busy waiting
@@ -55,10 +54,12 @@ void VehicleApp::run() {
 }
 
 void VehicleApp::stop() {
-    onStop();
+    logger().info("Stopping App...");
 
+    onStop();
     m_pubSubClient->disconnect();
-    logger().info("Stopping App...");
+
+    Config::getMiddleware().stop();
 }
 
 AsyncSubscriptionPtr_t<std::string> VehicleApp::subscribeToTopic(const std::string& topic) {