From 3f261f0e5384a0e2b8ca35f6b2d3c13f27f95347 Mon Sep 17 00:00:00 2001
From: Chenlei Hu <huchenlei@proton.me>
Date: Sun, 12 Jan 2025 17:16:16 -0500
Subject: [PATCH] [Desktop] Add user journey events to the metrics collection
 list (UI) (#2237)

Co-authored-by: github-actions <github-actions@github.com>
---
 .../install/DesktopSettingsConfiguration.vue  | 49 ++++++++++++++-----
 src/extensions/core/electronAdapter.ts        |  2 +-
 src/locales/en/main.json                      | 25 ++++++----
 src/locales/en/settings.json                  |  2 +-
 src/locales/fr/main.json                      | 25 ++++++----
 src/locales/fr/settings.json                  |  2 +-
 src/locales/ja/main.json                      | 25 ++++++----
 src/locales/ja/settings.json                  |  2 +-
 src/locales/ko/main.json                      | 25 ++++++----
 src/locales/ko/settings.json                  |  2 +-
 src/locales/ru/main.json                      | 25 ++++++----
 src/locales/ru/settings.json                  |  2 +-
 src/locales/zh/main.json                      | 25 ++++++----
 src/locales/zh/settings.json                  |  2 +-
 14 files changed, 134 insertions(+), 79 deletions(-)

diff --git a/src/components/install/DesktopSettingsConfiguration.vue b/src/components/install/DesktopSettingsConfiguration.vue
index 9780a8ee9..73ee39a7b 100644
--- a/src/components/install/DesktopSettingsConfiguration.vue
+++ b/src/components/install/DesktopSettingsConfiguration.vue
@@ -59,10 +59,27 @@
         </h4>
         <ul class="list-disc pl-6 space-y-1">
           <li>
-            {{ $t('install.settings.dataCollectionDialog.errorReports') }}
+            {{
+              $t('install.settings.dataCollectionDialog.collect.errorReports')
+            }}
           </li>
           <li>
-            {{ $t('install.settings.dataCollectionDialog.systemInfo') }}
+            {{ $t('install.settings.dataCollectionDialog.collect.systemInfo') }}
+          </li>
+          <li>
+            {{
+              $t(
+                'install.settings.dataCollectionDialog.collect.userJourneyEvents'
+              )
+            }}
+            <span
+              class="pi pi-info-circle text-neutral-400"
+              v-tooltip="
+                $t(
+                  'install.settings.dataCollectionDialog.collect.userJourneyTooltip'
+                )
+              "
+            />
           </li>
         </ul>
 
@@ -72,21 +89,29 @@
         <ul class="list-disc pl-6 space-y-1">
           <li>
             {{
-              $t('install.settings.dataCollectionDialog.personalInformation')
-            }}
-          </li>
-          <li>
-            {{ $t('install.settings.dataCollectionDialog.workflowContents') }}
-          </li>
-          <li>
-            {{
-              $t('install.settings.dataCollectionDialog.fileSystemInformation')
+              $t(
+                'install.settings.dataCollectionDialog.doNotCollect.personalInformation'
+              )
             }}
           </li>
           <li>
             {{
               $t(
-                'install.settings.dataCollectionDialog.customNodeConfigurations'
+                'install.settings.dataCollectionDialog.doNotCollect.workflowContents'
+              )
+            }}
+          </li>
+          <li>
+            {{
+              $t(
+                'install.settings.dataCollectionDialog.doNotCollect.fileSystemInformation'
+              )
+            }}
+          </li>
+          <li>
+            {{
+              $t(
+                'install.settings.dataCollectionDialog.doNotCollect.customNodeConfigurations'
               )
             }}
           </li>
diff --git a/src/extensions/core/electronAdapter.ts b/src/extensions/core/electronAdapter.ts
index 8e1f8a257..294f17adf 100644
--- a/src/extensions/core/electronAdapter.ts
+++ b/src/extensions/core/electronAdapter.ts
@@ -30,7 +30,7 @@ import { electronAPI as getElectronAPI, isElectron } from '@/utils/envUtil'
       {
         id: 'Comfy-Desktop.SendStatistics',
         category: ['Comfy-Desktop', 'General', 'Send Statistics'],
-        name: 'Send anonymous crash reports',
+        name: 'Send anonymous usage metrics',
         type: 'boolean',
         defaultValue: true,
         onChange: onChangeRestartApp
diff --git a/src/locales/en/main.json b/src/locales/en/main.json
index 78708f576..8fd22e1e3 100644
--- a/src/locales/en/main.json
+++ b/src/locales/en/main.json
@@ -181,21 +181,26 @@
     },
     "settings": {
       "autoUpdate": "Automatic Updates",
-      "allowMetrics": "Crash Reports",
-      "autoUpdateDescription": "Automatically download and install updates when they become available. You'll always be notified before updates are installed.",
-      "allowMetricsDescription": "Help improve ComfyUI by sending anonymous crash reports. No personal information or workflow content will be collected. This can be disabled at any time in the settings menu.",
+      "allowMetrics": "Usage Metrics",
+      "autoUpdateDescription": "Automatically download updates when they become available. You will be notified before updates are installed.",
+      "allowMetricsDescription": "Help improve ComfyUI by sending anonymous usage metrics. No personal information or workflow content will be collected.",
       "learnMoreAboutData": "Learn more about data collection",
       "dataCollectionDialog": {
         "title": "About Data Collection",
         "whatWeCollect": "What we collect:",
         "whatWeDoNotCollect": "What we don't collect:",
-        "errorReports": "Error message and stack trace",
-        "systemInfo": "Hardware, OS type, and app version",
-        "personalInformation": "Personal information",
-        "workflowContent": "Workflow content",
-        "fileSystemInformation": "File system information",
-        "workflowContents": "Workflow contents",
-        "customNodeConfigurations": "Custom node configurations"
+        "collect": {
+          "errorReports": "Error message and stack trace",
+          "systemInfo": "Hardware, OS type, and app version",
+          "userJourneyEvents": "User journey events",
+          "userJourneyTooltip": "User journey events are used to track the user's journey through the app installation process. The event collection ends on the first successful ComfyUI workflow run."
+        },
+        "doNotCollect": {
+          "personalInformation": "Personal information",
+          "fileSystemInformation": "File system information",
+          "workflowContents": "Workflow contents",
+          "customNodeConfigurations": "Custom node configurations"
+        }
       }
     },
     "customNodes": "Custom Nodes",
diff --git a/src/locales/en/settings.json b/src/locales/en/settings.json
index 471e86678..4c7929cad 100644
--- a/src/locales/en/settings.json
+++ b/src/locales/en/settings.json
@@ -3,7 +3,7 @@
     "name": "Automatically check for updates"
   },
   "Comfy-Desktop_SendStatistics": {
-    "name": "Send anonymous crash reports"
+    "name": "Send anonymous usage metrics"
   },
   "Comfy-Desktop_WindowStyle": {
     "name": "Window Style",
diff --git a/src/locales/fr/main.json b/src/locales/fr/main.json
index 66c58091f..2c9f65efb 100644
--- a/src/locales/fr/main.json
+++ b/src/locales/fr/main.json
@@ -206,21 +206,26 @@
     "pathValidationFailed": "Échec de la validation du chemin",
     "selectItemsToMigrate": "Sélectionnez les éléments à migrer",
     "settings": {
-      "allowMetrics": "Rapports de plantage",
-      "allowMetricsDescription": "Aidez à améliorer ComfyUI en envoyant des rapports de plantage anonymes. Aucune information personnelle ou contenu de flux de travail ne sera collecté. Cela peut être désactivé à tout moment dans le menu des paramètres.",
+      "allowMetrics": "Métriques d'utilisation",
+      "allowMetricsDescription": "Aidez à améliorer ComfyUI en envoyant des métriques d'utilisation anonymes. Aucune information personnelle ou contenu de flux de travail ne sera collecté.",
       "autoUpdate": "Mises à jour automatiques",
       "autoUpdateDescription": "Téléchargez et installez automatiquement les mises à jour lorsqu'elles deviennent disponibles. Vous serez toujours informé avant l'installation des mises à jour.",
       "dataCollectionDialog": {
-        "customNodeConfigurations": "Configurations de nœuds personnalisés",
-        "errorReports": "Message d'erreur et trace de la pile",
-        "fileSystemInformation": "Informations sur le système de fichiers",
-        "personalInformation": "Informations personnelles",
-        "systemInfo": "Matériel, type d'OS et version de l'application",
+        "collect": {
+          "errorReports": "Message d'erreur et trace de la pile",
+          "systemInfo": "Matériel, type de système d'exploitation et version de l'application",
+          "userJourneyEvents": "Événements du parcours utilisateur",
+          "userJourneyTooltip": "Les événements du parcours utilisateur sont utilisés pour suivre le parcours de l'utilisateur lors du processus d'installation de l'application. La collecte d'événements se termine lors de la première exécution réussie du flux de travail ComfyUI."
+        },
+        "doNotCollect": {
+          "customNodeConfigurations": "Configurations de nœud personnalisées",
+          "fileSystemInformation": "Informations sur le système de fichiers",
+          "personalInformation": "Informations personnelles",
+          "workflowContents": "Contenus du flux de travail"
+        },
         "title": "À propos de la collecte de données",
         "whatWeCollect": "Ce que nous collectons :",
-        "whatWeDoNotCollect": "Ce que nous ne collectons pas :",
-        "workflowContent": "Contenu du flux de travail",
-        "workflowContents": "Contenus du flux de travail"
+        "whatWeDoNotCollect": "Ce que nous ne collectons pas :"
       },
       "learnMoreAboutData": "En savoir plus sur la collecte de données"
     },
diff --git a/src/locales/fr/settings.json b/src/locales/fr/settings.json
index 70ee739d6..bce7b6165 100644
--- a/src/locales/fr/settings.json
+++ b/src/locales/fr/settings.json
@@ -3,7 +3,7 @@
     "name": "Vérifier automatiquement les mises à jour"
   },
   "Comfy-Desktop_SendStatistics": {
-    "name": "Envoyer des rapports de plantage anonymes"
+    "name": "Envoyer des métriques d'utilisation anonymes"
   },
   "Comfy-Desktop_WindowStyle": {
     "name": "Style de fenêtre",
diff --git a/src/locales/ja/main.json b/src/locales/ja/main.json
index a9ad84652..f306ac551 100644
--- a/src/locales/ja/main.json
+++ b/src/locales/ja/main.json
@@ -206,21 +206,26 @@
     "pathValidationFailed": "パスの検証に失敗しました",
     "selectItemsToMigrate": "移行する項目を選択",
     "settings": {
-      "allowMetrics": "クラッシュレポート",
-      "allowMetricsDescription": "ComfyUIの改善に協力してください。匿名のクラッシュレポートを送信します。個人情報やワークフロー内容は収集されません。この設定はいつでも無効にできます。",
+      "allowMetrics": "使用状況のメトリクス",
+      "allowMetricsDescription": "匿名の使用状況メトリクスを送信してComfyUIを改善します。個人情報やワークフローの内容は収集されません。",
       "autoUpdate": "自動更新",
       "autoUpdateDescription": "更新が利用可能になると、自動的にダウンロードおよびインストールを行います。インストール前に通知が表示されます。",
       "dataCollectionDialog": {
-        "customNodeConfigurations": "カスタムノード設定",
-        "errorReports": "エラーメッセージとスタックトレース",
-        "fileSystemInformation": "ファイルシステム情報",
-        "personalInformation": "個人情報",
-        "systemInfo": "ハードウェア、OSの種類、アプリのバージョン",
+        "collect": {
+          "errorReports": "エラーメッセージとスタックトレース",
+          "systemInfo": "ハードウェア、OSタイプ、アプリバージョン",
+          "userJourneyEvents": "ユーザージャーニーイベント",
+          "userJourneyTooltip": "ユーザージャーニーイベントは、アプリのインストールプロセスを通じてユーザーの旅を追跡するために使用されます。イベントの収集は、最初の成功したComfyUIワークフローの実行で終了します。"
+        },
+        "doNotCollect": {
+          "customNodeConfigurations": "カスタムノードの設定",
+          "fileSystemInformation": "ファイルシステム情報",
+          "personalInformation": "個人情報",
+          "workflowContents": "ワークフローの内容"
+        },
         "title": "データ収集について",
         "whatWeCollect": "収集内容:",
-        "whatWeDoNotCollect": "収集しない内容:",
-        "workflowContent": "ワークフロー内容",
-        "workflowContents": "ワークフロー内容"
+        "whatWeDoNotCollect": "収集しない内容:"
       },
       "learnMoreAboutData": "データ収集の詳細を見る"
     },
diff --git a/src/locales/ja/settings.json b/src/locales/ja/settings.json
index 13e19a374..c24b1e4bf 100644
--- a/src/locales/ja/settings.json
+++ b/src/locales/ja/settings.json
@@ -3,7 +3,7 @@
     "name": "自動的に更新を確認する"
   },
   "Comfy-Desktop_SendStatistics": {
-    "name": "匿名のクラッシュレポートを送信する"
+    "name": "匿名の使用統計を送信する"
   },
   "Comfy-Desktop_WindowStyle": {
     "name": "ウィンドウスタイル",
diff --git a/src/locales/ko/main.json b/src/locales/ko/main.json
index 758f69b59..ec6b159d0 100644
--- a/src/locales/ko/main.json
+++ b/src/locales/ko/main.json
@@ -206,21 +206,26 @@
     "pathValidationFailed": "경로 유효성 검사 실패",
     "selectItemsToMigrate": "마이그레이션 항목 선택",
     "settings": {
-      "allowMetrics": "충돌 보고서",
-      "allowMetricsDescription": "익명의 충돌 보고서를 보내 ComfyUI 개선에 도움을 줍니다. 개인 정보나 워크플로 내용은 수집되지 않습니다. 이는 설정 메뉴에서 언제든지 비활성화할 수 있습니다.",
+      "allowMetrics": "사용 통계",
+      "allowMetricsDescription": "익명의 사용 통계를 보내 ComfyUI를 개선하는 데 도움을 줍니다. 개인 정보나 워크플로우 내용은 수집되지 않습니다.",
       "autoUpdate": "자동 업데이트",
       "autoUpdateDescription": "업데이트가 가능해지면 자동으로 다운로드하고 설치합니다. 업데이트가 설치되기 전에 항상 알림을 받습니다.",
       "dataCollectionDialog": {
-        "customNodeConfigurations": "사용자 정의 노드 설정",
-        "errorReports": "오류 메시지 및 스택 추적",
-        "fileSystemInformation": "파일 시스템 정보",
-        "personalInformation": "개인 정보",
-        "systemInfo": "하드웨어, OS 유형 및 앱 버전",
+        "collect": {
+          "errorReports": "오류 메시지 및 스택 추적",
+          "systemInfo": "하드웨어, OS 유형, 앱 버전",
+          "userJourneyEvents": "사용자 여정 이벤트",
+          "userJourneyTooltip": "사용자 여정 이벤트는 앱 설치 과정을 통한 사용자의 여정을 추적하는 데 사용됩니다. 이벤트 수집은 첫 번째 성공적인 ComfyUI 워크플로우 실행에서 종료됩니다."
+        },
+        "doNotCollect": {
+          "customNodeConfigurations": "사용자 정의 노드 구성",
+          "fileSystemInformation": "파일 시스템 정보",
+          "personalInformation": "개인 정보",
+          "workflowContents": "워크플로우 내용"
+        },
         "title": "데이터 수집 안내",
         "whatWeCollect": "수집하는 정보:",
-        "whatWeDoNotCollect": "수집하지 않는 정보:",
-        "workflowContent": "워크플로 내용",
-        "workflowContents": "워크플로 내용"
+        "whatWeDoNotCollect": "수집하지 않는 정보:"
       },
       "learnMoreAboutData": "데이터 수집에 대해 더 알아보기"
     },
diff --git a/src/locales/ko/settings.json b/src/locales/ko/settings.json
index be07e15ba..379214f3a 100644
--- a/src/locales/ko/settings.json
+++ b/src/locales/ko/settings.json
@@ -3,7 +3,7 @@
     "name": "자동 업데이트 확인"
   },
   "Comfy-Desktop_SendStatistics": {
-    "name": "익명으로 충돌 보고서 전송"
+    "name": "익명 사용 통계 보내기"
   },
   "Comfy-Desktop_WindowStyle": {
     "name": "창 스타일",
diff --git a/src/locales/ru/main.json b/src/locales/ru/main.json
index 817e250ca..704a05969 100644
--- a/src/locales/ru/main.json
+++ b/src/locales/ru/main.json
@@ -206,21 +206,26 @@
     "pathValidationFailed": "Не удалось проверить путь",
     "selectItemsToMigrate": "Выберите элементы для миграции",
     "settings": {
-      "allowMetrics": "Отчеты о сбоях",
-      "allowMetricsDescription": "Помогите улучшить ComfyUI, отправляя анонимные отчеты о сбоях. Личная информация или содержимое рабочего процесса не будут собираться. Это можно отключить в любое время в меню настроек.",
+      "allowMetrics": "Метрики использования",
+      "allowMetricsDescription": "Помогите улучшить ComfyUI, отправляя анонимные метрики использования. Личная информация или содержание рабочего процесса не будут собираться.",
       "autoUpdate": "Автоматические обновления",
       "autoUpdateDescription": "Автоматически загружать и устанавливать обновления, когда они становятся доступными. Вы всегда будете уведомлены перед установкой обновлений.",
       "dataCollectionDialog": {
-        "customNodeConfigurations": "Конфигурации пользовательских узлов",
-        "errorReports": "Сообщения об ошибках и трассировка стека",
-        "fileSystemInformation": "Информация о файловой системе",
-        "personalInformation": "Личная информация",
-        "systemInfo": "Аппаратное обеспечение, тип ОС и версия приложения",
+        "collect": {
+          "errorReports": "Сообщение об ошибке и трассировка стека",
+          "systemInfo": "Аппаратное обеспечение, тип ОС и версия приложения",
+          "userJourneyEvents": "События пользовательского пути",
+          "userJourneyTooltip": "События пользовательского пути используются для отслеживания пути пользователя в процессе установки приложения. Сбор событий заканчивается после первого успешного запуска рабочего процесса ComfyUI."
+        },
+        "doNotCollect": {
+          "customNodeConfigurations": "Пользовательские конфигурации узлов",
+          "fileSystemInformation": "Информация о файловой системе",
+          "personalInformation": "Личная информация",
+          "workflowContents": "Содержание рабочего процесса"
+        },
         "title": "О сборе данных",
         "whatWeCollect": "Что мы собираем:",
-        "whatWeDoNotCollect": "Что мы не собираем:",
-        "workflowContent": "Содержимое рабочего процесса",
-        "workflowContents": "Содержимое рабочего процесса"
+        "whatWeDoNotCollect": "Что мы не собираем:"
       },
       "learnMoreAboutData": "Узнать больше о сборе данных"
     },
diff --git a/src/locales/ru/settings.json b/src/locales/ru/settings.json
index bec2bf2a6..1e31db9a3 100644
--- a/src/locales/ru/settings.json
+++ b/src/locales/ru/settings.json
@@ -3,7 +3,7 @@
     "name": "Автоматически проверять обновления"
   },
   "Comfy-Desktop_SendStatistics": {
-    "name": "Отправлять анонимные отчеты о сбоях"
+    "name": "Отправлять анонимную статистику использования"
   },
   "Comfy-Desktop_WindowStyle": {
     "name": "Стиль окна",
diff --git a/src/locales/zh/main.json b/src/locales/zh/main.json
index d825748e1..670923791 100644
--- a/src/locales/zh/main.json
+++ b/src/locales/zh/main.json
@@ -206,21 +206,26 @@
     "pathValidationFailed": "路径验证失败",
     "selectItemsToMigrate": "选择要迁移的项目",
     "settings": {
-      "allowMetrics": "崩溃报告",
-      "allowMetricsDescription": "发送匿名崩溃报告帮助改善 ComfyUI。报告不会收集任何个人信息或工作流内容。您可以随时在设置菜单中禁用此功能。",
+      "allowMetrics": "使用情况指标",
+      "allowMetricsDescription": "通过发送匿名使用情况指标来帮助改进ComfyUI。不会收集任何个人信息或工作流内容。",
       "autoUpdate": "自动更新",
       "autoUpdateDescription": "更新可用时自动更新。您将在安装更新之前收到通知。",
       "dataCollectionDialog": {
-        "customNodeConfigurations": "自定义节点配置",
-        "errorReports": "错误信息和堆栈跟踪",
-        "fileSystemInformation": "文件系统信息",
-        "personalInformation": "个人信息",
-        "systemInfo": "硬件、操作系统类型和应用版本",
+        "collect": {
+          "errorReports": "错误报告和堆栈跟踪",
+          "systemInfo": "硬件，操作系统类型和应用版本",
+          "userJourneyEvents": "用户旅程事件",
+          "userJourneyTooltip": "用户旅程事件用于跟踪用户通过应用安装过程的旅程。事件收集在第一次成功运行ComfyUI工作流后结束。"
+        },
+        "doNotCollect": {
+          "customNodeConfigurations": "自定义节点配置",
+          "fileSystemInformation": "文件系统信息",
+          "personalInformation": "个人信息",
+          "workflowContents": "工作流内容"
+        },
         "title": "关于数据收集",
         "whatWeCollect": "我们收集的内容：",
-        "whatWeDoNotCollect": "我们不收集的内容：",
-        "workflowContent": "工作流内容",
-        "workflowContents": "工作流内容"
+        "whatWeDoNotCollect": "我们不收集的内容："
       },
       "learnMoreAboutData": "了解更多关于数据收集的信息"
     },
diff --git a/src/locales/zh/settings.json b/src/locales/zh/settings.json
index 983ff0250..e34173e0a 100644
--- a/src/locales/zh/settings.json
+++ b/src/locales/zh/settings.json
@@ -3,7 +3,7 @@
     "name": "自动检查更新"
   },
   "Comfy-Desktop_SendStatistics": {
-    "name": "发送匿名崩溃报告"
+    "name": "发送匿名使用情况统计"
   },
   "Comfy-Desktop_WindowStyle": {
     "name": "窗口样式",