Merge pull request #6496 from remix-project-org/matamo_ai_update

rm RemixAIEvent in matamo types

Author: STetsing

apps/remix-ide/src/app/plugins/remix-ai-assistant.tsx

@@ -104,7 +104,7 @@ export class RemixAIAssistant extends ViewPlugin {
   async handleActivity(type: string, payload: any) {
     // Never log user prompts - only track the activity type
     const eventName = type === 'promptSend' ? 'remixai-assistant-promptSend' : `remixai-assistant-${type}-${payload}`;
-    trackMatomoEvent(this, { category: 'ai', action: 'remixAI', name: eventName as any, isClick: true })
+    trackMatomoEvent(this, { category: 'ai', action: 'chatting', name: `${type}-${payload}`, isClick: true })
   }
 
   updateComponent(state: {

apps/remix-ide/src/app/plugins/remixAIPlugin.tsx

@@ -195,7 +195,7 @@ export class RemixAIPlugin extends Plugin {
     params.threadId = newThreadID
     params.provider = 'anthropic' // enforce all generation to be only on anthropic
     useRag = false
-    trackMatomoEvent(this, { category: 'ai', action: 'remixAI', name: 'GenerateNewAIWorkspace', isClick: false })
+    trackMatomoEvent(this, { category: 'ai', action: 'GenerateNewAIWorkspace', name: 'GenerateNewAIWorkspace', isClick: false })
     let userPrompt = ''
 
     if (useRag) {
@@ -239,7 +239,7 @@ export class RemixAIPlugin extends Plugin {
     params.threadId = newThreadID
     params.provider = this.assistantProvider
     useRag = false
-    trackMatomoEvent(this, { category: 'ai', action: 'remixAI', name: 'WorkspaceAgentEdit', isClick: false })
+    trackMatomoEvent(this, { category: 'ai', action: 'GenerateNewAIWorkspace', name: 'WorkspaceAgentEdit', isClick: false })
 
     await statusCallback?.('Performing workspace request...')
     if (useRag) {
@@ -310,7 +310,7 @@ export class RemixAIPlugin extends Plugin {
     else {
       console.log("chatRequestBuffer is not empty. First process the last request.", this.chatRequestBuffer)
     }
-    trackMatomoEvent(this, { category: 'ai', action: 'remixAI', name: 'remixAI_chat', isClick: false })
+    trackMatomoEvent(this, { category: 'ai', action: 'chatting', name: 'remixAI_chat', isClick: false })
   }
 
   async ProcessChatRequestBuffer(params:IParams=GenerationParams){

libs/remix-api/src/lib/plugins/matomo/events/ai-events.ts

@@ -1,6 +1,6 @@
 /**
  * AI Events - AI and Copilot related tracking events
- * 
+ *
  * This file contains all AI-related Matomo events including RemixAI interactions,
  * Ollama local AI, and code completion features.
  * 
@@ -14,9 +14,12 @@ import { MatomoEventBase } from '../core/base-types';
 
 export interface AIEvent extends MatomoEventBase {
   category: 'ai';
-  action: 'remixAI';
-  name:
-    // Code completion & generation
+  action:
+    | 'remixAI'
+    | 'error_explaining_SolidityError'
+    | 'vulnerability_check_pasted_code'
+    | 'generateDocumentation'
+    | 'explainFunction'
     | 'Copilot_Completion_Accepted'
     | 'code_generation'
     | 'code_insertion'
@@ -33,17 +36,9 @@ export interface AIEvent extends MatomoEventBase {
     | 'error_explaining_SolidityError'
     // AI Context
     | 'AddingAIContext'
-    // RemixAI workspace & chat
     | 'GenerateNewAIWorkspace'
-    | 'WorkspaceAgentEdit'
-    | 'remixAI_chat'
-    | 'GenerateNewAIWorkspaceFromEditMode'
-    | 'GenerateNewAIWorkspaceFromModal'
-    // AI Provider selection
-    | 'SetAIProvider'
-    | 'SetOllamaModel'
-    | 'ModeSwitch'
-    // Ollama host discovery
+    | 'chatting'
+    | 'completion'
     | 'ollama_host_cache_hit'
     | 'ollama_port_check'
     | 'ollama_host_discovered_success'
@@ -91,18 +86,9 @@ export interface AIEvent extends MatomoEventBase {
     | 'ollama_fallback_to_provider'
     | 'ollama_unavailable'
     | 'ollama_connection_error'
-    // Assistant feedback (kebab-case to match original)
-    | 'like-response'
-    | 'dislike-response';
-}
-
-/**
- * @deprecated Use AIEvent with category: 'ai', action: 'remixAI' instead
- * This interface is kept for backward compatibility during migration
- */
-export interface RemixAIEvent extends MatomoEventBase {
-  category: 'remixAI';
-  action:
+    | 'ollama_model_selected'
+    | 'ollama_model_set_backend_success'
+    | 'ollama_model_set_backend_failed'
     | 'ModeSwitch'
     | 'GenerateNewAIWorkspaceFromEditMode'
     | 'SetAIProvider'

libs/remix-api/src/lib/plugins/matomo/index.ts

@@ -1,13 +1,13 @@
 /**
  * Matomo Events - Modular Event System
- * 
+ *
  * This is the main index for the split Matomo event system. 
  * It re-exports all events to maintain backward compatibility while 
  * organizing the code into manageable modules.
- * 
+ *
  * Usage:
  *   import { trackMatomoEvent } from '@remix-api'
- *   
+ *
  *   trackMatomoEvent(plugin, { category: 'ai', action: 'remixAI', name: 'code_generation', isClick: true })
  *   trackMatomoEvent(plugin, { category: 'git', action: 'COMMIT', name: 'success', isClick: true })
  */
@@ -18,7 +18,7 @@ export * from './core/categories';
 
 // Event modules - organized by domain
 export * from './events/ai-events';
-export * from './events/compiler-events'; 
+export * from './events/compiler-events';
 export * from './events/git-events';
 export * from './events/ui-events';
 export * from './events/file-events';
@@ -27,7 +27,7 @@ export * from './events/plugin-events';
 export * from './events/tools-events';
 
 // Import types for union
-import type { AIEvent, RemixAIEvent, RemixAIAssistantEvent } from './events/ai-events';
+import type { AIEvent, RemixAIAssistantEvent } from './events/ai-events';
 import type { CompilerEvent, SolidityCompilerEvent, CompilerContainerEvent } from './events/compiler-events';
 import type { GitEvent } from './events/git-events';
 import type { HomeTabEvent, TopbarEvent, LayoutEvent, SettingsEvent, ThemeEvent, LocaleEvent, LandingPageEvent, StatusBarEvent } from './events/ui-events';
@@ -40,17 +40,16 @@ import type { DebuggerEvent, EditorEvent, SolidityUnitTestingEvent, SolidityStat
 export type MatomoEvent = (
   // AI & Assistant events
   | AIEvent
-  | RemixAIEvent
   | RemixAIAssistantEvent
-  
+
   // Compilation events
   | CompilerEvent
   | SolidityCompilerEvent
   | CompilerContainerEvent
-  
+
   // Version Control events
   | GitEvent
-  
+
   // User Interface events
   | HomeTabEvent
   | TopbarEvent
@@ -66,12 +65,12 @@ export type MatomoEvent = (
   | WorkspaceEvent
   | StorageEvent
   | BackupEvent
-  
+
   // Blockchain & Contract events
   | BlockchainEvent
   | UdappEvent
   | RunEvent
-  
+
   // Plugin Management events
   | PluginEvent
   | ManagerEvent
@@ -80,7 +79,7 @@ export type MatomoEvent = (
   | MatomoManagerEvent
   | PluginPanelEvent
   | MigrateEvent
-  
+
   // Development Tools events
   | DebuggerEvent
   | EditorEvent
@@ -99,7 +98,7 @@ export type MatomoEvent = (
   | NoirCompilerEvent
   | ContractVerificationEvent
   | LearnethEvent
-  
+
 ) & {
   // Ensure all events have these base properties for backward compatibility
   name?: string;

libs/remix-ui/editor/src/lib/providers/inlineCompletionProvider.ts

@@ -307,7 +307,7 @@ export class RemixInLineCompletionProvider implements monacoTypes.languages.Inli
     this.currentCompletion.task = this.task
 
     this.rateLimiter.trackCompletionShown()
-    this.trackMatomoEvent?.({ category: 'ai', action: 'remixAI', name: `${this.task}_did_show` as any, isClick: true })
+    this.trackMatomoEvent?.({ category: 'ai', action: 'completion', name: this.task + '_did_show', isClick: true })
   }
 
   handlePartialAccept?(
@@ -319,7 +319,7 @@ export class RemixInLineCompletionProvider implements monacoTypes.languages.Inli
     this.currentCompletion.task = this.task
 
     this.rateLimiter.trackCompletionAccepted()
-    this.trackMatomoEvent?.({ category: 'ai', action: 'remixAI', name: `${this.task}_partial_accept` as any, isClick: true })
+    this.trackMatomoEvent?.({ category: 'ai', action: 'completion', name: this.task + '_partial_accept', isClick: true })
   }
 
   freeInlineCompletions(

libs/remix-ui/remix-ai-assistant/src/components/prompt.tsx

@@ -4,7 +4,7 @@ import GroupListMenu from "./contextOptMenu"
 import { AiContextType, groupListType } from '../types/componentTypes'
 import { AiAssistantType } from '../types/componentTypes'
 import { CustomTooltip } from "@remix-ui/helper"
-import { RemixAIEvent, MatomoEvent } from '@remix-api';
+import { AIEvent, MatomoEvent } from '@remix-api';
 import { TrackingContext } from '@remix-ide/tracking'
 
 // PromptArea component
@@ -84,7 +84,7 @@ export const PromptArea: React.FC<PromptAreaProps> = ({
   setIsMaximized
 }) => {
   const { trackMatomoEvent: baseTrackEvent } = useContext(TrackingContext)
-  const trackMatomoEvent = <T extends MatomoEvent = RemixAIEvent>(event: T) => {
+  const trackMatomoEvent = <T extends MatomoEvent = AIEvent>(event: T) => {
     baseTrackEvent?.<T>(event)
   }
 
@@ -129,7 +129,7 @@ export const PromptArea: React.FC<PromptAreaProps> = ({
                 className={`btn btn-sm ${aiMode === 'ask' ? 'btn-primary' : 'btn-outline-secondary'} px-2`}
                 onClick={() => {
                   setAiMode('ask')
-                  trackMatomoEvent({ category: 'ai', action: 'remixAI', name: 'ModeSwitch', value: 'ask', isClick: true })
+                  trackMatomoEvent({ category: 'ai', action: 'ModeSwitch', name: 'ask', isClick: true })
                 }}
                 title="Ask mode - Chat with AI"
               >
@@ -140,7 +140,7 @@ export const PromptArea: React.FC<PromptAreaProps> = ({
                 className={`btn btn-sm ${aiMode === 'edit' ? 'btn-primary' : 'btn-outline-secondary'} px-2`}
                 onClick={() => {
                   setAiMode('edit')
-                  trackMatomoEvent({ category: 'ai', action: 'remixAI', name: 'ModeSwitch', value: 'edit', isClick: true })
+                  trackMatomoEvent({ category: 'ai', action: 'ModeSwitch', name: 'edit', isClick: true })
                 }}
                 title="Edit mode - Edit workspace code"
               >

libs/remix-ui/remix-ai-assistant/src/components/remix-ui-remix-ai-assistant.tsx

@@ -6,7 +6,7 @@ import { HandleOpenAIResponse, HandleMistralAIResponse, HandleAnthropicResponse,
 import '../css/color.css'
 import { Plugin } from '@remixproject/engine'
 import { ModalTypes } from '@remix-ui/app'
-import { MatomoEvent, AIEvent, RemixAIEvent, RemixAIAssistantEvent } from '@remix-api'
+import { MatomoEvent, AIEvent, RemixAIAssistantEvent } from '@remix-api'
 import { TrackingContext } from '@remix-ide/tracking'
 import { PromptArea } from './prompt'
 import { ChatHistoryComponent } from './chat'
@@ -449,7 +449,7 @@ export const RemixUiRemixAiAssistant = React.forwardRef<
     dispatchActivity('button', 'generateWorkspace')
     if (prompt && prompt.trim()) {
       await sendPrompt(`/workspace ${prompt.trim()}`)
-      trackMatomoEvent<AIEvent>({ category: 'ai', action: 'remixAI', name: 'GenerateNewAIWorkspaceFromEditMode', value: prompt, isClick: true })
+      trackMatomoEvent<AIEvent>({ category: 'ai', action: 'GenerateNewAIWorkspaceFromEditMode', name: prompt, isClick: true })
     }
   }, [sendPrompt])
 
@@ -486,7 +486,7 @@ export const RemixUiRemixAiAssistant = React.forwardRef<
           dispatchActivity('button', 'setAssistant')
           setMessages([])
           sendPrompt(`/setAssistant ${assistantChoice}`)
-          trackMatomoEvent<AIEvent>({ category: 'ai', action: 'remixAI', name: 'SetAIProvider', value: assistantChoice, isClick: true })
+          trackMatomoEvent<AIEvent>({ category: 'ai', action: 'SetAIProvider', name: assistantChoice, isClick: true })
           // Log specific Ollama selection
           if (assistantChoice === 'ollama') {
             trackMatomoEvent({ category: 'ai', action: 'remixAI', name: 'ollama_provider_selected', value: `from:${choiceSetting || 'unknown'}`, isClick: false })
@@ -605,7 +605,7 @@ export const RemixUiRemixAiAssistant = React.forwardRef<
       console.warn('Failed to set model:', error)
       trackMatomoEvent({ category: 'ai', action: 'remixAI', name: 'ollama_model_set_backend_failed', value: `${modelName}|${error.message || 'unknown'}`, isClick: false })
     }
-    trackMatomoEvent<AIEvent>({ category: 'ai', action: 'remixAI', name: 'SetOllamaModel', value: modelName, isClick: true })
+    trackMatomoEvent<AIEvent>({ category: 'ai', action: 'SetOllamaModel', name: modelName, isClick: true })
   }, [props.plugin, selectedModel])
 
   // refresh context whenever selection changes (even if selector is closed)
@@ -654,7 +654,7 @@ export const RemixUiRemixAiAssistant = React.forwardRef<
 
       if (description && description.trim()) {
         sendPrompt(`/generate ${description.trim()}`)
-        trackMatomoEvent<AIEvent>({ category: 'ai', action: 'remixAI', name: 'GenerateNewAIWorkspaceFromModal', value: description, isClick: true })
+        trackMatomoEvent<AIEvent>({ category: 'ai', action: 'GenerateNewAIWorkspaceFromModal', name: description, isClick: true })
       }
     } catch {
       /* user cancelled */