Added Log with Crashlytics #967

Author: EddyVerbruggen

.gitignore

@@ -16,6 +16,7 @@ src/platforms/android/include.gradle
 !src/index.d.ts
 !src/references.d.ts
 !src/analytics/analytics.d.ts
+!src/crashlytics/crashlytics.d.ts
 !src/storage/storage.d.ts
 !src/admob/admob.d.ts
 !src/messaging/messaging.d.ts

demo/app/main-view-model.ts

@@ -1,8 +1,14 @@
 import { Observable } from "tns-core-modules/data/observable";
 import { alert, prompt } from "tns-core-modules/ui/dialogs";
-import { isIOS, isAndroid } from "tns-core-modules/platform";
+import { isAndroid, isIOS } from "tns-core-modules/platform";
 import * as firebase from "nativescript-plugin-firebase";
-import { AddEventListenerResult, storage as firebaseStorage, admob as firebaseAdMob, User } from "nativescript-plugin-firebase";
+import {
+  AddEventListenerResult,
+  admob as firebaseAdMob,
+  crashlytics as firebaseCrashlytics,
+  storage as firebaseStorage,
+  User
+} from "nativescript-plugin-firebase";
 import * as fs from "tns-core-modules/file-system";
 import { MessagingViewModel } from './messaging-view-model';
 
