Merge branch 'master' into S3backfill-allow-range-zero-val

jeffhwang-sq · jeffhwang-sq · commit fc667e5dddbf · 2025-04-16T00:23:11.000-04:00
* master: Make menu links configurable (#434) Log create/clone/update errors to Datadog, not just browser UI (#433)
diff --git a/service/src/main/kotlin/app/cash/backfila/ui/UiModule.kt b/service/src/main/kotlin/app/cash/backfila/ui/UiModule.kt
@@ -30,3 +30,10 @@ class UiModule : KAbstractModule() {
     install(WebActionModule.create<BackfillShowButtonHandlerAction>())
   }
 }
+
+/**
+ * Identifies the Misk dashboard for Backfila so dashboard links and other customization can be added.
+ */
+@Retention(AnnotationRetention.RUNTIME)
+@Target(AnnotationTarget.FUNCTION)
+annotation class BackfilaDashboard
diff --git a/service/src/main/kotlin/app/cash/backfila/ui/actions/BackfillCreateHandlerAction.kt b/service/src/main/kotlin/app/cash/backfila/ui/actions/BackfillCreateHandlerAction.kt
@@ -9,7 +9,6 @@ import app.cash.backfila.ui.pages.BackfillShowAction
 import javax.inject.Inject
 import javax.inject.Singleton
 import kotlinx.html.div
-import misk.exceptions.BadRequestException
 import misk.scope.ActionScoped
 import misk.security.authz.Authenticated
 import misk.web.Get
@@ -22,6 +21,7 @@ import misk.web.mediatype.MediaTypes
 import misk.web.toResponseBody
 import okhttp3.Headers
 import okio.ByteString.Companion.encodeUtf8
+import wisp.logging.getLogger
 
 @Singleton
 class BackfillCreateHandlerAction @Inject constructor(
@@ -74,6 +74,7 @@ class BackfillCreateHandlerAction @Inject constructor(
             AlertError(message = "Backfill create or clone failed: $e", label = "Try Again", onClick = "history.back(); return false;")
           }
         }
