Add Scala and Kotlin examples #1933

jonathanl-bq · 2024-07-12T22:25:36Z

Adds new examples for how to use Valkey GLIDE in both Scala and Kotlin projects. The Java README is also updated to show users how to use Valkey GLIDE in SBT projects.

java/README.md

examples/kotlin/example/src/main/kotlin/Main.kt

barshaul · 2024-07-18T06:58:25Z

examples/node/.gitignore

@@ -1 +0,0 @@
-*.js


please revert

This is following Yury's suggestion to merge all .gitignores into a single .gitignore for all examples.

barshaul · 2024-07-18T07:00:23Z

examples/kotlin/example/src/main/kotlin/Main.kt

+import kotlinx.coroutines.runBlocking
+import java.util.concurrent.ExecutionException
+
+suspend fun runApp() {


which app is it? it should be clear in the file/folder name or in the code itself that it tests a standalone client, and to provide cluster example as well. also i'm concern that users will do copy paste to their apps and it doesn't contain the error handling that we do in the main examples. Lets try to stick with one example format in #1925 and copy it exactly to the other java flavours (e.g. kotlin)

barshaul · 2024-07-18T07:01:34Z

examples/scala/example/build.sbt

+  }
+}
+
+libraryDependencies += "io.valkey" % "valkey-glide" % "1.0.1" classifier platformClassifier


don't use hardcoded glide versions, keep it as an env variable for all examples and use it once.

@jonathanl-bq Try using version wildcard if possible, e.g. (`1+)

barshaul · 2024-07-18T07:02:31Z

examples/scala/example/src/main/scala/Main.scala

+
+import java.util.concurrent.ExecutionException
+
+object Main {


same comments as I wrote in the kotlin example

barshaul · 2024-07-18T07:03:08Z

java/README.md

+- **IMPORTANT** must include a `classifier`. Please use this dependency block and add it to the build.sbt file.
+```scala
+// osx-aarch_64
+libraryDependencies += "io.valkey" % "valkey-glide" % "1.0.1" classifier "osx-aarch_64"


same - don't use hardcoded glide version

barshaul · 2024-07-18T07:04:39Z

java/README.md

@@ -130,6 +130,22 @@ Maven:
 </dependency>
 ```

+SBT:
+- **IMPORTANT** must include a `classifier`. Please use this dependency block and add it to the build.sbt file.


Why is the classifier is a must? shouldn't SBT decide based on the running platform?

It's the same as for Maven and Gradle, which both also have this note. There are plugins that can do this for each of the 3 build tools, but on its own, SBT cannot do this.

barshaul · 2024-07-18T07:05:48Z

java/README.md

+#### Scala
+To run the Scala example, from the `examples/scala/example` directory, execute:
+```shell
+sbt run
+```
+
+#### Kotlin
+To run the Kotlin example, from the `examples/kotlin/example` directory, execute:
+```shell
+./gradlew run
+```


Please remove it from here and add README file to each example folder that explains how to run the example

barshaul · 2024-07-18T07:08:58Z

examples/kotlin/example/build.gradle.kts

+
+dependencies {
+    testImplementation(kotlin("test"))
+    implementation("io.valkey:valkey-glide:1.0.1:$classifier")


don't use glide hardcoded version

barshaul · 2024-07-18T07:12:34Z

examples/kotlin/example/gradlew

@@ -0,0 +1,234 @@
+#!/bin/sh


Instead of storing all of the build files in the repo, is it possible to run in a build script "gradle init" or other relevant command to generate these files as a part of the example build process?

It requires gradle to be intalled on the computer. With gradlew you can bypass that and get any version of gradle at compile time.

barshaul

I think that it's great that you're adding also kotlin and scala examples!
We should make sure that the examples match the java example (see #1925 ), and lets try to make sure it doesn't have a lot of maintenance cost and keep it light as possible (can we get rid of all build files and generate them on user demand?), ), also see all comments inline.

jonathanl-bq · 2024-07-30T21:38:00Z

I think I've addressed all the comments now and aligned with Yi-Pin's merged Java examples.

Yury-Fridlyand · 2024-07-30T21:58:02Z

@barshaul round

barshaul · 2024-08-01T07:53:14Z

java/README.md

+libraryDependencies += "io.valkey" % "valkey-glide" % "1.0.0" classifier "osx-x86_64"
+
+// linux-aarch_64
+libraryDependencies += "io.valkey" % "valkey-glide" % "1.0.0" classifier "linux-aarch_64"


it's already an issue - above you wrote 1.0.1 and here 1.0.0. change it so we wont have hardcoded versions. and it's a must, use a variable once and set it only in one place.

For the documentation it does not make sense to use a variable. Every user will copy a different line depending on their platform and only one line. I will replace these all to use a wildcard.

barshaul · 2024-08-01T07:57:49Z

examples/scala/src/main/scala/StandaloneExample.scala

+                        // The client wasn't able to reestablish the connection within the given retries
+                        Logger.log(Logger.Level.ERROR, "glide", s"Connection error encountered: ${e.getMessage}")
+                        Future.failed(e)
+                    case e: ExecAbortException =>


dont catch ExecAbortException. it should be catched as a part of the general Execution error.

barshaul · 2024-08-01T08:02:01Z

examples/scala/src/main/scala/StandaloneExample.scala

+     * @param client An instance of <code>GlideClient</code>.
+     */
+    private def appLogic(client: GlideClient): Future[Unit] = {
+        for {


why is it inside a 'for'?

Scala has for-comprehensions, which act as monad comprehensions (inspired by Haskell's do-notation) for writing imperative code with effects (Future is used to encode the async effect). It's idiomatic for Scala code to be written this way, even if the keyword "for" is a bit confusing, unfortunately.

barshaul · 2024-08-01T12:39:42Z

examples/kotlin/README.md

+```
+
+To run the Cluster example:
+```


Suggested change

```

```shell

barshaul · 2024-08-01T12:43:58Z

examples/kotlin/src/main/kotlin/ClusterExample.kt

+                    is ExecAbortException -> {
+                        Logger.log(Logger.Level.ERROR, "glide", "ExecAbort error encountered: ${e.message}")
+                        throw e


same - ExecAbortException doesn't need specific error handling

barshaul · 2024-08-01T12:46:19Z

examples/kotlin/src/main/kotlin/StandaloneExample.kt

+                        Logger.log(Logger.Level.ERROR, "glide", "Connection error encountered: ${e.message}")
+                        throw e
+                    }
+                    is ExecAbortException -> {


barshaul · 2024-08-01T12:51:10Z

examples/scala/README.md

@@ -0,0 +1,14 @@
+# Run
+Ensure that you have an instance of Valkey running on "localhost" on "6379". Otherwise, update StandaloneExample or ClusterExample with a configuration that matches your server settings.


Please fix it on all examples (including java's):

Suggested change

Ensure that you have an instance of Valkey running on "localhost" on "6379". Otherwise, update StandaloneExample or ClusterExample with a configuration that matches your server settings.

Ensure that you have a server running on "localhost" on port "6379". To run the ClusterExample, make sure that the server has cluster mode enabled. If the server is running on a different host and/or port, update the StandaloneExample or ClusterExample with a configuration that matches your server settings.

barshaul · 2024-08-01T12:52:55Z

examples/scala/README.md

@@ -0,0 +1,14 @@
+# Run


Can you please add a note to the readme files that the examples are running version X, and to change it they need to change Y in file Z?

barshaul · 2024-08-01T12:53:31Z

examples/scala/src/main/scala/ClusterExample.scala

+                        // The client wasn't able to reestablish the connection within the given retries
+                        Logger.log(Logger.Level.ERROR, "glide", s"Connection error encountered: ${e.getMessage}")
+                        Future.failed(e)
+                    case e: ExecAbortException =>


Signed-off-by: Jonathan Louie <[email protected]>

Co-authored-by: Yury-Fridlyand <[email protected]> Signed-off-by: Jonathan Louie <[email protected]>

Signed-off-by: Jonathan Louie <[email protected]>

jonathanl-bq · 2024-08-02T17:11:30Z

@barshaul round

examples/scala/src/main/scala/StandaloneExample.scala

Signed-off-by: Guian Gumpac <[email protected]>

acarbonetto · 2024-08-08T17:29:51Z

examples/.gitignore

@@ -0,0 +1,51 @@
+### Kotlin ###
+.gradle
+build/


nit: move out of ### Kotlin ### section, since this is not specific to Kotlin

acarbonetto · 2024-08-08T17:33:11Z

examples/scala/build.sbt

+val os = System.getProperty("os.name").toLowerCase
+val platformClassifier = {
+  (os, System.getProperty("os.arch").toLowerCase) match {
+    case (mac, arm) if mac.contains("mac") && (arm.contains("aarch") || arm.contains("arm")) => "osx-aarch_64"


nit: rename each of these lines:

Suggested change

case (mac, arm) if mac.contains("mac") && (arm.contains("aarch") || arm.contains("arm")) => "osx-aarch_64"

case (osName, archName) if mac.contains("mac") && (arm.contains("aarch") || arm.contains("arm")) => "osx-aarch_64"

* Add Scala and Kotlin examples Signed-off-by: Guian Gumpac <[email protected]> --------- Signed-off-by: Jonathan Louie <[email protected]> Signed-off-by: Guian Gumpac <[email protected]> Co-authored-by: Yury-Fridlyand <[email protected]> Co-authored-by: Guian Gumpac <[email protected]> Signed-off-by: Chloe Yip <[email protected]>

jonathanl-bq requested a review from a team as a code owner July 12, 2024 22:25

jonathanl-bq added java issues and fixes related to the java client docs Documentation labels Jul 12, 2024

Yury-Fridlyand approved these changes Jul 15, 2024

View reviewed changes

java/README.md Outdated Show resolved Hide resolved

nihohit reviewed Jul 15, 2024

View reviewed changes

examples/kotlin/example/src/main/kotlin/Main.kt Outdated Show resolved Hide resolved

yipin-chen approved these changes Jul 16, 2024

View reviewed changes

jonathanl-bq force-pushed the java/lotjonat_other_lang_examples branch from 1251b89 to 13ba768 Compare July 16, 2024 23:49

Yury-Fridlyand approved these changes Jul 17, 2024

View reviewed changes

barshaul reviewed Jul 18, 2024

View reviewed changes

barshaul requested changes Jul 18, 2024

View reviewed changes

acarbonetto approved these changes Aug 1, 2024

View reviewed changes

barshaul reviewed Aug 1, 2024

View reviewed changes

examples/kotlin/README.md Outdated

```

To run the Cluster example:

```

Copy link

Collaborator

barshaul Aug 1, 2024

Choose a reason for hiding this comment

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

Suggested change

```

```shell

barshaul reviewed Aug 1, 2024

View reviewed changes

jonathanl-bq force-pushed the java/lotjonat_other_lang_examples branch from a265f46 to a7533c7 Compare August 1, 2024 22:14

jonathanl-bq and others added 19 commits August 1, 2024 16:39

Add Scala and Kotlin examples

e1f7911

Signed-off-by: Jonathan Louie <[email protected]>

Fix README changes to properly link to the examples

71faa70

Signed-off-by: Jonathan Louie <[email protected]>

Add instructions on how to run Scala and Kotlin examples

6b3ee43

Signed-off-by: Jonathan Louie <[email protected]>

Move Scala and Kotlin examples to root examples folder

94760c9

Signed-off-by: Jonathan Louie <[email protected]>

Add comment about cast in Scala example

dc99095

Signed-off-by: Jonathan Louie <[email protected]>

Merge .gitignores

e694f94

Signed-off-by: Jonathan Louie <[email protected]>

Update link to Scala and Kotlin examples in Java README

ce59808

Signed-off-by: Jonathan Louie <[email protected]>

Use coroutines in Kotlin example

0c498a2

Signed-off-by: Jonathan Louie <[email protected]>

Update Scala example to use Scala Futures

47364ed

Signed-off-by: Jonathan Louie <[email protected]>

Update java/README.md

78cb97a

Co-authored-by: Yury-Fridlyand <[email protected]> Signed-off-by: Jonathan Louie <[email protected]>

Align Kotlin examples with other examples

85e0a84

Signed-off-by: Jonathan Louie <[email protected]>

Align Scala examples with other examples

37b8b3a

Signed-off-by: Jonathan Louie <[email protected]>

Update Scala example imports

8f82e22

Signed-off-by: Jonathan Louie <[email protected]>

Update Kotlin example imports

39e043c

Signed-off-by: Jonathan Louie <[email protected]>

Update README instructions on how to run Scala and Kotlin examples

738d059

Signed-off-by: Jonathan Louie <[email protected]>

Move Scala and Kotlin example documentation

6af21d4

Signed-off-by: Jonathan Louie <[email protected]>

Align Scala and Kotlin examples with the now merged Java examples

0a8d968

Signed-off-by: Jonathan Louie <[email protected]>

Update versions for SBT in the Java README

bbb7294

Signed-off-by: Jonathan Louie <[email protected]>

Address PR comments

5f6dc97

Signed-off-by: Jonathan Louie <[email protected]>

jonathanl-bq force-pushed the java/lotjonat_other_lang_examples branch from a7533c7 to 5f6dc97 Compare August 1, 2024 23:40

barshaul reviewed Aug 4, 2024

View reviewed changes

examples/scala/src/main/scala/StandaloneExample.scala Outdated Show resolved Hide resolved

barshaul approved these changes Aug 4, 2024

View reviewed changes

GumpacG added 2 commits August 7, 2024 14:08

Fixed mac setup and addressed PR comment

775113a

Signed-off-by: Guian Gumpac <[email protected]>

Added an extra check for os.arch

d32f709

Signed-off-by: Guian Gumpac <[email protected]>

acarbonetto approved these changes Aug 8, 2024

View reviewed changes

acarbonetto merged commit 60f71af into valkey-io:main Aug 8, 2024
6 checks passed

asafpamzn mentioned this pull request Aug 11, 2024

OPS tasks for release #2116

Closed

10 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Scala and Kotlin examples #1933

Add Scala and Kotlin examples #1933

jonathanl-bq commented Jul 12, 2024

barshaul Jul 18, 2024

barshaul Jul 18, 2024

jonathanl-bq Jul 18, 2024

barshaul Jul 18, 2024 •

edited

Loading

barshaul Jul 18, 2024

Yury-Fridlyand Jul 18, 2024

barshaul Jul 18, 2024

barshaul Jul 18, 2024

barshaul Aug 1, 2024

barshaul Jul 18, 2024

jonathanl-bq Jul 25, 2024

barshaul Jul 18, 2024

barshaul Jul 18, 2024

barshaul Jul 18, 2024 •

edited

Loading

Yury-Fridlyand Jul 18, 2024

barshaul left a comment •

edited

Loading

jonathanl-bq commented Jul 30, 2024

Yury-Fridlyand commented Jul 30, 2024

barshaul Aug 1, 2024

jonathanl-bq Aug 1, 2024

barshaul Aug 1, 2024

barshaul Aug 1, 2024

jonathanl-bq Aug 1, 2024

barshaul Aug 1, 2024

barshaul Aug 1, 2024

barshaul Aug 1, 2024

barshaul Aug 1, 2024 •

edited

Loading

barshaul Aug 1, 2024

barshaul Aug 1, 2024

jonathanl-bq commented Aug 2, 2024

acarbonetto Aug 8, 2024

acarbonetto Aug 8, 2024

		@@ -0,0 +1,14 @@
		# Run
		Ensure that you have an instance of Valkey running on "localhost" on "6379". Otherwise, update StandaloneExample or ClusterExample with a configuration that matches your server settings.

	Ensure that you have an instance of Valkey running on "localhost" on "6379". Otherwise, update StandaloneExample or ClusterExample with a configuration that matches your server settings.
	Ensure that you have a server running on "localhost" on port "6379". To run the ClusterExample, make sure that the server has cluster mode enabled. If the server is running on a different host and/or port, update the StandaloneExample or ClusterExample with a configuration that matches your server settings.

	case (mac, arm) if mac.contains("mac") && (arm.contains("aarch") \|\| arm.contains("arm")) => "osx-aarch_64"
	case (osName, archName) if mac.contains("mac") && (arm.contains("aarch") \|\| arm.contains("arm")) => "osx-aarch_64"

		@@ -1 +0,0 @@
		*.js


		import java.util.concurrent.ExecutionException

		object Main {

Add Scala and Kotlin examples #1933

Add Scala and Kotlin examples #1933

Conversation

jonathanl-bq commented Jul 12, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

barshaul Jul 18, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

barshaul Jul 18, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

barshaul left a comment • edited Loading

Choose a reason for hiding this comment

jonathanl-bq commented Jul 30, 2024

Yury-Fridlyand commented Jul 30, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

barshaul Aug 1, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jonathanl-bq commented Aug 2, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

barshaul Jul 18, 2024 •

edited

Loading

barshaul Jul 18, 2024 •

edited

Loading

barshaul left a comment •

edited

Loading

barshaul Aug 1, 2024 •

edited

Loading