Update peer dependency to firebase-admin v5.0.0 (#66)

Author: laurenzlong

package.json

@@ -38,7 +38,7 @@
  "@types/sinon": "^1.16.29",
  "chai": "^3.5.0",
  "chai-as-promised": "^5.2.0",
- "firebase-admin": "^4.2.1",
+ "firebase-admin": "^5.0.0",
  "istanbul": "^0.4.2",
  "mocha": "^2.4.5",
  "mock-require": "^2.0.1",
@@ -48,7 +48,7 @@
  "typescript": "^2.0.3"
  },
  "peerDependencies": {
- "firebase-admin": "~4.2.1"
+ "firebase-admin": "~5.0.0"
  },
  "dependencies": {
  "@types/express": "^4.0.33",

spec/providers/auth.spec.ts

@@ -61,90 +61,76 @@ describe('AuthBuilder', () => {
  });
 
  describe('#_dataConstructor', () => {
- it('should handle an event with the appropriate fields', () => {
-  const cloudFunctionCreate = auth.user().onCreate((ev: Event<firebase.auth.UserRecord>) => ev.data);
-  const cloudFunctionDelete = auth.user().onDelete((ev: Event<firebase.auth.UserRecord>) => ev.data);
+ let cloudFunctionCreate;
+ let cloudFunctionDelete;
+ let event;
 
- // 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
- let event = {
- eventId: 'f2e2f0bf-2e47-4d92-b009-e7a375ecbd3e',
- eventType: 'providers/firebase.auth/eventTypes/user.create',
- resource: 'projects/myUnitTestProject',
- notSupported: {
- },
+ before(() => {
+ cloudFunctionCreate = auth.user().onCreate((ev: Event<firebase.auth.UserRecord>) => ev.data);
+ cloudFunctionDelete = auth.user().onDelete((ev: Event<firebase.auth.UserRecord>) => ev.data);
+ event = {
  data: {
- uid: 'abcde12345',
- email: 'foo@bar.baz',
- emailVerified: false,
- displayName: 'My Display Name',
- photoURL: 'bar.baz/foo.jpg',
- disabled: false,
  metadata: {
  createdAt: '2016-12-15T19:37:37.059Z',
  lastSignedInAt: '2017-01-01T00:00:00.000Z',
  },
- providerData: [{
- uid: 'g-abcde12345',
- email: 'foo@gmail.com',
- displayName: 'My Google Provider Display Name',
- photoURL: 'googleusercontent.com/foo.jpg',
- providerId: 'google.com',
- }],
- },
- };
-
- 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',
- }],
  };
+ });
 
+ it('should transform old wire format for UserRecord into v5.0.0 format', () => {
  return Promise.all([
- expect(cloudFunctionCreate(event)).to.eventually.deep.equal(expectedData),
- expect(cloudFunctionDelete(event)).to.eventually.deep.equal(expectedData),
+ cloudFunctionCreate(event).then(data => {
+ expect(data.metadata.creationTime).to.equal('2016-12-15T19:37:37.059Z');
+ expect(data.metadata.lastSignInTime).to.equal('2017-01-01T00:00:00.000Z');
+ }),
+ cloudFunctionDelete(event).then(data => {
+ expect(data.metadata.creationTime).to.equal('2016-12-15T19:37:37.059Z');
+ expect(data.metadata.lastSignInTime).to.equal('2017-01-01T00:00:00.000Z');
+ }),
  ]);
  });
 
- // This isn't expected to happen in production, but if it does we should
- // handle it gracefully.
- it('should tolerate missing fields in the payload', () => {
- const cloudFunction = auth.user().onCreate((ev: Event<firebase.auth.UserRecord>) => ev.data);
+ // createdAt and lastSignedIn are fields of admin.auth.UserMetadata below v5.0.0
+ // We want to add shims to still expose these fields so that user's code do not break
+ // The shim and this test should be removed in v1.0.0 of firebase-functions
+ it('should still retain createdAt and lastSignedIn', () => {
+ return Promise.all([
+ cloudFunctionCreate(event).then(data => {
+ expect(data.metadata.createdAt).to.deep.equal(new Date('2016-12-15T19:37:37.059Z'));
+ expect(data.metadata.lastSignedInAt).to.deep.equal(new Date('2017-01-01T00:00:00.000Z'));
+ }),
+ cloudFunctionDelete(event).then(data => {
+ expect(data.metadata.createdAt).to.deep.equal(new Date('2016-12-15T19:37:37.059Z'));
+ expect(data.metadata.lastSignedInAt).to.deep.equal(new Date('2017-01-01T00:00:00.000Z'));
+ }),
+ ]);
+ });
 
- let event: Event<firebase.auth.UserRecord> = {
+ it('should handle new wire format if/when there is a change', () => {
+ const newEvent = {
  data: {
- uid: 'abcde12345',
  metadata: {
- // TODO(inlined) We'll need to manually parse these!
- createdAt: new Date(),
- lastSignedInAt: new Date(),
+ creationTime: '2016-12-15T19:37:37.059Z',
+ lastSignInTime: '2017-01-01T00:00:00.000Z',
  },
- email: 'nobody@google.com',
- emailVerified: false,
- displayName: 'sample user',
- photoURL: '',
- disabled: false,
  },
- } as any;
+ };
 
- return expect(cloudFunction(event)).to.eventually.deep.equal(event.data);
+ return Promise.all([
+ cloudFunctionCreate(newEvent).then(data => {
+ expect(data.metadata.creationTime).to.equal('2016-12-15T19:37:37.059Z');
+ expect(data.metadata.lastSignInTime).to.equal('2017-01-01T00:00:00.000Z');
+ expect(data.metadata.createdAt).to.deep.equal(new Date('2016-12-15T19:37:37.059Z'));
+ expect(data.metadata.lastSignedInAt).to.deep.equal(new Date('2017-01-01T00:00:00.000Z'));
+ }),
+ cloudFunctionDelete(newEvent).then(data => {
+ expect(data.metadata.creationTime).to.equal('2016-12-15T19:37:37.059Z');
+ expect(data.metadata.lastSignInTime).to.equal('2017-01-01T00:00:00.000Z');
+ expect(data.metadata.createdAt).to.deep.equal(new Date('2016-12-15T19:37:37.059Z'));
+ expect(data.metadata.lastSignedInAt).to.deep.equal(new Date('2017-01-01T00:00:00.000Z'));
+ }),
+ ]);
  });
  });
 });

src/providers/auth.ts

@@ -22,6 +22,7 @@
 
 import { makeCloudFunction, CloudFunction, Event } from '../cloud-functions';
 import * as firebase from 'firebase-admin';
+import * as _ from 'lodash';
 
 /** @internal */
 export const provider = 'firebase.auth';
@@ -31,27 +32,51 @@ export function user() {
  return new UserBuilder('projects/' + process.env.GCLOUD_PROJECT);
 }
 
+export class UserRecordMetadata implements firebase.auth.UserMetadata {
+
+ constructor(public creationTime: string, public lastSignInTime: string) { };
+
+ // Remove in v1.0.0
+ /** @internal */
+ get lastSignedInAt() {
+ console.warn('WARNING: "lastSignedInAt" will be removed in firebase-functions v1.0.0. ' +
+ 'Please start using "lastSignInTime", which is an ISO string.');
+ return new Date(this.lastSignInTime);
+ }
+
+ // Remove in v1.0.0
+ /** @internal */
+ get createdAt() {
+ console.warn('WARNING: "createdAt" will be removed in firebase-functions v1.0.0. ' +
+ 'Please start using "creationTime", which is an ISO string.');
+ return new Date(this.creationTime);
+ }
+
+ toJSON() {
+ return {
+ creationTime: this.creationTime,
+ lastSignInTime: this.lastSignInTime,
+ };
+ }
+}
+
 /** 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);
- }
+ // also has a class of the same name, which is one implementation of the interface.
+
+ // Transform payload to firebase-admin v5.0.0 format
+ let data = _.clone(raw.data);
+ if (data.metadata) {
+ let meta = data.metadata;
+ data.metadata = new UserRecordMetadata(
+ meta.createdAt || meta.creationTime,
+ meta.lastSignedInAt || meta.lastSignInTime,
+ );
  }
 
- return raw.data;
+ return data;
  }
 
  /** @internal */

src/providers/datastore.ts

@@ -141,7 +141,7 @@ export class DeltaDocumentSnapshot {
  result = new Buffer(fieldValue, 'base64');
  }
  } else if (fieldType === 'referenceValue') {
- console.log('WARNING: you have a data field which is a datastore reference. ' +
+ console.warn('WARNING: you have a data field which is a datastore reference. ' +
  'There will be a breaking change later which will change it from a string to a reference object.');
  result = fieldValue;
  } else {