[#10950] Filter logs by feedback session name

.github/workflows/component.yml

@@ -5,10 +5,12 @@ on:
     branches:
       - master 
       - release
+      - audit-logs
   pull_request:
     branches:
       - master 
       - release
+      - audit-logs
   schedule:
     - cron: "0 0 * * *" #end of every day
 jobs:

.github/workflows/e2e.yml

@@ -5,10 +5,12 @@ on:
     branches:
       - master 
       - release
+      - audit-logs
   pull_request:
     branches:
       - master 
       - release
+      - audit-logs
   schedule:
     - cron: "0 0 * * *" #end of every day
 jobs:

.github/workflows/lnp.yml

@@ -5,6 +5,7 @@ on:
     branches:
       - master 
       - release
+      - audit-logs
 jobs:
   LnP-testing:
     runs-on: ubuntu-latest

src/main/java/teammates/common/datatransfer/FeedbackSessionLogEntry.java

@@ -0,0 +1,38 @@
+package teammates.common.datatransfer;
+
+import teammates.common.datatransfer.attributes.FeedbackSessionAttributes;
+import teammates.common.datatransfer.attributes.StudentAttributes;
+
+/**
+ * Represents a log entry of a feedback session.
+ */
+public class FeedbackSessionLogEntry {
+    private final StudentAttributes student;
+    private final FeedbackSessionAttributes feedbackSession;
+    private final String feedbackSessionLogType;
+    private final long timestamp;
+
+    public FeedbackSessionLogEntry(StudentAttributes student, FeedbackSessionAttributes feedbackSession,
+            String feedbackSessionLogType, long timestamp) {
+        this.student = student;
+        this.feedbackSession = feedbackSession;
+        this.feedbackSessionLogType = feedbackSessionLogType;
+        this.timestamp = timestamp;
+    }
+
+    public StudentAttributes getStudent() {
+        return this.student;
+    }
+
+    public FeedbackSessionAttributes getFeedbackSession() {
+        return this.feedbackSession;
+    }
+
+    public String getFeedbackSessionLogType() {
+        return this.feedbackSessionLogType;
+    }
+
+    public long getTimestamp() {
+        return this.timestamp;
+    }
+}

src/main/java/teammates/common/exception/LogServiceException.java

@@ -0,0 +1,17 @@
+package teammates.common.exception;
+
+/**
+ * Exception thrown when the logs service fails to create or retrieve logs.
+ */
+@SuppressWarnings("serial")
+public class LogServiceException extends Exception {
+
+    public LogServiceException(String message) {
+        super(message);
+    }
+
+    public LogServiceException(Throwable cause) {
+        super(cause);
+    }
+
+}

src/main/java/teammates/common/util/Const.java

@@ -112,6 +112,9 @@ public static class ParamsNames {
         public static final String FEEDBACK_SESSION_STARTTIME = "starttime";
         public static final String FEEDBACK_SESSION_ENDTIME = "endtime";
         public static final String FEEDBACK_SESSION_MODERATED_PERSON = "moderatedperson";
+        public static final String FEEDBACK_SESSION_LOG_TYPE = "fsltype";
+        public static final String FEEDBACK_SESSION_LOG_STARTTIME = "fslstarttime";
+        public static final String FEEDBACK_SESSION_LOG_ENDTIME = "fslendtime";
 
         public static final String FEEDBACK_QUESTION_ID = "questionid";
 
@@ -186,6 +189,11 @@ public static class CsrfConfig {
 
     }
 
+    public static class FeedbackSessionLogTypes {
+        public static final String ACCESS = "access";
+        public static final String SUBMISSION = "submission";
+    }
+
     @Deprecated
     public static class LegacyURIs {
 
@@ -291,6 +299,8 @@ public static class ResourceURIs {
         public static final String SESSION_LINKS_RECOVERY = URI_PREFIX + "/sessionlinksrecovery";
         public static final String NATIONALITIES = URI_PREFIX + "/nationalities";
         public static final String EMAIL = URI_PREFIX + "/email";
+        public static final String TRACK_SESSION = URI_PREFIX + "/track/session";
+        public static final String SESSION_LOGS = URI_PREFIX + "/logs/session";
 
         public static final String STUDENT_PROFILE_PICTURE = URI_PREFIX + "/student/profilePic";
         public static final String STUDENT_PROFILE = URI_PREFIX + "/student/profile";

src/main/java/teammates/logic/api/LogsProcessor.java

@@ -1,8 +1,11 @@
 package teammates.logic.api;
 
+import java.time.Instant;
 import java.util.List;
 
 import teammates.common.datatransfer.ErrorLogEntry;
+import teammates.common.datatransfer.FeedbackSessionLogEntry;
+import teammates.common.exception.LogServiceException;
 import teammates.common.util.Config;
 import teammates.logic.core.GoogleCloudLoggingService;
 import teammates.logic.core.LocalLoggingService;
@@ -33,4 +36,21 @@ public List<ErrorLogEntry> getRecentErrorLogs() {
         return service.getRecentErrorLogs();
     }
 
+    /**
+     * Creates a feedback session log.
+     */
+    public void createFeedbackSessionLog(String courseId, String email, String fsName, String fslType)
+            throws LogServiceException {
+        service.createFeedbackSessionLog(courseId, email, fsName, fslType);
+    }
+
+    /**
+     * Gets the feedback session logs as filtered by the given parameters.
+     * @param email Can be null
+     */
+    public List<FeedbackSessionLogEntry> getFeedbackSessionLogs(String courseId, String email,
+            String feedbackSessionName, Instant startTime, Instant endTime) throws LogServiceException {
+        return service.getFeedbackSessionLogs(courseId, email, feedbackSessionName, startTime, endTime);
+    }
+
 }