From 3d617fa3f38bdd3999435fdc3f0c799f42929d03 Mon Sep 17 00:00:00 2001 From: modzeleg Date: Fri, 26 Mar 2021 16:22:13 +0100 Subject: [PATCH 1/2] Added javadoc --- .../klaus/repository/EventRepositoryImpl.java | 31 +++++++++++++++++-- .../release11/klaus/utilis/RedisAppender.java | 15 ++++++++- 2 files changed, 43 insertions(+), 3 deletions(-) diff --git a/src/main/java/com/release11/klaus/repository/EventRepositoryImpl.java b/src/main/java/com/release11/klaus/repository/EventRepositoryImpl.java index e8c0698..752c655 100644 --- a/src/main/java/com/release11/klaus/repository/EventRepositoryImpl.java +++ b/src/main/java/com/release11/klaus/repository/EventRepositoryImpl.java @@ -20,15 +20,25 @@ import java.util.List; import java.util.Map; import java.util.stream.Collectors; -//TODO: Add javadoc +/** + * Builds Event list based on logs created via {@link com.release11.klaus.utilis.TrackingClient} and {@link com.release11.klaus.utilis.RedisAppender} + * @author Rafał Żukowicz + */ @Repository @AllArgsConstructor public class EventRepositoryImpl implements EventRepository { - + //TODO: create one constant for both Impl and well as RedisAppender private final String LOG_PREFIX = "logstash_"; private final JedisPool jedisPool; private final ObjectMapper objectMapper; + /** + * Creates list of {@link Event} based on {@link com.release11.klaus.model.EventRequestDto} data via searching logs + * @param localDateTimeFrom date from which logs are retrieved + * @param localDateTimeTo date to which logs are retrieved + * @param businessKeys set keys for redis values + * @return + */ @Override public List findEvents(LocalDateTime localDateTimeFrom, LocalDateTime localDateTimeTo, Map businessKeys) { @@ -45,6 +55,12 @@ public class EventRepositoryImpl implements EventRepository { .collect(Collectors.toList()); } + /** + * Returns logs between given dates + * @param localDateFrom date from which logs are retrieved + * @param localDateTo date to which logs are retrieved + * @return + */ private List findEventsBetweenDates(LocalDate localDateFrom, LocalDate localDateTo) { try (Jedis jedis = jedisPool.getResource()) { return localDateFrom.datesUntil(localDateTo.plusDays(1)).map(day -> LOG_PREFIX + day.toString()) @@ -52,6 +68,12 @@ public class EventRepositoryImpl implements EventRepository { } } + /** + * Filters keys so only the ones queried are retirned + * @param events list of logs + * @param businessKeys set keys for redis values + * @return filtered list of logs + */ private List businessKeysFilter(List events, Map businessKeys) { for (Map.Entry entry : businessKeys.entrySet()) { String stringPattern = entry.getKey().getReasonPhrase()+ "\"" + ":" + "\"" + entry.getValue() + "\""; @@ -60,6 +82,11 @@ public class EventRepositoryImpl implements EventRepository { return events; } + /** + * Parses list of logs into list of {@link Event} + * @param eventStrings list of logs + * @return list of {@link Event} + */ private List parseEvents(List eventStrings) { List events = new ArrayList<>(); for (String eventString : eventStrings) { diff --git a/src/main/java/com/release11/klaus/utilis/RedisAppender.java b/src/main/java/com/release11/klaus/utilis/RedisAppender.java index 081c2c6..df9cddf 100644 --- a/src/main/java/com/release11/klaus/utilis/RedisAppender.java +++ b/src/main/java/com/release11/klaus/utilis/RedisAppender.java @@ -15,7 +15,10 @@ import redis.clients.jedis.Jedis; import redis.clients.jedis.JedisPool; import redis.clients.jedis.Protocol; -//TODO: Add javadoc +/** + * Class is used to insert logs directly to Redis. {@link com.release11.klaus.repository.EventRepositoryImpl} is using those logs. + * @author Rafał Żukowicz + */ public class RedisAppender extends UnsynchronizedAppenderBase { JedisPool pool; @@ -37,6 +40,10 @@ public class RedisAppender extends UnsynchronizedAppenderBase { jsonlayout = new JSONEventLayout(); } + /** + * Appends JedisPool by another log + * @param event object containing log info + */ @Override protected void append(ILoggingEvent event) { Jedis client = pool.getResource(); @@ -208,6 +215,9 @@ public class RedisAppender extends UnsynchronizedAppenderBase { this.layout = layout; } + /** + * Starts new instance of JedisPool + */ @Override public void start() { super.start(); @@ -216,6 +226,9 @@ public class RedisAppender extends UnsynchronizedAppenderBase { pool = new JedisPool(config, host, port, timeout, password, database); } + /** + * Stops and destroys JedisPool object + */ @Override public void stop() { super.stop(); From 79d1bd67c333074afa25a39203ab46822f5ff5cb Mon Sep 17 00:00:00 2001 From: modzeleg Date: Fri, 26 Mar 2021 17:29:14 +0100 Subject: [PATCH 2/2] T230 added version span to header --- src/main/resources/static/css/main.css | 5 +++++ src/main/resources/static/html/mock.html | 2 +- .../repository/EventRepositoryImpl.class | Bin 8076 -> 8076 bytes .../klaus/service/KlausServiceImpl.class | Bin 6389 -> 6389 bytes .../klaus/utilis/RedisAppender.class | Bin 8092 -> 8092 bytes target/classes/static/css/main.css | 5 +++++ target/classes/static/html/mock.html | 2 +- 7 files changed, 12 insertions(+), 2 deletions(-) diff --git a/src/main/resources/static/css/main.css b/src/main/resources/static/css/main.css index 71277ff..edbfe73 100644 --- a/src/main/resources/static/css/main.css +++ b/src/main/resources/static/css/main.css @@ -302,5 +302,10 @@ input:focus { margin-right: 15px; } +#version { + color: rgba(85,85,85,0.555); + font-size: 13px; +} + diff --git a/src/main/resources/static/html/mock.html b/src/main/resources/static/html/mock.html index 1c5d7de..e43a22d 100644 --- a/src/main/resources/static/html/mock.html +++ b/src/main/resources/static/html/mock.html @@ -16,7 +16,7 @@
-
Mocked Service
+
Mocked Service v0.0.1
Your message
diff --git a/target/classes/com/release11/klaus/repository/EventRepositoryImpl.class b/target/classes/com/release11/klaus/repository/EventRepositoryImpl.class index e4cf001a88f51eb8b22fb4447bbea68c2ee8b06b..b6e1910161dabe8d66e823d8650b02bd0b920d9f 100644 GIT binary patch delta 184 zcmWN~%L+kp5XbTFzm!W-79!3$ZYdjg9a$ikM8aXq$#v~Ll-+-4;ThC<6nO}ip1?FU zO~2+dbL-uD&u5}gB0`xs6*AN)QkQBlqR9%I6D=;--aAoMu|5F?0 WsK3$&+P2op)>q5bA2Y0f*8LAx_#}G( delta 182 zcmWNJHwpq#6h+Sm!B7lXhBRrq*txZKNm z_x`>AdIi!+3{v<>6C*=bu0oCpdA3+wC~(EHKY^0+m2t_Kph}M#Gs#QJb|_>hZ$s>+ z)GhY3InuG4VW)}@#2AufL{VOjnTs`LAzTYLEcH3^b_a0~!9!4YqbJqUkLXHO^-oyQ Qb#tdIeKQX#r@!X&4>N@zk^lez diff --git a/target/classes/com/release11/klaus/service/KlausServiceImpl.class b/target/classes/com/release11/klaus/service/KlausServiceImpl.class index 6cac428ec54c30a56b49328453c851f71c750bd3..d3dc18640b9ffada5eee728f256d2c0ca6a2c0c1 100644 GIT binary patch delta 80 zcmexr_|h($ delta 80 zcmexr_|O)_tNX=}wnoTQyXE81`#?dU=ZS)4`>&Y+L$0j{rc%yYbj z4vZo#uPWcDbMm65QF^M9x{EcsWjJEXY?Y@j8TVBuwMXwYe!1FH{l?4mtMozRmVYij z#EjSBU>GrsFj=0xZyFzY?%U()fvH#NB=sZKdu-}m zakA=(YzF*NbX@%m8WUm#o!5bsnl$VMTs=*G{*Psb{*s>7GqhP+ubMOG9tK@qpuIKc ziouk6XWSQZ^&)-AxED&PWtj@4^$P91v7ez%{gHt_F_0sjH957)pnZCSR{U=b5)U`4 z&-8?hgVqNxezmqUY7Nlp+`OH+I=ET^gfLt?zu2UHGua5B|aL Y+n2Ryw&EA{Hy`Sc9F3h-w&Y^jza#B~zW@LL delta 530 zcmXZZ%}Z2K7zXg?fCtPb;X2OTnQ=av$nj#=j|yE3=tyLsFdwOi+6Txi{J@12O0y_% zkszXAZ;F-)EozYqT_~7{K_Zj{<-*j3w&@S)=^%G;cz@^ezRx*lIklWxFIe&GC_)4! zh{8e)eq3c0$2ERcsKhNKK>i}XkQGVjf)yT(1`u5P2Z8}BU7sf_UhdMCZhxaC`n_b_8G zZ1geZ12}kyM$Sv&G1}126nQ!Dy}dHX(+uGttUoc(Dg)WlT#;344BDYLXqy*SDe-W%`b@8q zr{NoVmwR8#-gY>v_RPWRBd-2N|4z@VAF>~5)xS99&`e20C#)l0$!~aY%m+T<^PS38 VG=1redd`dbBc-tx<&|tK{SUj_fmZ+k diff --git a/target/classes/static/css/main.css b/target/classes/static/css/main.css index 71277ff..edbfe73 100644 --- a/target/classes/static/css/main.css +++ b/target/classes/static/css/main.css @@ -302,5 +302,10 @@ input:focus { margin-right: 15px; } +#version { + color: rgba(85,85,85,0.555); + font-size: 13px; +} + diff --git a/target/classes/static/html/mock.html b/target/classes/static/html/mock.html index 1c5d7de..e43a22d 100644 --- a/target/classes/static/html/mock.html +++ b/target/classes/static/html/mock.html @@ -16,7 +16,7 @@
-
Mocked Service
+
Mocked Service v0.0.1
Your message