Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sarriaroman/fabricplugin
Fabric.io plugin for Cordova or Phonegap
https://github.com/sarriaroman/fabricplugin
android cordova cordova-cli crashlytics fabric fabric-sdk ios
Last synced: 2 days ago
JSON representation
Fabric.io plugin for Cordova or Phonegap
- Host: GitHub
- URL: https://github.com/sarriaroman/fabricplugin
- Owner: sarriaroman
- License: mit
- Created: 2015-07-30T20:02:06.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2019-10-12T11:11:01.000Z (almost 5 years ago)
- Last Synced: 2024-04-14T01:06:56.998Z (6 months ago)
- Topics: android, cordova, cordova-cli, crashlytics, fabric, fabric-sdk, ios
- Language: JavaScript
- Size: 36.6 MB
- Stars: 198
- Watchers: 21
- Forks: 159
- Open Issues: 81
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Fabric Plugin for Cordova
[](#backers)
[](#sponsors)
This is a [Cordova](http://cordova.apache.org/) plugin for [Fabric.io](https://www.fabric.io)'s Crashlytics and Answers services.
It requires Cordova 6.x or newer (tested on 7.0.0) and has APIs for iOS and Android.
The iOS version uses Fabric SDK 1.7.5 and Crashlytics SDK 3.10.1 framework bundles which are located in `lib/ios`.
The Android version uses Gradle to get the Fabric SDK (`io.fabric.tools:gradle:1.+`) and the Crashlytics SDK (`com.crashlytics.sdk.android:crashlytics:2.9.1`) from Maven repositories when the plugin is added.
# Install
1. Make sure that you have [Node](http://nodejs.org/) and [Cordova CLI](https://github.com/apache/cordova-cli) or [PhoneGap's CLI](https://github.com/mwbrooks/phonegap-cli) installed on your machine.
1. Setup your [Fabric.io](https://fabric.io) account and get your API Key and Build Secret from your [organization page](https://www.fabric.io/settings/organizations/).
1. Add a plugin to your project using Cordova CLI, specifying the keys with the `--variable` argument:
```bash
# Install from npm registry:
cordova plugin add cordova-fabric-plugin --variable FABRIC_API_KEY=XXX --variable FABRIC_API_SECRET=xxx
# Or to install directly from github:
# (replace x.x.x with the tag of the version your want, or omit for HEAD)
cordova plugin add https://github.com/sarriaroman/FabricPlugin#x.x.x --variable FABRIC_API_KEY=XXX --variable FABRIC_API_SECRET=xxx
```
> Note: If you have never registered an app with your organization, the [organization page](https://www.fabric.io/settings/organizations/) may redirect you to a wizard preventing you from obtaining your keys. You may be able to obtain your keys from [this page](https://fabric.io/kits/ios/crashlytics/install). Scroll down to the "Run Script Build Phase" block. The first, shorter string is the API key and the second, longer string is the build secret. If that doesn't work you can follow the wizard and integrate the kit into a dummy "Hello World" project which should then unlock the organization page.
# Usage
The plugin is available via global variable named `fabric`. It exposes APIs for both Crashlytics and Answers.
A TypeScript definition file for the JavaScript interface is available in the `typings` directory.
# API Documentation
See `typings/cordova-fabric-plugin.d.ts` for documentation of the JavaScript APIs including call signatures and parameter types.
# Examples
Below are a few examples; see the API documentation for a complete list.
## Simulate a Native Crash
```javascript
window.fabric.Crashlytics.addLog("about to send a crash for testing!");
window.fabric.Crashlytics.sendCrash();
```
## Send a Non Fatal Crash / Recording Errors
```javascript
//Android and iOS
window.fabric.Crashlytics.addLog("about to send a non fatal crash for testing!");
window.fabric.Crashlytics.sendNonFatalCrash("Error message");
//iOS only. Send message and error code
window.fabric.Crashlytics.addLog("about to send a non fatal crash for testing!");
window.fabric.Crashlytics.recordError("Error message", -1);
//Android only. Send stack trace with non fatal crash (requires https://www.stacktracejs.com/)
window.fabric.Crashlytics.sendNonFatalCrash("Error message", StackTrace.getSync());
```
Issue Grouping
Crashes are grouped via stack trace analysis. Logged errors are grouped, instead, by the error domain and code. Remember that this means error issues can span many different call sites.
## Set Information for Crash Reports
```javascript
window.fabric.Crashlytics.setUserIdentifier("123");
window.fabric.Crashlytics.setUserName("Some Guy");
window.fabric.Crashlytics.setUserEmail("[email protected]");
window.fabric.Crashlytics.setStringValueForKey("bar", "foo");
```
## Send a Sign Up Event
```javascript
window.fabric.Answers.sendSignUp("Facebook", true);
```
## Send a Sign Up Event (with custom attributes)
```javascript
var attributes = {
foo: "data",
bar: true,
};
window.fabric.Answers.sendSignUp("Facebook", true, attributes);
```
## Send a Add To Cart Event
```javascript
window.fabric.Answers.sendAddToCart(29.95, "USD", "Foo Bar Shirt", "apparel", "123");
```
# Notes
## Automatic Configuration of Fabric SDKs
A normal installation for the Fabric SDKs involves downloading the Fabric tool and pointing it at your native code project. This tool takes care of adding references and modifying your build scripts and/or project files.
This plugin instead performs these steps via two build hooks located in the `hooks` directory: `after_plugin_install` and `before_plugin_uninstall`.
This allows you to avoid using the Fabric tool as well as omit your `platforms` directory from source control.
## Automatic Debug Symbol Upload on Build
The Fabric SDK comes with a command line tool that takes care of uploading debug symbols after a build so that they can be used when viewing crash reports.
For iOS, our build hook adds a build script phase block to execute Fabric's uploader command line tool.
For Android, our build hook modifies the `build.gradle` file to delegate to Fabric's uploader Gradle task.
## Updating Fabric and Crashlytics
Fabric and Crashlytics can be udpated via [scripts/add-packages.sh](./scripts/add-packages.sh). This script creates a temporary directory, obtains packages from their cocoapods download locations, and overwrites the frameworks in [lib/ios](./lib/ios).
To run the package update script:
```sh
npm run add-packages
```
The desired package versions are pulled from [package.json](./package.json):
```json
"packages": {
"fabric": "1.7.2",
"crashlytics": "3.9.3"
}
```
# Contributing
If you wish to contribute please see `CONTRIBUTING.md`.
# Authors
- [Román A. Sarria](https://github.com/sarriaroman)
- [Justin Unterreiner](https://github.com/Justin-Credible)
- Based on the following plugins:
- https://github.com/francescobitmunks/cordova-plugin-crashlytics
- https://github.com/smistry-toushay/cordova-crashlytics-plugin
## Contributors
This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
## Backers
Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/FabricPlugin#backer)]
## Sponsors
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/FabricPlugin#sponsor)]
