Merge pull request #296 from shopware/feat/telemetry

Add anonymous feature usage telemetry

Author: shyim

src/main/kotlin/de/shyim/shopware6/action/context/InsertSnippetAction.kt

@@ -13,6 +13,7 @@ import com.intellij.ui.components.JBList
 import com.jetbrains.php.lang.psi.PhpFile
 import com.jetbrains.twig.TwigFile
 import de.shyim.shopware6.completion.SnippetCompletionElement
+import de.shyim.shopware6.telemetry.TelemetryClient
 import de.shyim.shopware6.util.AdminSnippetUtil
 import de.shyim.shopware6.util.FrontendSnippetUtil
 import icons.ShopwareToolBoxIcons
@@ -25,6 +26,8 @@ class InsertSnippetAction : DumbAwareAction("Insert Snippet", "Insert snippet co
         val pf: PsiFile = LangDataKeys.PSI_FILE.getData(e.dataContext) ?: return
         val editor = LangDataKeys.EDITOR.getData(e.dataContext) ?: return
 
+        val startedAt = System.currentTimeMillis()
+
         val items: MutableList<SnippetCompletionElement> = if (pf.virtualFile.path.contains("app/administration")) {
             AdminSnippetUtil.getAllEnglishKeys(pf.project)
         } else {
@@ -76,6 +79,8 @@ class InsertSnippetAction : DumbAwareAction("Insert Snippet", "Insert snippet co
                             )
                     }, "Insert Snippet", null)
                 }
+
+                TelemetryClient.trackFeature(pf.project, "snippet.insert", startedAt)
             })
             .createPopup()
             .showInBestPositionFor(e.dataContext)

src/main/kotlin/de/shyim/shopware6/action/context/admin/ExtendAdminComponentAction.kt

@@ -23,6 +23,7 @@ import com.intellij.ui.components.JBList
 import de.shyim.shopware6.action.generator.ActionUtil
 import de.shyim.shopware6.action.generic.GenericSimpleDialogWrapper
 import de.shyim.shopware6.index.dict.ShopwareBundle
+import de.shyim.shopware6.telemetry.TelemetryClient
 import de.shyim.shopware6.templates.ShopwareTemplates
 import de.shyim.shopware6.util.JavaScriptPattern
 import de.shyim.shopware6.util.PsiUtil
@@ -154,6 +155,8 @@ class ExtendAdminComponentAction : DumbAwareAction(
             project: Project,
             runnable: (String) -> Unit
         ) {
+            val startedAt = System.currentTimeMillis()
+
             val newComponentName: String
             val defaultFilePath = if (type == "override") {
                 newComponentName = componentName
@@ -214,6 +217,8 @@ class ExtendAdminComponentAction : DumbAwareAction(
 
             if (file != null) {
                 runnable(file.virtualFile.path)
+
+                TelemetryClient.trackFeature(project, "admin.extend_component.$type", startedAt)
             }
 
             val entryPoint = LocalFileSystem.getInstance().findFileByPath(bundle.getAdministrationEntrypoint())!!

src/main/kotlin/de/shyim/shopware6/action/context/admin/ExtendAdminComponentMethodAction.kt

@@ -23,6 +23,7 @@ import com.intellij.ui.components.JBList
 import com.intellij.util.containers.filterSmartMutable
 import de.shyim.shopware6.index.dict.AdminComponent
 import de.shyim.shopware6.index.dict.ShopwareBundle
+import de.shyim.shopware6.telemetry.TelemetryClient
 import de.shyim.shopware6.util.ShopwareBundleUtil
 import de.shyim.shopware6.util.StringUtil
 import icons.ShopwareToolBoxIcons
@@ -83,6 +84,8 @@ class ExtendAdminComponentMethodAction :
         private const val NEW_COMPONENT = "Create new component"
 
         fun extendMethod(element: PsiElement, editor: Editor) {
+            val startedAt = System.currentTimeMillis()
+
             val componentName = getComponentName(element)
 
             val popup = ShopwareBundleUtil.getBundleSelectionPopup(element.project)
@@ -130,9 +133,13 @@ class ExtendAdminComponentMethodAction :
                                 bundle
                             ) {
                                 addMethodToComponent(element, it)
+
+                                TelemetryClient.trackFeature(element.project, "admin.extend_method", startedAt)
                             }
                         } else {
                             addMethodToComponent(element, component.file)
+
+                            TelemetryClient.trackFeature(element.project, "admin.extend_method", startedAt)
                         }
                     }
 

src/main/kotlin/de/shyim/shopware6/action/copy/CopySnippet.kt

@@ -10,6 +10,7 @@ import com.intellij.openapi.ui.popup.PopupChooserBuilder
 import com.intellij.psi.PsiElement
 import com.intellij.psi.PsiFile
 import com.intellij.ui.components.JBList
+import de.shyim.shopware6.telemetry.TelemetryClient
 import icons.ShopwareToolBoxIcons
 import java.awt.Toolkit
 import java.awt.datatransfer.StringSelection
@@ -20,6 +21,8 @@ class CopySnippet : DumbAwareAction("Copy Snippet Code", "Copy the snippet code"
         val editor = LangDataKeys.EDITOR.getData(e.dataContext) ?: return
         val pe = pf.findElementAt(editor.caretModel.offset) ?: return
 
+        val startedAt = System.currentTimeMillis()
+
         val key = resolveKey(pe)
         val collectionList: MutableCollection<String> = mutableListOf()
         collectionList.add("Admin Twig")
@@ -45,6 +48,8 @@ class CopySnippet : DumbAwareAction("Copy Snippet Code", "Copy the snippet code"
                         StringSelection(code),
                         null
                     )
+
+                TelemetryClient.trackFeature(pf.project, "snippet.copy", startedAt)
             })
             .createPopup()
             .showInBestPositionFor(editor)

