@webiny/telemetry 5.15.0-beta.0

package/CHANGELOG.md

@@ -0,0 +1,231 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+# [5.15.0-beta.0](https://github.com/webiny/webiny-js/compare/v5.14.0...v5.15.0-beta.0) (2021-09-16)
+
+
+### Bug Fixes
+
+* add comment ([61dafeb](https://github.com/webiny/webiny-js/commit/61dafeb08883b1c80033d3164581f56138fee675))
+* correct args passing in `setProperties` function ([2ac0fed](https://github.com/webiny/webiny-js/commit/2ac0fedb8bf760b15686de44523138816e708c36))
+* correct if statements ([1dcdd73](https://github.com/webiny/webiny-js/commit/1dcdd735d89f1918952481a6ae510a60cf113b7f))
+* create utils ([6a24dcf](https://github.com/webiny/webiny-js/commit/6a24dcfb02130a672c1e90794910f8a0549f659d))
+* remove old api folder ([5dce8e2](https://github.com/webiny/webiny-js/commit/5dce8e2c7871fd1e24326e73e3a9459208ce7f75))
+* rename to `extraPayload` ([b5bcda8](https://github.com/webiny/webiny-js/commit/b5bcda88029c003d0c5704a37bff4771b9056d5e))
+* update dependencies ([37f2691](https://github.com/webiny/webiny-js/commit/37f2691f3cb615615a089d977f58a22a8bb21f50))
+* use base `sendEvent` function ([6f93072](https://github.com/webiny/webiny-js/commit/6f9307212e05b98f2a4866002258238b216e0b3b))
+* use built-in isEnabled ([4051257](https://github.com/webiny/webiny-js/commit/4051257c58165dbcc9805283d183583ed0bf7d15))
+* use global-config package ([a678b18](https://github.com/webiny/webiny-js/commit/a678b18d9d760a69eb6badaaf6451acd3c7fb953))
+
+
+### Features
+
+* add telemetry getter ([b1a5e8d](https://github.com/webiny/webiny-js/commit/b1a5e8df96b1591266fbd8df90d6689a526da0f3))
+* add utils ([d9be82a](https://github.com/webiny/webiny-js/commit/d9be82a76f5210704c71cd8e191aca698cb0963c))
+* create `sendEvent` function for CLI environment ([d0babff](https://github.com/webiny/webiny-js/commit/d0babffeb1cb3a7a796caa8a25f3f9a2ba9359d7))
+* create base `sendEvent` function ([a764e85](https://github.com/webiny/webiny-js/commit/a764e854c5da0ebcb99038e9b9aaf3184202edc3))
+
+
+
+
+
+# [5.14.0](https://github.com/webiny/webiny-js/compare/v5.14.0-beta.0...v5.14.0) (2021-08-30)
+
+**Note:** Version bump only for package @webiny/telemetry
+
+
+
+
+
+# [5.14.0-beta.0](https://github.com/webiny/webiny-js/compare/v5.13.0...v5.14.0-beta.0) (2021-08-26)
+
+**Note:** Version bump only for package @webiny/telemetry
+
+
+
+
+
+# [5.13.0](https://github.com/webiny/webiny-js/compare/v5.13.0-beta.4...v5.13.0) (2021-08-18)
+
+**Note:** Version bump only for package @webiny/telemetry
+
+
+
+
+
+# [5.13.0-beta.4](https://github.com/webiny/webiny-js/compare/v5.13.0-beta.3...v5.13.0-beta.4) (2021-08-18)
+
+**Note:** Version bump only for package @webiny/telemetry
+
+
+
+
+
+# [5.13.0-beta.3](https://github.com/webiny/webiny-js/compare/v5.13.0-beta.2...v5.13.0-beta.3) (2021-08-17)
+
+**Note:** Version bump only for package @webiny/telemetry
+
+
+
+
+
+# [5.13.0-beta.2](https://github.com/webiny/webiny-js/compare/v5.13.0-beta.1...v5.13.0-beta.2) (2021-08-17)
+
+**Note:** Version bump only for package @webiny/telemetry
+
+
+
+
+
+# [5.13.0-beta.1](https://github.com/webiny/webiny-js/compare/v5.13.0-beta.0...v5.13.0-beta.1) (2021-08-16)
+
+**Note:** Version bump only for package @webiny/telemetry
+
+
+
+
+
+# [5.13.0-beta.0](https://github.com/webiny/webiny-js/compare/v5.12.0...v5.13.0-beta.0) (2021-08-16)
+
+**Note:** Version bump only for package @webiny/telemetry
+
+
+
+
+
+# [5.12.0](https://github.com/webiny/webiny-js/compare/v5.12.0-beta.1...v5.12.0) (2021-08-05)
+
+**Note:** Version bump only for package @webiny/telemetry
+
+
+
+
+
+# [5.12.0-beta.1](https://github.com/webiny/webiny-js/compare/v5.12.0-beta.0...v5.12.0-beta.1) (2021-08-05)
+
+**Note:** Version bump only for package @webiny/telemetry
+
+
+
+
+
+# [5.12.0-beta.0](https://github.com/webiny/webiny-js/compare/v5.11.1...v5.12.0-beta.0) (2021-08-04)
+
+**Note:** Version bump only for package @webiny/telemetry
+
+
+
+
+
+## [5.11.1](https://github.com/webiny/webiny-js/compare/v5.11.1-beta.0...v5.11.1) (2021-07-31)
+
+**Note:** Version bump only for package @webiny/telemetry
+
+
+
+
+
+## [5.11.1-beta.0](https://github.com/webiny/webiny-js/compare/v5.11.0...v5.11.1-beta.0) (2021-07-31)
+
+**Note:** Version bump only for package @webiny/telemetry
+
+
+
+
+
+# [5.11.0](https://github.com/webiny/webiny-js/compare/v5.11.0-beta.2...v5.11.0) (2021-07-22)
+
+**Note:** Version bump only for package @webiny/telemetry
+
+
+
+
+
+# [5.11.0-beta.2](https://github.com/webiny/webiny-js/compare/v5.11.0-beta.1...v5.11.0-beta.2) (2021-07-21)
+
+**Note:** Version bump only for package @webiny/telemetry
+
+
+
+
+
+# [5.11.0-beta.1](https://github.com/webiny/webiny-js/compare/v5.11.0-beta.0...v5.11.0-beta.1) (2021-07-21)
+
+**Note:** Version bump only for package @webiny/telemetry
+
+
+
+
+
+# [5.11.0-beta.0](https://github.com/webiny/webiny-js/compare/v5.10.0...v5.11.0-beta.0) (2021-07-21)
+
+**Note:** Version bump only for package @webiny/telemetry
+
+
+
+
+
+# [5.10.0](https://github.com/webiny/webiny-js/compare/v5.10.0-beta.2...v5.10.0) (2021-07-06)
+
+**Note:** Version bump only for package @webiny/telemetry
+
+
+
+
+
+# [5.10.0-beta.2](https://github.com/webiny/webiny-js/compare/v5.10.0-beta.1...v5.10.0-beta.2) (2021-07-06)
+
+**Note:** Version bump only for package @webiny/telemetry
+
+
+
+
+
+# [5.10.0-beta.1](https://github.com/webiny/webiny-js/compare/v5.10.0-beta.0...v5.10.0-beta.1) (2021-07-06)
+
+**Note:** Version bump only for package @webiny/telemetry
+
+
+
+
+
+# [5.10.0-beta.0](https://github.com/webiny/webiny-js/compare/v5.9.0...v5.10.0-beta.0) (2021-07-02)
+
+**Note:** Version bump only for package @webiny/telemetry
+
+
+
+
+
+# [5.9.0](https://github.com/webiny/webiny-js/compare/v5.9.0-beta.2...v5.9.0) (2021-06-21)
+
+**Note:** Version bump only for package @webiny/telemetry
+
+
+
+
+
+# [5.9.0-beta.2](https://github.com/webiny/webiny-js/compare/v5.9.0-beta.1...v5.9.0-beta.2) (2021-06-20)
+
+**Note:** Version bump only for package @webiny/telemetry
+
+
+
+
+
+# [5.9.0-beta.1](https://github.com/webiny/webiny-js/compare/v5.9.0-beta.0...v5.9.0-beta.1) (2021-06-20)
+
+**Note:** Version bump only for package @webiny/telemetry
+
+
+
+
+
+# [5.9.0-beta.0](https://github.com/webiny/webiny-js/compare/v5.8.0...v5.9.0-beta.0) (2021-06-18)
+
+
+### Bug Fixes
+
+* **telemetry:** rename package and upgrade configs and env vars loading ([4791937](https://github.com/webiny/webiny-js/commit/4791937de3ec1431c82fca1dc2e91da9c7ac49d3))

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,36 @@
+const baseSendEvent = require("./sendEvent");
+const { globalConfig } = require("@webiny/global-config");
+
+const sendEvent = ({ event, user, version, properties, extraPayload }) => {
+    if (!isEnabled()) {
+        return;
+    }
+
+    return baseSendEvent({
+        event,
+        user: user || globalConfig.get("id"),
+        version: version || require("./package.json").version,
+        properties,
+        extraPayload
+    });
+};
+
+const enable = () => {
+    globalConfig.set("telemetry", true);
+};
+
+const disable = () => {
+    globalConfig.set("telemetry", false);
+};
+
+const isEnabled = () => {
+    const config = globalConfig.get();
+
+    if (config.telemetry === false) {
+        return false;
+    }
+
+    return config.tracking !== false;
+};
+
+module.exports = { sendEvent, enable, disable, isEnabled };

package/package.json

@@ -0,0 +1,15 @@
+{
+	"name": "@webiny/telemetry",
+	"version": "5.15.0-beta.0",
+	"license": "MIT",
+	"dependencies": {
+		"@webiny/global-config": "5.15.0-beta.0",
+		"form-data": "3.0.0",
+		"node-fetch": "2.6.1"
+	},
+	"publishConfig": {
+		"access": "public",
+		"directory": "."
+	},
+	"gitHead": "baf2dbb8cae1b623b59d20fedc0cd0e11a310ca1"
+}

package/react.js

@@ -0,0 +1,31 @@
+const baseSendEvent = 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") {
+        properties = data;
+    } else {
+        extraPayload = {
+            $set: data
+        };
+    }
+
+    return baseSendEvent({
+        event,
+        properties,
+        extraPayload,
+        user: process.env.REACT_APP_USER_ID,
+        version: process.env.REACT_APP_WEBINY_VERSION
+    });
+};
+
+module.exports = { setProperties, sendEvent };

package/sendEvent.js

@@ -0,0 +1,59 @@
+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: 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>}
+ */
+module.exports = async ({ 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 fetch(API_URL + "/capture/", {
+        body,
+        method: "POST"
+    }).catch(() => {
+        // Ignore errors
+    });
+};