Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[755] zio-schema breaking update #785

Merged
merged 7 commits into from
Mar 28, 2023
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 20 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

# ZIO Redis

[![Development](https://img.shields.io/badge/Project%20Stage-Development-green.svg)](https://github.com/zio/zio/wiki/Project-Stages) ![CI Badge](https://github.com/zio/zio-redis/workflows/CI/badge.svg) [![Sonatype Releases](https://img.shields.io/nexus/r/https/oss.sonatype.org/dev.zio/zio-redis_2.13.svg?label=Sonatype%20Release)](https://oss.sonatype.org/content/repositories/releases/dev/zio/zio-redis_2.13/) [![Sonatype Snapshots](https://img.shields.io/nexus/s/https/oss.sonatype.org/dev.zio/zio-redis_2.13.svg?label=Sonatype%20Snapshot)](https://oss.sonatype.org/content/repositories/snapshots/dev/zio/zio-redis_2.13/) [![javadoc](https://javadoc.io/badge2/dev.zio/zio-redis-docs_2.13/javadoc.svg)](https://javadoc.io/doc/dev.zio/zio-redis-docs_2.13) [![ZIO Redis](https://img.shields.io/github/stars/zio/zio-redis?style=social)](https://github.com/zio/zio-redis)
[![Development](https://img.shields.io/badge/Project%20Stage-Development-green.svg)](https://github.com/zio/zio/wiki/Project-Stages) ![CI Badge](https://github.com/zio/zio-redis/workflows/CI/badge.svg) [![Sonatype Snapshots](https://img.shields.io/nexus/s/https/oss.sonatype.org/dev.zio/zio-redis_2.13.svg?label=Sonatype%20Snapshot)](https://oss.sonatype.org/content/repositories/snapshots/dev/zio/zio-redis_2.13/) [![ZIO Redis](https://img.shields.io/github/stars/zio/zio-redis?style=social)](https://github.com/zio/zio-redis)

## Introduction

Expand All @@ -17,7 +17,7 @@ instances.
To use ZIO Redis, add the following line to your `build.sbt`:

```scala
libraryDependencies += "dev.zio" %% "zio-redis" % "0.1.0"
libraryDependencies += "dev.zio" %% "zio-redis" % "<version>"
```

## Example
Expand All @@ -32,17 +32,23 @@ To run this example we should put following dependencies in our `build.sbt` file

```scala
libraryDependencies ++= Seq(
"dev.zio" %% "zio-redis" % "0.1.0",
"dev.zio" %% "zio-schema-protobuf" % "0.3.0"
"dev.zio" %% "zio-redis" % "<version>",
"dev.zio" %% "zio-schema-protobuf" % "0.4.9"
)
```

```scala
import zio._
import zio.redis._
import zio.schema._
import zio.schema.codec._

object ZIORedisExample extends ZIOAppDefault {

object ProtobufCodecSupplier extends CodecSupplier {
implicit def codec[A: Schema]: BinaryCodec[A] = ProtobufCodec.protobufCodec
}

val myApp: ZIO[Redis, RedisError, Unit] = for {
redis <- ZIO.service[Redis]
_ <- redis.set("myKey", 8L, Some(1.minutes))
Expand All @@ -57,7 +63,7 @@ object ZIORedisExample extends ZIOAppDefault {
Redis.layer,
RedisExecutor.layer,
ZLayer.succeed(RedisConfig.Default),
ZLayer.succeed[BinaryCodec](ProtobufCodec)
ZLayer.succeed[CodecSupplier](ProtobufCodecSupplier)
)
}
```
Expand All @@ -67,24 +73,31 @@ object ZIORedisExample extends ZIOAppDefault {
To test you can use the embedded redis instance by adding to your build:

```scala
libraryDependencies := "dev.zio" %% "zio-redis-embedded" % "0.1.0"
libraryDependencies := "dev.zio" %% "zio-redis-embedded" % "<version>"
```

Then you can supply `EmbeddedRedis.layer.orDie` as your `RedisConfig` and you're good to go!

```scala
import zio._
import zio.redis._
import zio.redis.embedded.EmbeddedRedis
import zio.schema.{DeriveSchema, Schema}
import zio.schema.codec.{BinaryCodec, ProtobufCodec}
import zio.test._
import zio.test.Assertion._
import java.util.UUID

object EmbeddedRedisSpec extends ZIOSpecDefault {
object ProtobufCodecSupplier extends CodecSupplier {
implicit def codec[A: Schema]: BinaryCodec[A] = ProtobufCodec.protobufCodec
}

final case class Item private (id: UUID, name: String, quantity: Int)
object Item {
implicit val itemSchema: Schema[Item] = DeriveSchema.gen[Item]
}

def spec = suite("EmbeddedRedis should")(
test("set and get values") {
for {
Expand All @@ -97,7 +110,7 @@ object EmbeddedRedisSpec extends ZIOSpecDefault {
).provideShared(
EmbeddedRedis.layer.orDie,
RedisExecutor.layer.orDie,
ZLayer.succeed[BinaryCodec](ProtobufCodec),
ZLayer.succeed[CodecSupplier](ProtobufCodecSupplier),
Redis.layer
) @@ TestAspect.silentLogging
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ package zio.redis.benchmarks
import cats.effect.{IO => CIO}
import zio._
import zio.redis._
import zio.schema.Schema
import zio.schema.codec.{BinaryCodec, ProtobufCodec}

trait BenchmarkRuntime {
Expand All @@ -35,7 +36,9 @@ object BenchmarkRuntime {
private final val Layer =
ZLayer.make[Redis](
RedisExecutor.local,
ZLayer.succeed[BinaryCodec](ProtobufCodec),
ZLayer.succeed[CodecSupplier](new CodecSupplier {
implicit def codec[A: Schema]: BinaryCodec[A] = ProtobufCodec.protobufCodec
}),
Redis.layer
)
}
33 changes: 18 additions & 15 deletions build.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -44,12 +44,12 @@ lazy val redis =
.settings(stdSettings("zio-redis"))
.settings(
libraryDependencies ++= List(
"dev.zio" %% "zio-streams" % "2.0.10",
"dev.zio" %% "zio-streams" % zioVersion,
"dev.zio" %% "zio-logging" % "2.1.11",
"dev.zio" %% "zio-schema" % "0.3.1",
"dev.zio" %% "zio-schema-protobuf" % "0.3.1" % Test,
"dev.zio" %% "zio-test" % "2.0.10" % Test,
"dev.zio" %% "zio-test-sbt" % "2.0.10" % Test,
"dev.zio" %% "zio-schema" % zioSchemaVersion,
"dev.zio" %% "zio-schema-protobuf" % zioSchemaVersion % Test,
"dev.zio" %% "zio-test" % zioVersion % Test,
"dev.zio" %% "zio-test-sbt" % zioVersion % Test,
"org.scala-lang.modules" %% "scala-collection-compat" % "2.9.0"
),
testFrameworks := List(new TestFramework("zio.test.sbt.ZTestFramework"))
Expand All @@ -64,12 +64,12 @@ lazy val embedded =
.settings(stdSettings("zio-redis-embedded"))
.settings(
libraryDependencies ++= List(
"dev.zio" %% "zio" % "2.0.10",
"dev.zio" %% "zio" % zioVersion,
"com.github.kstyrc" % "embedded-redis" % "0.6",
"dev.zio" %% "zio-schema" % "0.3.1" % Test,
"dev.zio" %% "zio-schema-protobuf" % "0.3.1" % Test,
"dev.zio" %% "zio-test" % "2.0.8" % Test,
"dev.zio" %% "zio-test-sbt" % "2.0.8" % Test
"dev.zio" %% "zio-schema" % zioSchemaVersion % Test,
"dev.zio" %% "zio-schema-protobuf" % zioSchemaVersion % Test,
"dev.zio" %% "zio-test" % zioVersion % Test,
"dev.zio" %% "zio-test-sbt" % zioVersion % Test
),
testFrameworks := List(new TestFramework("zio.test.sbt.ZTestFramework"))
)
Expand All @@ -88,7 +88,7 @@ lazy val benchmarks =
"dev.profunktor" %% "redis4cats-effects" % "1.4.0",
"io.chrisdavenport" %% "rediculous" % "0.4.0",
"io.laserdisc" %% "laserdisc-fs2" % "0.6.0",
"dev.zio" %% "zio-schema-protobuf" % "0.3.1"
"dev.zio" %% "zio-schema-protobuf" % zioSchemaVersion
)
)

Expand All @@ -102,10 +102,10 @@ lazy val example =
libraryDependencies ++= List(
"com.softwaremill.sttp.client3" %% "zio" % "3.8.13",
"com.softwaremill.sttp.client3" %% "zio-json" % "3.8.13",
"dev.zio" %% "zio-streams" % "2.0.10",
"dev.zio" %% "zio-streams" % zioVersion,
"dev.zio" %% "zio-config-magnolia" % "3.0.7",
"dev.zio" %% "zio-config-typesafe" % "3.0.7",
"dev.zio" %% "zio-schema-protobuf" % "0.3.1",
"dev.zio" %% "zio-schema-protobuf" % zioSchemaVersion,
"dev.zio" %% "zio-json" % "0.5.0",
"io.d11" %% "zhttp" % "2.0.0-RC11"
)
Expand All @@ -123,7 +123,10 @@ lazy val docs = project
projectStage := ProjectStage.Development,
ScalaUnidoc / unidoc / unidocProjectFilter := inProjects(redis),
docsPublishBranch := "master",
libraryDependencies += "dev.zio" %% "zio-schema-protobuf" % "0.3.1"
libraryDependencies ++= List(
"dev.zio" %% "zio-schema-protobuf" % zioSchemaVersion,
"dev.zio" %% "zio-test" % zioVersion
)
)
.dependsOn(redis)
.dependsOn(redis, embedded)
.enablePlugins(WebsitePlugin)
21 changes: 17 additions & 4 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,16 +33,22 @@ To run this example we should put following dependencies in our `build.sbt` file
```scala
libraryDependencies ++= Seq(
"dev.zio" %% "zio-redis" % "@VERSION@",
"dev.zio" %% "zio-schema-protobuf" % "0.3.0"
"dev.zio" %% "zio-schema-protobuf" % "0.4.9"
)
```

```scala mdoc:compile-only
import zio._
import zio.redis._
import zio.schema._
import zio.schema.codec._

object ZIORedisExample extends ZIOAppDefault {

object ProtobufCodecSupplier extends CodecSupplier {
implicit def codec[A: Schema]: BinaryCodec[A] = ProtobufCodec.protobufCodec
}

val myApp: ZIO[Redis, RedisError, Unit] = for {
redis <- ZIO.service[Redis]
_ <- redis.set("myKey", 8L, Some(1.minutes))
Expand All @@ -57,7 +63,7 @@ object ZIORedisExample extends ZIOAppDefault {
Redis.layer,
RedisExecutor.layer,
ZLayer.succeed(RedisConfig.Default),
ZLayer.succeed[BinaryCodec](ProtobufCodec)
ZLayer.succeed[CodecSupplier](ProtobufCodecSupplier)
)
}
```
Expand All @@ -72,19 +78,26 @@ libraryDependencies := "dev.zio" %% "zio-redis-embedded" % "@VERSION@"

Then you can supply `EmbeddedRedis.layer.orDie` as your `RedisConfig` and you're good to go!

```scala
```scala mdoc:compile-only
import zio._
import zio.redis._
import zio.redis.embedded.EmbeddedRedis
import zio.schema.{DeriveSchema, Schema}
import zio.schema.codec.{BinaryCodec, ProtobufCodec}
import zio.test._
import zio.test.Assertion._
import java.util.UUID

object EmbeddedRedisSpec extends ZIOSpecDefault {
object ProtobufCodecSupplier extends CodecSupplier {
implicit def codec[A: Schema]: BinaryCodec[A] = ProtobufCodec.protobufCodec
}

final case class Item private (id: UUID, name: String, quantity: Int)
object Item {
implicit val itemSchema: Schema[Item] = DeriveSchema.gen[Item]
}

def spec = suite("EmbeddedRedis should")(
test("set and get values") {
for {
Expand All @@ -97,7 +110,7 @@ object EmbeddedRedisSpec extends ZIOSpecDefault {
).provideShared(
EmbeddedRedis.layer.orDie,
RedisExecutor.layer.orDie,
ZLayer.succeed[BinaryCodec](ProtobufCodec),
ZLayer.succeed[CodecSupplier](ProtobufCodecSupplier),
Redis.layer
) @@ TestAspect.silentLogging
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,9 @@ object EmbeddedRedisSpec extends ZIOSpecDefault {
).provideShared(
EmbeddedRedis.layer.orDie,
RedisExecutor.layer.orDie,
ZLayer.succeed[BinaryCodec](ProtobufCodec),
ZLayer.succeed[CodecSupplier](new CodecSupplier {
override implicit def codec[A: Schema]: BinaryCodec[A] = ProtobufCodec.protobufCodec
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
override implicit def codec[A: Schema]: BinaryCodec[A] = ProtobufCodec.protobufCodec
implicit def codec[A: Schema]: BinaryCodec[A] = ProtobufCodec.protobufCodec

}),
Redis.layer
) @@ TestAspect.silentLogging

Expand Down
7 changes: 5 additions & 2 deletions example/src/main/scala/example/Main.scala
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@ import example.config.AppConfig
import sttp.client3.httpclient.zio.HttpClientZioBackend
import zhttp.service.Server
import zio._
import zio.redis.{Redis, RedisExecutor}
import zio.redis.{CodecSupplier, Redis, RedisExecutor}
import zio.schema.Schema
import zio.schema.codec.{BinaryCodec, ProtobufCodec}

object Main extends ZIOAppDefault {
Expand All @@ -34,7 +35,9 @@ object Main extends ZIOAppDefault {
HttpClientZioBackend.layer(),
RedisExecutor.layer,
Redis.layer,
ZLayer.succeed[BinaryCodec](ProtobufCodec)
ZLayer.succeed[CodecSupplier](new CodecSupplier {
override def codec[A: Schema]: BinaryCodec[A] = ProtobufCodec.protobufCodec
})
)
.exitCode
}
3 changes: 3 additions & 0 deletions project/BuildHelper.scala
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,9 @@ object BuildHelper {
val Scala213 = versions("2.13")
val Scala3 = versions("3")

val zioVersion = "2.0.10"
val zioSchemaVersion = "0.4.9"

def buildInfoSettings(packageName: String) =
List(
buildInfoKeys := List[BuildInfoKey](name, version, scalaVersion, sbtVersion, isSnapshot),
Expand Down
6 changes: 2 additions & 4 deletions redis/src/main/scala/zio/redis/ClusterExecutor.scala
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,7 @@ package zio.redis
import zio._
import zio.redis.ClusterExecutor._
import zio.redis.api.Cluster.AskingCommand
import zio.redis.codecs.StringUtf8Codec
import zio.redis.options.Cluster._
import zio.schema.codec.BinaryCodec

import java.io.IOException

Expand All @@ -42,7 +40,7 @@ final case class ClusterExecutor(
def executeAsk(address: RedisUri) =
for {
executor <- executor(address)
_ <- executor.execute(AskingCommand(StringUtf8Codec, this).resp(()))
_ <- executor.execute(AskingCommand(this).resp(()))
res <- executor.execute(command)
} yield res

Expand Down Expand Up @@ -151,7 +149,7 @@ object ClusterExecutor {

private def redis(address: RedisUri) = {
val executorLayer = ZLayer.succeed(RedisConfig(address.host, address.port)) >>> RedisExecutor.layer
val codecLayer = ZLayer.succeed[BinaryCodec](StringUtf8Codec)
val codecLayer = ZLayer.succeed[CodecSupplier](StringCodecSupplier)
val redisLayer = executorLayer ++ codecLayer >>> Redis.layer
for {
closableScope <- Scope.make
Expand Down
29 changes: 29 additions & 0 deletions redis/src/main/scala/zio/redis/CodecSupplier.scala
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
/*
* Copyright 2021 John A. De Goes and the ZIO contributors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package zio.redis

import zio.redis.codecs.StringUtf8Codec
import zio.schema.Schema
import zio.schema.codec.BinaryCodec

trait CodecSupplier {
implicit def codec[A: Schema]: BinaryCodec[A]
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few remarks here:

  • let's rename to CodecSupplier
  • let's rename method to get
  • let's remove implicit

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. it's already called CodecSupplier or am i not seeing the difference?
  2. ok sure
  3. let me check if it's not used somewhere, if not i'll remove

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, typo 🤦‍♂️ I wanted to write CodecProvider.


private[redis] object StringCodecSupplier extends CodecSupplier {
implicit def codec[A: Schema]: BinaryCodec[A] = StringUtf8Codec.codec
}
Loading