src/main/kotlin/de/shyim/shopware6/action/generator/NewConfigXmlAction.kt

@@ -6,11 +6,14 @@ import com.intellij.openapi.actionSystem.AnActionEvent
 import com.intellij.openapi.actionSystem.PlatformDataKeys
 import com.intellij.openapi.project.DumbAwareAction
 import com.intellij.openapi.project.Project
+import de.shyim.shopware6.telemetry.TelemetryClient
 import de.shyim.shopware6.templates.ShopwareTemplates
 
 class NewConfigXmlAction : DumbAwareAction("Create a Config.Xml", "Create a new config.xml", AllIcons.FileTypes.Xml) {
 
     override fun actionPerformed(e: AnActionEvent) {
+        val startedAt = System.currentTimeMillis()
+
         val project: Project? = e.getData(PlatformDataKeys.PROJECT)
 
         if (project === null) {
@@ -24,6 +27,8 @@ class NewConfigXmlAction : DumbAwareAction("Create a Config.Xml", "Create a new
             "config.xml",
             XmlFileType.INSTANCE
         )
+
+        TelemetryClient.trackFeature(project, "generator.config_xml", startedAt)
     }
 
 }

src/main/kotlin/de/shyim/shopware6/action/generator/app/AddCmsActions.kt

@@ -7,6 +7,7 @@ class AddCmsActions : AddConfigFileAction(
     "cms.xml",
     "Resources",
     ShopwareTemplates.SHOPWARE_APP_CMS,
+    "generator.app_cms_blocks",
     "Add CMS blocks",
     "Add CMS blocks to an app",
     ShopwareToolBoxIcons.SHOPWARE

src/main/kotlin/de/shyim/shopware6/action/generator/app/AddConfigFileAction.kt

@@ -14,6 +14,7 @@ import com.intellij.psi.PsiManager
 import com.intellij.ui.components.JBList
 import de.shyim.shopware6.action.generator.ActionUtil
 import de.shyim.shopware6.index.dict.ShopwareApp
+import de.shyim.shopware6.telemetry.TelemetryClient
 import de.shyim.shopware6.templates.ShopwareTemplates
 import de.shyim.shopware6.util.ShopwareAppUtil
 import java.awt.Component
@@ -25,6 +26,7 @@ abstract class AddConfigFileAction(
     private val configFileName: String,
     private val configFilePath: String,
     private val shopwareTemplate: String,
+    private val telemetryFeature: String,
     text: String,
     description: String,
     icon: Icon
@@ -40,15 +42,17 @@ abstract class AddConfigFileAction(
             e.project!!,
             this.configFileName,
             this.configFilePath,
-            this.shopwareTemplate
+            this.shopwareTemplate,
+            System.currentTimeMillis()
         )
     }
 
     private fun chooseAppAndCreateConfigFileFromTemplate(
         project: Project,
         configFile: String,
         configFilePath: String,
-        shopwareTemplate: String
+        shopwareTemplate: String,
+        startedAt: Long
     ) {
         val apps = ShopwareAppUtil.getAllApps(project)
         val jbAppList = JBList(apps)
@@ -100,6 +104,8 @@ abstract class AddConfigFileAction(
 
                     FileEditorManager.getInstance(project)
                         .openTextEditor(OpenFileDescriptor(project, createdConfigFile.virtualFile), true)
+
+                    TelemetryClient.trackFeature(project, telemetryFeature, startedAt)
                 }, "Creating Config File", null)
             })
             .createPopup()

