-
Notifications
You must be signed in to change notification settings - Fork 12
Implement redis cache action example #64
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
base: master
Are you sure you want to change the base?
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| [![][license img]][license] | ||
| [![][gitter img]][gitter] | ||
|
|
||
| # 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. | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I am wondering if we can merge this project with the |
||
|
|
||
| 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 | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. You can remove lines below. |
||
| [license img]:https://img.shields.io/badge/License-Apache%202.0-blue.svg | ||
|
|
||
| [gitter]:https://gitter.im/Knotx/Lobby | ||
| [gitter img]:https://badges.gitter.im/Knotx/knotx-extensions.svg | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| /* | ||
| * 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() | ||
| mavenLocal() | ||
| maven { url = uri("https://plugins.gradle.org/m2/") } | ||
| maven { url = uri("https://oss.sonatype.org/content/groups/staging/") } | ||
| maven { url = uri("https://oss.sonatype.org/content/repositories/snapshots") } | ||
| } | ||
| } | ||
|
|
||
| tasks.named("build") { | ||
| dependsOn("runTest") | ||
| } | ||
|
|
||
| apply(from = "https://raw.githubusercontent.com/Knotx/knotx-starter-kit/master/gradle/docker.gradle.kts") | ||
| apply(from = "https://raw.githubusercontent.com/Knotx/knotx-starter-kit/master/gradle/javaAndUnitTests.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:4.10.0") | ||
| implementation("io.knotx:knotx-gradle-plugins:0.1.2") | ||
| } |
| 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" ] |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| package com.project.test.functional; | ||
|
|
||
| import static io.restassured.RestAssured.given; | ||
|
|
||
| import org.junit.jupiter.api.DisplayName; | ||
| import org.junit.jupiter.api.Test; | ||
|
|
||
| class ExampleApiITCase { | ||
|
|
||
| @Test | ||
| @DisplayName("Expect 200 status code when endpoint registered.") | ||
| void callUndefinedRoute() { | ||
|
||
| given() | ||
|
||
| .port(8092) | ||
| .when() | ||
| .get("/healthcheck") | ||
| .then() | ||
| .assertThat() | ||
| .statusCode(200); | ||
| } | ||
|
|
||
| } | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| version=2.0.0-SNAPSHOT | ||
| knotx.version=2.0.0 | ||
| knotx.conf=knotx | ||
| docker.image.name=knotx-example/redis |
| 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-5.4.1-bin.zip | ||
| zipStoreBase=GRADLE_USER_HOME | ||
| zipStorePath=wrapper/dists |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
you can remove those two lines.