diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml index b1fdcf6..c9638f7 100644 --- a/.github/workflows/codeql.yml +++ b/.github/workflows/codeql.yml @@ -43,7 +43,7 @@ jobs: # Initializes the CodeQL tools for scanning. - name: Initialize CodeQL - uses: github/codeql-action/init@v2 + uses: github/codeql-action/init@v3 with: languages: ${{ matrix.language }} # If you wish to specify custom queries, you can do so here or in a config file. @@ -64,6 +64,6 @@ jobs: run: make build - name: Perform CodeQL Analysis - uses: github/codeql-action/analyze@v2 + uses: github/codeql-action/analyze@v3 with: category: "/language:${{matrix.language}}" diff --git a/.github/workflows/on-pull-request.yml b/.github/workflows/on-pull-request.yml index 3332631..d53a1d9 100644 --- a/.github/workflows/on-pull-request.yml +++ b/.github/workflows/on-pull-request.yml @@ -50,3 +50,34 @@ jobs: - name: Run tests vs redis run: make test-redis + + build-examples: + runs-on: ubuntu-latest + env: + MOMENTO_API_KEY: ${{ secrets.ALPHA_TEST_AUTH_TOKEN }} + + steps: + - name: Checkout project + uses: actions/checkout@v3 + + - name: Set up JDK 17 + uses: actions/setup-java@v3 + with: + java-version: 17 + distribution: 'corretto' + + - name: Build examples + id: validation + continue-on-error: true + run: make build-examples + + - name: Send CI failure mail + if: ${{ steps.validation.outcome == 'failure' }} + uses: momentohq/standards-and-practices/github-actions/error-email-action@gh-actions-v1 + with: + username: ${{secrets.MOMENTO_ROBOT_GMAIL_USERNAME}} + password: ${{secrets.MOMENTO_ROBOT_GMAIL_PASSWORD}} + + - name: Flag Job Failure + if: ${{ steps.validation.outcome == 'failure' }} + run: exit 1 diff --git a/.github/workflows/on-push-to-main-branch.yml b/.github/workflows/on-push-to-main-branch.yml index eb24966..4687ec5 100644 --- a/.github/workflows/on-push-to-main-branch.yml +++ b/.github/workflows/on-push-to-main-branch.yml @@ -13,29 +13,9 @@ jobs: with: token: ${{ secrets.MOMENTO_MACHINE_USER_GITHUB_TOKEN }} -# - name: Generate README -# uses: momentohq/standards-and-practices/github-actions/generate-and-commit-oss-readme@gh-actions-v2 -# with: -# project_status: official -# project_stability: stable -# project_type: sdk -# sdk_language: Java -# dev_docs_slug: java -# -# - name: Verify Storage examples README generation -# uses: momentohq/standards-and-practices/github-actions/generate-and-commit-oss-readme@gh-actions-v2 -# with: -# project_status: official -# project_stability: beta -# project_type: other -# template_file: ./examples/storage/README.template.md -# output_file: ./examples/storage/README.md -# -# - name: Verify examples README generation -# uses: momentohq/standards-and-practices/github-actions/generate-and-commit-oss-readme@gh-actions-v2 -# with: -# project_status: official -# project_stability: beta -# project_type: other -# template_file: ./examples/README.template.md -# output_file: ./examples/README.md + - name: Generate README + uses: momentohq/standards-and-practices/github-actions/generate-and-commit-oss-readme@gh-actions-v2 + with: + project_status: official + project_stability: alpha + project_type: other diff --git a/.github/workflows/on-push-to-release-branch.yml b/.github/workflows/on-push-to-release-branch.yml index 2b1feb0..2027d5d 100644 --- a/.github/workflows/on-push-to-release-branch.yml +++ b/.github/workflows/on-push-to-release-branch.yml @@ -54,5 +54,4 @@ jobs: ORG_GRADLE_PROJECT_version: ${{ needs.release.outputs.version }} uses: gradle/gradle-build-action@v2 with: - # Note that this will require manual release from Sonatype - arguments: publishToSonatype closeSonatypeStagingRepository + arguments: publishToSonatype closeAndReleaseSonatypeStagingRepository diff --git a/.gitignore b/.gitignore index db9d3e1..6d32908 100644 --- a/.gitignore +++ b/.gitignore @@ -12,6 +12,8 @@ # Package Files # *.jar +!gradle/wrapper/gradle-wrapper.jar +!examples/gradle/wrapper/gradle-wrapper.jar *.war *.nar *.ear @@ -31,18 +33,4 @@ build *.iml .idea -# Ignore Gradle project-specific cache directory -examples/.gradle - -# Ignore Gradle build output directory -examples/build - -# Ignore IDE -examples/.idea -examples/.project -examples/.settings -examples/lib/.settings -examples/lib/.classpath -examples/lib/.project -examples/lib/bin .vscode/ diff --git a/Makefile b/Makefile index 508c6fc..4260638 100644 --- a/Makefile +++ b/Makefile @@ -11,6 +11,10 @@ clean: build: ./gradlew assemble +## Build the examples +build-examples: + cd ./examples && ./gradlew assemble + ## Run all the tests test: test-momento test-redis diff --git a/README.md b/README.md index 9f7fcb7..d5249cc 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,119 @@ -# momento-java-lettuce-client -Momento-backed implementation of [@lettuce](https://github.com/redis/lettuce) client +logo + +[![project status](https://momentohq.github.io/standards-and-practices/badges/project-status-official.svg)](https://github.com/momentohq/standards-and-practices/blob/main/docs/momento-on-github.md) +[![project stability](https://momentohq.github.io/standards-and-practices/badges/project-stability-alpha.svg)](https://github.com/momentohq/standards-and-practices/blob/main/docs/momento-on-github.md) + + +# Momento Lettuce Compatibility Client + +## What and why? + +This project provides a Momento-backed implementation of [lettuce](https://github.com/redis/lettuce) +The goal is to provide a drop-in replacement for [lettuce](https://github.com/redis/lettuce) so that you can +use the same code with either a Redis server or with the Momento Cache service! + +## Installation + +To use the compatiblity client, you will need three dependencies in your project: the Momento Lettuce compatibility client, the Momento Cache client, and the lettuce client. + +The Momento Lettuce compatibility client is [available on Maven Central](https://search.maven.org/artifact/software.momento.java/momento-lettuce). You can add it to your project via: + +```xml + + software.momento.java + momento-lettuce + 0.1.0 + +``` + +You will also need to add the Momento Cache client library to your project. You can find the latest version of the Momento Cache client library [on Maven Central](https://central.sonatype.com/artifact/software.momento.java/sdk) as well: + +```xml + + software.momento.java + sdk + 1.15.0 + +``` + +As well as the lettuce client also [on Maven Central](https://central.sonatype.com/artifact/io.lettuce/lettuce-core). + +## Usage + +To switch your existing `lettuce` application to use Momento Cache, you only need to change the code where you construct your client object. Here is an example of constructing a Momento lettuce client: + +```java +package momento.lettuce.example.doc_examples; + +import io.lettuce.core.api.reactive.RedisReactiveCommands; +import java.time.Duration; +import momento.lettuce.MomentoRedisReactiveClient; +import momento.sdk.CacheClient; +import momento.sdk.auth.CredentialProvider; +import momento.sdk.config.Configurations; + +class ReadmeExample { + public static void main(String[] args) { + // Create a Momento cache client + try (final CacheClient cacheClient = + CacheClient.create( + CredentialProvider.fromEnvVar("MOMENTO_API_KEY"), + Configurations.Laptop.v1(), + Duration.ofSeconds(60))) { + final String cacheName = "cache"; + + // Create a Redis client backed by the Momento cache client over the cache + RedisReactiveCommands redisClient = + MomentoRedisReactiveClient.create(cacheClient, cacheName); + + // Perform operations vs Momento as if using a regular Redis client + var setResult = redisClient.set("key", "value").block(); + System.out.println("Set result: " + setResult); + + var getResult = redisClient.get("key").block(); + System.out.println("Get result: " + getResult); + } + } +} + +``` + +Additionally, to understand what APIs are supported, you can use the interface `MomentoRedisReactiveCommands` which contains only those APIs that are supported by this compatibility client: + +```java +package momento.lettuce.example.doc_examples; + +import java.time.Duration; +import momento.lettuce.MomentoRedisReactiveClient; +import momento.lettuce.MomentoRedisReactiveCommands; +import momento.sdk.CacheClient; +import momento.sdk.auth.CredentialProvider; +import momento.sdk.config.Configurations; + +class LimitedApiExample { + public static void main(String[] args) { + // Create a Momento cache client + try (final CacheClient cacheClient = + CacheClient.create( + CredentialProvider.fromEnvVar("MOMENTO_API_KEY"), + Configurations.Laptop.v1(), + Duration.ofSeconds(60))) { + final String cacheName = "cache"; + + // This interface provides type safety as it only allows the user to interact with the + // RedisReactiveCommands + // commands that are supported by the MomentoRedisReactiveCommands class + MomentoRedisReactiveCommands redisClient = + MomentoRedisReactiveClient.create(cacheClient, cacheName); + } + } +} + +``` + +## Current Redis API support + +This library supports the most popular Redis APIs, but does not yet support all Redis APIs. We currently support the most common APIs related to string values (`get`, `set`, `unlink`), as well as list (`lpush`, `lrange`, `ltrim`). We will be adding support for additional APIs in the future. If there is a particular API that you need support for, please drop by our [Discord](https://discord.com/invite/3HkAKjUZGq) or e-mail us at [support@momentohq.com](mailto:support@momentohq.com) and let us know! + +---------------------------------------------------------------------------------------- +For more info, visit our website at [https://gomomento.com](https://gomomento.com)! diff --git a/README.template.md b/README.template.md new file mode 100644 index 0000000..4ec6da2 --- /dev/null +++ b/README.template.md @@ -0,0 +1,55 @@ +{{ ossHeader }} + +# Momento Lettuce Compatibility Client + +## What and why? + +This project provides a Momento-backed implementation of [lettuce](https://github.com/redis/lettuce) +The goal is to provide a drop-in replacement for [lettuce](https://github.com/redis/lettuce) so that you can +use the same code with either a Redis server or with the Momento Cache service! + +## Installation + +To use the compatiblity client, you will need three dependencies in your project: the Momento Lettuce compatibility client, the Momento Cache client, and the lettuce client. + +The Momento Lettuce compatibility client is [available on Maven Central](https://search.maven.org/artifact/software.momento.java/momento-lettuce). You can add it to your project via: + +```xml + + software.momento.java + momento-lettuce + 0.1.0 + +``` + +You will also need to add the Momento Cache client library to your project. You can find the latest version of the Momento Cache client library [on Maven Central](https://central.sonatype.com/artifact/software.momento.java/sdk) as well: + +```xml + + software.momento.java + sdk + 1.15.0 + +``` + +As well as the lettuce client also [on Maven Central](https://central.sonatype.com/artifact/io.lettuce/lettuce-core). + +## Usage + +To switch your existing `lettuce` application to use Momento Cache, you only need to change the code where you construct your client object. Here is an example of constructing a Momento lettuce client: + +```java +{% include "./examples/src/main/java/momento/lettuce/example/doc_examples/ReadmeExample.java" %} +``` + +Additionally, to understand what APIs are supported, you can use the interface `MomentoRedisReactiveCommands` which contains only those APIs that are supported by this compatibility client: + +```java +{% include "./examples/src/main/java/momento/lettuce/example/doc_examples/LimitedApiExample.java" %} +``` + +## Current Redis API support + +This library supports the most popular Redis APIs, but does not yet support all Redis APIs. We currently support the most common APIs related to string values (`get`, `set`, `unlink`), as well as list (`lpush`, `lrange`, `ltrim`). We will be adding support for additional APIs in the future. If there is a particular API that you need support for, please drop by our [Discord](https://discord.com/invite/3HkAKjUZGq) or e-mail us at [support@momentohq.com](mailto:support@momentohq.com) and let us know! + +{{ ossFooter }} diff --git a/examples/build.gradle.kts b/examples/build.gradle.kts new file mode 100644 index 0000000..64881d6 --- /dev/null +++ b/examples/build.gradle.kts @@ -0,0 +1,21 @@ +plugins { + id("java") + id("com.diffplug.spotless") version "5.15.1" +} + +repositories { + mavenCentral() +} + +dependencies { + implementation("io.lettuce:lettuce-core:6.4.0.RELEASE") + implementation("software.momento.java:momento-lettuce:0.1.0") + implementation("software.momento.java:sdk:1.15.0") +} + +spotless { + java { + removeUnusedImports() + googleJavaFormat("1.11.0") + } +} \ No newline at end of file diff --git a/examples/gradle.properties b/examples/gradle.properties new file mode 100644 index 0000000..3a26f08 --- /dev/null +++ b/examples/gradle.properties @@ -0,0 +1,8 @@ +# Needed for https://github.com/diffplug/spotless/issues/834 +# Google's Java Fromat has compatibility issues with JDK 16 - +# https://github.com/google/google-java-format#jdk-16 +org.gradle.jvmargs=--add-exports jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED \ + --add-exports jdk.compiler/com.sun.tools.javac.file=ALL-UNNAMED \ + --add-exports jdk.compiler/com.sun.tools.javac.parser=ALL-UNNAMED \ + --add-exports jdk.compiler/com.sun.tools.javac.tree=ALL-UNNAMED \ + --add-exports jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED \ No newline at end of file diff --git a/examples/gradle/wrapper/gradle-wrapper.jar b/examples/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..249e583 Binary files /dev/null and b/examples/gradle/wrapper/gradle-wrapper.jar differ diff --git a/examples/gradle/wrapper/gradle-wrapper.properties b/examples/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..4a0ee7d --- /dev/null +++ b/examples/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,6 @@ +#Mon Sep 16 10:36:21 PDT 2024 +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.5-bin.zip +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/examples/gradlew b/examples/gradlew new file mode 100755 index 0000000..1b6c787 --- /dev/null +++ b/examples/gradlew @@ -0,0 +1,234 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 the original authors. +# +# 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 +# +# https://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. +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit + +APP_NAME="Gradle" +APP_BASE_NAME=${0##*/} + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + +# Collect all arguments for the java command; +# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of +# shell script including quotes and variable substitutions, so put them in +# double quotes to make sure that they get re-expanded; and +# * put everything else in single quotes, so that it's not re-expanded. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/examples/gradlew.bat b/examples/gradlew.bat new file mode 100644 index 0000000..ac1b06f --- /dev/null +++ b/examples/gradlew.bat @@ -0,0 +1,89 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%" == "" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%" == "" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if "%ERRORLEVEL%" == "0" goto execute + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="0" goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/examples/settings.gradle.kts b/examples/settings.gradle.kts new file mode 100644 index 0000000..89f439a --- /dev/null +++ b/examples/settings.gradle.kts @@ -0,0 +1,2 @@ +rootProject.name = "examples" + diff --git a/examples/src/main/java/momento/lettuce/example/Basic.java b/examples/src/main/java/momento/lettuce/example/Basic.java new file mode 100644 index 0000000..ca83688 --- /dev/null +++ b/examples/src/main/java/momento/lettuce/example/Basic.java @@ -0,0 +1,61 @@ +package momento.lettuce.example; + +import io.lettuce.core.api.reactive.RedisReactiveCommands; +import java.time.Duration; +import momento.lettuce.MomentoRedisReactiveClient; +import momento.sdk.CacheClient; +import momento.sdk.auth.CredentialProvider; +import momento.sdk.config.Configurations; +import momento.sdk.exceptions.MomentoErrorCode; +import momento.sdk.responses.cache.control.CacheCreateResponse; + +class Basic { + private static final String API_KEY_ENV_VAR = "MOMENTO_API_KEY"; + private static final Duration DEFAULT_TTL = Duration.ofSeconds(60); + private static final String CACHE_NAME = "cache"; + + public static void main(String[] args) { + // Create a Momento cache client + try (final CacheClient cacheClient = setUpMomentoClient()) { + ensureCacheExists(cacheClient); + + // Create a Redis client backed by the Momento cache client over the cache + RedisReactiveCommands redisClient = + MomentoRedisReactiveClient.create(cacheClient, CACHE_NAME); + + // Perform operations vs Momento as if using a regular Redis client + var setResult = redisClient.set("key", "value").block(); + System.out.println("Set result: " + setResult); + + var getResult = redisClient.get("key").block(); + System.out.println("Get result: " + getResult); + + var unlinkResult = redisClient.unlink("key").block(); + System.out.println("Unlink result: " + unlinkResult); + + var getResultAfterUnlink = redisClient.get("key").block(); + System.out.println("Get result after unlink: " + getResultAfterUnlink); + } + } + + private static CacheClient setUpMomentoClient() { + return CacheClient.create( + CredentialProvider.fromEnvVar(API_KEY_ENV_VAR), Configurations.Laptop.v1(), DEFAULT_TTL); + } + + private static void ensureCacheExists(CacheClient client) { + var createCacheResponse = client.createCache(CACHE_NAME).join(); + + if (createCacheResponse instanceof CacheCreateResponse.Success) { + System.out.println("Cache created: " + CACHE_NAME); + } else if (createCacheResponse instanceof CacheCreateResponse.Error error) { + if (error.getErrorCode() == MomentoErrorCode.ALREADY_EXISTS_ERROR) { + System.out.println("Cache already exists: " + CACHE_NAME); + } else { + System.out.println("Failed to create cache: " + CACHE_NAME); + } + } else { + System.out.println("Unknown response type: " + createCacheResponse); + } + } +} diff --git a/examples/src/main/java/momento/lettuce/example/doc_examples/LimitedApiExample.java b/examples/src/main/java/momento/lettuce/example/doc_examples/LimitedApiExample.java new file mode 100644 index 0000000..7ceb78d --- /dev/null +++ b/examples/src/main/java/momento/lettuce/example/doc_examples/LimitedApiExample.java @@ -0,0 +1,27 @@ +package momento.lettuce.example.doc_examples; + +import java.time.Duration; +import momento.lettuce.MomentoRedisReactiveClient; +import momento.lettuce.MomentoRedisReactiveCommands; +import momento.sdk.CacheClient; +import momento.sdk.auth.CredentialProvider; +import momento.sdk.config.Configurations; + +class LimitedApiExample { + public static void main(String[] args) { + // Create a Momento cache client + try (final CacheClient cacheClient = + CacheClient.create( + CredentialProvider.fromEnvVar("MOMENTO_API_KEY"), + Configurations.Laptop.v1(), + Duration.ofSeconds(60))) { + final String cacheName = "cache"; + + // This interface provides type safety as it only allows the user to interact with the + // RedisReactiveCommands + // commands that are supported by the MomentoRedisReactiveCommands class + MomentoRedisReactiveCommands redisClient = + MomentoRedisReactiveClient.create(cacheClient, cacheName); + } + } +} diff --git a/examples/src/main/java/momento/lettuce/example/doc_examples/ReadmeExample.java b/examples/src/main/java/momento/lettuce/example/doc_examples/ReadmeExample.java new file mode 100644 index 0000000..f1c27f8 --- /dev/null +++ b/examples/src/main/java/momento/lettuce/example/doc_examples/ReadmeExample.java @@ -0,0 +1,32 @@ +package momento.lettuce.example.doc_examples; + +import io.lettuce.core.api.reactive.RedisReactiveCommands; +import java.time.Duration; +import momento.lettuce.MomentoRedisReactiveClient; +import momento.sdk.CacheClient; +import momento.sdk.auth.CredentialProvider; +import momento.sdk.config.Configurations; + +class ReadmeExample { + public static void main(String[] args) { + // Create a Momento cache client + try (final CacheClient cacheClient = + CacheClient.create( + CredentialProvider.fromEnvVar("MOMENTO_API_KEY"), + Configurations.Laptop.v1(), + Duration.ofSeconds(60))) { + final String cacheName = "cache"; + + // Create a Redis client backed by the Momento cache client over the cache + RedisReactiveCommands redisClient = + MomentoRedisReactiveClient.create(cacheClient, cacheName); + + // Perform operations vs Momento as if using a regular Redis client + var setResult = redisClient.set("key", "value").block(); + System.out.println("Set result: " + setResult); + + var getResult = redisClient.get("key").block(); + System.out.println("Get result: " + getResult); + } + } +} diff --git a/src/main/java/momento/lettuce/MomentoRedisReactiveClient.java b/src/main/java/momento/lettuce/MomentoRedisReactiveClient.java index 669a161..ed2e261 100644 --- a/src/main/java/momento/lettuce/MomentoRedisReactiveClient.java +++ b/src/main/java/momento/lettuce/MomentoRedisReactiveClient.java @@ -112,7 +112,6 @@ public class MomentoRedisReactiveClient private final CacheClient client; private final String cacheName; private final RedisCodecByteArrayConverter codec; - private volatile EventExecutorGroup scheduler; /** * Creates a new {@link MomentoRedisReactiveClient}. @@ -125,7 +124,6 @@ public MomentoRedisReactiveClient(CacheClient client, String cacheName, RedisCod this.client = client; this.cacheName = cacheName; this.codec = new RedisCodecByteArrayConverter<>(codec); - this.scheduler = ImmediateEventExecutor.INSTANCE; } /**