@webiny/telemetry 5.22.0 → 5.23.0-beta.1

package/CHANGELOG.md

@@ -3,6 +3,41 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [5.23.0-beta.1](https://github.com/webiny/webiny-js/compare/v5.23.0-beta.0...v5.23.0-beta.1) (2022-02-14)
+
+**Note:** Version bump only for package @webiny/telemetry
+
+
+
+
+
+# [5.23.0-beta.0](https://github.com/webiny/webiny-js/compare/v5.22.1...v5.23.0-beta.0) (2022-02-13)
+
+**Note:** Version bump only for package @webiny/telemetry
+
+
+
+
+
+## [5.22.1](https://github.com/webiny/webiny-js/compare/v5.22.1-beta.0...v5.22.1) (2022-01-29)
+
+**Note:** Version bump only for package @webiny/telemetry
+
+
+
+
+
+## [5.22.1-beta.0](https://github.com/webiny/webiny-js/compare/v5.22.0...v5.22.1-beta.0) (2022-01-29)
+
+
+### Bug Fixes
+
+* **telemetry:** add Buffer polyfill and improve telemetry code ([e078a2d](https://github.com/webiny/webiny-js/commit/e078a2d3659c979683a98c3c2f2aa769a5c7b56e))
+
+
+
+
+
 # [5.22.0](https://github.com/webiny/webiny-js/compare/v5.22.0-beta.3...v5.22.0) (2022-01-24)
 
 **Note:** Version bump only for package @webiny/telemetry

package/cli.js

@@ -1,18 +1,29 @@
-const baseSendEvent = require("./sendEvent");
+const createSendEvent = require("./sendEvent");
 const { globalConfig } = require("@webiny/global-config");
 
 const sendEvent = ({ event, user, version, properties, extraPayload }) => {
-    if (!isEnabled()) {
-        return;
+    const shouldSend = isEnabled();
+
+    try {
+        const sendTelemetry = createSendEvent({
+            event,
+            user: user || globalConfig.get("id"),
+            version: version || require("./package.json").version,
+            properties,
+            extraPayload
+        });
+
+        if (shouldSend) {
+            return sendTelemetry();
+        }
+    } catch (err) {
+        // Ignore errors if telemetry is disabled.
+        if (!shouldSend) {
+            return;
+        }
+
+        throw err;
     }
-
-    return baseSendEvent({
-        event,
-        user: user || globalConfig.get("id"),
-        version: version || require("./package.json").version,
-        properties,
-        extraPayload
-    });
 };
 
 const enable = () => {
@@ -30,6 +41,7 @@ const isEnabled = () => {
         return false;
     }
 
+    // `tracking` is left here for backwards compatibility with previous versions of Webiny.
     return config.tracking !== false;
 };
 

package/package.json

@@ -1,9 +1,9 @@
 {
 	"name": "@webiny/telemetry",
-	"version": "5.22.0",
+	"version": "5.23.0-beta.1",
 	"license": "MIT",
 	"dependencies": {
-		"@webiny/global-config": "5.22.0",
+		"@webiny/global-config": "5.23.0-beta.1",
 		"form-data": "3.0.0",
 		"node-fetch": "2.6.1"
 	},
@@ -11,5 +11,5 @@
 		"access": "public",
 		"directory": "."
 	},
-	"gitHead": "ab2ca1af058fdec3aa1bed3f30afd51f4592dbb6"
+	"gitHead": "04f2d5e43684b9086251e2a6370b3c085e6d51cb"
 }

package/react.js

@@ -1,14 +1,10 @@
-const baseSendEvent = require("./sendEvent");
+const createSendEvent = require("./sendEvent");
 
 const setProperties = data => {
     return sendEvent("$identify", data);
 };
 
 const sendEvent = (event, data = {}) => {
-    if (process.env.REACT_APP_WEBINY_TELEMETRY === "false") {
-        return;
-    }
-
     let properties = {};
     let extraPayload = {};
     if (event !== "$identify") {
@@ -19,13 +15,17 @@ const sendEvent = (event, data = {}) => {
         };
     }
 
-    return baseSendEvent({
+    const shouldSend = process.env.REACT_APP_WEBINY_TELEMETRY !== "false";
+
+    const sendTelemetry = createSendEvent({
         event,
         properties,
         extraPayload,
         user: process.env.REACT_APP_USER_ID,
         version: process.env.REACT_APP_WEBINY_VERSION
     });
+
+    return shouldSend ? sendTelemetry() : Promise.resolve();
 };
 
 module.exports = { setProperties, sendEvent };

package/sendEvent.js

@@ -6,15 +6,9 @@ const API_URL = "https://t.webiny.com";
 
 /**
  * The main `sendEvent` function.
- * Note: it's recommended the one from `cli.js` and `react.js` files is used instead.
- * @param event
- * @param user
- * @param version
- * @param properties
- * @param extraPayload
- * @returns {Promise<T>}
+ * NOTE: don't use this in your app directly. Instead, use the one from `cli.js` or `react.js` files accordingly.
  */
-module.exports = async ({ event, user, version, properties, extraPayload } = {}) => {
+module.exports = ({ event, user, version, properties, extraPayload } = {}) => {
     if (!event) {
         throw new Error(`Cannot send event - missing "event" name.`);
     }
@@ -50,10 +44,13 @@ module.exports = async ({ event, user, version, properties, extraPayload } = {})
     const body = new FormData();
     body.append("data", Buffer.from(JSON.stringify(payload)).toString("base64"));
 
-    return fetch(API_URL + "/capture/", {
-        body,
-        method: "POST"
-    }).catch(() => {
-        // Ignore errors
-    });
+    // Return a function which will send the prepared body when invoked.
+    return () => {
+        return fetch(API_URL + "/capture/", {
+            body,
+            method: "POST"
+        }).catch(() => {
+            // Ignore errors
+        });
+    };
 };