#65 Feature: Crash Reporting

Author: EddyVerbruggen

CHANGELOG.md

@@ -1,5 +1,26 @@
 <img src="docs/images/firebase-logo.png" width="116px" height="32px" alt="Firebase"/>
 
+## 3.4.2 (2016, July 14)
+
+[Full changelog](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/compare/3.4.0...3.4.2)
+
+### SDK versions
+If version numbers changed clean your platform folders to avoid build errors.
+
+- iOS: 3.3.x
+- Android: 9.2.0
+
+### New
+- [#61](#61) Added `keepInSync` for enhanced offline support.
+- [#65](#65) Crash Reporting, which is automatically enabled for you.
+
+### Fixes
+- [#68](#68) Fix an issue where you'd log in on Android before `application.start()`.
+- [#70](#70) Added a TypeScript definition for `getCurrentUser()`.
+- [#71](#71) Added a TypeScript definition for LoginResult.email.
+
+
+
 ## 3.4.0 (2016, July 7)
 
 [Full changelog](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/compare/3.3.0...3.4.0)

README.md

@@ -11,7 +11,8 @@ For readability the supported features have been moved to their own README's:
 * [Authentication](docs/AUTHENTICATION.md)
 * [Remote Config](docs/REMOTECONFIG.md)
 * [Cloud Messaging](docs/MESSAGING.md)
-* [Storage ](docs/STORAGE.md)
+* [Storage](docs/STORAGE.md)
+* [Crash Reporting](docs/CRASHREPORTING.md)
 
 ## Prerequisites
 Head on over to [https://console.firebase.google.com/](https://console.firebase.google.com/) and sign up for a free account.

docs/CRASHREPORTING.md

@@ -0,0 +1,42 @@
+<img src="images/firebase-logo.png" width="116px" height="32px" alt="Firebase"/>
+
+## Enabling Remote Config
+Since plugin version 3.2.0 you can retrieve _Remote Config_ properties.
+This feature lets you configure parameters in your Firebase instance like these:
+
+<img src="images/remote-config.png" width="500px" height="482px" alt="Remote Config"/>
+
+To enable support for Remote Config you need to manually adjust
+[Podfile](../platforms/ios/Podfile) and [include.gradle](../platforms/android/include.gradle).
+
+Just uncomment the relevant lines (one for each platform) to add the SDK's to your app.
+
+## Functions
+
+### getRemoteConfig
+Using this function you can retrieve the current values of the remote properties so you can change app behavior on the fly easily (feature toggles for instance).
+
+```js
+  firebase.getRemoteConfig({
+    developerMode: false, // play with this boolean to get more frequent updates during development
+    cacheExpirationSeconds: 600, // 10 minutes, default is 12 hours.. set to a lower value during dev
+    properties: [{
+      key: "holiday_promo_enabled",
+      default: false
+    },
+    {
+      key: "coupons_left",
+      default: 100
+    },
+    {
+      key: "double_or_nothing",
+      default: 9.99
+    }]
+  }).then(
+      function (result) {
+        console.log("Remote Config last fetched at " + result.lastFetch);
+        console.log("Remote Config: " + JSON.stringify(result.properties));
+        console.log("Remote Config property 'coupons_left': " + result.properties.coupons_left);
+      }
+  );
+```

docs/STORAGE.md

@@ -1,118 +1,13 @@
 <img src="images/firebase-logo.png" width="116px" height="32px" alt="Firebase"/>
 
-## Enabling Storage
-Since plugin version 3.4.0 you can use Firebase _Storage_ features.
+## Enabling Crash Reporting
+Nothing to do - since plugin version 3.4.2 this plugin automatically uploads
+crashes to your Firebase Console. Just check the 'Crash' menu item every now and then.
 
-_Storage_ lets you upload and download files to/from Google Cloud Storage which is connected to your Firebase instance.
+## Making sense of the stacktraces
+Please read [the official docs](https://firebase.google.com/docs/crash/)
+on what Crash reporting is and what you can do to have a better experience.
 
-To enable support for Remote Config you need to manually adjust
-[Podfile](../platforms/ios/Podfile) and [include.gradle](../platforms/android/include.gradle).
-
-Just uncomment the relevant lines (one for each platform) to add the SDK's to your app.
-
-### Setting the storage bucket
-You need to tell Firebase what your storage bucket is. You can retrieve it
-from the Firebase console by pressing 'Storage' in the menu.
-
-You can either pass it to the `init()` function as shown below,
-or pass it as a property any time you're using a storage feature.
-In theory the former is a little more efficient because it's cached by the plugin.
-
-```js
-  firebase.init({
-    storageBucket: 'gs://n-plugin-test.appspot.com'
-    // any other options
-  });
-```
-
-## Functions
-
-### uploadFile
-You can either pass in a full local path to a file, or (as a convenience) use the `file-system` module that comes shipped with {N} as standard.
-
-```js
-  // init the file-system module
-  var fs = require("file-system");
-
-  // grab a reference to the app folder
-  var appPath = fs.knownFolders.currentApp().path;
-
-  // determine the path to a file in the app/res folder
-  var logoPath = appPath + "/res/telerik-logo.png";
-
-  // now upload the file with either of the options below:
-  firebase.uploadFile({
-    // optional, can also be passed during init() as 'storageBucket' param so we can cache it (find it in the Firebase console)
-    bucket: 'gs://n-plugin-test.appspot.com',
-    // the full path of the file in your Firebase storage (folders will be created)
-    remoteFullPath: 'uploads/images/telerik-logo-uploaded.png',
-    // option 1: a file-system module File object
-    localFile: fs.File.fromPath(logoPath),
-    // option 2: a full file path (ignored if 'localFile' is set)
-    localFullPath: logoPath
-  }).then(
-      function (uploadedFile) 
-        console.log("File uploaded: " + JSON.stringify(uploadedFile));
-      },
-      function (error) {
-        console.log("File upload error: " + error);
-      };
-  );
-```
-
-### downloadFile
-As with `uploadFile` you can either pass in a full local path to a file, or (as a convenience) use the `file-system` module that comes shipped with {N} as standard.
-
-In this example we'll download the previously uploaded file to a certain path on the local filesystem.
-
-```js
-  // init the file-system module
-  var fs = require("file-system");
-
-  // let's first determine where we'll create the file using the 'file-system' module
-  var documents = fs.knownFolders.documents();
-  var logoPath = documents.path + "/telerik-logo-downloaded.png";
-
-  // this will create or overwrite a local file in the app's documents folder
-  var localLogoFile = documents.getFile("telerik-logo-downloaded.png");
-
-  // now download the file with either of the options below:
-  firebase.downloadFile({
-    // optional, can also be passed during init() as 'storageBucket' param so we can cache it
-    bucket: 'gs://n-plugin-test.appspot.com',
-    // the full path of an existing file in your Firebase storage
-    remoteFullPath: 'uploads/images/telerik-logo-uploaded.png',
-    // option 1: a file-system module File object
-    localFile: fs.File.fromPath(logoPath),
-    // option 2: a full file path (ignored if 'localFile' is set)
-    localFullPath: logoPath
-  }).then(
-      function (uploadedFile) 
-        console.log("File downloaded to the requested location");
-      },
-      function (error) {
-        console.log("File download error: " + error);
-      };
-  );
-```
-
-### getDownloadUrl
-If you just want to know the remote URL of a file in remote storage so you can either share it or download the file by any other means than `downloadFile` then use this method.
-
-In this example we'll determine the remote URL of the previously uploaded file.
-
-```js
-  firebase.getDownloadUrl({
-    // optional, can also be passed during init() as 'storageBucket' param so we can cache it
-    bucket: 'gs://n-plugin-test.appspot.com',
-    // the full path of an existing file in your Firebase storage
-    remoteFullPath: 'uploads/images/telerik-logo-uploaded.png'
-  }).then(
-      function (url) 
-        console.log("Remote URL: " + url);
-      },
-      function (error) {
-        console.log("Error: " + error);
-      };
-  );
-```
+## Future work
+There's an option to send logs to Firebase along with the crash in order
+to add some context. This is however currently problematic on iOS but we'll keep an eye out.

firebase.android.js

@@ -1040,4 +1040,29 @@ firebase.getDownloadUrl = function (arg) {
   });
 };
 
+/*
+firebase.sendCrashLog = function (arg) {
+  return new Promise(function (resolve, reject) {
+    try {
+
+      if (typeof(com.google.firebase.crash) === "undefined") {
+        reject("Make sure firebase-crash is in the plugin's include.gradle");
+        return;
+      }
+
+      if (!arg.log) {
+        reject("The mandatory 'log' argument is missing");
+        return;
+      }
+
+      com.google.firebase.crash.FirebaseCrash.log(arg.log);
+      resolve();
+    } catch (ex) {
+      console.log("Error in firebase.sendCrashLog: " + ex);
+      reject(ex);
+    }
+  });
+};
+*/
+
 module.exports = firebase;

firebase.d.ts

@@ -344,4 +344,7 @@ declare module "nativescript-plugin-firebase" {
     export function uploadFile(options: UploadFileOptions): Promise<UploadFileResult>;
     export function downloadFile(options: DownloadFileOptions): Promise<any>;
     export function getDownloadUrl(options: GetDownloadUrlOptions): Promise<string>;
+
+    // crash logging
+    // export function sendCrashLog(options: SendCrashLogOptions): Promise<any>;
 }

firebase.ios.js

@@ -423,7 +423,7 @@ firebase.getCurrentUser = function (arg) {
           email: user.email,
           emailVerified: user.emailVerified,
           name: user.displayName,
-          refreshToken: user.refreshToken
+          refreshToken: user.refreshToken,
         });
       } else {
         reject();
@@ -462,6 +462,7 @@ function toLoginResult(user) {
 
 firebase.login = function (arg) {
   return new Promise(function (resolve, reject) {
+
     try {
       var onCompletion = function(user, error) {
         if (error) {
@@ -1029,4 +1030,34 @@ firebase.getDownloadUrl = function (arg) {
   });
 };
 
+/* disabled since FIRCrashLog is always undefined
+firebase.sendCrashLog = function (arg) {
+  return new Promise(function (resolve, reject) {
+    try {
+
+      if (typeof(FIRCrashLog) === "undefined") {
+        reject("Make sure 'Firebase/Crash' is in the plugin's Podfile");
+        return;
+      }
+
+      if (!arg.log) {
+        reject("The mandatory 'log' argument is missing");
+        return;
+      }
+
+      if (showInConsole) {
+        FIRCrashNSLog(arg.log);
+      } else {
+        FIRCrashLog(arg.log);
+      }
+
+      resolve();
+    } catch (ex) {
+      console.log("Error in firebase.sendCrashLog: " + ex);
+      reject(ex);
+    }
+  });
+};
+*/
+
 module.exports = firebase;

package.json

@@ -1,6 +1,6 @@
 {
   "name": "nativescript-plugin-firebase",
-  "version": "3.4.1",
+  "version": "3.4.2",
   "description" : "Fire. Base. Firebase!",
   "main" : "firebase.js",
   "nativescript": {

platforms/android/include.gradle

@@ -17,6 +17,7 @@ dependencies {
     compile "com.google.firebase:firebase-core:9.2.0"
     compile "com.google.firebase:firebase-database:9.2.0"
     compile "com.google.firebase:firebase-auth:9.2.0"
+    compile "com.google.firebase:firebase-crash:9.2.0"
 
     // for reading google-services.json and configuration
     compile "com.google.android.gms:play-services-base:9.2.0"

platforms/ios/Podfile

@@ -2,6 +2,7 @@
 pod 'Firebase', '~> 3.3.0'
 pod 'Firebase/Database'
 pod 'Firebase/Auth'
+pod 'Firebase/Crash'
 
 # Uncomment if you want to enable Remote Config
 #pod 'Firebase/RemoteConfig'