JvmField annotation makes testing very difficult

[hudson155]

The typical way to test interaction with external APIs is to mock them.

val stytch = mockk<StytchClient>

every { stytch.users } returns mockk {
  every { create(any()) } returns mockk()
}

However, because of the @JvmField annotations on StytchClient.users and the other fields, this becomes impossible (MockK, Mockito, etc. can only mock getters, not fields themselves).

Is there a good reason for those annotations? If not, let's remove them?

[jhaven-stytch]

Hey @hudson155 , heard you loud and clear about testability.

Most of us are out for the holidays right now, but we will have a discussion when we're back next week and see what's appropriate here.

Thanks for raising the issue!

[hudson155]

Thanks for the quick response @jhaven-stytch! Enjoy the time off 😌. No rush on this because I do have a workaround for now, but it would be nice to get rid of that @JvmField if possible 😄

Here's the workaround if it's helpful — I basically created my own wrapper class.
https://github.com/hudson155/kairo/blob/main/kairo-stytch/src/main/kotlin/kairo/stytch/Stytch.kt

[hudson155]

I'm also including my test file in case it's helpful for getting some context

package summit.identity.user

import com.stytch.java.common.StytchResult
import io.kotest.matchers.shouldBe
import io.mockk.coEvery
import io.mockk.coVerify
import io.mockk.mockk
import kairo.exception.shouldThrow
import kairo.optional.Required
import kairo.sql.PostgresExtension
import kairo.stytch.Stytch
import kairo.testing.postcondition
import kairo.testing.setup
import kairo.testing.test
import kotlinx.coroutines.test.runTest
import org.junit.jupiter.api.Test
import org.junit.jupiter.api.extension.ExtendWith
import summit.identity.IdentityFeatureTest
import summit.identity.user.exception.UserNotFound
import com.stytch.java.consumer.models.users.Name as UserName
import com.stytch.java.consumer.models.users.UpdateRequest as UserUpdateRequest

@ExtendWith(PostgresExtension::class, IdentityFeatureTest::class)
class UpdateUserTest {
  @Test
  fun `User doesn't exist`(
    stytch: Stytch,
    userService: UserService,
  ): Unit =
    runTest {
      val stytchUsers = stytch.users
      setup {
        coEvery { stytchUsers.create(any()) } returns StytchResult.Success(mockk())
      }
      setup {
        userService.create(UserModel.Creator.fixture())
      }
      test {
        shouldThrow(UserNotFound.unprocessable(UserId.zero)) {
          userService.update(UserId.zero, UserModel.Update())
        }
      }
      postcondition {
        coVerify(exactly = 0) { stytchUsers.update(any()) }
      }
    }

  @Test
  fun `No properties updated`(
    stytch: Stytch,
    userService: UserService,
  ): Unit =
    runTest {
      val stytchUsers = stytch.users
      setup {
        coEvery { stytchUsers.create(any()) } returns StytchResult.Success(mockk())
        coEvery { stytchUsers.update(any()) } returns StytchResult.Success(mockk())
      }
      val user = setup {
        userService.create(UserModel.Creator.fixture())
      }
      test {
        userService.update(user.id, UserModel.Update())
          .shouldBe(user)
      }
      postcondition {
        userService.get(user.id)
          .shouldBe(user)
      }
      postcondition {
        coVerify(exactly = 1) {
          stytchUsers.update(
            UserUpdateRequest(
              userId = user.id.value,
              name = UserName(
                firstName = user.firstName,
                lastName = user.lastName,
              ),
            ),
          )
        }
      }
    }

  @Test
  fun `All properties updated`(
    stytch: Stytch,
    userService: UserService,
  ): Unit =
    runTest {
      val stytchUsers = stytch.users
      setup {
        coEvery { stytchUsers.create(any()) } returns StytchResult.Success(mockk())
        coEvery { stytchUsers.update(any()) } returns StytchResult.Success(mockk())
      }
      val user = setup {
        userService.create(UserModel.Creator.fixture())
      }
      test {
        userService.update(
          id = user.id,
          update = UserModel.Update(
            firstName = Required.Value("Noah"),
            lastName = Required.Value("Guld"),
          ),
        ).sanitized().shouldBe(
          UserModel.fixture().copy(
            firstName = "Noah",
            lastName = "Guld",
          ),
        )
      }
      postcondition {
        coVerify(exactly = 1) {
          stytchUsers.update(
            UserUpdateRequest(
              userId = user.id.value,
              name = UserName(
                firstName = "Noah",
                lastName = "Guld",
              ),
            ),
          )
        }
      }
    }
}

[jhaven-stytch]

Ok, cool, I'm glad you have a workaround and this isn't a blocker right now, but that's definitely not ideal.

And thanks for sharing your project, that seems interesting!