Instrument project-bluebird (Channels space) with analytics events (#2808)

Author: raquelmsmith

packages/core/src/canvas/canvasAnalytics.test.ts

@@ -0,0 +1,87 @@
+import { describe, expect, it } from "vitest";
+import {
+  buildCanvasPromptProps,
+  buildContextSaveProps,
+  dashboardIdFromThread,
+} from "./canvasAnalytics";
+
+describe("dashboardIdFromThread", () => {
+  it("strips the dashboard: prefix", () => {
+    expect(dashboardIdFromThread("dashboard:abc-123")).toBe("abc-123");
+  });
+
+  it("leaves an unprefixed id untouched", () => {
+    expect(dashboardIdFromThread("abc-123")).toBe("abc-123");
+  });
+});
+
+describe("buildCanvasPromptProps", () => {
+  it("resolves dashboard id and prompt length for a free-typed prompt", () => {
+    expect(
+      buildCanvasPromptProps({
+        surface: "json",
+        threadId: "dashboard:d1",
+        text: "hello",
+        fromSuggestion: false,
+      }),
+    ).toEqual({
+      surface: "json",
+      dashboard_id: "d1",
+      from_suggestion: false,
+      prompt_length_chars: 5,
+    });
+  });
+
+  it("flags suggestion-driven prompts", () => {
+    const props = buildCanvasPromptProps({
+      surface: "freeform",
+      threadId: "dashboard:d2",
+      text: "build a chart",
+      fromSuggestion: true,
+    });
+    expect(props.from_suggestion).toBe(true);
+    expect(props.surface).toBe("freeform");
+  });
+
+  it("passes through the ask_agent_to_fix intent and omits it otherwise", () => {
+    const withIntent = buildCanvasPromptProps({
+      surface: "freeform",
+      threadId: "dashboard:d3",
+      text: "fix it",
+      fromSuggestion: false,
+      intent: "ask_agent_to_fix",
+    });
+    expect(withIntent.intent).toBe("ask_agent_to_fix");
+
+    const withoutIntent = buildCanvasPromptProps({
+      surface: "freeform",
+      threadId: "dashboard:d3",
+      text: "fix it",
+      fromSuggestion: false,
+    });
+    expect(withoutIntent).not.toHaveProperty("intent");
+  });
+});
+
+describe("buildContextSaveProps", () => {
+  // is_first_version is the negation of hasInstructions; success passes through
+  // independently. The table covers both inputs against both outcomes.
+  it.each([
+    { hasInstructions: false, success: true, is_first_version: true },
+    { hasInstructions: true, success: true, is_first_version: false },
+    { hasInstructions: false, success: false, is_first_version: true },
+    { hasInstructions: true, success: false, is_first_version: false },
+  ])(
+    "hasInstructions=$hasInstructions success=$success → is_first_version=$is_first_version",
+    ({ hasInstructions, success, is_first_version }) => {
+      expect(
+        buildContextSaveProps({ channelId: "c1", hasInstructions, success }),
+      ).toEqual({
+        action_type: "save_version",
+        channel_id: "c1",
+        is_first_version,
+        success,
+      });
+    },
+  );
+});

packages/core/src/canvas/canvasAnalytics.ts

@@ -0,0 +1,48 @@
+import type {
+  CanvasPromptSentProperties,
+  CanvasPromptSurface,
+  ContextActionProperties,
+} from "@posthog/shared/analytics-events";
+
+/** The dashboardId a canvas thread persists to ("dashboard:<id>" → "<id>"). */
+export function dashboardIdFromThread(threadId: string): string {
+  return threadId.replace(/^dashboard:/, "");
+}
+
+/**
+ * Build the properties for a `CANVAS_PROMPT_SENT` event. Resolves the
+ * dashboard id from the thread id, measures the prompt length, and folds in
+ * the suggestion / intent context.
+ */
+export function buildCanvasPromptProps(opts: {
+  surface: CanvasPromptSurface;
+  threadId: string;
+  text: string;
+  fromSuggestion: boolean;
+  intent?: "ask_agent_to_fix";
+}): CanvasPromptSentProperties {
+  return {
+    surface: opts.surface,
+    dashboard_id: dashboardIdFromThread(opts.threadId),
+    from_suggestion: opts.fromSuggestion,
+    prompt_length_chars: opts.text.length,
+    ...(opts.intent ? { intent: opts.intent } : {}),
+  };
+}
+
+/**
+ * Build the properties for a `save_version` `CONTEXT_ACTION` event. A channel
+ * with no published instructions yet is publishing its first version.
+ */
+export function buildContextSaveProps(opts: {
+  channelId: string;
+  hasInstructions: boolean;
+  success: boolean;
+}): ContextActionProperties {
+  return {
+    action_type: "save_version",
+    channel_id: opts.channelId,
+    is_first_version: !opts.hasInstructions,
+    success: opts.success,
+  };
+}

packages/shared/src/analytics-events.ts

@@ -211,6 +211,8 @@ export interface FolderRegisteredProperties {
 // Navigation events
 export interface CommandMenuActionProperties {
   action_type: CommandMenuAction;
+  /** Channel acted on for the bluebird `open-channel` / `open-task` actions. */
+  channel_id?: string;
 }
 
 export interface SkillButtonTriggeredProperties {
@@ -764,6 +766,119 @@ export interface AgentsActionProperties {
   success?: boolean;
 }
 
+// ── Project Bluebird / Channels (Website) space events ──
+
+/** Where within the Channels space an interaction originated. */
+export type ChannelsSurface =
+  | "header_button"
+  | "title_bar"
+  | "nav"
+  | "sidebar"
+  | "command_menu"
+  | "new_task"
+  | "dashboards_grid"
+  | "canvas"
+  | "context";
+
+export type ChannelActionType =
+  | "enter_space"
+  | "leave_space"
+  | "leave_feedback"
+  | "nav_click"
+  | "open_channel"
+  | "collapse_channel"
+  | "view_more_tasks"
+  | "create"
+  | "rename"
+  | "delete"
+  | "star"
+  | "unstar"
+  | "edit_context_open"
+  | "new_task_open"
+  | "new_task_suggestion"
+  | "file_task"
+  | "unfile_task"
+  | "archive_task"
+  | "open_task";
+
+export interface ChannelActionProperties {
+  action_type: ChannelActionType;
+  surface: ChannelsSurface;
+  /** The channel acted on, when one is in scope. */
+  channel_id?: string;
+  /** For file/unfile/archive/open task actions. */
+  task_id?: string;
+  /** For file_task: destination channel when different from `channel_id`. */
+  target_channel_id?: string;
+  /** For nav_click: which destination ("home"|"inbox"|"canvas"|"agents"|"files"|"settings"). */
+  nav_target?: string;
+  /** For new_task_suggestion: the starter-prompt card label. */
+  suggestion_label?: string;
+  /** Whether the underlying mutation resolved successfully. */
+  success?: boolean;
+}
+
+export type DashboardActionType =
+  | "open"
+  | "create"
+  | "delete"
+  | "save"
+  | "fork"
+  | "edit_toggle"
+  | "revert"
+  | "refresh"
+  | "poll_mode_change"
+  | "date_range_apply";
+
+export interface DashboardActionProperties {
+  action_type: DashboardActionType;
+  surface: ChannelsSurface;
+  channel_id?: string;
+  dashboard_id?: string;
+  /** The canvas render kind. */
+  kind?: "json-render" | "freeform";
+  /** Template chosen on create. */
+  template_id?: string;
+  /** edit_toggle: the state being entered. */
+  editing?: boolean;
+  /** poll_mode_change: the new value ("static"|"10s"|"10min"). */
+  poll_mode?: string;
+  /** date_range_apply: the named range, when not custom. */
+  range_name?: string;
+  /** Whether the underlying mutation resolved successfully. */
+  success?: boolean;
+}
+
+export type CanvasPromptSurface = "json" | "freeform";
+
+export interface CanvasPromptSentProperties {
+  surface: CanvasPromptSurface;
+  dashboard_id?: string;
+  /** True when sent via a suggestion chip rather than free-typed. */
+  from_suggestion: boolean;
+  /** "ask_agent_to_fix" for the freeform self-repair path; absent otherwise. */
+  intent?: "ask_agent_to_fix";
+  prompt_length_chars: number;
+}
+
+export type ContextActionType = "save_version" | "generate_started" | "discard";
+
+export interface ContextActionProperties {
+  action_type: ContextActionType;
+  channel_id: string;
+  /** generate_started only. */
+  execution_type?: "local" | "cloud";
+  /** save_version: whether this created the first version vs. an update. */
+  is_first_version?: boolean;
+  success?: boolean;
+}
+
+export interface ChannelsSpaceViewedProperties {
+  /** Total channels visible when the space mounts. */
+  channel_count: number;
+  starred_count: number;
+}
+
 // Subscription / billing events
 
 export type UpgradePromptShownSurface = "usage_limit_modal" | "upgrade_dialog";
@@ -936,6 +1051,13 @@ export const ANALYTICS_EVENTS = {
   CLOUD_TASK_USAGE_BLOCKED: "Cloud task usage blocked",
   SUBSCRIPTION_STARTED: "Subscription started",
   SUBSCRIPTION_CANCELLED: "Subscription cancelled",
+
+  // Project Bluebird (Channels) events
+  CHANNELS_SPACE_VIEWED: "Channels space viewed",
+  CHANNEL_ACTION: "Channel action",
+  DASHBOARD_ACTION: "Dashboard action",
+  CANVAS_PROMPT_SENT: "Canvas prompt sent",
+  CONTEXT_ACTION: "Context action",
 } as const;
 
 // Event property mapping
@@ -1071,4 +1193,11 @@ export type EventPropertyMap = {
   [ANALYTICS_EVENTS.CLOUD_TASK_USAGE_BLOCKED]: CloudTaskUsageBlockedProperties;
   [ANALYTICS_EVENTS.SUBSCRIPTION_STARTED]: SubscriptionStartedProperties;
   [ANALYTICS_EVENTS.SUBSCRIPTION_CANCELLED]: SubscriptionCancelledProperties;
+
+  // Project Bluebird (Channels) events
+  [ANALYTICS_EVENTS.CHANNELS_SPACE_VIEWED]: ChannelsSpaceViewedProperties;
+  [ANALYTICS_EVENTS.CHANNEL_ACTION]: ChannelActionProperties;
+  [ANALYTICS_EVENTS.DASHBOARD_ACTION]: DashboardActionProperties;
+  [ANALYTICS_EVENTS.CANVAS_PROMPT_SENT]: CanvasPromptSentProperties;
+  [ANALYTICS_EVENTS.CONTEXT_ACTION]: ContextActionProperties;
 };

packages/ui/src/features/canvas/components/CanvasChat.tsx

@@ -1,11 +1,15 @@
 import { isNonEmptySpec } from "@json-render/core";
 import { PaperPlaneRightIcon, SpinnerGapIcon } from "@phosphor-icons/react";
+import { buildCanvasPromptProps } from "@posthog/core/canvas/canvasAnalytics";
 import { Button } from "@posthog/quill";
+import { ANALYTICS_EVENTS } from "@posthog/shared/analytics-events";
 import { useCanvasTemplates } from "@posthog/ui/features/canvas/hooks/useCanvasTemplates";
+import { useFromSuggestion } from "@posthog/ui/features/canvas/hooks/useFromSuggestion";
 import {
   useCanvasChatStore,
   useCanvasThread,
 } from "@posthog/ui/features/canvas/stores/canvasChatStore";
+import { track } from "@posthog/ui/shell/analytics";
 import { Box, Flex, ScrollArea, Text, TextArea } from "@radix-ui/themes";
 import { useEffect, useRef, useState } from "react";
 
@@ -24,9 +28,11 @@ export function CanvasChat({ threadId }: { threadId: string }) {
   const [draft, setDraft] = useState("");
   const threadRef = useRef<HTMLDivElement>(null);
   const inputRef = useRef<HTMLTextAreaElement>(null);
+  const fromSuggestion = useFromSuggestion();
 
   // Drop a suggestion into the composer and focus it (ready to edit or send).
   const fillSuggestion = (text: string) => {
+    fromSuggestion.mark();
     setDraft(text);
     inputRef.current?.focus();
   };
@@ -40,6 +46,15 @@ export function CanvasChat({ threadId }: { threadId: string }) {
   const submit = () => {
     const text = draft.trim();
     if (!text || isStreaming) return;
+    track(
+      ANALYTICS_EVENTS.CANVAS_PROMPT_SENT,
+      buildCanvasPromptProps({
+        surface: "json",
+        threadId,
+        text,
+        fromSuggestion: fromSuggestion.consume(),
+      }),
+    );
     setDraft("");
     void send(threadId, text);
   };
@@ -133,7 +148,10 @@ export function CanvasChat({ threadId }: { threadId: string }) {
             className="flex-1"
             placeholder="Build a canvas of…"
             value={draft}
-            onChange={(e) => setDraft(e.target.value)}
+            onChange={(e) => {
+              fromSuggestion.clear();
+              setDraft(e.target.value);
+            }}
             onKeyDown={(e) => {
               if (e.key === "Enter" && !e.shiftKey) {
                 e.preventDefault();