UNPKG

react-ga-neo

Version:
516 lines (472 loc) 26.1 kB
"use strict"; function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); } var _gtag = _interopRequireDefault(require("./gtag")); var _ga = _interopRequireDefault(require("./ga4")); function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; } function _regeneratorRuntime() { "use strict"; /*! regenerator-runtime -- Copyright (c) 2014-present, Facebook, Inc. -- license (MIT): https://github.com/facebook/regenerator/blob/main/LICENSE */ _regeneratorRuntime = function _regeneratorRuntime() { return e; }; var t, e = {}, r = Object.prototype, n = r.hasOwnProperty, o = Object.defineProperty || function (t, e, r) { t[e] = r.value; }, i = "function" == typeof Symbol ? Symbol : {}, a = i.iterator || "@@iterator", c = i.asyncIterator || "@@asyncIterator", u = i.toStringTag || "@@toStringTag"; function define(t, e, r) { return Object.defineProperty(t, e, { value: r, enumerable: !0, configurable: !0, writable: !0 }), t[e]; } try { define({}, ""); } catch (t) { define = function define(t, e, r) { return t[e] = r; }; } function wrap(t, e, r, n) { var i = e && e.prototype instanceof Generator ? e : Generator, a = Object.create(i.prototype), c = new Context(n || []); return o(a, "_invoke", { value: makeInvokeMethod(t, r, c) }), a; } function tryCatch(t, e, r) { try { return { type: "normal", arg: t.call(e, r) }; } catch (t) { return { type: "throw", arg: t }; } } e.wrap = wrap; var h = "suspendedStart", l = "suspendedYield", f = "executing", s = "completed", y = {}; function Generator() {} function GeneratorFunction() {} function GeneratorFunctionPrototype() {} var p = {}; define(p, a, function () { return this; }); var d = Object.getPrototypeOf, v = d && d(d(values([]))); v && v !== r && n.call(v, a) && (p = v); var g = GeneratorFunctionPrototype.prototype = Generator.prototype = Object.create(p); function defineIteratorMethods(t) { ["next", "throw", "return"].forEach(function (e) { define(t, e, function (t) { return this._invoke(e, t); }); }); } function AsyncIterator(t, e) { function invoke(r, o, i, a) { var c = tryCatch(t[r], t, o); if ("throw" !== c.type) { var u = c.arg, h = u.value; return h && "object" == _typeof(h) && n.call(h, "__await") ? e.resolve(h.__await).then(function (t) { invoke("next", t, i, a); }, function (t) { invoke("throw", t, i, a); }) : e.resolve(h).then(function (t) { u.value = t, i(u); }, function (t) { return invoke("throw", t, i, a); }); } a(c.arg); } var r; o(this, "_invoke", { value: function value(t, n) { function callInvokeWithMethodAndArg() { return new e(function (e, r) { invoke(t, n, e, r); }); } return r = r ? r.then(callInvokeWithMethodAndArg, callInvokeWithMethodAndArg) : callInvokeWithMethodAndArg(); } }); } function makeInvokeMethod(e, r, n) { var o = h; return function (i, a) { if (o === f) throw new Error("Generator is already running"); if (o === s) { if ("throw" === i) throw a; return { value: t, done: !0 }; } for (n.method = i, n.arg = a;;) { var c = n.delegate; if (c) { var u = maybeInvokeDelegate(c, n); if (u) { if (u === y) continue; return u; } } if ("next" === n.method) n.sent = n._sent = n.arg;else if ("throw" === n.method) { if (o === h) throw o = s, n.arg; n.dispatchException(n.arg); } else "return" === n.method && n.abrupt("return", n.arg); o = f; var p = tryCatch(e, r, n); if ("normal" === p.type) { if (o = n.done ? s : l, p.arg === y) continue; return { value: p.arg, done: n.done }; } "throw" === p.type && (o = s, n.method = "throw", n.arg = p.arg); } }; } function maybeInvokeDelegate(e, r) { var n = r.method, o = e.iterator[n]; if (o === t) return r.delegate = null, "throw" === n && e.iterator["return"] && (r.method = "return", r.arg = t, maybeInvokeDelegate(e, r), "throw" === r.method) || "return" !== n && (r.method = "throw", r.arg = new TypeError("The iterator does not provide a '" + n + "' method")), y; var i = tryCatch(o, e.iterator, r.arg); if ("throw" === i.type) return r.method = "throw", r.arg = i.arg, r.delegate = null, y; var a = i.arg; return a ? a.done ? (r[e.resultName] = a.value, r.next = e.nextLoc, "return" !== r.method && (r.method = "next", r.arg = t), r.delegate = null, y) : a : (r.method = "throw", r.arg = new TypeError("iterator result is not an object"), r.delegate = null, y); } function pushTryEntry(t) { var e = { tryLoc: t[0] }; 1 in t && (e.catchLoc = t[1]), 2 in t && (e.finallyLoc = t[2], e.afterLoc = t[3]), this.tryEntries.push(e); } function resetTryEntry(t) { var e = t.completion || {}; e.type = "normal", delete e.arg, t.completion = e; } function Context(t) { this.tryEntries = [{ tryLoc: "root" }], t.forEach(pushTryEntry, this), this.reset(!0); } function values(e) { if (e || "" === e) { var r = e[a]; if (r) return r.call(e); if ("function" == typeof e.next) return e; if (!isNaN(e.length)) { var o = -1, i = function next() { for (; ++o < e.length;) if (n.call(e, o)) return next.value = e[o], next.done = !1, next; return next.value = t, next.done = !0, next; }; return i.next = i; } } throw new TypeError(_typeof(e) + " is not iterable"); } return GeneratorFunction.prototype = GeneratorFunctionPrototype, o(g, "constructor", { value: GeneratorFunctionPrototype, configurable: !0 }), o(GeneratorFunctionPrototype, "constructor", { value: GeneratorFunction, configurable: !0 }), GeneratorFunction.displayName = define(GeneratorFunctionPrototype, u, "GeneratorFunction"), e.isGeneratorFunction = function (t) { var e = "function" == typeof t && t.constructor; return !!e && (e === GeneratorFunction || "GeneratorFunction" === (e.displayName || e.name)); }, e.mark = function (t) { return Object.setPrototypeOf ? Object.setPrototypeOf(t, GeneratorFunctionPrototype) : (t.__proto__ = GeneratorFunctionPrototype, define(t, u, "GeneratorFunction")), t.prototype = Object.create(g), t; }, e.awrap = function (t) { return { __await: t }; }, defineIteratorMethods(AsyncIterator.prototype), define(AsyncIterator.prototype, c, function () { return this; }), e.AsyncIterator = AsyncIterator, e.async = function (t, r, n, o, i) { void 0 === i && (i = Promise); var a = new AsyncIterator(wrap(t, r, n, o), i); return e.isGeneratorFunction(r) ? a : a.next().then(function (t) { return t.done ? t.value : a.next(); }); }, defineIteratorMethods(g), define(g, u, "Generator"), define(g, a, function () { return this; }), define(g, "toString", function () { return "[object Generator]"; }), e.keys = function (t) { var e = Object(t), r = []; for (var n in e) r.push(n); return r.reverse(), function next() { for (; r.length;) { var t = r.pop(); if (t in e) return next.value = t, next.done = !1, next; } return next.done = !0, next; }; }, e.values = values, Context.prototype = { constructor: Context, reset: function reset(e) { if (this.prev = 0, this.next = 0, this.sent = this._sent = t, this.done = !1, this.delegate = null, this.method = "next", this.arg = t, this.tryEntries.forEach(resetTryEntry), !e) for (var r in this) "t" === r.charAt(0) && n.call(this, r) && !isNaN(+r.slice(1)) && (this[r] = t); }, stop: function stop() { this.done = !0; var t = this.tryEntries[0].completion; if ("throw" === t.type) throw t.arg; return this.rval; }, dispatchException: function dispatchException(e) { if (this.done) throw e; var r = this; function handle(n, o) { return a.type = "throw", a.arg = e, r.next = n, o && (r.method = "next", r.arg = t), !!o; } for (var o = this.tryEntries.length - 1; o >= 0; --o) { var i = this.tryEntries[o], a = i.completion; if ("root" === i.tryLoc) return handle("end"); if (i.tryLoc <= this.prev) { var c = n.call(i, "catchLoc"), u = n.call(i, "finallyLoc"); if (c && u) { if (this.prev < i.catchLoc) return handle(i.catchLoc, !0); if (this.prev < i.finallyLoc) return handle(i.finallyLoc); } else if (c) { if (this.prev < i.catchLoc) return handle(i.catchLoc, !0); } else { if (!u) throw new Error("try statement without catch or finally"); if (this.prev < i.finallyLoc) return handle(i.finallyLoc); } } } }, abrupt: function abrupt(t, e) { for (var r = this.tryEntries.length - 1; r >= 0; --r) { var o = this.tryEntries[r]; if (o.tryLoc <= this.prev && n.call(o, "finallyLoc") && this.prev < o.finallyLoc) { var i = o; break; } } i && ("break" === t || "continue" === t) && i.tryLoc <= e && e <= i.finallyLoc && (i = null); var a = i ? i.completion : {}; return a.type = t, a.arg = e, i ? (this.method = "next", this.next = i.finallyLoc, y) : this.complete(a); }, complete: function complete(t, e) { if ("throw" === t.type) throw t.arg; return "break" === t.type || "continue" === t.type ? this.next = t.arg : "return" === t.type ? (this.rval = this.arg = t.arg, this.method = "return", this.next = "end") : "normal" === t.type && e && (this.next = e), y; }, finish: function finish(t) { for (var e = this.tryEntries.length - 1; e >= 0; --e) { var r = this.tryEntries[e]; if (r.finallyLoc === t) return this.complete(r.completion, r.afterLoc), resetTryEntry(r), y; } }, "catch": function _catch(t) { for (var e = this.tryEntries.length - 1; e >= 0; --e) { var r = this.tryEntries[e]; if (r.tryLoc === t) { var n = r.completion; if ("throw" === n.type) { var o = n.arg; resetTryEntry(r); } return o; } } throw new Error("illegal catch attempt"); }, delegateYield: function delegateYield(e, r, n) { return this.delegate = { iterator: values(e), resultName: r, nextLoc: n }, "next" === this.method && (this.arg = t), y; } }, e; } function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) { try { var info = gen[key](arg); var value = info.value; } catch (error) { reject(error); return; } if (info.done) { resolve(value); } else { Promise.resolve(value).then(_next, _throw); } } function _asyncToGenerator(fn) { return function () { var self = this, args = arguments; return new Promise(function (resolve, reject) { var gen = fn.apply(self, args); function _next(value) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value); } function _throw(err) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err); } _next(undefined); }); }; } var newDate = new Date("2020-01-01"); jest.mock("./gtag"); jest.useFakeTimers("modern").setSystemTime(newDate.getTime()); describe("GA4", function () { // Given var GA_MEASUREMENT_ID = "GA_MEASUREMENT_ID"; beforeEach(function () { _gtag["default"].mockReset(); _ga["default"].reset(); }); describe("Initialization", function () { it("Default", function () { // When _ga["default"].initialize(GA_MEASUREMENT_ID); // Then expect(_gtag["default"]).toHaveBeenNthCalledWith(1, "js", newDate); expect(_gtag["default"]).toHaveBeenNthCalledWith(2, "config", GA_MEASUREMENT_ID); expect(_gtag["default"]).toHaveBeenCalledTimes(2); }); it("With options", function () { // Given var options = { gaOptions: { cookieUpdate: false } }; // When _ga["default"].initialize(GA_MEASUREMENT_ID, options); // Then expect(_gtag["default"]).toHaveBeenNthCalledWith(1, "js", newDate); expect(_gtag["default"]).toHaveBeenNthCalledWith(2, "config", GA_MEASUREMENT_ID, { cookie_update: false }); expect(_gtag["default"]).toHaveBeenCalledTimes(2); }); it("Test mode", function () { // Given var options = { testMode: true }; var command = "send"; var object = { hitType: "pageview" }; // When _ga["default"].initialize(GA_MEASUREMENT_ID, options); _ga["default"].ga(command, object); // Then expect(_gtag["default"]).toHaveBeenCalledTimes(0); }); it("Capitalization of event names (enabled)", function () { // Given var options = {}; // When _ga["default"].initialize(GA_MEASUREMENT_ID, options); _ga["default"].event({ action: "action_name", category: "category_name", label: "label_name" }); // Then expect(_gtag["default"]).toHaveBeenNthCalledWith(1, "js", newDate); expect(_gtag["default"]).toHaveBeenNthCalledWith(2, "config", GA_MEASUREMENT_ID); expect(_gtag["default"]).toHaveBeenNthCalledWith(3, "event", "Action_name", { "event_category": "Category_name", "event_label": "Label_name" }); }); it("Capitalization of event names (disabled)", function () { // Given var options = { titleCase: false }; // When _ga["default"].initialize(GA_MEASUREMENT_ID, options); _ga["default"].event({ action: "action_name", category: "category_name", label: "label_name" }); // Then expect(_gtag["default"]).toHaveBeenNthCalledWith(1, "js", newDate); expect(_gtag["default"]).toHaveBeenNthCalledWith(2, "config", GA_MEASUREMENT_ID); expect(_gtag["default"]).toHaveBeenNthCalledWith(3, "event", "action_name", { "event_category": "category_name", "event_label": "label_name" }); }); it("With multiple measurement IDs", function () { // Given var GA_MEASUREMENT_ID2 = "GA_MEASUREMENT_ID2"; var config = [{ trackingId: GA_MEASUREMENT_ID }, { trackingId: GA_MEASUREMENT_ID2 }]; // When _ga["default"].initialize(config); // Then expect(_gtag["default"]).toHaveBeenNthCalledWith(1, "js", newDate); expect(_gtag["default"]).toHaveBeenNthCalledWith(2, "config", GA_MEASUREMENT_ID); expect(_gtag["default"]).toHaveBeenNthCalledWith(3, "config", GA_MEASUREMENT_ID2); expect(_gtag["default"]).toHaveBeenCalledTimes(3); }); }); describe("Legacy ga() support", function () { it("sends pageviews", function () { // Given var command = "send"; var object = { hitType: "pageview" }; // When _ga["default"].ga(command, object); // Then expect(_gtag["default"]).toHaveBeenNthCalledWith(1, "event", "page_view"); }); it("sends timing", function () { // Given var command = "send"; var hitType = "timing"; var timingCategory = "DOM"; var timingVar = "first-contentful-paint"; var timingValue = 120; // When _ga["default"].ga(command, hitType, timingCategory, timingVar, timingValue); // Then expect(_gtag["default"]).toHaveBeenNthCalledWith(1, "event", "timing_complete", { event_category: timingCategory, name: timingVar, value: timingValue }); }); it("sends timing as an object", function () { var timingCategory = "JS Dependencies"; var timingVar = "load"; var timingValue = 3549; // Scrambled order is intentional _ga["default"].ga('send', { hitType: 'timing', timingValue: timingValue, timingCategory: timingCategory, timingVar: timingVar // timingLabel was omitted on purpose }); expect(_gtag["default"]).toHaveBeenNthCalledWith(1, "event", "timing_complete", { event_category: timingCategory, name: timingVar, value: timingValue }); }); it("supports exceptions", function () { // Given var exDescription = "exDescription value"; var exFatal = true; // When _ga["default"].ga('send', 'exception', exDescription, exFatal); // Then expect(_gtag["default"]).toHaveBeenNthCalledWith(1, "event", "exception", { description: exDescription, fatal: exFatal }); }); it("supports empty exceptions", function () { _ga["default"].ga('send', 'exception'); expect(_gtag["default"]).toHaveBeenNthCalledWith(1, "event", "exception", {}); }); it("invokes callback", function (done) { // Given var clientId = "clientId value"; _gtag["default"].mockImplementationOnce(function (command, target, field_name, cb) { return cb(clientId); }); var callback = jest.fn(function (tracker) { var trackerClientId = tracker.get("clientId"); var trackerTrackingId = tracker.get("trackingId"); var trackerApiVersion = tracker.get("apiVersion"); expect(trackerClientId).toEqual(clientId); expect(trackerTrackingId).toEqual(GA_MEASUREMENT_ID); expect(trackerApiVersion).toEqual("1"); done(); }); // When _ga["default"].ga(callback); // Then expect(_gtag["default"]).toHaveBeenNthCalledWith(1, "get", GA_MEASUREMENT_ID, "client_id", expect.any(Function)); }); it("supports async callback", function (done) { // Given var clientId = "clientId value"; _gtag["default"].mockImplementationOnce(function (command, target, field_name, cb) { return cb(clientId); }); var callback = jest.fn( /*#__PURE__*/function () { var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee(tracker) { var trackerClientId; return _regeneratorRuntime().wrap(function _callee$(_context) { while (1) switch (_context.prev = _context.next) { case 0: trackerClientId = tracker.get("clientId"); expect(trackerClientId).toEqual(clientId); done(); case 3: case "end": return _context.stop(); } }, _callee); })); return function (_x) { return _ref.apply(this, arguments); }; }()); // When _ga["default"].ga(callback); // Then expect(_gtag["default"]).toHaveBeenNthCalledWith(1, "get", GA_MEASUREMENT_ID, "client_id", expect.any(Function)); }); it("handles queueing correctly", function (done) { // Given var clientId = "clientId value"; _gtag["default"].mockImplementationOnce(function (command, target, field_name, cb) { setImmediate(function () { return cb(clientId); }); }); var callback = jest.fn(function () { _ga["default"].ga("send", { hitType: "pageview" }); expect(_gtag["default"]).toHaveBeenNthCalledWith(2, "event", "page_view"); done(); }); // When _ga["default"].ga(callback); _ga["default"].ga("send", "event", "category value"); // Then expect(_gtag["default"]).toHaveBeenNthCalledWith(1, "get", GA_MEASUREMENT_ID, "client_id", expect.any(Function)); expect(_gtag["default"]).toHaveBeenCalledTimes(1); expect(_ga["default"]._isQueuing).toBeTruthy(); expect(_ga["default"]._queueGtag).toHaveLength(1); jest.runAllTimers(); expect(_ga["default"]._isQueuing).toBeFalsy(); expect(_ga["default"]._queueGtag).toHaveLength(0); expect(_gtag["default"]).toHaveBeenNthCalledWith(3, "event", undefined, { event_category: "category value" }); }); }); describe("Send method", function () { it("sends pageviews", function () { // Given var object = { hitType: "pageview" }; // When _ga["default"].send(object); // Then expect(_gtag["default"]).toHaveBeenNthCalledWith(1, "event", "page_view"); }); }); describe("Event method", function () { it("Custom events", function () { // Given var eventName = "screenview"; var eventParams = { app_name: "myAppName", screen_name: "Home" }; // When _ga["default"].event(eventName, eventParams); // Then expect(_gtag["default"]).toHaveBeenNthCalledWith(1, "event", eventName, eventParams); }); it("Simple events", function () { // Given var object = { category: "category value", action: "action value", label: "label value", nonInteraction: true }; // When _ga["default"].event(object); // Then expect(_gtag["default"]).toHaveBeenNthCalledWith(1, "event", "Action Value", { event_category: "Category Value", event_label: "Label Value", non_interaction: true }); }); }); describe("Set method", function () { it("sends parameters correctly", function () { // Given var object = { anonymizeIp: true, referrer: "/signup", allowAdFeatures: "allowAdFeatures value", allowAdPersonalizationSignals: "allowAdPersonalizationSignals value", page: "/home" }; // When _ga["default"].set(object); // Then expect(_gtag["default"]).toHaveBeenNthCalledWith(1, "set", { anonymize_ip: true, referrer: "/signup", allow_google_signals: "allowAdFeatures value", allow_ad_personalization_signals: "allowAdPersonalizationSignals value", page_path: "/home" }); }); it("takes additional params", function () { // Given var object = ['user_properties', { favorite_composer: 'Mahler', favorite_instrument: 'double bass', season_ticketholder: 'true' }]; // When _ga["default"].set.apply(_ga["default"], object); // Then expect(_gtag["default"]).toHaveBeenNthCalledWith(1, "set", "user_properties", { favorite_composer: 'Mahler', favorite_instrument: 'double bass', season_ticketholder: 'true' }); }); }); describe("Exception method", function () { it("sends parameters correctly", function () { // When _ga["default"].exception(); // Then expect(_gtag["default"]).toHaveBeenNthCalledWith(1, "event", "exception", {}); }); it("takes details", function () { // Given var exceptionDetails = { description: 'Descriptive error message', fatal: false }; // When _ga["default"].exception(exceptionDetails); // Then expect(_gtag["default"]).toHaveBeenNthCalledWith(1, "event", "exception", { description: 'Descriptive error message', fatal: false }); }); }); describe("Timing method", function () { it("sends parameters correctly", function () { _ga["default"].timing({ category: "category value", variable: "variable value", value: 123, label: "label value" }); expect(_gtag["default"]).toHaveBeenNthCalledWith(1, "event", "timing_complete", { event_category: "category value", name: "variable value", value: 123, event_label: "label value" }); }); }); describe("Reference", function () { it("pageview", function () { // Old https://developers.google.com/analytics/devguides/collection/analyticsjs/pages // New https://developers.google.com/gtagjs/reference/event#page_view // Given var hitType = "pageview"; var path = "/location-pathname"; var title = "title value"; // When / Then // Without parameters _ga["default"].send(hitType); expect(_gtag["default"]).toHaveBeenNthCalledWith(1, "event", "page_view"); _ga["default"].send({ hitType: hitType }); expect(_gtag["default"]).toHaveBeenNthCalledWith(2, "event", "page_view"); _ga["default"].ga("send", hitType); expect(_gtag["default"]).toHaveBeenNthCalledWith(3, "event", "page_view"); // With path parameter _ga["default"].send({ hitType: hitType, page: path }); expect(_gtag["default"]).toHaveBeenNthCalledWith(4, "event", "page_view", { page_path: path }); _ga["default"].ga("send", hitType, path); expect(_gtag["default"]).toHaveBeenNthCalledWith(5, "event", "page_view", { page_path: path }); // With path and title parameter _ga["default"].send({ hitType: hitType, page: path, title: title }); expect(_gtag["default"]).toHaveBeenNthCalledWith(6, "event", "page_view", { page_path: path, page_title: title }); _ga["default"].ga("send", hitType, path, { title: title }); expect(_gtag["default"]).toHaveBeenNthCalledWith(7, "event", "page_view", { page_path: path, page_title: title }); }); }); describe("Web vitals", function () { it("Web vitals", function () { // https://github.com/GoogleChrome/web-vitals/blob/main/README.md function sendToGoogleAnalytics(_ref2) { var name = _ref2.name, delta = _ref2.delta, value = _ref2.value, id = _ref2.id; _ga["default"].send({ hitType: "event", eventCategory: "Web Vitals", eventAction: name, eventLabel: id, nonInteraction: true, // Built-in params: value: Math.round(name === "CLS" ? delta * 1000 : delta), // Use `delta` so the value can be summed. // Custom params: metric_id: id, // Needed to aggregate events. metric_value: value, // Optional. metric_delta: delta // Optional. // OPTIONAL: any additional params or debug info here. // See: https://web.dev/debug-web-vitals-in-the-field/ // metric_rating: 'good' | 'ni' | 'poor', // debug_info: '...', // ... }); } sendToGoogleAnalytics({ name: "CLS", delta: 12.34, value: 1, id: "v2-1632380328370-6426221164013" }); expect(_gtag["default"]).toHaveBeenNthCalledWith(1, "event", "CLS", { event_category: "Web Vitals", event_label: "v2-1632380328370-6426221164013", metric_delta: 12.34, metric_id: "v2-1632380328370-6426221164013", metric_value: 1, non_interaction: true, value: 12340 }); }); }); });