feat: send health check event

sakshamg1304 · rohitesh-wingify · commit 3d670da83df3 · 2025-08-07T10:35:32.000+05:30
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.10.0] - 2025-08-04
+
+### Added
+
+- Added support for sending a one-time initialization event to the server to verify correct SDK setup.
+
 ## [1.9.2] - 2025-07-24
 
 ### Added
diff --git a/pom.xml b/pom.xml
@@ -19,7 +19,7 @@ limitations under the License. -->
 
     <groupId>com.vwo.sdk</groupId>
     <artifactId>vwo-fme-java-sdk</artifactId>
-    <version>1.9.2</version>
+    <version>1.10.0</version>
     <packaging>jar</packaging>
 
     <name>VWO FME Java SDK</name>
diff --git a/src/main/java/com/vwo/VWO.java b/src/main/java/com/vwo/VWO.java
@@ -16,9 +16,12 @@
 package com.vwo;
 
 import com.vwo.models.user.VWOInitOptions;
+import com.vwo.enums.EventEnum;
 import com.vwo.utils.LogMessageUtil;
+import com.vwo.utils.EventUtil;
 
-import java.util.Objects;
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.core.JsonProcessingException;
 
 
 public class VWO extends VWOClient {
@@ -82,8 +85,36 @@ public static VWO init(VWOInitOptions options) {
             String message = LogMessageUtil.buildMessage("Account ID is required to initialize VWO. Please provide the accountId in the options.", null);
             System.err.println(message);
         }
-
+        //start timer
+        long initStartTime = System.currentTimeMillis();
         instance = VWO.setInstance(options);
+        long initTime = System.currentTimeMillis() - initStartTime;
+
+        // if wasInitializedEarlier in sdkMetaInfo in settings is false or is absent and settings is valid on init, then send sdk init event
+        String settings = vwoBuilder.getOriginalSettings();
+        if (settings != null && !settings.isEmpty()) {
+            try {
+                JsonNode settingsJsonNode = VWOClient.objectMapper.readTree(settings);
+
+                boolean wasInitializedEarlier = false; // default value
+                JsonNode sdkMetaInfoNode = settingsJsonNode.get("sdkMetaInfo");
+                if (sdkMetaInfoNode != null) {
+                    JsonNode wasInitializedEarlierNode = sdkMetaInfoNode.get("wasInitializedEarlier");
+                    if (wasInitializedEarlierNode != null) {
+                        wasInitializedEarlier = wasInitializedEarlierNode.asBoolean();
+                    }
+                }
+                
+                boolean isSettingsValidOnInit = vwoBuilder.getSettingsService().isSettingsValidOnInit;
+                
+                if (!wasInitializedEarlier && isSettingsValidOnInit) {
+                    EventUtil.sendSdkInitEvent(vwoBuilder.getSettingsService().getSettingsFetchTime(), initTime, EventEnum.VWO_SDK_INIT_EVENT.getValue());
+                }
+            } catch (JsonProcessingException e) {
+                String message = LogMessageUtil.buildMessage("Error parsing settings JSON: " + e.getMessage(), null);
+                System.err.println(message);
+            }
+        }
         return instance;
     }
 }
diff --git a/src/main/java/com/vwo/VWOBuilder.java b/src/main/java/com/vwo/VWOBuilder.java
@@ -299,9 +299,21 @@ private void checkAndPoll() {
     }
 
     /**
-     * Initializes batching based on options.
-     * @return The instance of this builder.
+     * Gets the original settings string
+     * @return The original settings string
      */
