search

cashapp / misk

Microservice Kontainer
https://cashapp.github.io/misk/
Apache License 2.0
404 stars 170 forks source link

[Proposal] Migration plan for Guice 7+ #2863

Open Nava2 opened 1 year ago

Nava2 commented 1 year ago

Wanted to make an issue for tracking migration to Guice 7.0.0.

@ThePumpingLemma migrated to using Guice 6.0.0 (#2846), however, there remains issues with projects wanting to use misk-inject with Guice 7+. The largest issue is that when a project tries to use Guice 7+, it can not inject classes that are labelled with javax.inject.XXX annotations. Guice 6+ happily accepts both jakarta and javax.

Proposed path forwards

It seems like the path to migration would be twp steps:

  1. Replace all usages of javax.inject.XXX with com.google.inject.XXX
    • This enables projects to transition to using jakarta.inject in their own projects, while consuming misk-inject @ 6.0.0
  2. Eventually cut over to Guice 7.0.0 at some point
  3. Optional: Replace com.google.inject.XXX with jakarta.inject.XXX

Open question

  1. misk uses detekt. Could we enable forbidding imports to enforce only using jakarta.inject.XXX?
    • IntelliJ can also be adjusted to ignore certain imports for "Auto import" (Link), but there is no intellij configuration within misk by default

P.S. I'm happy to do the find-and-replace 😄

r3mariano commented 1 year ago

👋 I'm one of the engineers working on frameworks at Cash.

We'd have to migrate our internal downstream services before we're able to do the migration to Guice 7. Will talk to the team about where to prioritise that. Given Guice 7 doesn't really have anything that isn't in Guice 6 at the moment, I'd lean towards doing the cutover later.

Using detekt would be great to check for imports!

r3mariano commented 1 year ago

I'm curious btw, why com.google.inject instead of jakarta.inject if they both work? I think I'd prefer to use the more generic one of the two where possible.

Nava2 commented 1 year ago

If we used Jakarta, it would force usage of 6.0+.. which seems fine... 🤦🏻 Admittedly, I'm biased as our downstream services are not on 6.0 yet and it would force our update - which we need to do.

Nava2 commented 1 year ago

I agree strongly with holding off on the cutover until later, but doing the initial migration to Jakarta seems good to get done.

adrw commented 1 year ago

I'd also lean towards jakarta.inject instead of com.google.inject since it looks like javax.inject has been replaced by jakarta.inject https://github.com/google/dagger/issues/2058#issuecomment-677925454