Auth: change the UserRecord's timestamps from strings to Date, in accordance with our spec. (#114)

* Auth: change the UserRecord's timestamps from strings to Date, in accordance with our spec.
* Auth: Update testing to test both onCreate and onDelete separately, to ensure they both use the correct dataConstructor.
* Move deep clone of incoming payload to makeCloudFunction(), as it was intended to be.

Author: Robert-Jan Huijsman

spec/providers/auth.spec.ts

@@ -41,8 +41,8 @@ describe('AuthBuilder', () => {
       const cloudFunction = auth.user().onCreate(() => null);
       expect(cloudFunction.__trigger).to.deep.equal({
         eventTrigger: {
-            eventType: 'providers/firebase.auth/eventTypes/user.create',
-            resource: 'projects/project1',
+          eventType: 'providers/firebase.auth/eventTypes/user.create',
+          resource: 'projects/project1',
         },
       });
     });
@@ -53,16 +53,17 @@ describe('AuthBuilder', () => {
       const cloudFunction = auth.user().onDelete(handler);
       expect(cloudFunction.__trigger).to.deep.equal({
         eventTrigger: {
-            eventType: 'providers/firebase.auth/eventTypes/user.delete',
-            resource: 'projects/project1',
+          eventType: 'providers/firebase.auth/eventTypes/user.delete',
+          resource: 'projects/project1',
         },
       });
     });
   });
 
   describe('#_dataConstructor', () => {
     it('should handle an event with the appropriate fields', () => {
-      const cloudFunction = auth.user().onCreate((ev: Event<firebase.auth.UserRecord>) => ev.data);
+      const cloudFunctionCreate = auth.user().onCreate((ev: Event<firebase.auth.UserRecord>) => ev.data);
+      const cloudFunctionDelete = auth.user().onDelete((ev: Event<firebase.auth.UserRecord>) => ev.data);
 
       // The event data delivered over the wire will be the JSON for a UserRecord:
       // https://firebase.google.com/docs/auth/admin/manage-users#retrieve_user_data
@@ -93,7 +94,33 @@ describe('AuthBuilder', () => {
         },
       };
 
-      return expect(cloudFunction(event)).to.eventually.deep.equal(event.data);
+      const expectedData = {
+        uid: 'abcde12345',
+        email: 'foo@bar.baz',
+        emailVerified: false,
+        displayName: 'My Display Name',
+        photoURL: 'bar.baz/foo.jpg',
+        disabled: false,
+        metadata: {
+          // Gotcha's:
+          // - JS Date is, by default, local-time based, not UTC-based.
+          // - JS Date's month is zero-based.
+          createdAt: new Date(Date.UTC(2016, 11, 15, 19, 37, 37, 59)),
+          lastSignedInAt: new Date(Date.UTC(2017, 0, 1)),
+        },
+        providerData: [{
+          uid: 'g-abcde12345',
+          email: 'foo@gmail.com',
+          displayName: 'My Google Provider Display Name',
+          photoURL: 'googleusercontent.com/foo.jpg',
+          providerId: 'google.com',
+        }],
+      };
+
+      return Promise.all([
+        expect(cloudFunctionCreate(event)).to.eventually.deep.equal(expectedData),
+        expect(cloudFunctionDelete(event)).to.eventually.deep.equal(expectedData),
+      ]);
     });
 
     // This isn't expected to happen in production, but if it does we should
@@ -102,9 +129,9 @@ describe('AuthBuilder', () => {
       const cloudFunction = auth.user().onCreate((ev: Event<firebase.auth.UserRecord>) => ev.data);
 
       let event: Event<firebase.auth.UserRecord> = {
-        data:  {
+        data: {
           uid: 'abcde12345',
-          metadata:  {
+          metadata: {
             // TODO(inlined) We'll need to manually parse these!
             createdAt: new Date(),
             lastSignedInAt: new Date(),

src/cloud-functions.ts

@@ -29,7 +29,7 @@ export interface Event<T> {
   timestamp?: string;
   eventType?: string;
   resource?: string;
-  params?: {[option: string]: any};
+  params?: { [option: string]: any };
   data: T;
 
   /** @internal */
@@ -76,19 +76,19 @@ export function makeCloudFunction<EventData>({
 }: MakeCloudFunctionArgs<EventData>): CloudFunction<EventData> {
   let cloudFunction: any = (event: Event<any>) => {
     return Promise.resolve(event)
-    .then(before)
-    .then(() => {
-      let typedEvent: Event<EventData> = _.assign({}, event);
-      typedEvent.data = dataConstructor(event);
-      typedEvent.params = event.params || {};
-      return handler(typedEvent);
-    }).then(result => {
-      if (after) { after(event); };
-      return result;
-    }, err => {
-      if (after) { after(event); };
-      return Promise.reject(err);
-    });
+      .then(before)
+      .then(() => {
+        let typedEvent: Event<EventData> = _.cloneDeep(event);
+        typedEvent.data = dataConstructor(event);
+        typedEvent.params = event.params || {};
+        return handler(typedEvent);
+      }).then(result => {
+        if (after) { after(event); };
+        return result;
+      }, err => {
+        if (after) { after(event); };
+        return Promise.reject(err);
+      });
   };
   cloudFunction.__trigger = {
     eventTrigger: {

src/providers/auth.ts

@@ -1,24 +1,24 @@
- // The MIT License (MIT)
- //
- // Copyright (c) 2017 Firebase
- //
- // Permission is hereby granted, free of charge, to any person obtaining a copy
- // of this software and associated documentation files (the "Software"), to deal
- // in the Software without restriction, including without limitation the rights
- // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- // copies of the Software, and to permit persons to whom the Software is
- // furnished to do so, subject to the following conditions:
- //
- // The above copyright notice and this permission notice shall be included in all
- // copies or substantial portions of the Software.
- //
- // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- // SOFTWARE.
+// The MIT License (MIT)
+//
+// Copyright (c) 2017 Firebase
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in all
+// copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
 
 import { makeCloudFunction, CloudFunction, Event } from '../cloud-functions';
 import * as firebase from 'firebase-admin';
@@ -33,6 +33,26 @@ export function user() {
 
 /** Builder used to create Cloud Functions for Firebase Auth user lifecycle events. */
 export class UserBuilder {
+  private static dataConstructor(raw: any): firebase.auth.UserRecord {
+    // The UserRecord returned here is an interface. The firebase-admin/auth/user-record module
+    // also has a class of the same name, which is one implementation of the interface. Here,
+    // because our wire format already almost matches the UserRecord interface, we only use the
+    // interface, no need to use the class.
+    //
+    // The one change we need to make to match the interface is to our incoming timestamps. The
+    // interface requires them to be Date objects, while they raw payload has them as strings.
+    if (raw.data.metadata) {
+      let metadata = raw.data.metadata;
+      if (metadata.lastSignedInAt && typeof metadata.lastSignedInAt === 'string') {
+        metadata.lastSignedInAt = new Date(metadata.lastSignedInAt);
+      }
+      if (metadata.createdAt && typeof metadata.createdAt === 'string') {
+        metadata.createdAt = new Date(metadata.createdAt);
+      }
+    }
+    return raw.data;
+  }
+
   /** @internal */
   constructor(private resource: string) { }
 
@@ -44,6 +64,7 @@ export class UserBuilder {
       provider, handler,
       resource: this.resource,
       eventType: 'user.create',
+      dataConstructor: UserBuilder.dataConstructor,
     });
   }
 
@@ -55,12 +76,13 @@ export class UserBuilder {
       provider, handler,
       resource: this.resource,
       eventType: 'user.delete',
+      dataConstructor: UserBuilder.dataConstructor,
     });
   }
 }
 
- /**
-  * The UserRecord passed to Cloud Functions is the same UserRecord that is returned by the Firebase Admin
-  * SDK.
-  */
+/**
+ * The UserRecord passed to Cloud Functions is the same UserRecord that is returned by the Firebase Admin
+ * SDK.
+ */
 export type UserRecord = firebase.auth.UserRecord;