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.

Sign up for GitHub

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

Jump to bottom

perf: implement client-side caching based on ETags to reduce network traffic and potentially reduce load on ZGW API's backend #370

Open
wants to merge 18 commits into
base: master
Choose a base branch
from
Open

perf: implement client-side caching based on ETags to reduce network traffic and potentially reduce load on ZGW API's backend #370

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
e2efae9
feat: add caching solution
DelanoWAF Jun 6, 2024
7f5c687
Merge pull request #369 from wearefrank/master
DelanoWAF Jun 6, 2024
cc5f2dd
chore: add orig files
DelanoWAF Jun 6, 2024
04785f5
refactor: remove excess logging
DelanoWAF Jun 6, 2024
de22131
feat: apply HttpSenderCached to select HttpSenders
DelanoWAF Jun 27, 2024
8d3a3f9
Merge branch 'master' into GT-1035-Integrate-caching-solution
DelanoWAF Jun 27, 2024
a5a353f
Revert "merge from main"
DelanoWAF Jun 27, 2024
4f1ccef
Merge pull request #401 from wearefrank/revert-400-master
DelanoWAF Jun 27, 2024
886d0d5
build: remove Parameter.java from dockerfile
DelanoWAF Jun 27, 2024
91abbd2
Reapply "merge from main"
DelanoWAF Jun 27, 2024
e9dbb33
Revert "Reapply "merge from main""
DelanoWAF Jun 27, 2024
8ef4798
Revert "Merge branch 'master' into GT-1035-Integrate-caching-solution"
DelanoWAF Jun 27, 2024
982a75b
Reapply "Merge branch 'master' into GT-1035-Integrate-caching-solution"
DelanoWAF Jun 27, 2024
15ae5cb
Reapply "Reapply "merge from main""
DelanoWAF Jun 27, 2024
0964397
fix: uncomment necessary lines
DelanoWAF Jun 27, 2024
7627f94
Merge branch 'master' into GT-1035-Integrate-caching-solution
MLenterman Jul 16, 2024
970c946
Merge branch 'master' into GT-1035-Integrate-caching-solution
DelanoWAF Aug 12, 2024
c0ece02
refactor: apply requested changes
DelanoWAF Aug 13, 2024
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
28 changes: 16 additions & 12 deletions Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Keep in sync with version in frank-runner.properties. Detailed instructions can be found in CONTRIBUTING.md.
# Check whether java-orig files have changed in F!F and update custom code (java and java-orig files) accordingly
ARG FF_VERSION=8.1.0-20240404.042328
FROM docker.io/frankframework/frankframework:${FF_VERSION} as ff-base

Check warning on line 4 in Dockerfile

View workflow job for this annotation

GitHub Actions / ci / docker-ci / build

The 'as' keyword should match the case of the 'from' keyword 

FromAsCasing: 'as' and 'FROM' keywords' casing do not match
More info: https://docs.docker.com/go/dockerfile/rule/from-as-casing/

