From 683914584dbf6d555d15bf31be8e0d6da4260e84 Mon Sep 17 00:00:00 2001
From: Alberto Codutti <alberto.codutti@eurotech.com>
Date: Tue, 18 Jun 2024 15:02:21 +0200
Subject: [PATCH] :sparkles: [Messaging] Introduced configuration to optionally
 skip Device.id resolution for KapuaDataMessage

Signed-off-by: Alberto Codutti <alberto.codutti@eurotech.com>
---
 .../kura/kapua/TranslatorDataKuraKapua.java   | 17 +++++-
 .../TranslatorKapuaKuraSettingKeys.java       | 56 ++++++++++++++++++
 .../setting/TranslatorKapuaKuraSettings.java  | 57 +++++++++++++++++++
 .../translator-kapua-kura-settings.properties | 14 +++++
 4 files changed, 141 insertions(+), 3 deletions(-)
 create mode 100644 translator/kapua/kura/src/main/java/org/eclipse/kapua/translator/setting/TranslatorKapuaKuraSettingKeys.java
 create mode 100644 translator/kapua/kura/src/main/java/org/eclipse/kapua/translator/setting/TranslatorKapuaKuraSettings.java
 create mode 100644 translator/kapua/kura/src/main/resources/translator-kapua-kura-settings.properties

diff --git a/translator/kapua/kura/src/main/java/org/eclipse/kapua/translator/kura/kapua/TranslatorDataKuraKapua.java b/translator/kapua/kura/src/main/java/org/eclipse/kapua/translator/kura/kapua/TranslatorDataKuraKapua.java
index f4ec4763e4d..89b43d93228 100644
--- a/translator/kapua/kura/src/main/java/org/eclipse/kapua/translator/kura/kapua/TranslatorDataKuraKapua.java
+++ b/translator/kapua/kura/src/main/java/org/eclipse/kapua/translator/kura/kapua/TranslatorDataKuraKapua.java
@@ -30,6 +30,8 @@
 import org.eclipse.kapua.translator.exception.InvalidMessageException;
 import org.eclipse.kapua.translator.exception.InvalidPayloadException;
 import org.eclipse.kapua.translator.exception.TranslateException;
