feat: add client upload time

packages/analytics-browser-test/test/index.test.ts

@@ -25,6 +25,9 @@ describe('integration', () => {
   let apiKey = '';
   let client = amplitude.createInstance();
 
+  const event_upload_time = '2023-01-01T12:00:00:000Z';
+  Date.prototype.toISOString = jest.fn(() => event_upload_time);
+
   beforeEach(() => {
     client = amplitude.createInstance();
     apiKey = UUID();
@@ -145,6 +148,7 @@ describe('integration', () => {
 
       expect(requestBody1).toEqual({
         api_key: apiKey,
+        client_upload_time: event_upload_time,
         events: [
           {
             device_id: deviceId,
@@ -880,6 +884,7 @@ describe('integration', () => {
         setTimeout(() => {
           expect(payload).toEqual({
             api_key: apiKey,
+            client_upload_time: event_upload_time,
             events: [
               {
                 // This is a `session_end` event for the previous session
@@ -1104,6 +1109,7 @@ describe('integration', () => {
           expect(payload.events[4].session_id).toEqual(payload.events[5].session_id);
           expect(payload).toEqual({
             api_key: apiKey,
+            client_upload_time: event_upload_time,
             events: [
               {
                 device_id: uuid,
@@ -1290,6 +1296,7 @@ describe('integration', () => {
         setTimeout(() => {
           expect(payload).toEqual({
             api_key: apiKey,
+            client_upload_time: event_upload_time,
             events: [
               {
                 device_id: uuid,
@@ -1474,6 +1481,7 @@ describe('integration', () => {
         setTimeout(() => {
           expect(payload).toEqual({
             api_key: apiKey,
+            client_upload_time: event_upload_time,
             events: [
               {
                 device_id: uuid,
@@ -1572,6 +1580,7 @@ describe('integration', () => {
         setTimeout(() => {
           expect(payload).toEqual({
             api_key: apiKey,
+            client_upload_time: event_upload_time,
             events: [
               {
                 device_id: uuid,

packages/analytics-core/src/plugins/destination.ts

@@ -146,6 +146,7 @@ export class Destination implements DestinationPlugin {
       options: {
         min_id_length: this.config.minIdLength,
       },
+      client_upload_time: new Date().toISOString(),
     };
 
     try {

packages/analytics-core/test/plugins/destination.test.ts

@@ -222,6 +222,50 @@ describe('destination', () => {
   });
 
   describe('send', () => {
+    test('should include client upload time', async () => {
+      const destination = new Destination();
+      const callback = jest.fn();
+      const event = {
+        event_type: 'event_type',
+      };
+      const context = {
+        attempts: 0,
+        callback,
+        event,
+        timeout: 0,
+      };
+      const event_upload_time = '2023-01-01T12:00:00:000Z';
+      Date.prototype.toISOString = jest.fn().mockReturnValueOnce(event_upload_time);
+
+      const transportProvider = {
+        send: jest.fn().mockImplementationOnce((_url: string, payload: Payload) => {
+          expect(payload.client_upload_time).toBe(event_upload_time);
+          return Promise.resolve({
+            status: Status.Success,
+            statusCode: 200,
+            body: {
+              eventsIngested: 1,
+              payloadSizeBytes: 1,
+              serverUploadTime: 1,
+            },
+          });
+        }),
+      };
+      await destination.setup({
+        ...useDefaultConfig(),
+        transportProvider,
+        apiKey: API_KEY,
+        minIdLength: 10,
+      });
+      await destination.send([context]);
+      expect(callback).toHaveBeenCalledTimes(1);
+      expect(callback).toHaveBeenCalledWith({
+        event,
+        code: 200,
+        message: SUCCESS_MESSAGE,
+      });
+    });
+
     test('should include min id length', async () => {
       const destination = new Destination();
       const callback = jest.fn();

packages/analytics-types/src/payload.ts

@@ -8,4 +8,5 @@ export interface Payload {
   api_key: string;
   events: readonly Event[];
   options?: PayloadOptions;
+  client_upload_time?: string;
 }