+      logger.error(e) { "Backfill create or clone failed $e" }
       return Response(
         body = errorHtmlResponseBody,
         statusCode = 200,
@@ -91,6 +92,8 @@ class BackfillCreateHandlerAction @Inject constructor(
   }
 
   companion object {
+    private val logger = getLogger<BackfillCreateHandlerAction>()
+
     const val PATH = "/api/backfill/create"
 
     private fun <T>String?.ifNotBlank(block: (String) -> T) = if (this.isNullOrBlank()) null else block(this)
diff --git a/service/src/main/kotlin/app/cash/backfila/ui/actions/BackfillShowButtonHandlerAction.kt b/service/src/main/kotlin/app/cash/backfila/ui/actions/BackfillShowButtonHandlerAction.kt
@@ -9,6 +9,8 @@ import app.cash.backfila.dashboard.UpdateBackfillRequest
 import app.cash.backfila.service.persistence.BackfillState
 import app.cash.backfila.ui.components.AlertError
 import app.cash.backfila.ui.components.DashboardPageLayout
+import javax.inject.Inject
+import javax.inject.Singleton
 import kotlinx.html.div
 import misk.security.authz.Authenticated
 import misk.web.Get
@@ -21,8 +23,7 @@ import misk.web.actions.WebAction
 import misk.web.mediatype.MediaTypes
 import misk.web.toResponseBody
 import okhttp3.Headers
-import javax.inject.Inject
-import javax.inject.Singleton
+import wisp.logging.getLogger
 
 @Singleton
 class BackfillShowButtonHandlerAction @Inject constructor(
@@ -91,6 +92,7 @@ class BackfillShowButtonHandlerAction @Inject constructor(
             AlertError(message = "Update backfill field failed: $e", label = "Try Again", onClick = "history.back(); return false;")
           }
         }
+      logger.error(e) { "Update backfill field failed $e" }
       return Response(
         body = errorHtmlResponseBody,
         statusCode = 200,
@@ -106,6 +108,8 @@ class BackfillShowButtonHandlerAction @Inject constructor(
   }
 
   companion object {
+    private val logger = getLogger<BackfillShowButtonHandlerAction>()
+
     const val PATH = "/api/backfill/{id}/update"
     fun path(id: String) = PATH.replace("{id}", id)
     fun path(id: Long) = path(id.toString())
diff --git a/service/src/main/kotlin/app/cash/backfila/ui/components/DashboardPageLayout.kt b/service/src/main/kotlin/app/cash/backfila/ui/components/DashboardPageLayout.kt
@@ -5,6 +5,7 @@ import app.cash.backfila.service.BackfilaConfig
 import app.cash.backfila.service.persistence.BackfilaDb
 import app.cash.backfila.service.persistence.BackfillRunQuery
 import app.cash.backfila.service.persistence.BackfillState
+import app.cash.backfila.ui.BackfilaDashboard
 import app.cash.backfila.ui.pages.IndexAction
 import jakarta.inject.Inject
 import kotlinx.html.TagConsumer
@@ -30,6 +31,7 @@ import misk.tailwind.pages.MenuSection
 import misk.tailwind.pages.Navbar
 import misk.web.HttpCall
 import misk.web.ResponseBody
+import misk.web.dashboard.DashboardTab
 import misk.web.dashboard.HtmlLayout
 import okio.BufferedSink
 import wisp.deployment.Deployment
@@ -47,6 +49,7 @@ class DashboardPageLayout @Inject constructor(
   private val getBackfillRunsAction: GetBackfillRunsAction,
   @BackfilaDb private val transacter: Transacter,
   private val queryFactory: Query.Factory,
+  private val allTabs: List<DashboardTab>,
 ) {
   private var newBuilder = false
   private var headBlock: TagConsumer<*>.() -> Unit = {}
@@ -57,6 +60,10 @@ class DashboardPageLayout @Inject constructor(
     clientHttpCall.get().url.encodedPath
   }
 
+  private val backfilaLinks by lazy {
+    allTabs.filter { it.dashboardAnnotationKClass == BackfilaDashboard::class }
+  }
+
   private fun setNewBuilder() = apply { newBuilder = true }
 
   fun newBuilder(): DashboardPageLayout = DashboardPageLayout(
@@ -67,6 +74,7 @@ class DashboardPageLayout @Inject constructor(
     getBackfillRunsAction = getBackfillRunsAction,
     transacter = transacter,
     queryFactory = queryFactory,
+    allTabs = allTabs,
   ).setNewBuilder()
 
   fun title(title: String) = apply {
@@ -181,9 +189,30 @@ class DashboardPageLayout @Inject constructor(
               href = "/backfills/",
               isSelected = currentPath == "/backfills/",
             ),
-          ),
+          ) + backfilaLinks.filter { it.menuCategory == "Backfila" }.map { tab ->
+            Link(
+              label = tab.menuLabel,
+              href = tab.menuUrl,
+              isSelected = currentPath.startsWith(tab.menuUrl),
+            )
+          },
         ),
-      ) + if (services.isNotEmpty()) {
+      ) + if (backfilaLinks.filterNot { it.menuCategory == "Backfila" }.isNotEmpty()) {
+        backfilaLinks.filterNot { it.menuCategory == "Backfila" }.groupBy { it.menuCategory }.map { (category, tabs) ->
+          MenuSection(
+            title = category,
+            links = tabs.map { tab ->
+              Link(
+                label = tab.menuLabel,
+                href = tab.menuUrl,
+                isSelected = currentPath.startsWith(tab.menuUrl),
+              )
+            },
+          )
+        }
+      } else {
+        listOf()
+      } + if (services.isNotEmpty()) {
         listOf(
           MenuSection(
             title = "Your Services",
diff --git a/service/src/test/kotlin/app/cash/backfila/development/BackfilaDevelopmentService.kt b/service/src/test/kotlin/app/cash/backfila/development/BackfilaDevelopmentService.kt
@@ -16,6 +16,7 @@ import app.cash.backfila.protos.clientservice.RunBatchResponse
 import app.cash.backfila.service.BackfilaConfig
 import app.cash.backfila.service.BackfilaServiceModule
 import app.cash.backfila.service.persistence.DbBackfillRun
+import app.cash.backfila.ui.BackfilaDashboard
 import misk.MiskApplication
 import misk.MiskRealServiceModule
 import misk.audit.NoOpAuditClientModule
@@ -28,8 +29,10 @@ import misk.jdbc.DataSourceConfig
 import misk.jdbc.DataSourceType
 import misk.security.authz.FakeCallerAuthenticator
 import misk.security.authz.MiskCallerAuthenticator
+import misk.security.authz.Unauthenticated
 import misk.web.MiskWebModule
 import misk.web.WebConfig
+import misk.web.dashboard.DashboardModule
 import okio.ByteString.Companion.encodeUtf8
 import wisp.deployment.Deployment
 
@@ -54,6 +57,22 @@ fun main(args: Array<String>) {
         multibind<MiskCallerAuthenticator>().to<FakeCallerAuthenticator>()
         bind<ViewLogsUrlProvider>().to<DevelopmentViewLogsUrlProvider>()
 
+        // Example custom link that shows up in navbar
+        install(
+          DashboardModule.createMenuLink<BackfilaDashboard, Unauthenticated>(
+            label = "Go to Repo",
+            url = "https://github.com/cashapp/backfila",
+            category = "Backfila",
+          ),
+        )
+        install(
+          DashboardModule.createMenuLink<BackfilaDashboard, Unauthenticated>(
+            label = "Test other link",
+            url = "https://github.com/cashapp/backfila",
+            category = "Alpha",
+          ),
+        )
+
         newMapBinder<String, BackfilaCallbackConnectorProvider>(ForConnectors::class)
           .permitDuplicates().addBinding("DEV")
           .toInstance(object : BackfilaCallbackConnectorProvider {

Original file line number	Diff line number	Diff line change
`@@ -30,3 +30,10 @@ class UiModule : KAbstractModule() {`
`30`	`30`	`install(WebActionModule.create<BackfillShowButtonHandlerAction>())`
`31`	`31`	`}`
`32`	`32`	`}`
	`33`	`+`
	`34`	`+/**`
	`35`	`+ * Identifies the Misk dashboard for Backfila so dashboard links and other customization can be added.`
	`36`	`+ */`
	`37`	`+@Retention(AnnotationRetention.RUNTIME)`
	`38`	`+@Target(AnnotationTarget.FUNCTION)`
	`39`	`+annotation class BackfilaDashboard`