+    public String getOriginalSettings() {
+        return this.originalSettings;
+    }
+
+    /**
+     * Gets the settings service instance
+     * @return The settings service instance
+     */
+    public SettingsManager getSettingsService() {
+        return this.settingFileManager;
+    }
+
     public VWOBuilder initBatching() {
         // Check if gatewayService is provided and skip SDK batching if so
         if (SettingsManager.getInstance().isGatewayServiceProvided) {
diff --git a/src/main/java/com/vwo/api/SetAttributeAPI.java b/src/main/java/com/vwo/api/SetAttributeAPI.java
@@ -52,7 +52,6 @@ private static void createAndSendImpressionForSetAttribute(
     ) {
         // Get base properties for the event
         Map<String, String> properties = NetworkUtil.getEventsBaseProperties(
-                settings,
                 EventEnum.VWO_SYNC_VISITOR_PROP.getValue(),
                 encodeURIComponent(context.getUserAgent()),
                 context.getIpAddress()
diff --git a/src/main/java/com/vwo/api/TrackEventAPI.java b/src/main/java/com/vwo/api/TrackEventAPI.java
@@ -83,7 +83,6 @@ private static void createAndSendImpressionForTrack(
     ) {
         // Get base properties for the event
         Map<String, String> properties = NetworkUtil.getEventsBaseProperties(
-                settings,
                 eventName,
                 encodeURIComponent(context.getUserAgent()),
                 context.getIpAddress()
diff --git a/src/main/java/com/vwo/constants/Constants.java b/src/main/java/com/vwo/constants/Constants.java
@@ -28,7 +28,7 @@ public class Constants {
   public static final int DEFAULT_REQUEST_TIME_INTERVAL = 600; // 10 * 60(secs) = 600 secs i.e. 10 minutes
   public static final int DEFAULT_EVENTS_PER_REQUEST = 100;
   public static final String SDK_NAME = "vwo-fme-java-sdk";
-  public static final String SDK_VERSION = "1.9.2";
+  public static final String SDK_VERSION = "1.10.0";
   public static final long SETTINGS_EXPIRY = 10000000;
   public static final long SETTINGS_TIMEOUT = 50000;
 
@@ -43,4 +43,5 @@ public class Constants {
   public static final String VWO_META_MEG_KEY = "_vwo_meta_meg_";
 
   public static final int DEFAULT_POLL_INTERVAL = 600000; // 10 minutes
+  public static final String FME = "fme";
 }
diff --git a/src/main/java/com/vwo/enums/EventEnum.java b/src/main/java/com/vwo/enums/EventEnum.java
@@ -17,7 +17,9 @@
 
 public enum EventEnum {
     VWO_VARIATION_SHOWN("vwo_variationShown"),
-    VWO_SYNC_VISITOR_PROP("vwo_syncVisitorProp");
+    VWO_SYNC_VISITOR_PROP("vwo_syncVisitorProp"),
+    VWO_SDK_INIT_EVENT("vwo_fmeSdkInit"),
+    VWO_ERROR("vwo_log");
 
     private final String value;
 
diff --git a/src/main/java/com/vwo/models/request/Props.java b/src/main/java/com/vwo/models/request/Props.java
@@ -39,6 +39,10 @@ public class Props {
   private Boolean isCustomEvent;
   @JsonProperty("vwoMeta")
   private Map<String, Object> vwoMeta;
+  @JsonProperty("product")
+  private String product;
+  @JsonProperty("data")
+  private Map<String, Object> data;
 
   @JsonIgnore
   private Map<String,Object> additionalProperties = new HashMap<String,Object>();
@@ -100,4 +104,11 @@ public void setVwoMeta(Map<String, Object> vwoMeta) {
     this.vwoMeta = vwoMeta;
   }
 
+  public void setData(Map<String, Object> data) {
+    this.data = data;
+  }
+
+  public void setProduct(String product) {
+    this.product = product;
+  }
 }
diff --git a/src/main/java/com/vwo/services/SettingsManager.java b/src/main/java/com/vwo/services/SettingsManager.java
@@ -33,14 +33,16 @@
 
 // public class SettingsManager implements ISettingsManager {
 public class SettingsManager {
-    private String sdkKey;
-    private Integer accountId;
+    public String sdkKey;
+    public Integer accountId;
     private int expiry;
     private int networkTimeout;
     public String hostname;
     public int port;
     public String protocol = "https";
     public boolean isGatewayServiceProvided = false;
+    public boolean isSettingsValidOnInit = false;
+    private Long settingsFetchTime;
     private static SettingsManager instance;
 
     public SettingsManager(VWOInitOptions options) {
@@ -85,6 +87,14 @@ public static SettingsManager getInstance() {
         return instance;
     }
 
+    /**
+     * Gets the settings fetch time
+     * @return The settings fetch time in milliseconds
+     */
+    public Long getSettingsFetchTime() {
+        return this.settingsFetchTime;
+    }
+
     /**
      * Fetches settings from the server
      */
@@ -126,6 +136,9 @@ public String fetchSettings(Boolean isViaWebhook) {
         }
 
         try {
+            // Set fetch time
+            long startTime = System.currentTimeMillis();
+
             RequestModel request = new RequestModel(hostname, "GET", endpoint, options, null, null, this.protocol, port);
             request.setTimeout(networkTimeout);
 
@@ -138,6 +151,7 @@ public String fetchSettings(Boolean isViaWebhook) {
                 });
                 return null;
             }
+            this.settingsFetchTime = System.currentTimeMillis() - startTime;
             return response.getData();
         } catch (Exception e) {
             LoggerService.log(LogLevelEnum.ERROR, "SETTINGS_FETCH_ERROR", new HashMap<String, String>() {
@@ -166,6 +180,7 @@ public String getSettings(Boolean forceFetch) {
                 }
                 boolean settingsValid = new SettingsSchema().isSettingsValid(VWOClient.objectMapper.readValue(settings, Settings.class));
                 if (settingsValid) {
+                    this.isSettingsValidOnInit = true;
                     return settings;
                 } else {
                     LoggerService.log(LogLevelEnum.ERROR, "SETTINGS_SCHEMA_INVALID", null);
diff --git a/src/main/java/com/vwo/utils/EventUtil.java b/src/main/java/com/vwo/utils/EventUtil.java
@@ -0,0 +1,71 @@
+/**
+ * Copyright 2024-2025 Wingify Software Pvt. Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://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.
+ */
+package com.vwo.utils;
+
+import com.vwo.VWO;
+import com.vwo.packages.logger.enums.LogLevelEnum;
+import com.vwo.services.LoggerService;
+
+import java.util.HashMap;
+import java.util.Map;
+
+/**
+ * Utility class for handling SDK events
+ */
+public class EventUtil {
+
+    /**
+     * Sends SDK initialization event
+     * This event is triggered when the init function is called.
+     * 
+     * @param settingsFetchTime Time taken to fetch settings in milliseconds (can be null)
+     * @param sdkInitTime Time taken to initialize the SDK in milliseconds (can be null)
+     * @param eventName The name of the event to send
+     */
+    public static void sendSdkInitEvent(Long settingsFetchTime, Long sdkInitTime, String eventName) {
+        try {    
+            // Create event properties
+            Map<String, String> properties = NetworkUtil.getEventsBaseProperties(
+                eventName,
+                null,
+                null
+            );
+
+            // Create payload for SDK init event using the new method
+            Map<String, Object> payload = NetworkUtil.getSdkInitEventPayload(
+                eventName,
+                settingsFetchTime,
+                sdkInitTime
+            );
+
+             // Get the instance of VWO
+            VWO vwoInstance = VWO.getInstance();
+            // Check if batch events are enabled
+            if (vwoInstance.getBatchEventQueue() != null) {
+                // Enqueue the event to the batch queue
+                vwoInstance.getBatchEventQueue().enqueue(payload);
+            } else {
+                // Send the event immediately if batch events are not enabled
+                NetworkUtil.sendEvent(properties, payload, eventName);
+            }
+
+        } catch (Exception e) {
+            LoggerService.log(LogLevelEnum.ERROR, "SDK_INIT_EVENT_FAILED", new HashMap<String, String>() {{
+                put("error", e.getMessage());
+            }});
+        }
+    }
+} 
diff --git a/src/main/java/com/vwo/utils/ImpressionUtil.java b/src/main/java/com/vwo/utils/ImpressionUtil.java
@@ -41,7 +41,6 @@ public static void createAndSendImpressionForVariationShown(
             VWOContext context) {
         // Get base properties for the event
         Map<String, String> properties = NetworkUtil.getEventsBaseProperties(
-                settings,
                 EventEnum.VWO_VARIATION_SHOWN.getValue(),
                 encodeURIComponent(context.getUserAgent()),
                 context.getIpAddress());
diff --git a/src/main/java/com/vwo/utils/NetworkUtil.java b/src/main/java/com/vwo/utils/NetworkUtil.java
diff --git a/src/main/resources/error-messages.json b/src/main/resources/error-messages.json