# Copy dependencies
COPY --chown=tomcat lib/server/* /usr/local/tomcat/lib/
Expand All @@ -10,19 +10,23 @@
# # Compile custom class
# FROM eclipse-temurin:17-jdk-jammy AS custom-code-builder

# # Copy dependencies
# COPY --from=ff-base /usr/local/tomcat/lib/ /usr/local/tomcat/lib/
# COPY --from=ff-base /usr/local/tomcat/webapps/ROOT /usr/local/tomcat/webapps/ROOT
# Compile custom class
FROM eclipse-temurin:17-jdk-jammy AS custom-code-builder

# # Copy custom class
# COPY src/main/java /tmp/java
# RUN mkdir /tmp/classes && \
# javac \
# /tmp/java/org/frankframework/parameters/Parameter.java \
# -classpath "/usr/local/tomcat/webapps/ROOT/WEB-INF/lib/*:/usr/local/tomcat/lib/*" \
# -verbose -d /tmp/classes
# Copy dependencies
COPY --from=ff-base /usr/local/tomcat/lib/ /usr/local/tomcat/lib/
COPY --from=ff-base /usr/local/tomcat/webapps/ROOT /usr/local/tomcat/webapps/ROOT

# Copy custom class
COPY src/main/java /tmp/java
RUN mkdir /tmp/classes && \
javac \
/tmp/java/org/frankframework/http/HttpSenderCached.java \
/tmp/java/org/frankframework/http/HttpSenderBaseCached.java \
-classpath "/usr/local/tomcat/webapps/ROOT/WEB-INF/lib/*:/usr/local/tomcat/lib/*" \
-verbose -d /tmp/classes

# FROM ff-base
FROM ff-base

# Copy custom entrypoint script with added options
COPY --chown=tomcat docker/entrypoint.sh /scripts/entrypoint.sh
Expand All @@ -44,7 +48,7 @@
COPY --chown=tomcat src/test/testtool/ /opt/frank/testtool/

# # Copy compiled custom class
# COPY --from=custom-code-builder --chown=tomcat /tmp/classes/ /usr/local/tomcat/webapps/ROOT/WEB-INF/classes
COPY --from=custom-code-builder --chown=tomcat /tmp/classes/ /usr/local/tomcat/webapps/ROOT/WEB-INF/classes

# Check if Frank! is still healthy
HEALTHCHECK --interval=15s --timeout=5s --start-period=30s --retries=60 \
Expand Down
2 changes: 1 addition & 1 deletion src/main/configurations/Translate/Configuration_GetRolTypenByUrl.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
name="GetRolTypenByUrlSender"
getInputFromSessionKey="originalMessage"
>
<HttpSender
<Sender className="org.frankframework.http.HttpSenderCached"
name="GetRolTypenByUrlHttpSender"
methodType="GET"
headersParams="Authorization,Accept-Crs"
Expand Down
2 changes: 1 addition & 1 deletion src/main/configurations/Translate/Configuration_GetZaakDocumentByUrl.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@

<SenderPipe name="GetZaakDocumentByUrl"
getInputFromFixedValue="&lt;dummy/&gt;">
<HttpSender
<Sender className="org.frankframework.http.HttpSenderCached"
name="GetZaakDocumentByUrlSender"
methodType="GET"
headersParams="Authorization,Accept-Crs"
Expand Down
2 changes: 1 addition & 1 deletion src/main/configurations/Translate/Configuration_GetZaakTypeByUrl.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@

<SenderPipe name="GetZgwZaakTypeByUrlSender"
getInputFromFixedValue="&lt;dummy/&gt;">
<HttpSender
<Sender className="org.frankframework.http.HttpSenderCached"
name="GetZgwZaakTypeByUrlHttpSender"
methodType="GET"
headersParams="Authorization,Accept-Crs"
Expand Down
2 changes: 1 addition & 1 deletion src/main/configurations/Translate/Configuration_GetZgwInformatieObjectTypeByUrl.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@

<SenderPipe name="GetZgwInformatieObjectTypeByUrl"
getInputFromFixedValue="&lt;dummy/&gt;">
<HttpSender
<Sender className="org.frankframework.http.HttpSenderCached"
name="GetZgwInformatieObjectTypeByUrlSender"
methodType="GET"
headersParams="Authorization,Accept-Crs"
Expand Down
2 changes: 1 addition & 1 deletion src/main/configurations/Translate/Configuration_GetZgwStatusTypeByUrl.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@

<SenderPipe name="GetZgwStatusTypeByUrlSender"
getInputFromFixedValue="&lt;dummy/&gt;">
<HttpSender
<Sender className="org.frankframework.http.HttpSenderCached"
name="GetZgwStatusTypeByUrlLocalSender"
methodType="GET"
headersParams="Authorization,Accept-Crs"
Expand Down
2 changes: 1 addition & 1 deletion src/main/configurations/Translate/Configuration_GetZgwZaakByUrl.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@

<SenderPipe name="GetZgwZaakByUrl"
getInputFromFixedValue="&lt;dummy/&gt;">
<HttpSender
<Sender className="org.frankframework.http.HttpSenderCached"
name="GetZgwZaakByUrlSender"
methodType="GET"
headersParams="Authorization,Accept-Crs"
Expand Down
8 changes: 4 additions & 4 deletions src/main/configurations/Translate/Configuration_Translate_GeefZaakdetails_Lv01.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
</PutInSessionPipe>

<SenderPipe name="getZaakTypeByUrl" storeResultInSessionKey="zaakTypeJson">
<HttpSender
<Sender className="org.frankframework.http.HttpSenderCached"
name="getZaakTypeByUrl"
methodType="GET"
headersParams="Authorization,Accept-Crs"
Expand All @@ -59,7 +59,7 @@
<Param name="Authorization" xpathExpression="concat('Bearer ', $token)" >
<Param name="token" sessionKey="token" />
</Param>
</HttpSender>
</Sender>
<Forward name="exception" path="ErrorJsonToXml_2" />
</SenderPipe>
<JsonPipe name="ErrorJsonToXml_2">
Expand All @@ -82,7 +82,7 @@
</XsltPipe>

<SenderPipe name="getRollenByUrl" getInputFromFixedValue="&lt;dummy/&gt;" storeResultInSessionKey="rollenJson">
<HttpSender
<Sender className="org.frankframework.http.HttpSenderCached"
name="getRollenByUrl"
methodType="GET"
headersParams="Authorization,Accept-Crs"
Expand All @@ -93,7 +93,7 @@
<Param name="Authorization" xpathExpression="concat('Bearer ', $token)" >
<Param name="token" sessionKey="token" />
</Param>
</HttpSender>
</Sender>
<Forward name="exception" path="ErrorJsonToXml_3" />
</SenderPipe>
<JsonPipe name="ErrorJsonToXml_3">
Expand Down
2 changes: 1 addition & 1 deletion src/main/configurations/Translate/Configuration_Zaken_GetZgwRolTypeByUrl.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
<SenderPipe
name="GetZgwRolTypeByUrlSender"
getInputFromFixedValue="&lt;dummy/&gt;">
<HttpSender
<Sender className="org.frankframework.http.HttpSenderCached"
name="GetZgwRolTypeByUrlHttpSender"
methodType="GET"
headersParams="Authorization,Accept-Crs"
Expand Down
Loading
Loading