*
* Optional.
- *
+ *
*
*
* This parameter specifies that this visitor has been exposed to an experiment with the given ID. It should be sent
@@ -1765,8 +1763,8 @@ public String applicationId() {
*
*
*
- *
- *
+ *
+ *
*
Example value: Qp0gahJ3RAO3DJ18b0XoUQ
* Example usage: xid=Qp0gahJ3RAO3DJ18b0XoUQ
*
* Optional.
- *
+ *
*
*
* This parameter specifies that this visitor has been exposed to a particular variation of an experiment. It should
@@ -1880,4 +1878,17 @@ public GoogleAnalyticsRequest setExecutor(GoogleAnalyticsExecutor delegateExe
this.delegateExecutor = delegateExecutor;
return this;
}
+
+ /**
+ * Indicates the datetime at which this event occurred. This is used to report the qt parameter, if one
+ * is not set. The occurredAt defaults to datetime when this request was instantiated.
+ */
+ public T occurredAt(ZonedDateTime value) {
+ this.occurredAt = value;
+ return (T) this;
+ }
+
+ public ZonedDateTime occurredAt() {
+ return occurredAt;
+ }
}
diff --git a/src/main/java/com/brsanthu/googleanalytics/request/GoogleAnalyticsResponse.java b/src/main/java/com/brsanthu/googleanalytics/request/GoogleAnalyticsResponse.java
index eba245f..b4152a1 100644
--- a/src/main/java/com/brsanthu/googleanalytics/request/GoogleAnalyticsResponse.java
+++ b/src/main/java/com/brsanthu/googleanalytics/request/GoogleAnalyticsResponse.java
@@ -1,15 +1,12 @@
/*
- * 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
+ * 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
+ * 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.
+ * 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.brsanthu.googleanalytics.request;
@@ -22,6 +19,7 @@
*/
public class GoogleAnalyticsResponse {
private int statusCode = 200;
+ private GoogleAnalyticsRequest googleAnalyticsRequest;
private Map requestParams = null;
public Map getRequestParams() {
@@ -29,7 +27,7 @@ public Map getRequestParams() {
}
public void setRequestParams(Map postedParms) {
- this.requestParams = postedParms;
+ requestParams = postedParms;
}
public void setStatusCode(int statusCode) {
@@ -48,4 +46,13 @@ public String toString() {
builder.append("]");
return builder.toString();
}
+
+ public GoogleAnalyticsRequest getGoogleAnalyticsRequest() {
+ return googleAnalyticsRequest;
+ }
+
+ public GoogleAnalyticsResponse setGoogleAnalyticsRequest(GoogleAnalyticsRequest googleAnalyticsRequest) {
+ this.googleAnalyticsRequest = googleAnalyticsRequest;
+ return this;
+ }
}
diff --git a/src/test/java/com/brsanthu/googleanalytics/GoogleAnalyticsTest.java b/src/test/java/com/brsanthu/googleanalytics/GoogleAnalyticsTest.java
index 77d1ab1..408b39a 100644
--- a/src/test/java/com/brsanthu/googleanalytics/GoogleAnalyticsTest.java
+++ b/src/test/java/com/brsanthu/googleanalytics/GoogleAnalyticsTest.java
@@ -1,18 +1,25 @@
package com.brsanthu.googleanalytics;
import static com.brsanthu.googleanalytics.internal.Constants.TEST_TRACKING_ID;
+import static com.brsanthu.googleanalytics.request.GoogleAnalyticsParameter.QUEUE_TIME;
+import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatThrownBy;
+import static org.assertj.core.api.Assertions.within;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;
+import java.time.ZonedDateTime;
+
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.Test;
import org.mockito.ArgumentMatchers;
import com.brsanthu.googleanalytics.httpclient.HttpClient;
+import com.brsanthu.googleanalytics.httpclient.HttpResponse;
import com.brsanthu.googleanalytics.request.DefaultRequest;
+import com.brsanthu.googleanalytics.request.GoogleAnalyticsParameter;
import com.brsanthu.googleanalytics.request.GoogleAnalyticsResponse;
public class GoogleAnalyticsTest {
@@ -150,4 +157,60 @@ void testExceptionHandler() throws Exception {
assertThatThrownBy(() -> propagatingGa.screenView().sendAsync().get()).hasMessageContaining("Testing Exception");
}
+
+ @Test
+ void testAutoQueueTime() throws Exception {
+
+ HttpClient client = mock(HttpClient.class);
+ when(client.post(ArgumentMatchers.any())).thenReturn(new HttpResponse().setStatusCode(200));
+
+ // By default queue time is added based on when hit was created and posted. In this test case, it should be
+ // close to 0
+ GoogleAnalytics gaAutoTimeEnabled = GoogleAnalytics.builder().withHttpClient(client).withConfig(new GoogleAnalyticsConfig()).build();
+ GoogleAnalyticsResponse respEnabled = gaAutoTimeEnabled.screenView().send();
+ assertThat(Integer.parseInt(respEnabled.getRequestParams().get(GoogleAnalyticsParameter.QUEUE_TIME.getParameterName()))).isCloseTo(0,
+ within(100));
+
+ // We can set occurred at to a past value and if so, it will be used to calcualte queue time.
+ GoogleAnalytics gaAutoTimeEnabledOccurredAt = GoogleAnalytics.builder().withHttpClient(client).withConfig(
+ new GoogleAnalyticsConfig()).build();
+ GoogleAnalyticsResponse respEnabledOccurredAt = gaAutoTimeEnabledOccurredAt.screenView().occurredAt(
+ ZonedDateTime.now().minusSeconds(5)).send();
+ assertThat(Integer.parseInt(respEnabledOccurredAt.getRequestParams().get(GoogleAnalyticsParameter.QUEUE_TIME.getParameterName()))).isCloseTo(
+ 5000, within(100));
+
+ // We can set both occurredAt and queue time, then time based on occurred at will be added to set queue time.
+ GoogleAnalyticsResponse respEnabledWithSetQueueTime = gaAutoTimeEnabled.screenView().occurredAt(
+ ZonedDateTime.now().minusSeconds(5)).queueTime(1000).send();
+ assertThat(Integer.parseInt(
+ respEnabledWithSetQueueTime.getRequestParams().get(GoogleAnalyticsParameter.QUEUE_TIME.getParameterName()))).isCloseTo(6000,
+ within(100));
+
+ // If we disable auto queue time, then queue time is not calculated
+ GoogleAnalytics gaAutoTimeDisabled = GoogleAnalytics.builder().withHttpClient(client).withConfig(
+ new GoogleAnalyticsConfig().setAutoQueueTimeEnabled(false)).build();
+ GoogleAnalyticsResponse respDisabled = gaAutoTimeDisabled.screenView().occurredAt(ZonedDateTime.now().minusSeconds(5)).send();
+ assertThat(respDisabled.getRequestParams().get(GoogleAnalyticsParameter.QUEUE_TIME.getParameterName())).isNull();
+ }
+
+ @Test
+ void testAutoQueueTimeBatch() throws Exception {
+ HttpClient client = mock(HttpClient.class);
+ when(client.post(ArgumentMatchers.any())).thenReturn(new HttpResponse().setStatusCode(200));
+
+ GoogleAnalytics gaAutoTimeEnabled = GoogleAnalytics.builder().withHttpClient(client).withConfig(
+ new GoogleAnalyticsConfig().setBatchingEnabled(true).setBatchSize(2)).build();
+
+ // First request will add to batch.
+ GoogleAnalyticsResponse resp1 = gaAutoTimeEnabled.screenView().send();
+
+ Thread.sleep(500);
+
+ GoogleAnalyticsResponse resp2 = gaAutoTimeEnabled.screenView().send();
+
+ assertThat(Integer.parseInt(resp1.getRequestParams().get(QUEUE_TIME.getParameterName()))).isCloseTo(500, within(100));
+
+ assertThat(Integer.parseInt(resp2.getRequestParams().get(QUEUE_TIME.getParameterName()))).isCloseTo(0, within(100));
+ }
+
}