|
| 1 | +'use strict'; |
| 2 | + |
| 3 | +/** |
| 4 | + * Module dependencies. |
| 5 | + */ |
| 6 | + |
| 7 | +var integration = require('@segment/analytics.js-integration'); |
| 8 | +var clone = require('@ndhoule/clone'); |
| 9 | + |
| 10 | +/** |
| 11 | + * Expose `Keen IO` integration. |
| 12 | + */ |
| 13 | + |
| 14 | +var Keen = module.exports = integration('Keen IO') |
| 15 | + .global('KeenSegment') |
| 16 | + .option('ipAddon', false) |
| 17 | + .option('projectId', '') |
| 18 | + .option('readKey', '') |
| 19 | + .option('referrerAddon', false) |
| 20 | + .option('trackAllPages', false) |
| 21 | + .option('trackCategorizedPages', true) |
| 22 | + .option('trackNamedPages', true) |
| 23 | + .option('uaAddon', false) |
| 24 | + .option('urlAddon', false) |
| 25 | + .option('writeKey', '') |
| 26 | + .tag('<script src="//d26b395fwzu5fz.cloudfront.net/3.4.0/{{ lib }}.min.js">'); |
| 27 | + |
| 28 | +/** |
| 29 | + * Initialize. |
| 30 | + * |
| 31 | + * https://keen.io/docs/ |
| 32 | + * |
| 33 | + * @api public |
| 34 | + */ |
| 35 | + |
| 36 | +Keen.prototype.initialize = function() { |
| 37 | + var lib = this.options.readKey ? 'keen' : 'keen-tracker'; |
| 38 | + var options = this.options; |
| 39 | + var previousKeen = window.Keen || null; |
| 40 | + var self = this; |
| 41 | + |
| 42 | + // Skip this step if [email protected] is already available |
| 43 | + if (!window.Keen || window.Keen.version !== '3.4.0') { |
| 44 | + // Force-undefine `Keen` (saved as `previousKeen`) |
| 45 | + window.Keen = undefined; |
| 46 | + /** |
| 47 | + * Shim out the Keen client library. |
| 48 | + * |
| 49 | + * To update the library, grab the most up-to-date embed code from Keen's |
| 50 | + * JS library readme (https://github.com/keen/keen-js) and remove any of the |
| 51 | + * script loading/appending business. Next, update the script tag above with |
| 52 | + * the new client library URL. |
| 53 | + */ |
| 54 | + /* eslint-disable */ |
| 55 | + !(function(a,b){if(void 0===b[a]){b["_"+a]={},b[a]=function(c){b["_"+a].clients=b["_"+a].clients||{},b["_"+a].clients[c.projectId]=this,this._config=c},b[a].ready=function(c){b["_"+a].ready=b["_"+a].ready||[],b["_"+a].ready.push(c)};for(var c=["addEvent","setGlobalProperties","trackExternalLink","on"],d=0;d<c.length;d++){var e=c[d],f=function(a){return function(){return this["_"+a]=this["_"+a]||[],this["_"+a].push(arguments),this}};b[a].prototype[e]=f(e)}}})("Keen",window); |
| 56 | + /* eslint-enable */ |
| 57 | + // [email protected] will be installed once `.load()` is called |
| 58 | + } |
| 59 | + |
| 60 | + // Define a safe namespace (stub) |
| 61 | + window.KeenSegment = window.Keen; |
| 62 | + |
| 63 | + // Define client (stub) |
| 64 | + this.client = new window.KeenSegment({ |
| 65 | + projectId: options.projectId, |
| 66 | + readKey: options.readKey, |
| 67 | + writeKey: options.writeKey |
| 68 | + }); |
| 69 | + |
| 70 | + this.load({ lib: lib }, function() { |
| 71 | + // Redefine safe namespace with full library |
| 72 | + window.KeenSegment = window.Keen; |
| 73 | + // Restore original `Keen` |
| 74 | + if (previousKeen) { |
| 75 | + window.Keen = previousKeen; |
| 76 | + previousKeen = undefined; |
| 77 | + } |
| 78 | + self.ready(); |
| 79 | + }); |
| 80 | +}; |
| 81 | + |
| 82 | +/** |
| 83 | + * Loaded? |
| 84 | + * |
| 85 | + * @api private |
| 86 | + * @return {boolean} |
| 87 | + */ |
| 88 | + |
| 89 | +Keen.prototype.loaded = function() { |
| 90 | + return !!(window.KeenSegment && window.KeenSegment.prototype.configure); |
| 91 | +}; |
| 92 | + |
| 93 | +/** |
| 94 | + * Page. |
| 95 | + * |
| 96 | + * @api public |
| 97 | + * @param {Page} page |
| 98 | + */ |
| 99 | + |
| 100 | +Keen.prototype.page = function(page) { |
| 101 | + var category = page.category(); |
| 102 | + var name = page.fullName(); |
| 103 | + var opts = this.options; |
| 104 | + |
| 105 | + // all pages |
| 106 | + if (opts.trackAllPages) { |
| 107 | + this.track(page.track()); |
| 108 | + } |
| 109 | + |
| 110 | + // named pages |
| 111 | + if (name && opts.trackNamedPages) { |
| 112 | + this.track(page.track(name)); |
| 113 | + } |
| 114 | + |
| 115 | + // categorized pages |
| 116 | + if (category && opts.trackCategorizedPages) { |
| 117 | + this.track(page.track(category)); |
| 118 | + } |
| 119 | +}; |
| 120 | + |
| 121 | +/** |
| 122 | + * Identify. |
| 123 | + * |
| 124 | + * TODO: migrate from old `userId` to simpler `id` |
| 125 | + * https://keen.io/docs/data-collection/data-enrichment/#add-ons |
| 126 | + * |
| 127 | + * Set up the Keen addons object. These must be specifically |
| 128 | + * enabled by the settings in order to include the plugins, or else |
| 129 | + * Keen will reject the request. |
| 130 | + * |
| 131 | + * @api public |
| 132 | + * @param {Identify} identify |
| 133 | + */ |
| 134 | + |
| 135 | +Keen.prototype.identify = function(identify) { |
| 136 | + var traits = identify.traits(); |
| 137 | + var id = identify.userId(); |
| 138 | + var user = {}; |
| 139 | + if (id) user.userId = id; |
| 140 | + if (traits) user.traits = traits; |
| 141 | + var props = { user: user }; |
| 142 | + this.addons(props, identify); |
| 143 | + this.client.setGlobalProperties(function() { |
| 144 | + // Clone the props so the Keen Client can't manipulate the ref |
| 145 | + return clone(props); |
| 146 | + }); |
| 147 | +}; |
| 148 | + |
| 149 | +/** |
| 150 | + * Track. |
| 151 | + * |
| 152 | + * @api public |
| 153 | + * @param {Track} track |
| 154 | + */ |
| 155 | + |
| 156 | +Keen.prototype.track = function(track) { |
| 157 | + var props = track.properties(); |
| 158 | + this.addons(props, track); |
| 159 | + this.client.addEvent(track.event(), props); |
| 160 | +}; |
| 161 | + |
| 162 | +/** |
| 163 | + * Attach addons to `obj` with `msg`. |
| 164 | + * |
| 165 | + * @api private |
| 166 | + * @param {Object} obj |
| 167 | + * @param {Facade} msg |
| 168 | + */ |
| 169 | + |
| 170 | +Keen.prototype.addons = function(obj, msg) { |
| 171 | + var options = this.options; |
| 172 | + var addons = []; |
| 173 | + |
| 174 | + if (options.ipAddon) { |
| 175 | + addons.push({ |
| 176 | + name: 'keen:ip_to_geo', |
| 177 | + input: { ip: 'ip_address' }, |
| 178 | + output: 'ip_geo_info' |
| 179 | + }); |
| 180 | + obj.ip_address = '${keen.ip}'; |
| 181 | + } |
| 182 | + |
| 183 | + if (options.uaAddon) { |
| 184 | + addons.push({ |
| 185 | + name: 'keen:ua_parser', |
| 186 | + input: { ua_string: 'user_agent' }, |
| 187 | + output: 'parsed_user_agent' |
| 188 | + }); |
| 189 | + obj.user_agent = '${keen.user_agent}'; |
| 190 | + } |
| 191 | + |
| 192 | + if (options.urlAddon) { |
| 193 | + addons.push({ |
| 194 | + name: 'keen:url_parser', |
| 195 | + input: { url: 'page_url' }, |
| 196 | + output: 'parsed_page_url' |
| 197 | + }); |
| 198 | + obj.page_url = document.location.href; |
| 199 | + } |
| 200 | + |
| 201 | + if (options.referrerAddon) { |
| 202 | + addons.push({ |
| 203 | + name: 'keen:referrer_parser', |
| 204 | + input: { |
| 205 | + referrer_url: 'referrer_url', |
| 206 | + page_url: 'page_url' |
| 207 | + }, |
| 208 | + output: 'referrer_info' |
| 209 | + }); |
| 210 | + obj.referrer_url = document.referrer; |
| 211 | + obj.page_url = document.location.href; |
| 212 | + } |
| 213 | + |
| 214 | + obj.keen = { |
| 215 | + timestamp: msg.timestamp(), |
| 216 | + addons: addons |
| 217 | + }; |
| 218 | +}; |
0 commit comments