Deprecate SetUpAction

atlassian · Jun 17, 2024 · 5e69deb · 5e69deb
1 parent a403ec3
commit 5e69deb
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -29,6 +29,10 @@ Dropping a requirement of a major version of a dependency is a new contract.
 ### Added
 - Split `SetUpAction` into `DisableRichTextEditor` and `HideHealthNotifications`.
 
+### Deprecated
+- Deprecate `SetUpAction` and `SET_UP`. It's too vague to interpret and track performance changes.
+  Use specific UXes instead, like `DisableRichTextEditor` or `HideHealthNotifications`.
+
 ### Fixed
 - Stop disabling Rich Text Editor by default in `Scenario`. RTE is supported since [3.5.0].
 

diff --git a/src/main/kotlin/com/atlassian/performance/tools/jiraactions/api/ActionType.kt b/src/main/kotlin/com/atlassian/performance/tools/jiraactions/api/ActionType.kt
@@ -48,8 +48,9 @@ data class ActionType<out T>(
 @JvmField val VIEW_DASHBOARD = ActionType("View Dashboard") { Unit }
 @JvmField val VIEW_BOARD = ActionType("View Board") { IssuesOnBoard(it) }
 @JvmField val LOG_IN = ActionType("Log In") { Unit }
+@Deprecated("Use [HIDE_HEALTH_NOTIFICATIONS] and/or [DISABLE_RICH_TEXT_EDITOR] for fine-grained measurement. When you hear 'Set Up' takes 20 seconds, it's not clear what is really involved or what the UX is.")
 @JvmField val SET_UP = ActionType("Set Up") { Unit }
-@JvmField val DISABLE_RTE = ActionType("Disable Rich Text Editor") { Unit }
+@JvmField val DISABLE_RICH_TEXT_EDITOR = ActionType("Disable Rich Text Editor") { Unit }
 @JvmField val HIDE_HEALTH_NOTIFICATIONS = ActionType("Hide Instance Health Notifications") { Unit }
 @JvmField val VIEW_COMMENT = ActionType("View Comment") { Unit }
 @JvmField val VIEW_HISTORY_TAB = ActionType("View History Tab") { IssueObservation(it) }
diff --git a/...in/kotlin/com/atlassian/performance/tools/jiraactions/api/action/DisableRichTextEditor.kt b/...in/kotlin/com/atlassian/performance/tools/jiraactions/api/action/DisableRichTextEditor.kt
@@ -1,6 +1,6 @@
 package com.atlassian.performance.tools.jiraactions.api.action
 
-import com.atlassian.performance.tools.jiraactions.api.DISABLE_RTE
+import com.atlassian.performance.tools.jiraactions.api.DISABLE_RICH_TEXT_EDITOR
 import com.atlassian.performance.tools.jiraactions.api.WebJira
 import com.atlassian.performance.tools.jiraactions.api.measure.ActionMeter
 
@@ -9,7 +9,7 @@ class DisableRichTextEditor(
     private val meter: ActionMeter
 ) : Action {
     override fun run() {
-        meter.measure(DISABLE_RTE) {
+        meter.measure(DISABLE_RICH_TEXT_EDITOR) {
             jira.configureRichTextEditor().disable()
         }
     }

diff --git a/src/main/kotlin/com/atlassian/performance/tools/jiraactions/api/action/SetUpAction.kt b/src/main/kotlin/com/atlassian/performance/tools/jiraactions/api/action/SetUpAction.kt
@@ -4,10 +4,12 @@ import com.atlassian.performance.tools.jiraactions.api.SET_UP
 import com.atlassian.performance.tools.jiraactions.api.WebJira
 import com.atlassian.performance.tools.jiraactions.api.measure.ActionMeter
 
+@Deprecated("Use [HideHealthNotifications] and/or [DisableRichTextEditor] for fine-grained control and measurements")
 class SetUpAction(
     private val jira: WebJira,
     private val meter: ActionMeter
 ) : Action {
+
     override fun run() {
         meter.measure(SET_UP) {
             DisableRichTextEditor(jira, meter).run()