Skip to content
Open
Show file tree
Hide file tree
Changes from all 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
46 changes: 46 additions & 0 deletions api-gateway/caching-with-redis/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Redis Cache

This project provides an example Redis cache implementation in Knot.x.

It was created with [Knot.x Starter Kit](https://github.com/Knotx/knotx-starter-kit).

## Run
Build and run docker swarm:

```bash
./gradlew build
docker swarm init
docker stack deploy -c redis-handler.yml redis-handler
```

## Endpoints

There is one endpoint `GET /book` that calls Google Books API. It's value is cached for 20 seconds.
Copy link
Member

Choose a reason for hiding this comment

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

I am wondering if we can merge this project with the api-gateway/caching one. The you can reuse Wiremock endpoints that respond with random values. Then you can validate cache implementation without checking Knot.x logs.


You can check the logs with

```bash
docker service logs redis-handler_knotx
```

Open [localhost:8092/book](http://localhost:8092/book). In the logs there should be:

```
No valid cache for key: the-book, calling the action
New value cached under key: the-book for 20 seconds
```

After refresh the value will be retrieved from Redis and Google Books API won't be called:

```
Retrieved value from cache under key the-book
```

And after waiting 20 seconds and refreshing the Google API will be called again, because the cache will be invalidated:

```
No valid cache for key: the-book, calling the action
New value cached under key: the-book for 20 seconds
```

[license]:https://github.com/Cognifide/knotx/blob/master/LICENSE
Copy link
Member

Choose a reason for hiding this comment

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

You can remove lines below.

44 changes: 44 additions & 0 deletions api-gateway/caching-with-redis/build.gradle.kts
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
/*
* Copyright (C) 2019 Knot.x Project
*
* 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.
*/
plugins {
id("io.knotx.distribution")
id("com.bmuschko.docker-remote-api")
id("java")
}

dependencies {
subprojects.forEach { "dist"(project(":${it.name}")) }
}

sourceSets.named("test") {
java.srcDir("functional/src/test/java")
}

allprojects {
group = "io.knotx"

repositories {
jcenter()
gradlePluginPortal()
}
}

tasks.named("build") {
dependsOn("runTest")
}

apply(from = "https://raw.githubusercontent.com/Knotx/knotx-starter-kit/${project.property("knotxVersion")}/gradle/docker.gradle.kts")
apply(from = "https://raw.githubusercontent.com/Knotx/knotx-starter-kit/${project.property("knotxVersion")}/gradle/javaAndUnitTests.gradle.kts")
9 changes: 9 additions & 0 deletions api-gateway/caching-with-redis/buildSrc/build.gradle.kts
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
repositories {
mavenLocal()
mavenCentral()
gradlePluginPortal()
}
dependencies {
implementation("com.bmuschko:gradle-docker-plugin:6.4.0")
implementation("io.knotx:knotx-gradle-plugins:0.1.2")
}
11 changes: 11 additions & 0 deletions api-gateway/caching-with-redis/docker/Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
FROM knotx/knotx:$knotx_version
LABEL maintainer="Knot.x Project"

ENV JAVA_OPTS "-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=18092"

COPY ./out/knotx /usr/local/knotx

HEALTHCHECK --interval=5s --timeout=2s --retries=12 \
CMD curl --silent --fail localhost:8092/healthcheck || exit 1

CMD [ "knotx", "run-knotx" ]
6 changes: 6 additions & 0 deletions api-gateway/caching-with-redis/gradle.properties
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
version=0.0.1-SNAPSHOT
knotxVersion=2.2.1
knotx.version=2.2.1
knotxConf=knotx
knotx.conf=knotx
docker.image.name=knotx-example/redis
Binary file not shown.
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-6.5.1-bin.zip
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists
188 changes: 188 additions & 0 deletions api-gateway/caching-with-redis/gradlew

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading