Set Analytics event.timestamp from event.data.logTime if timestamp is invalid (#129)

Currently, the Analytics backend is still sending an invalid (1969 or 1970) timestamp in 'event.timestamp'. This PR adds a shim to detect that, and pull a better timestamp from 'event.data.logTime', if available. This is temporary; we'll remove the shim when we roll a fix for the backend out to production.

Author: Robert-Jan Huijsman

spec/providers/analytics.spec.input.ts

@@ -22,6 +22,7 @@
 
 /* tslint:disable:max-line-length */
 import { AnalyticsEvent } from '../../src/providers/analytics';
+import { Event } from '../../src/cloud-functions';
 
 // A payload, as it might arrive over the wire. Every possible field is filled out at least once.
 export const fullPayload = JSON.parse(`{
@@ -124,70 +125,77 @@ export const fullPayload = JSON.parse(`{
 }`);
 
 // The event data that we expect would be constructed if the payload above were to arrive.
-export const fullEventData: AnalyticsEvent = {
-  reportingDate: '20170202',
-  name: 'Loaded_In_Background',
-  params: {
-    build: '1350',
-    calls_remaining: 10,
-    fraction_calls_dropped: 0.0123456,
-    average_call_rating: 4.5,
-  },
-  logTime: '2017-02-02T23:06:26.124Z',
-  previousLogTime: '2017-02-02T23:01:19.797Z',
-  valueInUSD: 1234.5,
-  user: {
-    userId: 'abcdefghijklmnop!',
-    appInfo: {
-      appId: 'com.mobileday.MobileDay',
-      appInstanceId: 'E3C9939401814B9B954725A740B8C7BC',
-      appPlatform: 'IOS',
-      appStore: 'iTunes',
-      appVersion: '5.2.0',
-    },
-    trafficSource: {
-      userAcquiredSource: 'Pizza Everywhere',
-      userAcquiredCampaign: 'Functions launch party',
-      userAcquiredMedium: 'Free food',
-    },
-    bundleInfo: {
-      bundleSequenceId: 6034,
-      serverTimestampOffset: 371,
+export const fullEvent: Event<AnalyticsEvent> = {
+  eventId: '1486080145623867projects/analytics-integration-fd82a/events/i_made_this_upproviders/google.firebase.analytics/eventTypes/event.sendprojects/f949d1bb9ef782579-tp/topics/cloud-functions-u54ejabpzs4prfjh7433eklhae',
+  eventType: 'providers/google.firebase.analytics/eventTypes/event.send',
+  resource: 'projects/analytics-integration-fd82a/events/i_made_this_up',
+  timestamp: '2017-02-02T23:06:26.124Z',
+  params: {},
+  data: {
+    reportingDate: '20170202',
+    name: 'Loaded_In_Background',
+    params: {
+      build: '1350',
+      calls_remaining: 10,
+      fraction_calls_dropped: 0.0123456,
+      average_call_rating: 4.5,
     },
-    deviceInfo: {
-      deviceCategory: 'mobile',
-      deviceModel: 'iPhone7,2',
-      deviceTimeZoneOffsetSeconds: -21600,
-      mobileBrandName: 'Apple',
-      mobileMarketingName: 'iPhone 6',
-      mobileModelName: 'iPhone 6',
-      platformVersion: '10.2.1',
-      userDefaultLanguage: 'en-us',
-      deviceId: '599F9C00-92DC-4B5C-9464-7971F01F8370',
-      resettableDeviceId: '599F9C00-92DC-4B5C-9464-7971F01F8370',
-      limitedAdTracking: true,
-    },
-    firstOpenTime: '2016-04-28T15:00:35.819Z',
-    geoInfo: {
-      city: 'Plano',
-      continent: '021',
-      country: 'United States',
-      region: 'Texas',
-    },
-    userProperties: {
-      build: {
-        setTime: '2017-02-02T23:06:26.090Z',
-        value: '1350',
+    logTime: '2017-02-02T23:06:26.124Z',
+    previousLogTime: '2017-02-02T23:01:19.797Z',
+    valueInUSD: 1234.5,
+    user: {
+      userId: 'abcdefghijklmnop!',
+      appInfo: {
+        appId: 'com.mobileday.MobileDay',
+        appInstanceId: 'E3C9939401814B9B954725A740B8C7BC',
+        appPlatform: 'IOS',
+        appStore: 'iTunes',
+        appVersion: '5.2.0',
+      },
+      trafficSource: {
+        userAcquiredSource: 'Pizza Everywhere',
+        userAcquiredCampaign: 'Functions launch party',
+        userAcquiredMedium: 'Free food',
       },
-      calls_remaining: {
-        setTime: '2017-02-02T23:06:26.094Z',
-        value: '10',
+      bundleInfo: {
+        bundleSequenceId: 6034,
+        serverTimestampOffset: 371,
       },
-      version: {
-        setTime: '2017-02-02T23:06:26.085Z',
-        value: '5.2.0',
+      deviceInfo: {
+        deviceCategory: 'mobile',
+        deviceModel: 'iPhone7,2',
+        deviceTimeZoneOffsetSeconds: -21600,
+        mobileBrandName: 'Apple',
+        mobileMarketingName: 'iPhone 6',
+        mobileModelName: 'iPhone 6',
+        platformVersion: '10.2.1',
+        userDefaultLanguage: 'en-us',
+        deviceId: '599F9C00-92DC-4B5C-9464-7971F01F8370',
+        resettableDeviceId: '599F9C00-92DC-4B5C-9464-7971F01F8370',
+        limitedAdTracking: true,
+      },
+      firstOpenTime: '2016-04-28T15:00:35.819Z',
+      geoInfo: {
+        city: 'Plano',
+        continent: '021',
+        country: 'United States',
+        region: 'Texas',
+      },
+      userProperties: {
+        build: {
+          setTime: '2017-02-02T23:06:26.090Z',
+          value: '1350',
+        },
+        calls_remaining: {
+          setTime: '2017-02-02T23:06:26.094Z',
+          value: '10',
+        },
+        version: {
+          setTime: '2017-02-02T23:06:26.085Z',
+          value: '5.2.0',
+        },
       },
+      ltvInUSD: 133.7,
     },
-    ltvInUSD: 133.7,
   },
 };

spec/providers/analytics.spec.ts

@@ -226,10 +226,10 @@ describe('AnalyticsEventBuilder', () => {
     });
 
     it('should recognize all the fields the payload can contain', () => {
-      const cloudFunction = analytics.event('first_open').onLog((ev: Event<analytics.AnalyticsEvent>) => ev.data);
+      const cloudFunction = analytics.event('first_open').onLog((ev: Event<analytics.AnalyticsEvent>) => ev);
       // The payload in analytics_spec_input contains all possible fields at least once.
       return expect(cloudFunction(analytics_spec_input.fullPayload))
-        .to.eventually.deep.equal(analytics_spec_input.fullEventData);
+        .to.eventually.deep.equal(analytics_spec_input.fullEvent);
     });
   });
 });

src/providers/analytics.ts

@@ -44,8 +44,23 @@ export class AnalyticsEventBuilder {
     const dataConstructor = (raw: Event<any>) => {
       return new AnalyticsEvent(raw.data);
     };
+    const attemptTimestampFix = (event: Event<AnalyticsEvent>) => {
+      // This is a temporary shim, to mask an issue in which Analytics events may carry an
+      // incorrect Event.timestamp. Often there's a correct timestamp present in
+      // Event.data.logTime, so until the production backend sends correct top-level timestamps
+      // we can pull a timestamp from there.
+      // BUG(36001921).
+      if (event.timestamp && (event.timestamp.substr(0, 4) === '1969' || event.timestamp.substr(0, 4) === '1970')) {
+        event.timestamp = undefined;  // If we don't have a good timestamp, prefer no timestamp at all.
+        if (event.data && event.data.logTime) {
+          event.timestamp = event.data.logTime;
+        }
+      }
+      return handler(event);
+    };
     return makeCloudFunction({
-      provider, handler,
+      provider,
+      handler: attemptTimestampFix,
       eventType: 'event.log',
       resource: this.resource,
       dataConstructor,