@webiny/telemetry 0.0.0-ee-vpcs.549378cf03

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Webiny
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1 @@
+# @webiny/telemetry

package/cli.js

@@ -0,0 +1,48 @@
+const createSendEvent = require("./sendEvent");
+const { globalConfig } = require("@webiny/global-config");
+
+const sendEvent = ({ event, user, version, properties, extraPayload }) => {
+    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;
+    }
+};
+
+const enable = () => {
+    globalConfig.set("telemetry", true);
+};
+
+const disable = () => {
+    globalConfig.set("telemetry", false);
+};
+
+const isEnabled = () => {
+    const config = globalConfig.get();
+
+    if (config.telemetry === false) {
+        return false;
+    }
+
+    // `tracking` is left here for backwards compatibility with previous versions of Webiny.
+    return config.tracking !== false;
+};
+
+module.exports = { sendEvent, enable, disable, isEnabled };

package/package.json

@@ -0,0 +1,15 @@
+{
+	"name": "@webiny/telemetry",
+	"version": "0.0.0-ee-vpcs.549378cf03",
+	"license": "MIT",
+	"dependencies": {
+		"@webiny/global-config": "0.0.0-ee-vpcs.549378cf03",
+		"form-data": "3.0.0",
+		"node-fetch": "2.6.1"
+	},
+	"publishConfig": {
+		"access": "public",
+		"directory": "."
+	},
+	"gitHead": "549378cf03fcd27845fc3fa23d1dc6b32896f630"
+}

package/react.js

@@ -0,0 +1,36 @@
+const createSendEvent = require("./sendEvent");
+
+const setProperties = data => {
+    return sendEvent("$identify", data);
+};
+/**
+ *
+ * @param event {String}
+ * @param data {Record<string, string>}
+ * @return {Promise<T>}
+ */
+const sendEvent = (event, data = {}) => {
+    let properties = {};
+    let extraPayload = {};
+    if (event !== "$identify") {
+        properties = data;
+    } else {
+        extraPayload = {
+            $set: data
+        };
+    }
+
+    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

@@ -0,0 +1,56 @@
+const FormData = require("form-data");
+const fetch = require("node-fetch");
+
+const API_KEY = "ZdDZgkeOt4Z_m-UWmqFsE1d6-kcCK3BH0ypYTUIFty4";
+const API_URL = "https://t.webiny.com";
+
+/**
+ * The main `sendEvent` function.
+ * NOTE: don't use this in your app directly. Instead, use the one from `cli.js` or `react.js` files accordingly.
+ */
+module.exports = ({ event, user, version, properties, extraPayload } = {}) => {
+    if (!event) {
+        throw new Error(`Cannot send event - missing "event" name.`);
+    }
+
+    if (!user) {
+        throw new Error(`Cannot send event - missing "user" property.`);
+    }
+
+    if (!version) {
+        throw new Error(`Cannot send event - missing "version" property.`);
+    }
+
+    if (!properties) {
+        properties = {};
+    }
+
+    if (!extraPayload) {
+        extraPayload = {};
+    }
+
+    const payload = {
+        ...extraPayload,
+        event,
+        properties: {
+            ...properties,
+            version
+        },
+        distinct_id: user,
+        api_key: API_KEY,
+        timestamp: new Date().toISOString()
+    };
+
+    const body = new FormData();
+    body.append("data", Buffer.from(JSON.stringify(payload)).toString("base64"));
+
+    // Return a function which will send the prepared body when invoked.
+    return () => {
+        return fetch(API_URL + "/capture/", {
+            body,
+            method: "POST"
+        }).catch(() => {
+            // Ignore errors
+        });
+    };
+};