@webiny/telemetry 0.0.0-unstable.ecd8734205 → 0.0.0-unstable.f6dc066313

package/README.md

@@ -1 +1,11 @@
 # @webiny/telemetry
+
+> [!NOTE]
+> This package is part of the [Webiny](https://www.webiny.com) monorepo.
+> It’s **included in every Webiny project by default** and is not meant to be used as a standalone package.
+
+📘 **Documentation:** [https://www.webiny.com/docs](https://www.webiny.com/docs)
+
+---
+
+_This README file is automatically generated during the publish process._

package/cli.d.ts

@@ -0,0 +1,12 @@
+export declare interface SendEventParams {
+    event: string;
+    user?: string;
+    version?: string;
+    properties: Record<string, any>;
+}
+
+export declare function sendEvent(params: SendEventParams): Promise<void>;
+
+export declare function isEnabled(): boolean;
+export declare function enable(): boolean;
+export declare function disable(): boolean;

package/cli.js

@@ -1,40 +1,60 @@
-const createSendEvent = require("./sendEvent");
-const { globalConfig } = require("@webiny/global-config");
+import { globalConfig } from "@webiny/global-config";
+import { isCI } from "ci-info";
+import { WTS } from "wts-client/node.js";
+import baseSendEvent from "./sendEvent.js";
+import { loadJsonFileSync } from "load-json-file";
+import path from "path";
 
-const sendEvent = ({ event, user, version, properties, extraPayload }) => {
+export const sendEvent = async ({ event, user, version, properties }) => {
     const shouldSend = isEnabled();
+    if (!shouldSend) {
+        return;
+    }
+
+    const wts = new WTS();
+
+    const wcpProperties = {};
+    const [wcpOrgId, wcpProjectId] = getWcpOrgProjectId();
+    if (wcpOrgId && wcpProjectId) {
+        wcpProperties.wcpOrgId = wcpOrgId;
+        wcpProperties.wcpProjectId = wcpProjectId;
+    }
 
-    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 packageJsonPath = path.join(import.meta.dirname, "package.json");
+    const packageJson = loadJsonFileSync(packageJsonPath);
+
+    return baseSendEvent({
+        event,
+        user: user || globalConfig.get("id"),
+        properties: {
+            ...properties,
+            ...wcpProperties,
+            version: version || packageJson.version,
+            ci: isCI,
+            newUser: Boolean(globalConfig.get("newUser"))
+        },
+        wts
+    });
+};
+
+const getWcpOrgProjectId = () => {
+    // In CLI, WCP project ID is stored in the `WCP_PROJECT_ID` environment variable.
+    const id = process.env.WCP_PROJECT_ID;
+    if (typeof id === "string") {
+        return id.split("/");
     }
+    return [];
 };
 
-const enable = () => {
+export const enable = () => {
     globalConfig.set("telemetry", true);
 };
 
-const disable = () => {
+export const disable = () => {
     globalConfig.set("telemetry", false);
 };
 
-const isEnabled = () => {
+export const isEnabled = () => {
     const config = globalConfig.get();
 
     if (config.telemetry === false) {
@@ -44,5 +64,3 @@ const isEnabled = () => {
     // `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

@@ -1,15 +1,19 @@
 {
 	"name": "@webiny/telemetry",
-	"version": "0.0.0-unstable.ecd8734205",
+	"version": "0.0.0-unstable.f6dc066313",
+	"type": "module",
 	"license": "MIT",
 	"dependencies": {
-		"@webiny/global-config": "0.0.0-unstable.ecd8734205",
-		"form-data": "3.0.0",
-		"node-fetch": "2.6.1"
+		"@webiny/global-config": "0.0.0-unstable.f6dc066313",
+		"ci-info": "4.4.0",
+		"jsesc": "3.1.0",
+		"load-json-file": "7.0.1",
+		"strip-ansi": "6.0.1",
+		"wts-client": "2.0.0"
 	},
 	"publishConfig": {
 		"access": "public",
 		"directory": "."
 	},
-	"gitHead": "ecd8734205e0e21ae04076c28ff9806dad07a730"
+	"gitHead": "f6dc066313ddce5339d2aacec3aa84e61232689b"
 }

package/react.d.ts

@@ -0,0 +1 @@
+export declare function sendEvent(ev: string, properties?: Record<string, any>): Promise<any>;

package/react.js

@@ -1,36 +1,40 @@
-const createSendEvent = require("./sendEvent");
+import baseSendEvent from "./sendEvent.js";
+import { WTS } from "wts-client/admin.js";
 
-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
-        };
+export const sendEvent = async (event, properties = {}) => {
+    const shouldSend = process.env.REACT_APP_WEBINY_TELEMETRY !== "false";
+    if (!shouldSend) {
+        return;
     }
 
-    const shouldSend = process.env.REACT_APP_WEBINY_TELEMETRY !== "false";
+    const wts = new WTS();
+
+    const wcpProperties = {};
+    const [wcpOrgId, wcpProjectId] = getWcpOrgProjectId();
+    if (wcpOrgId && wcpProjectId) {
+        wcpProperties.wcpOrgId = wcpOrgId;
+        wcpProperties.wcpProjectId = wcpProjectId;
+    }
 
-    const sendTelemetry = createSendEvent({
+    return baseSendEvent({
         event,
-        properties,
-        extraPayload,
-        user: process.env.REACT_APP_USER_ID,
-        version: process.env.REACT_APP_WEBINY_VERSION
+        user: process.env.REACT_APP_WEBINY_TELEMETRY_USER_ID,
+        properties: {
+            ...properties,
+            ...wcpProperties,
+            version: process.env.REACT_APP_WEBINY_VERSION,
+            ci: process.env.REACT_APP_IS_CI === "true",
+            newUser: process.env.REACT_APP_WEBINY_TELEMETRY_NEW_USER === "true"
+        },
+        wts
     });
-
-    return shouldSend ? sendTelemetry() : Promise.resolve();
 };
 
-module.exports = { setProperties, sendEvent };
+const getWcpOrgProjectId = () => {
+    // In React applications, WCP project ID is stored in the `REACT_APP_WCP_PROJECT_ID` environment variable.
+    const id = process.env.REACT_APP_WCP_PROJECT_ID;
+    if (typeof id === "string") {
+        return id.split("/");
+    }
+    return [];
+};

package/sendEvent.js

@@ -1,56 +1,61 @@
-const FormData = require("form-data");
-const fetch = require("node-fetch");
-
-const API_KEY = "ZdDZgkeOt4Z_m-UWmqFsE1d6-kcCK3BH0ypYTUIFty4";
-const API_URL = "https://t.webiny.com";
+import stripAnsi from "strip-ansi";
+import jsesc from "jsesc";
 
 /**
  * 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 } = {}) => {
+export default ({ event, user, properties, wts } = {}) => {
+    // 1. Check for the existence of required base parameters.
     if (!event) {
         throw new Error(`Cannot send event - missing "event" name.`);
     }
 
     if (!user) {
-        throw new Error(`Cannot send event - missing "user" property.`);
+        throw new Error(`Cannot send event - missing "user" ID.`);
+    }
+
+    if (!properties) {
+        throw new Error(`Cannot send event - missing "properties" object.`);
+    }
+
+    if (!wts) {
+        throw new Error(`Cannot send event - missing "wts" instance.`);
     }
 
-    if (!version) {
+    // 2. Extract properties and check for existence of required properties.
+    if (!properties.version) {
         throw new Error(`Cannot send event - missing "version" property.`);
     }
 
-    if (!properties) {
-        properties = {};
+    const hasCiProp = "ci" in properties;
+    if (!hasCiProp) {
+        throw new Error(`Cannot send event - missing "ci" boolean property.`);
     }
 
-    if (!extraPayload) {
-        extraPayload = {};
+    const hasNewUserProp = "newUser" in properties;
+    if (!hasNewUserProp) {
+        throw new Error(`Cannot send event - missing "newUser" boolean property.`);
     }
 
-    const payload = {
-        ...extraPayload,
-        event,
-        properties: {
-            ...properties,
-            version
-        },
-        distinct_id: user,
-        api_key: API_KEY,
-        timestamp: new Date().toISOString()
+    // 2. Sanitize properties.
+    const sanitizedProperties = {
+        ...properties,
+        newUser: properties.newUser === true ? "yes" : "no",
+        ci: properties.ci === true ? "yes" : "no"
     };
 
-    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
-        });
-    };
+    for (const key in sanitizedProperties) {
+        let sanitizedValue = sanitizedProperties[key];
+        if (typeof sanitizedValue === "string") {
+            sanitizedValue = sanitizedValue.trim();
+            sanitizedValue = stripAnsi(sanitizedValue);
+            sanitizedValue = jsesc(sanitizedValue);
+        }
+
+        sanitizedProperties[key] = sanitizedValue;
+    }
+
+    // 3. Send.
+    return wts.trackEvent(user, event, sanitizedProperties);
 };