-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Test case: Dependency injection via Providers
- Loading branch information
Showing
2 changed files
with
191 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
11 | ||
hi | ||
List(1, 2, 3) | ||
hi | ||
|
||
Direct: | ||
You've just been subscribed to RockTheJVM. Welcome, Daniel | ||
Acquired connection | ||
Executing query: insert into subscribers(name, email) values Daniel daniel@RocktheJVM.com | ||
You've just been subscribed to RockTheJVM. Welcome, Martin | ||
Acquired connection | ||
Executing query: insert into subscribers(name, email) values Martin odersky@gmail.com | ||
|
||
Injected | ||
You've just been subscribed to RockTheJVM. Welcome, Daniel | ||
Acquired connection | ||
Executing query: insert into subscribers(name, email) values Daniel daniel@RocktheJVM.com | ||
You've just been subscribed to RockTheJVM. Welcome, Martin | ||
Acquired connection | ||
Executing query: insert into subscribers(name, email) values Martin odersky@gmail.com |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,171 @@ | ||
import language.experimental.modularity | ||
import compiletime.constValue | ||
import compiletime.ops.int.S | ||
|
||
// Featherweight dependency injection library, inspired by the use case | ||
// laid out in the ZIO course of RockTheJVM. | ||
|
||
/** Some things that are not part of Tuple yet, but that would be nice to have. */ | ||
object TupleUtils: | ||
|
||
/** The index of the first element type of the tuple `Xs` that is a subtype of `X` */ | ||
type IndexOf[Xs <: Tuple, X] <: Int = Xs match | ||
case X *: _ => 0 | ||
case _ *: ys => S[IndexOf[ys, X]] | ||
|
||
/** A trait describing a selection from a tuple `Xs` returning an element of type `X` */ | ||
trait Select[Xs <: Tuple, X]: | ||
def apply(xs: Xs): X | ||
|
||
/** A given implementing `Select` to return the first element of tuple `Xs` | ||
* that has a static type matching `X`. | ||
*/ | ||
given [Xs <: NonEmptyTuple, X] => (idx: ValueOf[IndexOf[Xs, X]]) => Select[Xs, X]: | ||
def apply(xs: Xs) = xs.apply(idx.value).asInstanceOf[X] | ||
|
||
/** A featherweight library for dependency injection */ | ||
object Providers: | ||
import TupleUtils.* | ||
|
||
/** A provider is a zero-cost wrapper around a type that is intended | ||
* to be passed implicitly | ||
*/ | ||
opaque type Provider[T] = T | ||
|
||
def provide[X](x: X): Provider[X] = x | ||
|
||
def provided[X](using p: Provider[X]): X = p | ||
|
||
/** Project a provider to one of its element types */ | ||
given [Xs <: Tuple, X] => (ps: Provider[Xs], select: Select[Xs, X]) => Provider[X] = | ||
select(ps) | ||
|
||
/** Form a compound provider wrapping a tuple */ | ||
given [X, Xs <: Tuple] => (p: Provider[X], ps: Provider[Xs]) => Provider[X *: Xs] = | ||
p *: ps | ||
|
||
given Provider[EmptyTuple] = EmptyTuple | ||
|
||
end Providers | ||
|
||
@main def Test = | ||
import TupleUtils.* | ||
|
||
type P = (Int, String, List[Int]) | ||
val x: P = (11, "hi", List(1, 2, 3)) | ||
val selectInt = summon[Select[P, Int]] | ||
println(selectInt(x)) | ||
val selectString = summon[Select[P, String]] | ||
println(selectString(x)) | ||
val selectList = summon[Select[P, List[Int]]] | ||
println(selectList(x)) | ||
val selectObject = summon[Select[P, Object]] | ||
println(selectObject(x)) // prints "hi" | ||
println(s"\nDirect:") | ||
Explicit() | ||
println(s"\nInjected") | ||
Injected() | ||
|
||
/** Demonstrator for explicit dependency construction */ | ||
class Explicit: | ||
|
||
case class User(name: String, email: String) | ||
|
||
class UserSubscription(emailService: EmailService, db: UserDatabase): | ||
def subscribe(user: User) = | ||
emailService.email(user) | ||
db.insert(user) | ||
|
||
class EmailService: | ||
def email(user: User) = | ||
println(s"You've just been subscribed to RockTheJVM. Welcome, ${user.name}") | ||
|
||
class UserDatabase(pool: ConnectionPool): | ||
def insert(user: User) = | ||
val conn = pool.get() | ||
conn.runQuery(s"insert into subscribers(name, email) values ${user.name} ${user.email}") | ||
|
||
class ConnectionPool(n: Int): | ||
def get(): Connection = | ||
println(s"Acquired connection") | ||
Connection() | ||
|
||
class Connection(): | ||
def runQuery(query: String): Unit = | ||
println(s"Executing query: $query") | ||
|
||
val subscriptionService = | ||
UserSubscription( | ||
EmailService(), | ||
UserDatabase( | ||
ConnectionPool(10) | ||
) | ||
) | ||
|
||
def subscribe(user: User) = | ||
val sub = subscriptionService | ||
sub.subscribe(user) | ||
|
||
subscribe(User("Daniel", "daniel@RocktheJVM.com")) | ||
subscribe(User("Martin", "odersky@gmail.com")) | ||
|
||
/** The same application as `Explicit` but using dependency injection */ | ||
class Injected: | ||
import Providers.* | ||
|
||
case class User(name: String, email: String) | ||
|
||
class UserSubscription(using Provider[(EmailService, UserDatabase)]): | ||
def subscribe(user: User) = | ||
provided[EmailService].email(user) | ||
provided[UserDatabase].insert(user) | ||
|
||
class EmailService: | ||
def email(user: User) = | ||
println(s"You've just been subscribed to RockTheJVM. Welcome, ${user.name}") | ||
|
||
class UserDatabase(using Provider[ConnectionPool]): | ||
def insert(user: User) = | ||
val conn = provided[ConnectionPool].get() | ||
conn.runQuery(s"insert into subscribers(name, email) values ${user.name} ${user.email}") | ||
|
||
class ConnectionPool(n: Int): | ||
def get(): Connection = | ||
println(s"Acquired connection") | ||
Connection() | ||
|
||
class Connection(): | ||
def runQuery(query: String): Unit = | ||
println(s"Executing query: $query") | ||
|
||
given Provider[EmailService] = provide(EmailService()) | ||
given Provider[ConnectionPool] = provide(ConnectionPool(10)) | ||
given Provider[UserDatabase] = provide(UserDatabase()) | ||
given Provider[UserSubscription] = provide(UserSubscription()) | ||
|
||
def subscribe(user: User)(using Provider[UserSubscription]) = | ||
val sub = provided[UserSubscription] | ||
sub.subscribe(user) | ||
|
||
subscribe(User("Daniel", "daniel@RocktheJVM.com")) | ||
subscribe(User("Martin", "odersky@gmail.com")) | ||
|
||
// explicit version, not used here | ||
object explicit: | ||
val subscriptionService = | ||
UserSubscription( | ||
using provide( | ||
EmailService(), | ||
UserDatabase( | ||
using provide( | ||
ConnectionPool(10) | ||
) | ||
) | ||
) | ||
) | ||
|
||
given Provider[UserSubscription] = provide(subscriptionService) | ||
end explicit | ||
|
||
|
||
|