src/main/kotlin/de/shyim/shopware6/action/generator/app/AddCustomEntitiesAction.kt

@@ -7,6 +7,7 @@ class AddCustomEntitiesAction : AddConfigFileAction(
     "entities.xml",
     "Resources",
     ShopwareTemplates.SHOPWARE_APP_CUSTOM_ENTITIES,
+    "generator.app_custom_entities",
     "Add Custom Entities",
     "Add custom entities to an app",
     ShopwareToolBoxIcons.SHOPWARE

src/main/kotlin/de/shyim/shopware6/action/generator/app/NewAppAction.kt

@@ -5,6 +5,7 @@ import com.intellij.openapi.actionSystem.AnActionEvent
 import com.intellij.openapi.project.DumbAwareAction
 import com.intellij.openapi.ui.Messages
 import de.shyim.shopware6.action.generator.ActionUtil
+import de.shyim.shopware6.telemetry.TelemetryClient
 import de.shyim.shopware6.templates.ShopwareTemplates
 import icons.ShopwareToolBoxIcons
 
@@ -14,6 +15,8 @@ class NewAppAction : DumbAwareAction("Create an App", "Create a new Shopware app
             return
         }
 
+        val startedAt = System.currentTimeMillis()
+
         val rootDirectory = ActionUtil.getViewDirectory(e.dataContext) ?: return
 
         val wrapper = NewAppDialogWrapper()
@@ -40,5 +43,7 @@ class NewAppAction : DumbAwareAction("Create an App", "Create a new Shopware app
             content,
             appFolder
         )
+
+        TelemetryClient.trackFeature(e.project, "generator.app", startedAt)
     }
 }

src/main/kotlin/de/shyim/shopware6/action/generator/app/NewAppScriptAction.kt

@@ -13,6 +13,7 @@ import com.jetbrains.twig.TwigFileType
 import de.shyim.shopware6.action.generator.ActionUtil
 import de.shyim.shopware6.index.dict.ScriptHook
 import de.shyim.shopware6.index.dict.ShopwareApp
+import de.shyim.shopware6.telemetry.TelemetryClient
 import de.shyim.shopware6.templates.ShopwareTemplates
 import de.shyim.shopware6.util.PsiUtil
 import de.shyim.shopware6.util.ScriptHookUtil
@@ -29,6 +30,8 @@ class NewAppScriptAction :
             return
         }
 
+        val startedAt = System.currentTimeMillis()
+
         val hooks = ScriptHookUtil.getAllHooks(e.project!!)
 
         val jbHookList = JBList(hooks.sortedBy { it.name })
@@ -57,13 +60,13 @@ class NewAppScriptAction :
                 return@setFilteringEnabled (it as ScriptHook).name
             }
             .setItemChosenCallback(Runnable {
-                this.chooseApp(jbHookList.selectedValue!!, e.project!!)
+                this.chooseApp(jbHookList.selectedValue!!, e.project!!, startedAt)
             })
             .createPopup()
             .showInFocusCenter()
     }
 
-    private fun chooseApp(scriptHook: ScriptHook, project: Project) {
+    private fun chooseApp(scriptHook: ScriptHook, project: Project, startedAt: Long) {
         val apps = ShopwareAppUtil.getAllApps(project)
         val jbAppList = JBList(apps)
 
@@ -89,15 +92,15 @@ class NewAppScriptAction :
             .setTitle("Shopware: Select App")
             .setItemChosenCallback(Runnable {
                 CommandProcessor.getInstance().executeCommand(project, {
-                    this.createFile(jbAppList.selectedValue, scriptHook, project)
+                    this.createFile(jbAppList.selectedValue, scriptHook, project, startedAt)
 
                 }, "Create Hook", null)
             })
             .createPopup()
             .showInFocusCenter()
     }
 
-    private fun createFile(app: ShopwareApp, scriptHook: ScriptHook, project: Project) {
+    private fun createFile(app: ShopwareApp, scriptHook: ScriptHook, project: Project, startedAt: Long) {
         val localFolder = LocalFileSystem.getInstance().findFileByPath(app.rootFolder)
         val psiDir = PsiManager.getInstance(project).findDirectory(localFolder!!) as PsiDirectory
 
@@ -118,5 +121,7 @@ class NewAppScriptAction :
             ),
             scriptsDir
         ) ?: return
+
+        TelemetryClient.trackFeature(project, "generator.app_script", startedAt)
     }
 }