+import org.eclipse.kapua.translator.setting.TranslatorKapuaKuraSettingKeys;
+import org.eclipse.kapua.translator.setting.TranslatorKapuaKuraSettings;
 
 /**
  * {@link Translator} implementation from {@link KuraDataMessage} to {@link KapuaDataMessage}
@@ -45,6 +47,12 @@ public class TranslatorDataKuraKapua extends Translator<KuraDataMessage, KapuaDa
 
     private static final KapuaDataMessageFactory DATA_MESSAGE_FACTORY = LOCATOR.getFactory(KapuaDataMessageFactory.class);
 
+    final private boolean resolveDeviceId;
+
+    public TranslatorDataKuraKapua() {
+        resolveDeviceId = TranslatorKapuaKuraSettings.getInstance().getBoolean(TranslatorKapuaKuraSettingKeys.TRANSLATOR_KURA_KAPUA_DATA_DEVICE_ID_RESOLVE);
+    }
+
     @Override
     public KapuaDataMessage translate(KuraDataMessage kuraMessage) throws TranslateException {
         try {
@@ -64,11 +72,8 @@ public KapuaDataMessage translate(KuraDataMessage kuraMessage) throws TranslateE
                 throw new KapuaEntityNotFoundException(Account.TYPE, kuraMessage.getChannel().getScope());
             }
 
-            Device device = DEVICE_REGISTRY_SERVICE.findByClientId(account.getId(), kuraMessage.getChannel().getClientId());
-
             KapuaDataMessage kapuaDataMessage = DATA_MESSAGE_FACTORY.newKapuaDataMessage();
             kapuaDataMessage.setScopeId(account.getId());
-            kapuaDataMessage.setDeviceId(device != null ? device.getId() : null);
             kapuaDataMessage.setClientId(kuraMessage.getChannel().getClientId());
             kapuaDataMessage.setChannel(kapuaDataChannel);
             kapuaDataMessage.setPayload(kapuaDataPayload);
@@ -77,6 +82,12 @@ public KapuaDataMessage translate(KuraDataMessage kuraMessage) throws TranslateE
             kapuaDataMessage.setReceivedOn(kuraMessage.getTimestamp());
             kapuaDataMessage.setPosition(TranslatorKuraKapuaUtils.translate(kuraMessage.getPayload().getPosition()));
 
+            // Optionally resolve the KapuaDataChannel.clientId to improve performances
+            if (resolveDeviceId) {
+                Device device = DEVICE_REGISTRY_SERVICE.findByClientId(account.getId(), kuraMessage.getChannel().getClientId());
+                kapuaDataMessage.setDeviceId(device != null ? device.getId() : null);
+            }
+
             // Return Kapua Message
             return kapuaDataMessage;
         } catch (InvalidChannelException | InvalidPayloadException te) {
diff --git a/translator/kapua/kura/src/main/java/org/eclipse/kapua/translator/setting/TranslatorKapuaKuraSettingKeys.java b/translator/kapua/kura/src/main/java/org/eclipse/kapua/translator/setting/TranslatorKapuaKuraSettingKeys.java
new file mode 100644
index 00000000000..befa4d47ec0
--- /dev/null
+++ b/translator/kapua/kura/src/main/java/org/eclipse/kapua/translator/setting/TranslatorKapuaKuraSettingKeys.java
@@ -0,0 +1,56 @@
+/*******************************************************************************
+ * Copyright (c) 2024, 2022 Eurotech and/or its affiliates and others
+ *
+ * This program and the accompanying materials are made
+ * available under the terms of the Eclipse Public License 2.0
+ * which is available at https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Contributors:
+ *     Eurotech - initial API and implementation
+ *******************************************************************************/
+package org.eclipse.kapua.translator.setting;
+
+import org.eclipse.kapua.commons.setting.SettingKey;
+import org.eclipse.kapua.message.device.data.KapuaDataMessage;
+import org.eclipse.kapua.service.device.call.message.kura.KuraChannel;
+import org.eclipse.kapua.service.device.call.message.kura.data.KuraDataMessage;
+import org.eclipse.kapua.service.device.registry.Device;
+
+/**
+ * {@link SettingKey}s for {@link TranslatorKapuaKuraSettings}
+ *
+ * @since 2.1.0
+ */
+public enum TranslatorKapuaKuraSettingKeys implements SettingKey {
+
+    /**
+     * Whether to resolve the {@link Device#getId()} from the {@link KuraChannel#getClientId()} when converting from {@link KuraDataMessage} to {@link KapuaDataMessage}.
+     *
+     * @since 2.1.0
+     */
+    TRANSLATOR_KURA_KAPUA_DATA_DEVICE_ID_RESOLVE("translator.kura.kapua.data.deviceId.resolve");
+
+    /**
+     * The key value of the {@link SettingKey}.
+     *
+     * @since 2.1.0
+     */
+    private final String key;
+
+    /**
+     * Constructor.
+     *
+     * @param key The key value of the {@link SettingKey}.
+     * @since 2.1.0
+     */
+    TranslatorKapuaKuraSettingKeys(String key) {
+        this.key = key;
+    }
+
+    @Override
+    public String key() {
+        return key;
+    }
+}
diff --git a/translator/kapua/kura/src/main/java/org/eclipse/kapua/translator/setting/TranslatorKapuaKuraSettings.java b/translator/kapua/kura/src/main/java/org/eclipse/kapua/translator/setting/TranslatorKapuaKuraSettings.java
new file mode 100644
index 00000000000..0d5c11fd97d
--- /dev/null
+++ b/translator/kapua/kura/src/main/java/org/eclipse/kapua/translator/setting/TranslatorKapuaKuraSettings.java
@@ -0,0 +1,57 @@
+/*******************************************************************************
+ * Copyright (c) 2024, 2022 Eurotech and/or its affiliates and others
+ *
+ * This program and the accompanying materials are made
+ * available under the terms of the Eclipse Public License 2.0
+ * which is available at https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Contributors:
+ *     Eurotech - initial API and implementation
+ *******************************************************************************/
+package org.eclipse.kapua.translator.setting;
+
+import org.eclipse.kapua.commons.setting.AbstractKapuaSetting;
+
+/**
+ * {@link TranslatorKapuaKuraSettings} for {@code kapua-translator-kapua-kura} module.
+ *
+ * @see AbstractKapuaSetting
+ * @since 2.1.0
+ */
+public class TranslatorKapuaKuraSettings extends AbstractKapuaSetting<TranslatorKapuaKuraSettingKeys> {
+
+    /**
+     * Setting filename.
+     *
+     * @since 2.1.0
+     */
+    private static final String TRANSLATOR_KAPUA_KURA_SETTING_RESOURCE = "translator-kapua-kura-settings.properties";
+
+    /**
+     * The singleton instance of {@link TranslatorKapuaKuraSettings}
+     *
+     * @since 2.1.0
+     */
+    private static final TranslatorKapuaKuraSettings INSTANCE = new TranslatorKapuaKuraSettings();
+
+    /**
+     * Constructor.
+     *
+     * @since 2.1.0
+     */
+    public TranslatorKapuaKuraSettings() {
+        super(TRANSLATOR_KAPUA_KURA_SETTING_RESOURCE);
+    }
+
+    /**
+     * Gets the singleton instance of {@link TranslatorKapuaKuraSettings}
+     * @return The singleton instance of {@link TranslatorKapuaKuraSettings}
+     *
+     * @since 2.1.0
+     */
+    public static TranslatorKapuaKuraSettings getInstance() {
+        return INSTANCE;
+    }
+}
diff --git a/translator/kapua/kura/src/main/resources/translator-kapua-kura-settings.properties b/translator/kapua/kura/src/main/resources/translator-kapua-kura-settings.properties
new file mode 100644
index 00000000000..036714020fe
--- /dev/null
+++ b/translator/kapua/kura/src/main/resources/translator-kapua-kura-settings.properties
@@ -0,0 +1,14 @@
+###############################################################################
+# Copyright (c) 2024, 2022 Eurotech and/or its affiliates and others
+#
+# This program and the accompanying materials are made
+# available under the terms of the Eclipse Public License 2.0
+# which is available at https://www.eclipse.org/legal/epl-2.0/
+#
+# SPDX-License-Identifier: EPL-2.0
+#
+# Contributors:
+#     Eurotech - initial API and implementation
+#
+###############################################################################
+translator.kura.kapua.data.deviceId.resolve=true