sportly / ember-cli-mixpanel-service Goto Github PK

9.0 6.0 21.0 44 KB

This ember-cli addon injects mixpanel as a service into your ember app.

License: MIT License

JavaScript 89.90% HTML 10.10%

ember-cli-mixpanel-service's Introduction

ember-cli-mixpanel-service

This ember-cli addon injects mixpanel into your ember app.

The mixpanel js is injected into the app's index.html. Pageview tracking is by default automatic, no mixins required. The mixpanel service is injected into your apps controllers and routes and is available as this.get('mixpanel').

More on mixpanel at http://www.mixpanel.com

Installation

ember install ember-cli-mixpanel-service

Configuration

This plugin uses the ember-cli project's configuration as defined in config/environment.js.

Add your Mixpanel API token to config/environment.js and you're good to go. A couple more params below

// environment.js

    ENV.mixpanel = {
      enabled: false,
      LOG_EVENT_TRACKING: false,
      token: 'abcd123456789'
    }

Configuration Parameters

enabled (Default: true): Enable mixpanel tracking
autoPageviewTracking (Default: true): Enable automatic pageview tracking
pageViewAttribute (Default: url): Use some other attribute available to the router instead of url for pageview tracking
attributeOverrides (Default: {}): Configure overrides, if any, for any of the attributes mixpanel stores by default
LOG_EVENT_TRACKING (Default: false): Output logging to the console.
token (Default: null): Mandatory Mixpanel API token

CORS Content Security Policy

If you use ember-cli-content-security-policy you should add the Mixpanel API to your app's content security policy settings. To do this add api.mixpanel.com to the 'connect-src' key in the ENV.contentSecurityPolicy hash as below:

// environment.js
    ENV.contentSecurityPolicy = {
      'connect-src': "'self' api.mixpanel.com ..."
      ...
    }

Mixpanel API

pageviews

trackPageView: function(page, overrides = {})

Note: Pageviews are tracked automatically by default, no mixins required. You can override any properties mixpanel stores by default by providing an optional overrides object.

events

trackEvent: function(event, properties, options, callback)

Alias of the mixpanel track function

identify

identify: function(userId, traits, options, callback)

Alias of the mixpanel identify function

alias

alias: function(userId, previousId, options, callback)

Alias of the mixpanel alias function

register

register: function(traits, options, callback)

Alias of the mixpanel register function

peopleSet

peopleSet: function(attributes)

Alias of the mixpanel people.set function

ember-cli-mixpanel-service's People

Contributors

Stargazers

Watchers

ember-cli-mixpanel-service's Issues

Address Ember.merge deprecation warnings

DEPRECATION: Usage of `Ember.merge` is deprecated, use `Ember.assign` instead. [deprecation id: ember-metal.merge] See http://emberjs.com/deprecations/v2.x/#toc_ember-merge for more details.

Mixpanel JS update?

Looks like the officially JS snippet given on the Mixpanel dev page is slightly longer than the one used in index.js.

Should it be updated?

Incompatible with Content Security Policy

Content-Security-Policy v2 doesn't allow inline scripts unless they are signed with a hash. See https://www.w3.org/TR/2015/CR-CSP2-20150721/#script-src-hash-usage

This addon injects inline script into the <body> tag.

Some possibilities:

detect if ENV.contentSecurityPolicy exists and if it does, add the hash of the script to that configuration
move the mixpanel setup into vendor.js

TypeError: Cannot read property 'enabled' of undefined

I just did a fresh install and am getting this message. I referenced closed issue #1 but am still returning a similar error: TypeError: Cannot read property 'enabled' of undefined. Thoughts?

environment
Ember 1.13.2
Ember Cli 0.2.7

package.json

"ember-cli-mixpanel-service": "0.0.8",

config/environment

if (environment === 'production') {
    ENV.APP.dataHost = 'https://api.myhubapp.com';
    ENV.mixpanel = {
      enabled: true,
      LOG_EVENT_TRACKING: false,
      token: 'my_token'
    };

Add CORS security policy suggestion to README

Basically http://api.mixpanel.com/ needs to be added to config/environment's connect-src declaration.

Uncaught TypeError: Cannot read property 'trackPageView' of undefined

fresh install using the installation guide and I get this error after building:
Uncaught TypeError: Cannot read property 'trackPageView' of undefined