@pagopa/selfcare-common-frontend 1.3.0 → 1.3.1

package/CHANGELOG.md

@@ -4,8 +4,14 @@ All notable changes to this project will be documented in this file. Dates are d
 
 Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
+#### [v1.3.1](https://github.com/pagopa/selfcare-common-frontend/compare/v1.3.0...v1.3.1)
+
+- analyticsService will accept a callback [`#18`](https://github.com/pagopa/selfcare-common-frontend/pull/18)
+
 #### [v1.3.0](https://github.com/pagopa/selfcare-common-frontend/compare/v1.2.3...v1.3.0)
 
+> 4 February 2022
+
 - SELC-145 e SELC-144 [`#17`](https://github.com/pagopa/selfcare-common-frontend/pull/17)
 - SELC-144 analytcsService through mixPanel [`#16`](https://github.com/pagopa/selfcare-common-frontend/pull/16)
 - SELC-145 e SELC-144 (#17) [`#145`](https://pagopa.atlassian.net/browse/145) [`#144`](https://pagopa.atlassian.net/browse/144) [`#145`](https://pagopa.atlassian.net/browse/145)

package/README.md

@@ -269,6 +269,11 @@ This feature can be configured with the following keys of the [CONFIG](#Configur
 | ADDITIONAL_PROPERTIES | {[key: string]: string} | An object containing a fixed set of properties to send every time, overridden if the actual event will report the same properties | {} |
 | ADDITIONAL_PROPERTIES_IMPORTANT | {[key: string]: string} | As ADDITIONAL_PROPERTIES, but these properties will take the precedence overriding events conflicting properties | {} |
 
+In order track an event (once the initAnalytics method has been invoked) you have to call the trackEvent(event_name: string, properties?: any, callback?: () => void)=> void method where:
+* event_name: the name of the event
+* properties: the additional payload sent with the event
+* callback: an action taken when the track has completed (If the action taken immediately after the track is an exit action from the application, it's better to use this callback to perform the exit, in order to give to mixPanel the time to send the event)
+
 ## Consent management
 This feature allows the automatic enabling of the [analytics feature](#analytics) only when the user accept to send that data.
 

package/build.info

@@ -1,2 +1,2 @@
-20220204.1 - selfcare-common-frontend.deploy(19176)
-tags/v1.3.0^0 28b9f7a08d60a63d2224568a4180ab7b3c1fbcb7
+20220207.1 - selfcare-common-frontend.deploy(19531)
+remotes/origin/SELC-144-track-events 0606cfa74d6adbdd06cb25b128ea601cb3daf5f3

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@pagopa/selfcare-common-frontend",
   "description": "Shared React components for the pagopa selfcare project",
-  "version": "1.3.0",
+  "version": "1.3.1",
   "license": "MIT",
   "repository": "https://github.com/pagopa/selfcare-common-frontend",
   "author": "https://www.pagopa.gov.it",

package/services/analyticsService.d.ts

@@ -1,7 +1,12 @@
 import { AppError } from '../redux/slices/appStateSlice';
 /** To call in order to start the analytics service, otherwise no event will be sent */
 export declare const initAnalytics: () => void;
-/** To notify an event through the analytics tool */
-export declare const trackEvent: (event_name: string, properties?: any) => void;
 /** To notify an error through the analytics tool */
 export declare const trackAppError: (error: AppError) => void;
+/**
+ * To notify an event through the analytics tool:
+ * @property event_name: the name of the event
+ * @property properties: the additional payload sent with the event
+ * @property callback: an action taken when the track has completed (If the action taken immediately after the track is an exit action from the application, it's better to use this callback to perform the exit, in order to give to mixPanel the time to send the event)
+ */
+export declare const trackEvent: (event_name: string, properties?: any, callback?: (() => void) | undefined) => void;

package/services/analyticsService.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.trackAppError = exports.trackEvent = exports.initAnalytics = void 0;
+exports.trackEvent = exports.trackAppError = exports.initAnalytics = void 0;
 const tslib_1 = require("tslib");
 const mixpanel_browser_1 = (0, tslib_1.__importDefault)(require("mixpanel-browser"));
 const env_1 = require("../config/env");
@@ -26,38 +26,70 @@ const initAnalytics = () => {
     }
 };
 exports.initAnalytics = initAnalytics;
-/** To notify an event through the analytics tool */
-const trackEvent = (event_name, properties) => {
+/** To notify an error through the analytics tool */
+const trackAppError = (error) => {
+    if (env_1.CONFIG.ANALYTCS.ENABLE && init) {
+        (0, exports.trackEvent)('GENERIC_ERROR', error);
+    }
+    else {
+        console.error(error);
+    }
+};
+exports.trackAppError = trackAppError;
+/**
+ * To notify an event through the analytics tool:
+ * @property event_name: the name of the event
+ * @property properties: the additional payload sent with the event
+ * @property callback: an action taken when the track has completed (If the action taken immediately after the track is an exit action from the application, it's better to use this callback to perform the exit, in order to give to mixPanel the time to send the event)
+ */
+const trackEvent = (event_name, properties, callback) => {
     if (env_1.CONFIG.ANALYTCS.ENABLE && init) {
         if (env_1.CONFIG.ANALYTCS.MOCK) {
             // eslint-disable-next-line no-console
             console.log(event_name, properties);
+            if (callback) {
+                callback();
+            }
         }
         else {
+            trackEventThroughAnalyticTool(event_name, properties, callback);
+        }
+    }
+    else {
+        if (callback) {
+            callback();
+        }
+    }
+};
+exports.trackEvent = trackEvent;
+const trackEventThroughAnalyticTool = (event_name, properties, callback) => {
+    // eslint-disable-next-line functional/no-let
+    let called = false;
+    const wrappedCallback = callback
+        ? () => {
             try {
-                mixpanel_browser_1.default.track(event_name, {
-                    ...env_1.CONFIG.ANALYTCS.ADDITIONAL_PROPERTIES,
-                    ...properties,
-                    ...env_1.CONFIG.ANALYTCS.ADDITIONAL_PROPERTIES_IMPORTANT,
-                });
+                called = true;
+                callback();
             }
             catch (reason) {
-                console.error('Something gone wrong while sending data to mixpanel:', reason);
-                // eslint-disable-next-line no-console
-                console.log(event_name, properties);
+                console.error(`Something gone wrong while calling trackEvent ${event_name} callback`, reason);
             }
         }
+        : undefined;
+    try {
+        mixpanel_browser_1.default.track(event_name, {
+            ...env_1.CONFIG.ANALYTCS.ADDITIONAL_PROPERTIES,
+            ...properties,
+            ...env_1.CONFIG.ANALYTCS.ADDITIONAL_PROPERTIES_IMPORTANT,
+        }, wrappedCallback ? { send_immediately: true } : undefined, wrappedCallback);
     }
-};
-exports.trackEvent = trackEvent;
-/** To notify an error through the analytics tool */
-const trackAppError = (error) => {
-    if (env_1.CONFIG.ANALYTCS.ENABLE && init) {
-        (0, exports.trackEvent)('GENERIC_ERROR', error);
-    }
-    else {
-        console.error(error);
+    catch (reason) {
+        console.error('Something gone wrong while sending data to mixpanel:', reason);
+        // eslint-disable-next-line no-console
+        console.log(event_name, properties);
+        if (wrappedCallback && !called) {
+            wrappedCallback();
+        }
     }
 };
-exports.trackAppError = trackAppError;
 //# sourceMappingURL=analyticsService.js.map

package/services/analyticsService.js.map

@@ -1 +1 @@
-{"version":3,"file":"analyticsService.js","sourceRoot":"","sources":["../../src/lib/services/analyticsService.ts"],"names":[],"mappings":";;;;AAAA,qFAAwC;AACxC,uCAAuC;AAGvC,6CAA6C;AAC7C,IAAI,IAAI,GAAG,KAAK,CAAC;AAEjB,uFAAuF;AAChF,MAAM,aAAa,GAAG,GAAS,EAAE;IACtC,IAAI,YAAM,CAAC,QAAQ,CAAC,MAAM,EAAE;QAC1B,IAAI,GAAG,IAAI,CAAC;QACZ,IAAI,YAAM,CAAC,QAAQ,CAAC,IAAI,EAAE;YACxB,sCAAsC;YACtC,OAAO,CAAC,GAAG,CAAC,sCAAsC,CAAC,CAAC;SACrD;aAAM;YACL,0BAAQ,CAAC,IAAI,CAAC,YAAM,CAAC,QAAQ,CAAC,KAAK,EAAE;gBACnC,QAAQ,EAAE,YAAM,CAAC,QAAQ,CAAC,QAAQ;gBAClC,WAAW,EAAE,YAAM,CAAC,QAAQ,CAAC,WAAwC;gBACrE,EAAE,EAAE,YAAM,CAAC,QAAQ,CAAC,MAAM;gBAC1B,kBAAkB,EAAE,YAAM,CAAC,QAAQ,CAAC,kBAAkB;gBACtD,KAAK,EAAE,YAAM,CAAC,QAAQ,CAAC,KAAK;aAC7B,CAAC,CAAC;SACJ;KACF;AACH,CAAC,CAAC;AAhBW,QAAA,aAAa,iBAgBxB;AAEF,oDAAoD;AAC7C,MAAM,UAAU,GAAG,CAAC,UAAkB,EAAE,UAAgB,EAAQ,EAAE;IACvE,IAAI,YAAM,CAAC,QAAQ,CAAC,MAAM,IAAI,IAAI,EAAE;QAClC,IAAI,YAAM,CAAC,QAAQ,CAAC,IAAI,EAAE;YACxB,sCAAsC;YACtC,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;SACrC;aAAM;YACL,IAAI;gBACF,0BAAQ,CAAC,KAAK,CAAC,UAAU,EAAE;oBACzB,GAAG,YAAM,CAAC,QAAQ,CAAC,qBAAqB;oBACxC,GAAG,UAAU;oBACb,GAAG,YAAM,CAAC,QAAQ,CAAC,+BAA+B;iBACnD,CAAC,CAAC;aACJ;YAAC,OAAO,MAAM,EAAE;gBACf,OAAO,CAAC,KAAK,CAAC,sDAAsD,EAAE,MAAM,CAAC,CAAC;gBAC9E,sCAAsC;gBACtC,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;aACrC;SACF;KACF;AACH,CAAC,CAAC;AAnBW,QAAA,UAAU,cAmBrB;AAEF,oDAAoD;AAC7C,MAAM,aAAa,GAAG,CAAC,KAAe,EAAQ,EAAE;IACrD,IAAI,YAAM,CAAC,QAAQ,CAAC,MAAM,IAAI,IAAI,EAAE;QAClC,IAAA,kBAAU,EAAC,eAAe,EAAE,KAAK,CAAC,CAAC;KACpC;SAAM;QACL,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;KACtB;AACH,CAAC,CAAC;AANW,QAAA,aAAa,iBAMxB"}
+{"version":3,"file":"analyticsService.js","sourceRoot":"","sources":["../../src/lib/services/analyticsService.ts"],"names":[],"mappings":";;;;AAAA,qFAAwC;AACxC,uCAAuC;AAGvC,6CAA6C;AAC7C,IAAI,IAAI,GAAG,KAAK,CAAC;AAEjB,uFAAuF;AAChF,MAAM,aAAa,GAAG,GAAS,EAAE;IACtC,IAAI,YAAM,CAAC,QAAQ,CAAC,MAAM,EAAE;QAC1B,IAAI,GAAG,IAAI,CAAC;QACZ,IAAI,YAAM,CAAC,QAAQ,CAAC,IAAI,EAAE;YACxB,sCAAsC;YACtC,OAAO,CAAC,GAAG,CAAC,sCAAsC,CAAC,CAAC;SACrD;aAAM;YACL,0BAAQ,CAAC,IAAI,CAAC,YAAM,CAAC,QAAQ,CAAC,KAAK,EAAE;gBACnC,QAAQ,EAAE,YAAM,CAAC,QAAQ,CAAC,QAAQ;gBAClC,WAAW,EAAE,YAAM,CAAC,QAAQ,CAAC,WAAwC;gBACrE,EAAE,EAAE,YAAM,CAAC,QAAQ,CAAC,MAAM;gBAC1B,kBAAkB,EAAE,YAAM,CAAC,QAAQ,CAAC,kBAAkB;gBACtD,KAAK,EAAE,YAAM,CAAC,QAAQ,CAAC,KAAK;aAC7B,CAAC,CAAC;SACJ;KACF;AACH,CAAC,CAAC;AAhBW,QAAA,aAAa,iBAgBxB;AAEF,oDAAoD;AAC7C,MAAM,aAAa,GAAG,CAAC,KAAe,EAAQ,EAAE;IACrD,IAAI,YAAM,CAAC,QAAQ,CAAC,MAAM,IAAI,IAAI,EAAE;QAClC,IAAA,kBAAU,EAAC,eAAe,EAAE,KAAK,CAAC,CAAC;KACpC;SAAM;QACL,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;KACtB;AACH,CAAC,CAAC;AANW,QAAA,aAAa,iBAMxB;AAEF;;;;;GAKG;AACI,MAAM,UAAU,GAAG,CAAC,UAAkB,EAAE,UAAgB,EAAE,QAAqB,EAAQ,EAAE;IAC9F,IAAI,YAAM,CAAC,QAAQ,CAAC,MAAM,IAAI,IAAI,EAAE;QAClC,IAAI,YAAM,CAAC,QAAQ,CAAC,IAAI,EAAE;YACxB,sCAAsC;YACtC,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;YACpC,IAAI,QAAQ,EAAE;gBACZ,QAAQ,EAAE,CAAC;aACZ;SACF;aAAM;YACL,6BAA6B,CAAC,UAAU,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC;SACjE;KACF;SAAM;QACL,IAAI,QAAQ,EAAE;YACZ,QAAQ,EAAE,CAAC;SACZ;KACF;AACH,CAAC,CAAC;AAhBW,QAAA,UAAU,cAgBrB;AAEF,MAAM,6BAA6B,GAAG,CACpC,UAAkB,EAClB,UAAgB,EAChB,QAAqB,EACf,EAAE;IACR,6CAA6C;IAC7C,IAAI,MAAM,GAAG,KAAK,CAAC;IACnB,MAAM,eAAe,GAAG,QAAQ;QAC9B,CAAC,CAAC,GAAG,EAAE;YACH,IAAI;gBACF,MAAM,GAAG,IAAI,CAAC;gBACd,QAAQ,EAAE,CAAC;aACZ;YAAC,OAAO,MAAM,EAAE;gBACf,OAAO,CAAC,KAAK,CACX,iDAAiD,UAAU,WAAW,EACtE,MAAM,CACP,CAAC;aACH;QACH,CAAC;QACH,CAAC,CAAC,SAAS,CAAC;IACd,IAAI;QACF,0BAAQ,CAAC,KAAK,CACZ,UAAU,EACV;YACE,GAAG,YAAM,CAAC,QAAQ,CAAC,qBAAqB;YACxC,GAAG,UAAU;YACb,GAAG,YAAM,CAAC,QAAQ,CAAC,+BAA+B;SACnD,EACD,eAAe,CAAC,CAAC,CAAC,EAAE,gBAAgB,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,SAAS,EACxD,eAAe,CAChB,CAAC;KACH;IAAC,OAAO,MAAM,EAAE;QACf,OAAO,CAAC,KAAK,CAAC,sDAAsD,EAAE,MAAM,CAAC,CAAC;QAC9E,sCAAsC;QACtC,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;QAEpC,IAAI,eAAe,IAAI,CAAC,MAAM,EAAE;YAC9B,eAAe,EAAE,CAAC;SACnB;KACF;AACH,CAAC,CAAC"}