@webiny/telemetry 0.0.0-unstable.e622468070 → 0.0.0-unstable.e9333b3f0b

package/cli.d.ts

@@ -1,6 +1,5 @@
 export declare interface SendEventParams {
     event: string;
-    user?: string;
     version?: string;
     properties: Record<string, any>;
 }

package/cli.js

@@ -1,17 +1,24 @@
 import { globalConfig } from "@webiny/global-config";
 import { isCI } from "ci-info";
-import { WTS } from "wts-client/node.js";
+import { WTS } from "@webiny/wts-client/node";
 import baseSendEvent from "./sendEvent.js";
-import readJson from "load-json-file";
+import { loadJsonFileSync } from "load-json-file";
 import path from "path";
 
-export const sendEvent = async ({ event, user, version, properties }) => {
+export const sendEvent = async ({ event, version, properties }) => {
     const shouldSend = isEnabled();
     if (!shouldSend) {
         return;
     }
 
-    const wts = new WTS();
+    // Use the canonical Webiny machine id — the top-level `id` field in
+    // `~/.webiny/config`, owned by @webiny/global-config. The admin app
+    // (REACT_APP_WEBINY_TELEMETRY_USER_ID) and the website install/finish alias
+    // both key off this same id, so passing it here keeps CLI, admin, and
+    // website events on a single PostHog person. Without it, the WTS client
+    // falls back to its own `user.id` field, which is a different UUID and
+    // fragments funnels across surfaces.
+    const wts = new WTS({ source: "cli", distinctId: globalConfig.get("id") });
 
     const wcpProperties = {};
     const [wcpOrgId, wcpProjectId] = getWcpOrgProjectId();
@@ -20,15 +27,31 @@ export const sendEvent = async ({ event, user, version, properties }) => {
         wcpProperties.wcpProjectId = wcpProjectId;
     }
 
+    const installationProperties = {};
+    const installationId = getInstallationId();
+    if (installationId) {
+        installationProperties.installation_id = installationId;
+    }
+
+    // Which hosting type the project runs on ("aws" or "server"). Both CLI bins set this marker at
+    // startup (`cli-aws/src/bin.ts`, `cli-server/src/bin.ts`), so every CLI event can be segmented
+    // by hosting type without each call site passing it along. Omitted when unset rather than
+    // defaulted to "aws", because a missing marker means an unknown caller, not an AWS project.
+    const hostingTypeProperties = {};
+    if (process.env.WEBINY_HOSTING_TYPE) {
+        hostingTypeProperties.hostingType = process.env.WEBINY_HOSTING_TYPE;
+    }
+
     const packageJsonPath = path.join(import.meta.dirname, "package.json");
-    const packageJson = await readJson(packageJsonPath);
+    const packageJson = loadJsonFileSync(packageJsonPath);
 
     return baseSendEvent({
         event,
-        user: user || globalConfig.get("id"),
         properties: {
             ...properties,
             ...wcpProperties,
+            ...installationProperties,
+            ...hostingTypeProperties,
             version: version || packageJson.version,
             ci: isCI,
             newUser: Boolean(globalConfig.get("newUser"))
@@ -38,14 +61,30 @@ export const sendEvent = async ({ event, user, version, properties }) => {
 };
 
 const getWcpOrgProjectId = () => {
-    // In CLI, WCP project ID is stored in the `WCP_PROJECT_ID` environment variable.
-    const id = process.env.WCP_PROJECT_ID;
+    // In CLI, project ID is stored in the `WEBINY_PROJECT_ID` or `WCP_PROJECT_ID` environment variable.
+    const id = process.env.WEBINY_PROJECT_ID || process.env.WCP_PROJECT_ID;
     if (typeof id === "string") {
         return id.split("/");
     }
     return [];
 };
 
+/**
+ * Reads the anonymous per-project installation id from
+ * `<project-root>/package.json` → `webiny.installationId`. Generated once at
+ * `create-webiny-project` time and tracked in git so it stays stable across
+ * machines that share the project. Returns null if the file is missing or
+ * unreadable — telemetry events still fire, just without the property.
+ */
+const getInstallationId = () => {
+    try {
+        const data = loadJsonFileSync(path.join(process.cwd(), "package.json"));
+        return typeof data?.webiny?.installationId === "string" ? data.webiny.installationId : null;
+    } catch {
+        return null;
+    }
+};
+
 export const enable = () => {
     globalConfig.set("telemetry", true);
 };

package/package.json

@@ -1,19 +1,17 @@
 {
 	"name": "@webiny/telemetry",
-	"version": "0.0.0-unstable.e622468070",
+	"version": "0.0.0-unstable.e9333b3f0b",
 	"type": "module",
 	"license": "MIT",
 	"dependencies": {
-		"@webiny/global-config": "0.0.0-unstable.e622468070",
+		"@webiny/global-config": "0.0.0-unstable.e9333b3f0b",
+		"@webiny/wts-client": "3.1.4",
 		"ci-info": "4.4.0",
 		"jsesc": "3.1.0",
-		"load-json-file": "6.2.0",
-		"strip-ansi": "6.0.1",
-		"wts-client": "2.0.0"
+		"load-json-file": "7.0.1",
+		"strip-ansi": "7.2.0"
 	},
 	"publishConfig": {
-		"access": "public",
-		"directory": "."
-	},
-	"gitHead": "e622468070839dc3f9552c85bf2bbac12d2ef88f"
+		"access": "public"
+	}
 }

package/react.d.ts

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

package/react.js

@@ -1,5 +1,92 @@
 import baseSendEvent from "./sendEvent.js";
-import { WTS } from "wts-client/admin.js";
+import { WTS } from "@webiny/wts-client/web";
+
+const STORAGE_MACHINE_ID = "wts_machine_id";
+// Storage key kept as-is: ids persisted by earlier versions still live under it, and renaming the
+// key would silently mint a new installation id for every existing admin session.
+const STORAGE_INSTALLATION_ID = "wts_project_id";
+
+let wtsInstance = null;
+let installationId = null;
+let distinctId = null;
+
+/**
+ * Resolves the WTS client identity for the admin app.
+ *
+ * Priority for `distinct_id` (machine_id):
+ *   1. URL param `wts_did` on first load. Persisted to localStorage.
+ *   2. localStorage (subsequent loads).
+ *   3. `process.env.REACT_APP_WEBINY_TELEMETRY_USER_ID` (build-time fallback,
+ *      set by `SetAdminAppEnvVarsBefore{Build,Watch}` from `~/.webiny/config`).
+ *
+ * Priority for `installation_id`:
+ *   1. URL param `iid` on first load. Persisted to localStorage.
+ *   2. localStorage.
+ *   3. `process.env.REACT_APP_WEBINY_INSTALLATION_ID` (build-time fallback,
+ *      set from `<project>/package.json` → `webiny.installationId`).
+ *
+ * Attached as a super-property on every admin event so PostHog funnels can
+ * group per-install. The property name matches the one the CLI sends
+ * (`telemetry/cli.js`) so CLI and admin events for the same project join on a
+ * single property.
+ */
+const initWts = () => {
+    if (wtsInstance) {
+        return wtsInstance;
+    }
+
+    distinctId = process.env.REACT_APP_WEBINY_TELEMETRY_USER_ID;
+    installationId = process.env.REACT_APP_WEBINY_INSTALLATION_ID || null;
+
+    if (typeof window !== "undefined") {
+        const params = new URLSearchParams(window.location.search);
+
+        const fromUrl = params.get("wts_did");
+        if (fromUrl) {
+            distinctId = fromUrl;
+            try {
+                window.localStorage.setItem(STORAGE_MACHINE_ID, fromUrl);
+            } catch {
+                // localStorage unavailable; URL value is used for this session only.
+            }
+        } else {
+            try {
+                distinctId = window.localStorage.getItem(STORAGE_MACHINE_ID) || distinctId;
+            } catch {
+                // ignore
+            }
+        }
+
+        const iidFromUrl = params.get("iid");
+        if (iidFromUrl) {
+            installationId = iidFromUrl;
+            try {
+                window.localStorage.setItem(STORAGE_INSTALLATION_ID, iidFromUrl);
+            } catch {
+                // ignore
+            }
+        } else {
+            try {
+                installationId =
+                    window.localStorage.getItem(STORAGE_INSTALLATION_ID) || installationId;
+            } catch {
+                // env-var value (set above) is used as fallback.
+            }
+        }
+    }
+
+    wtsInstance = new WTS({ source: "admin", distinctId });
+    return wtsInstance;
+};
+
+/**
+ * Returns the machine_id used by admin events, if known. Used by the
+ * install/finish CTA to construct the alias handoff URL.
+ */
+export const getMachineId = () => {
+    initWts();
+    return distinctId || null;
+};
 
 export const sendEvent = async (event, properties = {}) => {
     const shouldSend = process.env.REACT_APP_WEBINY_TELEMETRY !== "false";
@@ -7,7 +94,7 @@ export const sendEvent = async (event, properties = {}) => {
         return;
     }
 
-    const wts = new WTS();
+    const wts = initWts();
 
     const wcpProperties = {};
     const [wcpOrgId, wcpProjectId] = getWcpOrgProjectId();
@@ -16,12 +103,23 @@ export const sendEvent = async (event, properties = {}) => {
         wcpProperties.wcpProjectId = wcpProjectId;
     }
 
+    const installationProperties = {};
+    if (installationId) {
+        installationProperties.installation_id = installationId;
+    }
+
+    const hostingTypeProperties = {};
+    if (process.env.REACT_APP_WEBINY_HOSTING_TYPE) {
+        hostingTypeProperties.hostingType = process.env.REACT_APP_WEBINY_HOSTING_TYPE;
+    }
+
     return baseSendEvent({
         event,
-        user: process.env.REACT_APP_WEBINY_TELEMETRY_USER_ID,
         properties: {
             ...properties,
             ...wcpProperties,
+            ...installationProperties,
+            ...hostingTypeProperties,
             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"
@@ -31,8 +129,8 @@ export const sendEvent = async (event, properties = {}) => {
 };
 
 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;
+    // In React applications, project ID is stored in the `REACT_APP_WEBINY_PROJECT_ID` or `REACT_APP_WCP_PROJECT_ID` environment variable.
+    const id = process.env.REACT_APP_WEBINY_PROJECT_ID || process.env.REACT_APP_WCP_PROJECT_ID;
     if (typeof id === "string") {
         return id.split("/");
     }

package/sendEvent.js

@@ -4,17 +4,16 @@ 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.
+ *
+ * Identity is owned by the WTS instance — `cli.js` reads `~/.webiny/config`,
+ * `react.js` reads URL params / localStorage / env. This function only
+ * validates and sanitises the event payload before dispatching.
  */
-export default ({ event, user, properties, wts } = {}) => {
-    // 1. Check for the existence of required base parameters.
+export default ({ event, properties, wts } = {}) => {
     if (!event) {
         throw new Error(`Cannot send event - missing "event" name.`);
     }
 
-    if (!user) {
-        throw new Error(`Cannot send event - missing "user" ID.`);
-    }
-
     if (!properties) {
         throw new Error(`Cannot send event - missing "properties" object.`);
     }
@@ -23,7 +22,6 @@ export default ({ event, user, properties, wts } = {}) => {
         throw new Error(`Cannot send event - missing "wts" instance.`);
     }
 
-    // 2. Extract properties and check for existence of required properties.
     if (!properties.version) {
         throw new Error(`Cannot send event - missing "version" property.`);
     }
@@ -38,7 +36,6 @@ export default ({ event, user, properties, wts } = {}) => {
         throw new Error(`Cannot send event - missing "newUser" boolean property.`);
     }
 
-    // 2. Sanitize properties.
     const sanitizedProperties = {
         ...properties,
         newUser: properties.newUser === true ? "yes" : "no",
@@ -56,6 +53,5 @@ export default ({ event, user, properties, wts } = {}) => {
         sanitizedProperties[key] = sanitizedValue;
     }
 
-    // 3. Send.
-    return wts.trackEvent(user, event, sanitizedProperties);
+    return wts.track(event, sanitizedProperties);
 };