@@ -1626,47 +1632,26 @@ export class HelloWorldModel extends Observable {
   public doLogMessageCrashlytics(): void {
     if (isAndroid) {
       // Send the desired exception
-      firebase.sendCrashlyticsLog(new java.lang.Exception("test Exception")).then(
-        () => {
-          alert({
-            title: "Message logged",
-            message: "Check the Firebase console",
-            okButtonText: "Okay"
-          });
-        },
-        error => {
-          alert({
-            title: "Logging error",
-            message: error,
-            okButtonText: "OK"
-          });
-        }
-    );
+      firebaseCrashlytics.sendCrashLog(new java.lang.Exception("test Exception"));
     } else if (isIOS) {
       // Send the desired exception
-      firebase.sendCrashlyticsLog(new NSError({domain: 'ShiploopHttpResponseErrorDomain', code: 42, userInfo: null})).then(
-          () => {
-            alert({
-              title: "Message logged",
-              message: "Check the Firebase console",
-              okButtonText: "Okay"
-            });
-          },
-          error => {
-            alert({
-              title: "Logging error",
-              message: error,
-              okButtonText: "OK"
-            });
-          }
-      );
+      firebaseCrashlytics.sendCrashLog(new NSError({
+        domain: 'ShiploopHttpResponseErrorDomain',
+        code: 42,
+        userInfo: null
+      }));
     }
-    
-  }
 
+    alert({
+      title: "Message logged",
+      message: "Check the Firebase console",
+      okButtonText: "Okay"
+    });
+  }
 
   public doSetCrashlyticString(): void {
-    firebase.setCrashlyticsString("test_key", "test_value");
+    firebaseCrashlytics.setString("test_key", "test_value");
+
     alert({
       title: "String created",
       message: "New string key created, log a new message and check firebase console",
@@ -1675,7 +1660,8 @@ export class HelloWorldModel extends Observable {
   }
 
   public doSetCrashlyticBool(): void {
-    firebase.setCrashlyticsBool("test_key_bool", true);
+    firebaseCrashlytics.setBool("test_key_bool", true);
+
     alert({
       title: "Bool created",
       message: "New string key created, log a new message and check firebase console",
@@ -1684,7 +1670,8 @@ export class HelloWorldModel extends Observable {
   }
 
   public doSetCrashlyticInt(): void {
-    firebase.setCrashlyticsInt("test_key_int", 2);
+    firebaseCrashlytics.setInt("test_key_int", 2);
+
     alert({
       title: "Int created",
       message: "New string key created, log a new message and check firebase console",
@@ -1693,7 +1680,8 @@ export class HelloWorldModel extends Observable {
   }
 
   public doSetCrashlyticDouble(): void {
-    firebase.setCrashlyticsDouble("test_key_double", 56615.55548465);
+    firebaseCrashlytics.setDouble("test_key_double", 56615.55548465);
+
     alert({
       title: "Double created",
       message: "New string key created, log a new message and check firebase console",
@@ -1702,7 +1690,8 @@ export class HelloWorldModel extends Observable {
   }
 
   public doSetCrashlyticFloat(): void {
-    firebase.setCrashlyticsFloat("test_key", 54646.45);
+    firebaseCrashlytics.setFloat("test_key", 54646.45);
+
     alert({
       title: "Float created",
       message: "New string key created, log a new message and check firebase console",
@@ -1711,7 +1700,9 @@ export class HelloWorldModel extends Observable {
   }
 
   public doSetUserId(): void {
-    firebase.setUserIdCrashlytics("user#42");
+    // just for fun: showing usage of 'firebase.crashlytics' instead of 'firebaseCrashlytics'
+    firebase.crashlytics.setUserId("user#42");
+
     alert({
       title: "User id changed",
       message: "Log a new message and check firebase console",

demo/package.json

@@ -10,7 +10,7 @@
   },
   "dependencies": {
     "firebase-functions": "^2.0.5",
-    "nativescript-plugin-firebase": "file:../publish/package/nativescript-plugin-firebase-7.1.6.tgz",
+    "nativescript-plugin-firebase": "file:../publish/package/nativescript-plugin-firebase-7.2.0.tgz",
     "nativescript-theme-core": "^1.0.4",
     "nativescript-unit-test-runner": "^0.3.4",
     "tns-core-modules": "^4.2.1"
@@ -37,4 +37,4 @@
     "build.plugin": "cd ../src && npm run build",
     "ci.tslint": "npm i && tslint --config '../tslint.json' 'app/**/*.ts' --exclude '**/node_modules/**' --exclude '**/typings/**'"
   }
-}
+}

docs/CRASHREPORTING.md

@@ -1,8 +1,51 @@
-<img src="https://raw.githubusercontent.com/EddyVerbruggen/nativescript-plugin-firebase/master/docs/images/features/crash.png" height="85px" alt="Crash Reporting"/>
+<img src="https://raw.githubusercontent.com/EddyVerbruggen/nativescript-plugin-firebase/master/docs/images/features/crashlytics.png" height="85px" alt="Crashlytics"/>
+
+> Firebase Crash reporting is deprecated - use Crashlytics if you can!
 
 ## Enabling Crash Reporting / Crashlytics
 Since version 5.3.0 you can choose either Crashlytics (recommended) or the older Firebase Crash Reporting (which doesn't really work on iOS).
 You will be prompted during installation of the plugin to enable either Crashlytics or Crash Reporting (both are off by default).
 
 Note that if you want to use Crashlytics, make sure your `firebase.nativescript.json` file has `"crashlytics": true` and `"crash_reporting": false`,
 then remove the `platforms` folder so these changes are picked up.
+
+## Crashlytics API
+
+### `sendCrashLog`
+Send a native iOS or Android exception to Crashlytics.
+
+```typescript
+// either import like this:
+import { crashlytics } from "nativescript-plugin-firebase"; // and do: crashlytics.sendCrashLog
+// or this:
+import { crashlytics as firebaseCrashlytics } from "nativescript-plugin-firebase"; // and do: firebaseCrashlytics.sendCrashLog
+// or this:
+import * as firebase from "nativescript-plugin-firebase"; // and do: firebase.crashlytics.sendCrashLog
+
+import { isAndroid, isIOS } from "tns-core-modules/platform";
+
+if (isAndroid) {
+  crashlytics.sendCrashLog(new java.lang.Exception("test Exception"));
+} else if (isIOS) {
+  crashlytics.sendCrashLog(new NSError({
+    domain: 'ShiploopHttpResponseErrorDomain',
+    code: 42,
+    userInfo: null
+  }));
+}
+```
+
+### `set*`
+Set a value that will be logged with an error and showing in the Firebase console on the 'Keys' tab of the error details.
+
+```typescript
+import { crashlytics } from "nativescript-plugin-firebase"; // and do: crashlytics.sendCrashLog
+
+crashlytics.setString("test_key", "test_value");
+crashlytics.setBool("test_key_bool", true);
+crashlytics.setInt("test_key_int", 2);
+crashlytics.setDouble("test_key_double", 56615.55548465);
+crashlytics.setFloat("test_key", 54646.45);
+
+crashlytics.setUserId("user#42");
+```

docs/images/features/crashlytics.png

@@ -0,0 +1,51 @@
+declare const com: any;
+
+export function sendCrashLog(exception: any /* java.lang.Exception */): void {
+  if (isCrashlyticsAvailable()) {
+    com.crashlytics.android.Crashlytics.logException(exception);
+  }
+}
+
+export function setString(key: string, value: string): void {
+  if (isCrashlyticsAvailable()) {
+    com.crashlytics.android.Crashlytics.setString(key, value);
+  }
+}
+
+export function setBool(key: string, value: boolean): void {
+  if (isCrashlyticsAvailable()) {
+    com.crashlytics.android.Crashlytics.setBool(key, value);
+  }
+}
+
+export function setFloat(key: string, value: number): void {
+  if (isCrashlyticsAvailable()) {
+    com.crashlytics.android.Crashlytics.setFloat(key, value);
+  }
+}
+
+export function setInt(key: string, value: number): void {
+  if (isCrashlyticsAvailable()) {
+    com.crashlytics.android.Crashlytics.setInt(key, value);
+  }
+}
+
+export function setDouble(key: string, value: number): void {
+  if (isCrashlyticsAvailable()) {
+    com.crashlytics.android.Crashlytics.setDouble(key, value);
+  }
+}
+
+export function setUserId(id: string): void {
+  if (isCrashlyticsAvailable()) {
+    com.crashlytics.android.Crashlytics.setUserIdentifier(id);
+  }
+}
+
+function isCrashlyticsAvailable(): boolean {
+  if (typeof (com.crashlytics) === "undefined" || typeof (com.crashlytics.android.Crashlytics) === "undefined") {
+    console.log("Add 'crashlytics: true' to firebase.nativescript.json and remove the platforms folder");
+    return false;
+  }
+  return true;
+}

src/crashlytics/crashlytics.android.ts

@@ -0,0 +1,17 @@
+/**
+ * send Crashlytics Log -> android Exception or iOS Exception
+ * @param exception
+ */
+export declare function sendCrashLog(exception: any): void;
+
+export declare function setString(key: string, value: string): void;
+
+export declare function setBool(key: string, value: boolean): void;
+
+export declare function setFloat(key: string, value: number): void;
+
+export declare function setInt(key: string, value: number): void;
+
+export declare function setDouble(key: string, value: number): void;
+
+export declare function setUserId(userId: string): void;

src/crashlytics/crashlytics.d.ts

@@ -0,0 +1,49 @@
+export function sendCrashLog(exception: any /* NSError */): void {
+  if (isCrashlyticsAvailable()) {
+    Crashlytics.sharedInstance().recordError(exception);
+  }
+}
+
+export function setString(key: string, value: string): void {
+  if (isCrashlyticsAvailable()) {
+    Crashlytics.sharedInstance().setObjectValueForKey(value, key);
+  }
+}
+
+export function setBool(key: string, value: boolean): void {
+  if (isCrashlyticsAvailable()) {
+    Crashlytics.sharedInstance().setBoolValueForKey(value, key);
+  }
+}
+
+export function setFloat(key: string, value: number): void {
+  if (isCrashlyticsAvailable()) {
+    Crashlytics.sharedInstance().setFloatValueForKey(value, key);
+  }
+}
+
+export function setInt(key: string, value: number): void {
+  if (isCrashlyticsAvailable()) {
+    Crashlytics.sharedInstance().setIntValueForKey(value, key);
+  }
+}
+
+export function setDouble(key: string, value: number): void {
+  if (isCrashlyticsAvailable()) {
+    Crashlytics.sharedInstance().setFloatValueForKey(value, key);
+  }
+}
+
+export function setUserId(id: string): void {
+  if (isCrashlyticsAvailable()) {
+    Crashlytics.sharedInstance().setUserIdentifier(id);
+  }
+}
+
+function isCrashlyticsAvailable(): boolean {
+  if (typeof (Crashlytics) === "undefined") {
+    console.log("Add 'crashlytics: true' to firebase.nativescript.json and remove the platforms folder");
+    return false;
+  }
+  return true;
+}

src/crashlytics/crashlytics.ios.ts

@@ -0,0 +1,2 @@
+import * as crashlytz from "./crashlytics";
+export const crashlytics = crashlytz;

src/crashlytics/index.ts

@@ -3,6 +3,7 @@ import { getString, setString } from "tns-core-modules/application-settings";
 import { firestore } from "./firebase";
 import * as admob from "./admob/admob";
 import * as analytics from "./analytics/analytics";
+import * as crashlytics from "./crashlytics/crashlytics";
 import * as storage from "./storage/storage";
 import * as mlkit from "./mlkit";
 
@@ -33,6 +34,7 @@ export const firebase: any = {
   _dynamicLinkCallback: null,
   admob,
   analytics,
+  crashlytics,
   storage,
   mlkit,
   firestore: {