diff --git a/CHANGELOG.md b/CHANGELOG.md index a24cb8d5..9f6f15d0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -55,6 +55,9 @@ * Mitigated an issue where verbose logs showed the values of custom network request headers. Only the number of headers is logged now. * Mitigated an issue where a fresh initialization logged an error for storage files that did not exist yet. * Mitigated an issue where a crash breadcrumb added while a crash was being recorded on another thread could be lost. +* Mitigated an issue where backend mode requests carried no device ID type, so the server did not count the users recorded in backend mode as identified. +* Mitigated an issue where a backend mode direct request sent a key twice when the given map contained a key the SDK also sets. The value in the map now replaces the SDK's value, as documented. +* Mitigated an issue where a backend mode direct request changed the given map, and failed with an unmodifiable map. ## 26.8.0 * Added support for the Content feature, accessible through the "Countly.instance().content()" interface: diff --git a/sdk-java/src/main/java/ly/count/sdk/java/internal/ModuleBackendMode.java b/sdk-java/src/main/java/ly/count/sdk/java/internal/ModuleBackendMode.java index 42e2256c..3e089eee 100644 --- a/sdk-java/src/main/java/ly/count/sdk/java/internal/ModuleBackendMode.java +++ b/sdk-java/src/main/java/ly/count/sdk/java/internal/ModuleBackendMode.java @@ -26,6 +26,8 @@ public class ModuleBackendMode extends ModuleBase { final String[] userPredefinedKeys = { "name", "username", "email", "organization", "phone", "gender", "byear" }; + static final String[] DIRECT_REQUEST_PROTECTED_KEYS = { "checksum", "checksum256", "sdk_name", "sdk_version" }; + @Override public void init(InternalConfig config) { super.init(config); @@ -97,7 +99,7 @@ private void sessionBeginInternal(String deviceID, Map metrics, JSONObject metricsJson = new JSONObject(metrics); request.params.add("metrics", metricsJson); - ModuleRequests.addRequiredParametersToParams(internalConfig, request.params); + addRequiredParameters(request); if (location != null) { for (Map.Entry entry : location.entrySet()) { @@ -120,7 +122,7 @@ private void sessionUpdateInternal(String deviceID, Double duration, Long timest Request request = new Request(); request.params.add("device_id", deviceID); request.params.add("session_duration", duration); - ModuleRequests.addRequiredParametersToParams(internalConfig, request.params); + addRequiredParameters(request); addTimeInfoIntoRequest(request, timestamp); addRequestToRequestQ(request); @@ -141,7 +143,7 @@ private void sessionEndInternal(String deviceID, double duration, Long timestamp request.params.add("device_id", deviceID); request.params.add("end_session", 1); request.params.add("session_duration", duration); - ModuleRequests.addRequiredParametersToParams(internalConfig, request.params); + addRequiredParameters(request); addTimeInfoIntoRequest(request, timestamp); addRequestToRequestQ(request); @@ -171,7 +173,7 @@ public void recordExceptionInternal(String deviceID, String message, String stac Request request = new Request(); request.params.add("device_id", deviceID); request.params.add("crash", crash); - ModuleRequests.addRequiredParametersToParams(internalConfig, request.params); + addRequiredParameters(request); addTimeInfoIntoRequest(request, timestamp); @@ -214,7 +216,7 @@ private void recordUserPropertiesInternal(String deviceID, Map u request.params.add("device_id", deviceID); request.params.add("user_details", properties); - ModuleRequests.addRequiredParametersToParams(internalConfig, request.params); + addRequiredParameters(request); addTimeInfoIntoRequest(request, timestamp); addRequestToRequestQ(request); @@ -231,18 +233,15 @@ void recordDirectRequestInternal(String deviceID, Map requestDat request.params.add("device_id", deviceID); request.params.add("dr", "1"); addTimeInfoIntoRequest(request, timestamp); - - //remove checksum, will add before sending request to server - requestData.remove("checksum"); - requestData.remove("checksum256"); - requestData.remove("sdk_name"); - requestData.remove("sdk_version"); + addRequiredParameters(request); for (Map.Entry item : requestData.entrySet()) { - request.params.add(item.getKey(), item.getValue()); + if (!Arrays.asList(DIRECT_REQUEST_PROTECTED_KEYS).contains(item.getKey())) { + request.params.remove(item.getKey()); + request.params.add(item.getKey(), item.getValue()); + } } - ModuleRequests.addRequiredParametersToParams(internalConfig, request.params); addRequestToRequestQ(request); } @@ -274,6 +273,17 @@ private JSONObject buildEventJSONObject(String key, int count, Double sum, Doubl return jsonObject; } + /** + * Adds the parameters every backend mode request carries: the common ones and the device ID type + * "developer supplied" (t=0), because every backend mode call provides its device ID. + * + * @param request the request to add the parameters to + */ + private void addRequiredParameters(Request request) { + ModuleRequests.addRequiredParametersToParams(internalConfig, request.params); + request.params.add("t", 0); + } + private void addTimeInfoIntoRequest(Request request, Long timestamp) { Calendar calendar = Calendar.getInstance(); calendar.setTimeInMillis(timestamp); @@ -298,7 +308,7 @@ private synchronized void addEventsAgainstDeviceIdToRequestQ(String deviceID) { Request request = new Request(); request.params.add("device_id", deviceID); request.params.add("events", events); - ModuleRequests.addRequiredParametersToParams(internalConfig, request.params); + addRequiredParameters(request); addTimeInfoIntoRequest(request, System.currentTimeMillis()); request.own(ModuleBackendMode.class); @@ -599,7 +609,8 @@ public void recordUserProperties(String deviceID, Map userProper } /** - * Record a direct request. + * Record a direct request. A value in the map replaces the base request's value of the same key, + * except sdk_name, sdk_version, checksum and checksum256, so each key is sent once. The given map is not changed. * * @param deviceID device id, cannot be null or empty * @param requestData a map contains request data, it can not be null or empty diff --git a/sdk-java/src/test/java/ly/count/sdk/java/internal/BackendModeTests.java b/sdk-java/src/test/java/ly/count/sdk/java/internal/BackendModeTests.java index 5e8dc8e3..2e3981ff 100644 --- a/sdk-java/src/test/java/ly/count/sdk/java/internal/BackendModeTests.java +++ b/sdk-java/src/test/java/ly/count/sdk/java/internal/BackendModeTests.java @@ -5,6 +5,7 @@ import java.io.StringWriter; import java.math.BigDecimal; import java.util.Calendar; +import java.util.Collections; import java.util.HashMap; import java.util.Map; import java.util.concurrent.ConcurrentHashMap; @@ -833,7 +834,7 @@ public void testCrashSegmentDataType() { public void testRecordDirectRequest() { ModuleBackendMode.BackendMode backendMode = moduleBackendMode.new BackendMode(); - // Direct request with timestamp and device id + // Values in the map replace the base request's values Map requestData = new ConcurrentHashMap<>(); requestData.put("data1", "value1"); requestData.put("device_id", "device-id-1"); @@ -852,7 +853,14 @@ public void testRecordDirectRequest() { Assert.assertEquals("value1", request.params.get("data1")); Assert.assertEquals("value3", request.params.get("data3")); Assert.assertEquals("1", request.params.get("dr")); - validateRequestTimeFields("device-id-2", 1_647_938_191_782L, request); + Assert.assertEquals("device-id-1", request.params.get("device_id")); + Assert.assertEquals("1647938191782", request.params.get("timestamp")); + Assert.assertEquals("100", request.params.get("tz")); + Assert.assertEquals("0", request.params.get("dow")); + Assert.assertEquals("9", request.params.get("hour")); + for (String key : new String[] { "device_id", "timestamp", "tz", "dow", "hour" }) { + Assert.assertEquals(key + " is sent more than once: " + request.params, 1, countParam(request.params, key)); + } // Direct request without timestamp and device id requestData = new ConcurrentHashMap<>(); @@ -872,6 +880,92 @@ public void testRecordDirectRequest() { validateRequestTimeFields("device-id-2", 987_654_321L, request); } + /** + * Every backend mode request carries the device ID type "developer supplied" (t=0), + * so the server counts the users recorded in backend mode as identified. + */ + @Test + public void testEveryRequestCarriesDeveloperSuppliedDeviceIdType() { + ModuleBackendMode.BackendMode backendMode = moduleBackendMode.new BackendMode(); + Map userProperties = new HashMap<>(); + userProperties.put("name", "Full Name"); + Map requestData = new HashMap<>(); + requestData.put("custom_key", "custom_value"); + + backendMode.sessionBegin("device-id-1", new HashMap<>(), null, 1_646_640_780_130L); + backendMode.sessionUpdate("device-id-1", 10, 1_646_640_780_130L); + backendMode.recordEvent("device-id-1", "key-1", 1, null, null, null, 1_646_640_780_130L); + backendMode.sessionEnd("device-id-1", 20, 1_646_640_780_130L); + backendMode.recordException("device-id-1", "message", "stacktrace", null, null, 1_646_640_780_130L); + backendMode.recordUserProperties("device-id-1", userProperties, 1_646_640_780_130L); + backendMode.recordDirectRequest("device-id-1", requestData, 1_646_640_780_130L); + + Assert.assertEquals(7, SDKCore.instance.requestQueueMemory.size()); + for (Request request : SDKCore.instance.requestQueueMemory) { + Assert.assertEquals(request.params.toString(), "0", request.params.get("t")); + } + } + + /** + * In a direct request, a value given in the map replaces the SDK's value, so each key is sent once. + * sdk_name, sdk_version, checksum and checksum256 stay the SDK's. + */ + @Test + public void testRecordDirectRequestMapValuesReplaceBaseValues() { + ModuleBackendMode.BackendMode backendMode = moduleBackendMode.new BackendMode(); + Map requestData = new HashMap<>(); + requestData.put("app_key", "other-app-key"); + requestData.put("old_device_id", "old-device-id"); + requestData.put("t", "1"); + requestData.put("sdk_name", "other-sdk"); + requestData.put("sdk_version", "0.0.0"); + requestData.put("checksum", "given"); + requestData.put("checksum256", "given"); + + backendMode.recordDirectRequest("device-id-1", requestData, 1_646_640_780_130L); + + Assert.assertEquals(1, SDKCore.instance.requestQueueMemory.size()); + Request request = SDKCore.instance.requestQueueMemory.remove(); + Assert.assertEquals("other-app-key", request.params.get("app_key")); + Assert.assertEquals("old-device-id", request.params.get("old_device_id")); + Assert.assertEquals("1", request.params.get("t")); + Assert.assertEquals("java-native-backend", request.params.get("sdk_name")); + Assert.assertNotEquals("0.0.0", request.params.get("sdk_version")); + Assert.assertFalse(request.params.has("checksum")); + Assert.assertFalse(request.params.has("checksum256")); + for (String key : new String[] { "app_key", "old_device_id", "t", "sdk_name", "sdk_version", "device_id", "timestamp" }) { + Assert.assertEquals(key + " is sent more than once: " + request.params, 1, countParam(request.params, key)); + } + } + + /** + * Recording a direct request leaves the given map unchanged, so an unmodifiable map works too. + */ + @Test + public void testRecordDirectRequestKeepsGivenMapUnchanged() { + ModuleBackendMode.BackendMode backendMode = moduleBackendMode.new BackendMode(); + Map data = new HashMap<>(); + data.put("custom_key", "custom_value"); + data.put("checksum", "given"); + Map requestData = Collections.unmodifiableMap(data); + + backendMode.recordDirectRequest("device-id-1", requestData, 1_646_640_780_130L); + + Assert.assertEquals(2, requestData.size()); + Assert.assertEquals(1, SDKCore.instance.requestQueueMemory.size()); + Assert.assertEquals("custom_value", SDKCore.instance.requestQueueMemory.remove().params.get("custom_key")); + } + + private int countParam(Params params, String key) { + int count = 0; + for (String pair : params.toString().split("&")) { + if (pair.split("=")[0].equals(key)) { + count++; + } + } + return count; + } + private Map populateUserProperties(boolean addUserDetail, boolean addCustomDetail, boolean addOperation) { Map userDetail = new ConcurrentHashMap<>(); if (addUserDetail) {