Bump Misk & add audit client

Misk 2025.04.01.184033-1915641

Author: adrw

gradle/libs.versions.toml

@@ -71,6 +71,7 @@ kotlinxHtml = { module = "org.jetbrains.kotlinx:kotlinx-html-jvm", version = "0.
 misk = { module = "com.squareup.misk:misk", version.ref = "misk" }
 miskActions = { module = "com.squareup.misk:misk-actions", version.ref = "misk" }
 miskAdmin = { module = "com.squareup.misk:misk-admin", version.ref = "misk" }
+miskAuditClient = { module = "com.squareup.misk:misk-audit-client", version.ref = "misk" }
 miskAwsDynamodb = { module = "com.squareup.misk:misk-aws-dynamodb", version.ref = "misk" }
 miskAws2Dynamodb = { module = "com.squareup.misk:misk-aws2-dynamodb", version.ref = "misk" }
 miskCore = { module = "com.squareup.misk:misk-core", version.ref = "misk" }

service-self-backfill/src/test/kotlin/app/cash/backfila/service/selfbackfill/SelfBackfillTestingModule.kt

@@ -50,8 +50,8 @@ class SelfBackfillTestingModule : KAbstractModule() {
       slack = null,
     )
     newMultibinder<BackfillRunListener>()
-      .addBinding()
-      .to(SlackHelper::class.java)
+    multibind<BackfillRunListener>().to<SlackHelper>()
+
     bind<BackfilaConfig>().toInstance(config)
     install(DeploymentModule(TESTING))
     install(LogCollectorModule())

service/build.gradle.kts

@@ -46,6 +46,7 @@ dependencies {
   implementation(libs.misk)
   implementation(libs.miskActions)
   implementation(libs.miskAdmin)
+  implementation(libs.miskAuditClient)
   implementation(libs.miskCore)
   implementation(libs.miskHibernate)
   implementation(libs.miskHotwire)
@@ -77,6 +78,7 @@ dependencies {
 
   testImplementation(libs.miskTesting)
   testImplementation(libs.miskHibernateTesting)
+  testImplementation(testFixtures(libs.miskAuditClient))
   testImplementation(libs.junitApi)
   testImplementation(libs.junitParams)
   testImplementation(libs.junitEngine)

service/src/main/kotlin/app/cash/backfila/dashboard/CreateBackfillAction.kt

@@ -3,8 +3,10 @@ package app.cash.backfila.dashboard
 import app.cash.backfila.BackfillCreator
 import app.cash.backfila.protos.service.CreateBackfillRequest
 import app.cash.backfila.protos.service.CreateBackfillResponse
+import app.cash.backfila.ui.pages.BackfillShowAction
 import javax.inject.Inject
 import misk.MiskCaller
+import misk.audit.AuditClient
 import misk.scope.ActionScoped
 import misk.security.authz.Authenticated
 import misk.web.PathParam
@@ -16,8 +18,9 @@ import misk.web.actions.WebAction
 import misk.web.mediatype.MediaTypes
 
 class CreateBackfillAction @Inject constructor(
-  private val caller: @JvmSuppressWildcards ActionScoped<MiskCaller?>,
+  private val callerProvider: @JvmSuppressWildcards ActionScoped<MiskCaller?>,
   private val backfillCreator: BackfillCreator,
+  private val auditClient: AuditClient,
 ) : WebAction {
   @Post("/services/{service}/variants/{variant}/create")
   @RequestContentType(MediaTypes.APPLICATION_JSON)
@@ -37,7 +40,14 @@ class CreateBackfillAction @Inject constructor(
     request: CreateBackfillRequest,
   ): CreateBackfillResponse {
     // TODO check user has permissions for this service with access api
-    val id = backfillCreator.create(caller.get()!!.user!!, service, variant, request)
+    val id = backfillCreator.create(callerProvider.get()!!.user!!, service, variant, request)
+
+    auditClient.logEvent(
+      target = request.backfill_name,
+      description = "Backfill Created",
+      applicationName = if (variant != "default") "$service/$variant" else service,
+      detailURL = BackfillShowAction.path(id.id),
+    )
 
     return CreateBackfillResponse(id.id)
   }

service/src/main/kotlin/app/cash/backfila/service/BackfilaServiceModule.kt

@@ -44,8 +44,7 @@ class BackfilaServiceModule(
     )
 
     newMultibinder<BackfillRunListener>()
-      .addBinding()
-      .to(SlackHelper::class.java)
+    multibind<BackfillRunListener>().to<SlackHelper>()
 
     install(ConfigModule.create("backfila", config))
     install(BackfilaPersistenceModule(config))

service/src/main/kotlin/app/cash/backfila/ui/actions/BackfillCreateHandlerAction.kt

@@ -3,6 +3,7 @@ package app.cash.backfila.ui.actions
 import app.cash.backfila.dashboard.CreateBackfillAction
 import app.cash.backfila.protos.service.CreateBackfillRequest
 import app.cash.backfila.ui.pages.BackfillCreateAction.BackfillCreateField
+import app.cash.backfila.ui.pages.BackfillShowAction
 import javax.inject.Inject
 import javax.inject.Singleton
 import misk.scope.ActionScoped
@@ -63,9 +64,9 @@ class BackfillCreateHandlerAction @Inject constructor(
     val id = response.backfill_run_id
 
     return Response(
-      body = "go to /backfills/$id".toResponseBody(),
+      body = "go to ${BackfillShowAction.path(id)}".toResponseBody(),
       statusCode = 303,
-      headers = Headers.headersOf("Location", "/backfills/$id"),
+      headers = Headers.headersOf("Location", BackfillShowAction.path(id)),
     )
   }
 

service/src/test/kotlin/app/cash/backfila/BackfilaTestingModule.kt

@@ -21,6 +21,8 @@ import java.util.concurrent.Executors
 import javax.inject.Singleton
 import misk.MiskCaller
 import misk.MiskTestingServiceModule
+import misk.audit.FakeAuditClientModule
+import misk.config.AppNameModule
 import misk.environment.DeploymentModule
 import misk.hibernate.HibernateTestingModule
 import misk.inject.KAbstractModule
@@ -54,12 +56,13 @@ internal class BackfilaTestingModule : KAbstractModule() {
     bind<BackfilaConfig>().toInstance(config)
 
     newMultibinder<BackfillRunListener>()
-      .addBinding()
-      .to(SlackHelper::class.java)
+    multibind<BackfillRunListener>().to<SlackHelper>()
 
     install(DeploymentModule(wisp.deployment.TESTING))
     install(LogCollectorModule())
     install(MiskTestingServiceModule())
+    install(AppNameModule("backfila"))
+    install(FakeAuditClientModule())
 
     install(HibernateTestingModule(BackfilaDb::class))
     install(BackfilaPersistenceModule(config))

service/src/test/kotlin/app/cash/backfila/actions/CreateBackfillActionTest.kt

@@ -20,7 +20,9 @@ import app.cash.backfila.service.persistence.RunPartitionQuery
 import app.cash.backfila.service.persistence.ServiceQuery
 import com.google.inject.Module
 import javax.inject.Inject
+import kotlin.test.assertEquals
 import kotlin.test.assertNotNull
+import misk.audit.FakeAuditClient
 import misk.exceptions.BadRequestException
 import misk.hibernate.Query
 import misk.hibernate.Transacter
@@ -58,6 +60,9 @@ class CreateBackfillActionTest {
   @Inject
   lateinit var fakeBackfilaClientServiceClient: FakeBackfilaCallbackConnector
 
+  @Inject
+  lateinit var fakeAuditClient: FakeAuditClient
+
   @Test
   fun serviceDoesntExist() {
     scope.fakeCaller(user = "molly") {
@@ -98,6 +103,8 @@ class CreateBackfillActionTest {
 
   @Test
   fun created() {
+    assertEquals(0, fakeAuditClient.sentEvents.size)
+
     scope.fakeCaller(service = "deep-fryer") {
       configureServiceAction.configureService(
         ConfigureServiceRequest.Builder()
@@ -144,6 +151,25 @@ class CreateBackfillActionTest {
         assertThat(partitions[1].lease_token).isNull()
         assertThat(partitions[1].run_state).isEqualTo(BackfillState.PAUSED)
       }
+
+      assertEquals(1, fakeAuditClient.sentEvents.size)
+      assertEquals(
+        FakeAuditClient.FakeAuditEvent(
+          eventSource = "backfila",
+          eventTarget = "ChickenSandwich",
+          timestampSent = 2147483647,
+          applicationName = "deep-fryer",
+          approverLDAP = "molly",
+          automatedChange = false,
+          description = "Backfill Created",
+          richDescription = null,
+          environment = "testing",
+          detailURL = "/backfills/${response.backfill_run_id}",
+          region = "us-west-2",
+          requestorLDAP = "molly",
+        ),
+        fakeAuditClient.sentEvents.single(),
+      )
     }
   }
 

service/src/test/kotlin/app/cash/backfila/development/BackfilaDevelopmentService.kt

@@ -18,6 +18,7 @@ import app.cash.backfila.service.BackfilaServiceModule
 import app.cash.backfila.service.persistence.DbBackfillRun
 import misk.MiskApplication
 import misk.MiskRealServiceModule
+import misk.audit.NoOpAuditClientModule
 import misk.environment.DeploymentModule
 import misk.hibernate.Session
 import misk.inject.KAbstractModule
@@ -124,6 +125,7 @@ fun main(args: Array<String>) {
     DevelopmentAdminDashboardModule(),
     BackfilaDefaultEndpointConfigModule(),
     MiskRealServiceModule(),
+    NoOpAuditClientModule(),
   ).run(args)
 }
 

service/src/test/kotlin/app/cash/backfila/development/finedining/FineDiningDevelopmentService.kt

@@ -7,6 +7,7 @@ import app.cash.backfila.development.DevelopmentAdminDashboardModule
 import app.cash.backfila.development.ServiceHeaderInterceptor
 import misk.MiskApplication
 import misk.MiskRealServiceModule
+import misk.audit.NoOpAuditClientModule
 import misk.client.HttpClientEndpointConfig
 import misk.client.HttpClientsConfig
 import misk.client.HttpClientsConfigModule
@@ -57,7 +58,8 @@ fun main(args: Array<String>) {
     FineDiningServiceModule(),
     DevelopmentAdminDashboardModule(),
     MiskRealServiceModule(),
-  ).run(args)
+    NoOpAuditClientModule(),
+    ).run(args)
 }
 
 data class FineDiningConfig(

service/src/test/kotlin/app/cash/backfila/development/mcdees/McDeesDevelopmentServiceBase.kt

@@ -6,6 +6,7 @@ import app.cash.backfila.development.DevelopmentAdminDashboardModule
 import app.cash.backfila.development.ServiceHeaderInterceptor
 import misk.MiskApplication
 import misk.MiskRealServiceModule
+import misk.audit.NoOpAuditClientModule
 import misk.client.HttpClientEndpointConfig
 import misk.client.HttpClientsConfig
 import misk.client.HttpClientsConfigModule
@@ -64,6 +65,7 @@ class McDeesDevelopmentServiceBase {
       ),
       DevelopmentAdminDashboardModule(),
       MiskRealServiceModule(),
+      NoOpAuditClientModule(),
     ).run(args)
   }