How to set Firestore serverTimestamp on document create / update #736

Author: EddyVerbruggen

CHANGELOG.md

@@ -4,9 +4,7 @@
 [Firebase Android SDK Changelog](https://firebase.google.com/support/release-notes/android)
 
 ## 6.1.0 (PENDING)
-
-### Fixes
-- [#711](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/issues/711) Crashlytics: "Configure Crashlytics" build step phase added multiple times 
+[Fixes & Enhancements](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/milestone/57)
 
 
 ## 6.0.2 (2018, May 16)

demo-ng/app/tabs/firestore/firestore.component.ts

@@ -42,7 +42,16 @@ export class FirestoreComponent {
 
   public firestoreSet(): void {
     firebase.firestore().collection("dogs").doc("fave")
-        .set({name: "Woofie", last: "lastofwoofie", date: new Date()}, {merge: true})
+        .set({
+              name: "Woofie",
+              last: "lastofwoofie",
+          // note that this only works on iOS (there's a limitation in the Firestore Android SDK)
+              // updateTsSet: firebase.firestore().FieldValue().serverTimestamp()
+            },
+            {
+              merge: true
+            }
+        )
         .then(() => {
           console.log("Woofie set");
         })
@@ -112,7 +121,11 @@ export class FirestoreComponent {
 
   public firestoreUpdate(): void {
     firebase.firestore().collection("dogs").doc("fave")
-        .update({name: "Woofieupdate", last: "updatedwoofie"})
+        .update({
+          name: "Woofieupdate",
+          last: "updatedwoofie!",
+          updateTs: firebase.firestore().FieldValue().serverTimestamp()
+        })
         .then(() => {
           console.log("Woofie updated");
         })

demo/app/main-view-model.ts

@@ -1359,6 +1359,7 @@ export class HelloWorldModel extends Observable {
       remoteFullPath: 'uploads/images/telerik-logo-uploaded.png'
     }).then(
         theUrl => {
+          console.log("Download url: " + theUrl);
           alert({
             title: "File download URL determined",
             message: "You can download the file at: " + theUrl,

docs/FIRESTORE.md

@@ -152,13 +152,17 @@ citiesCollection.doc("LA").set({
 ```
 
 ### `collection.doc().update()`
-Update any number of properties of a document:
+Update any number of properties of a document.
+
+Use the special property `firebase.firestore().FieldValue().serverTimestamp()` to update a server timestamp
+(as opposed to a local timestamp, which would be different for every client).
 
 ```typescript
 const sanFranciscoDocument = firebase.firestore().collection("cities").doc("SF");
 
 sanFranciscoDocument.update({
-  population: 860001
+  population: 860001,
+  updateTimestamp: firebase.firestore().FieldValue().serverTimestamp()
 }).then(() => {
   console.log("SF population updated");
 });
@@ -217,4 +221,4 @@ query
 ```
 
 ## Future work
-Need something else that's not supported yet? Please open an Issue or PR 😚
+Need something else that's not supported yet? Please open an Issue or PR 😚

src/app/firestore/index.ts

@@ -1,9 +1,15 @@
 import * as firebase from "../../firebase";
+import { FIRESTORE_SERVER_TS } from "../../firebase";
 
 export module firestore {
   export class Firestore {
     collection(collectionPath: string): firebase.firestore.CollectionReference {
       return firebase.firestore.collection(collectionPath);
     }
+    FieldValue(): firebase.firestore.FieldValue {
+      return {
+        serverTimestamp: () => FIRESTORE_SERVER_TS
+      }
+    }
   }
 }

src/firebase-common.ts

@@ -1,8 +1,13 @@
 import { prompt } from "tns-core-modules/ui/dialogs";
-import { firestore } from "./firebase";
+import { getString, setString } from "tns-core-modules/application-settings";
+import { firestore, FIRESTORE_SERVER_TS } from "./firebase";
 import * as analytics from "./analytics/analytics";
 import * as mlkit from "./mlkit";
-import * as applicationSettings from "tns-core-modules/application-settings";
+
+// note that this implementation is overridden for iOS
+export class FieldValue {
+  serverTimestamp = () => FIRESTORE_SERVER_TS;
+}
 
 export const firebase: any = {
   initialized: false,
@@ -14,7 +19,9 @@ export const firebase: any = {
   _dynamicLinkCallback: null,
   analytics,
   mlkit,
-  firestore: {},
+  firestore: {
+    FieldValue
+  },
   invites: {
     MATCH_TYPE: {
       WEAK: 0,
@@ -103,10 +110,10 @@ export const firebase: any = {
     });
   },
   rememberEmailForEmailLinkLogin: (email: string) => {
-    applicationSettings.setString("FirebasePlugin.EmailLinkLogin", email);
+    setString("FirebasePlugin.EmailLinkLogin", email);
   },
   getRememberedEmailForEmailLinkLogin: () => {
-    return applicationSettings.getString("FirebasePlugin.EmailLinkLogin");
+    return getString("FirebasePlugin.EmailLinkLogin");
   },
   strongTypeify: value => {
     if (value === "true") {

src/firebase.android.ts

@@ -1,13 +1,13 @@
 import { DocumentSnapshot, firebase, QuerySnapshot } from "./firebase-common";
 import * as appModule from "tns-core-modules/application";
 import { AndroidActivityResultEventData } from "tns-core-modules/application";
-import * as utils from "tns-core-modules/utils/utils";
+import { ad as AndroidUtils, layout } from "tns-core-modules/utils/utils";
 import lazy from "tns-core-modules/utils/lazy";
-import * as frame from "tns-core-modules/ui/frame";
-import * as fs from "tns-core-modules/file-system";
-import { firestore } from "./firebase";
+import { topmost } from "tns-core-modules/ui/frame";
+import { File } from "tns-core-modules/file-system";
+import { firestore, FIRESTORE_SERVER_TS } from "./firebase";
 
-declare const com, org: any;
+declare const android, com, org: any;
 
 firebase._launchNotification = null;
 firebase._cachedDynamicLink = null;
@@ -126,12 +126,16 @@ firebase.toHashMap = obj => {
       if (obj[property] === null) {
         node.put(property, null);
       } else {
-        if (obj[property] instanceof Date) {
+        // note that the Android Firestore SDK only supports this for 'update' (not for 'set')
+        if (obj[property] === FIRESTORE_SERVER_TS) {
+          node.put(property, com.google.firebase.firestore.FieldValue.serverTimestamp());
+        } else if (obj[property] instanceof Date) {
           node.put(property, new java.util.Date(obj[property].getTime()));
         } else if (Array.isArray(obj[property])) {
           node.put(property, firebase.toJavaArray(obj[property]));
         } else {
           switch (typeof obj[property]) {
+            case 'object':
             case 'object':
               node.put(property, firebase.toHashMap(obj[property], node));
               break;
@@ -616,7 +620,7 @@ firebase.admob.showBanner = arg => {
       const ad = firebase.admob._buildAdRequest(settings);
       firebase.admob.adView.loadAd(ad);
 
-      const density = utils.layout.getDisplayDensity(),
+      const density = layout.getDisplayDensity(),
           top = settings.margins.top * density,
           bottom = settings.margins.bottom * density;
 
@@ -644,8 +648,8 @@ firebase.admob.showBanner = arg => {
       // Wrapping it in a timeout makes sure that when this function is loaded from a Page.loaded event 'frame.topmost()' doesn't resolve to 'undefined'.
       // Also, in NativeScript 4+ it may be undefined anyway.. so using the appModule in that case.
       setTimeout(() => {
-        if (frame.topmost() !== undefined) {
-          frame.topmost().currentPage.android.getParent().addView(adViewLayout, relativeLayoutParamsOuter);
+        if (topmost() !== undefined) {
+          topmost().currentPage.android.getParent().addView(adViewLayout, relativeLayoutParamsOuter);
         } else {
           appModule.android.foregroundActivity.getWindow().getDecorView().addView(adViewLayout, relativeLayoutParamsOuter);
         }
@@ -1154,7 +1158,7 @@ firebase.login = arg => {
             arg.phoneOptions.phoneNumber,
             60, // timeout (in seconds, because of the next argument)
             java.util.concurrent.TimeUnit.SECONDS,
-            appModule.android.foregroundActivity, // or utils.ad.getApplicationContext()
+            appModule.android.foregroundActivity,
             new OnVerificationStateChangedCallbacks());
 
       } else if (arg.type === firebase.LoginType.CUSTOM) {
@@ -1215,7 +1219,7 @@ firebase.login = arg => {
         if (arg.facebookOptions && arg.facebookOptions.scope) {
           scope = arg.facebookOptions.scope;
         }
-        const permissions = utils.ad.collections.stringArrayToStringSet(scope);
+        const permissions = AndroidUtils.collections.stringArrayToStringSet(scope);
 
         const activity = appModule.android.foregroundActivity;
         fbLoginManager.logInWithReadPermissions(activity, permissions);
@@ -1226,8 +1230,8 @@ firebase.login = arg => {
           return;
         }
 
-        const clientStringId = utils.ad.resources.getStringId("default_web_client_id");
-        const clientId = utils.ad.getApplicationContext().getResources().getString(clientStringId);
+        const clientStringId = AndroidUtils.resources.getStringId("default_web_client_id");
+        const clientId = AndroidUtils.getApplicationContext().getResources().getString(clientStringId);
 
         // Configure Google Sign In
         const googleSignInOptionsBuilder = new com.google.android.gms.auth.api.signin.GoogleSignInOptions.Builder(com.google.android.gms.auth.api.signin.GoogleSignInOptions.DEFAULT_SIGN_IN)
@@ -1967,7 +1971,7 @@ firebase.uploadFile = arg => {
 
       } else if (arg.localFullPath) {
 
-        if (!fs.File.exists(arg.localFullPath)) {
+        if (!File.exists(arg.localFullPath)) {
           reject("File does not exist: " + arg.localFullPath);
           return;
         }

src/firebase.d.ts

@@ -1,3 +1,5 @@
+export declare const FIRESTORE_SERVER_TS = "SERVER_TIMESTAMP";
+
 /**
  * The allowed values for LoginOptions.type.
  */
@@ -827,6 +829,10 @@ export namespace firestore {
     add(data: DocumentData): Promise<DocumentReference>;
   }
 
+  export class FieldValue {
+    static serverTimestamp: () => FIRESTORE_SERVER_TS
+  }
+
   export interface QuerySnapshot {
     docSnapshots: firestore.DocumentSnapshot[];