feat: [FC-0072] Static code analyzer (openedx#403)

* feat: detekt * refactor: Changes according to detekt warnings * refactor: Address NestedBlockDepth warnings by reducing block nesting * refactor: Changes according to detekt warnings * refactor: minor rule changes
raccoongang · Nov 15, 2024 · af3b8a9 · af3b8a9
1 parent 88dfc54
commit af3b8a9
Show file tree

Hide file tree

Showing 336 changed files with 3,328 additions and 2,445 deletions.
diff --git a/.github/workflows/detekt.yml b/.github/workflows/detekt.yml
@@ -0,0 +1,33 @@
+name: Detekt
+
+on:
+  workflow_dispatch:
+  pull_request: { }
+
+env:
+  GRADLE_OPTS: -Dorg.gradle.daemon=false
+  CI_GRADLE_ARG_PROPERTIES: --stacktrace
+
+jobs:
+  linting:
+    name: Run Detekt
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Repo
+        uses: actions/checkout@v4
+
+      - name: Setup Java
+        uses: actions/setup-java@v4
+        with:
+          distribution: 'temurin' # See 'Supported distributions' for available options
+          java-version: '17'
+
+      - name: Run Detekt
+        run: ./gradlew detektAll
+
+      - name: Upload report
+        uses: github/codeql-action/upload-sarif@v3
+        if: success() || failure()
+        with:
+          sarif_file: build/reports/detekt/detekt.sarif
diff --git a/app/src/main/java/org/openedx/app/AnalyticsManager.kt b/app/src/main/java/org/openedx/app/AnalyticsManager.kt
@@ -11,9 +11,17 @@ import org.openedx.foundation.interfaces.Analytics
 import org.openedx.profile.presentation.ProfileAnalytics
 import org.openedx.whatsnew.presentation.WhatsNewAnalytics
 
-class AnalyticsManager : AppAnalytics, AppReviewAnalytics, AuthAnalytics, CoreAnalytics,
-    CourseAnalytics, DashboardAnalytics, DiscoveryAnalytics, DiscussionAnalytics,
-    ProfileAnalytics, WhatsNewAnalytics {
+class AnalyticsManager :
+    AppAnalytics,
+    AppReviewAnalytics,
+    AuthAnalytics,
+    CoreAnalytics,
+    CourseAnalytics,
+    DashboardAnalytics,
+    DiscoveryAnalytics,
+    DiscussionAnalytics,
+    ProfileAnalytics,
+    WhatsNewAnalytics {
 
     private val analytics: MutableList<Analytics> = mutableListOf()
 
@@ -45,17 +53,26 @@ class AnalyticsManager : AppAnalytics, AppReviewAnalytics, AuthAnalytics, CoreAn
         }
     }
 
-    override fun dashboardCourseClickedEvent(courseId: String, courseName: String) {
-        logEvent(Event.DASHBOARD_COURSE_CLICKED, buildMap {
-            put(Key.COURSE_ID.keyName, courseId)
-            put(Key.COURSE_NAME.keyName, courseName)
-        })
+    override fun dashboardCourseClickedEvent(
+        courseId: String,
+        courseName: String
+    ) {
+        logEvent(
+            Event.DASHBOARD_COURSE_CLICKED,
+            buildMap {
+                put(Key.COURSE_ID.keyName, courseId)
+                put(Key.COURSE_NAME.keyName, courseName)
+            }
+        )
     }
 
     override fun logoutEvent(force: Boolean) {
-        logEvent(Event.USER_LOGOUT, buildMap {
-            put(Key.FORCE.keyName, force)
-        })
+        logEvent(
+            Event.USER_LOGOUT,
+            buildMap {
+                put(Key.FORCE.keyName, force)
+            }
+        )
     }
 
     override fun setUserIdForSession(userId: Long) {
@@ -67,104 +84,164 @@ class AnalyticsManager : AppAnalytics, AppReviewAnalytics, AuthAnalytics, CoreAn
     }
 
     override fun discoveryCourseSearchEvent(label: String, coursesCount: Int) {
-        logEvent(Event.DISCOVERY_COURSE_SEARCH, buildMap {
-            put(Key.LABEL.keyName, label)
-            put(Key.COURSE_COUNT.keyName, coursesCount)
-        })
+        logEvent(
+            Event.DISCOVERY_COURSE_SEARCH,
+            buildMap {
+                put(Key.LABEL.keyName, label)
+                put(Key.COURSE_COUNT.keyName, coursesCount)
+            }
+        )
     }
 
     override fun discoveryCourseClickedEvent(courseId: String, courseName: String) {
-        logEvent(Event.DISCOVERY_COURSE_CLICKED, buildMap {
-            put(Key.COURSE_ID.keyName, courseId)
-            put(Key.COURSE_NAME.keyName, courseName)
-        })
+        logEvent(
+            Event.DISCOVERY_COURSE_CLICKED,
+            buildMap {
+                put(Key.COURSE_ID.keyName, courseId)
+                put(Key.COURSE_NAME.keyName, courseName)
+            }
+        )
     }
 
     override fun sequentialClickedEvent(
-        courseId: String, courseName: String, blockId: String, blockName: String,
+        courseId: String,
+        courseName: String,
+        blockId: String,
+        blockName: String,
     ) {
-        logEvent(Event.SEQUENTIAL_CLICKED, buildMap {
-            put(Key.COURSE_ID.keyName, courseId)
-            put(Key.COURSE_NAME.keyName, courseName)
-            put(Key.BLOCK_ID.keyName, blockId)
-            put(Key.BLOCK_NAME.keyName, blockName)
-        })
+        logEvent(
+            Event.SEQUENTIAL_CLICKED,
+            buildMap {
+                put(Key.COURSE_ID.keyName, courseId)
+                put(Key.COURSE_NAME.keyName, courseName)
+                put(Key.BLOCK_ID.keyName, blockId)
+                put(Key.BLOCK_NAME.keyName, blockName)
+            }
+        )
     }
 
     override fun nextBlockClickedEvent(
-        courseId: String, courseName: String, blockId: String, blockName: String,
+        courseId: String,
+        courseName: String,
+        blockId: String,
+        blockName: String,
     ) {
-        logEvent(Event.NEXT_BLOCK_CLICKED, buildMap {
-            put(Key.COURSE_ID.keyName, courseId)
-            put(Key.COURSE_NAME.keyName, courseName)
-            put(Key.BLOCK_ID.keyName, blockId)
-            put(Key.BLOCK_NAME.keyName, blockName)
-        })
+        logEvent(
+            Event.NEXT_BLOCK_CLICKED,
+            buildMap {
+                put(Key.COURSE_ID.keyName, courseId)
+                put(Key.COURSE_NAME.keyName, courseName)
+                put(Key.BLOCK_ID.keyName, blockId)
+                put(Key.BLOCK_NAME.keyName, blockName)
+            }
+        )
     }
 
     override fun prevBlockClickedEvent(
-        courseId: String, courseName: String, blockId: String, blockName: String,
+        courseId: String,
+        courseName: String,
+        blockId: String,
+        blockName: String,
     ) {
-        logEvent(Event.PREV_BLOCK_CLICKED, buildMap {
-            put(Key.COURSE_ID.keyName, courseId)
-            put(Key.COURSE_NAME.keyName, courseName)
-            put(Key.BLOCK_ID.keyName, blockId)
-            put(Key.BLOCK_NAME.keyName, blockName)
-        })
+        logEvent(
+            Event.PREV_BLOCK_CLICKED,
+            buildMap {
+                put(Key.COURSE_ID.keyName, courseId)
+                put(Key.COURSE_NAME.keyName, courseName)
+                put(Key.BLOCK_ID.keyName, blockId)
+                put(Key.BLOCK_NAME.keyName, blockName)
+            }
+        )
     }
 
     override fun finishVerticalClickedEvent(
-        courseId: String, courseName: String, blockId: String, blockName: String,
+        courseId: String,
+        courseName: String,
+        blockId: String,
+        blockName: String,
     ) {
-        logEvent(Event.FINISH_VERTICAL_CLICKED, buildMap {
-            put(Key.COURSE_ID.keyName, courseId)
-            put(Key.COURSE_NAME.keyName, courseName)
-            put(Key.BLOCK_ID.keyName, blockId)
-            put(Key.BLOCK_NAME.keyName, blockName)
-        })
+        logEvent(
+            Event.FINISH_VERTICAL_CLICKED,
+            buildMap {
+                put(Key.COURSE_ID.keyName, courseId)
+                put(Key.COURSE_NAME.keyName, courseName)
+                put(Key.BLOCK_ID.keyName, blockId)
+                put(Key.BLOCK_NAME.keyName, blockName)
+            }
+        )
     }
 
     override fun finishVerticalNextClickedEvent(
-        courseId: String, courseName: String, blockId: String, blockName: String,
+        courseId: String,
+        courseName: String,
+        blockId: String,
+        blockName: String,
     ) {
-        logEvent(Event.FINISH_VERTICAL_NEXT_CLICKED, buildMap {
-            put(Key.COURSE_ID.keyName, courseId)
-            put(Key.COURSE_NAME.keyName, courseName)
-            put(Key.BLOCK_ID.keyName, blockId)
-            put(Key.BLOCK_NAME.keyName, blockName)
-        })
+        logEvent(
+            Event.FINISH_VERTICAL_NEXT_CLICKED,
+            buildMap {
+                put(Key.COURSE_ID.keyName, courseId)
+                put(Key.COURSE_NAME.keyName, courseName)
+                put(Key.BLOCK_ID.keyName, blockId)
+                put(Key.BLOCK_NAME.keyName, blockName)
+            }
+        )
     }
 
-    override fun finishVerticalBackClickedEvent(courseId: String, courseName: String) {
-        logEvent(Event.FINISH_VERTICAL_BACK_CLICKED, buildMap {
-            put(Key.COURSE_ID.keyName, courseId)
-            put(Key.COURSE_NAME.keyName, courseName)
-        })
+    override fun finishVerticalBackClickedEvent(
+        courseId: String,
+        courseName: String
+    ) {
+        logEvent(
+            Event.FINISH_VERTICAL_BACK_CLICKED,
+            buildMap {
+                put(Key.COURSE_ID.keyName, courseId)
+                put(Key.COURSE_NAME.keyName, courseName)
+            }
+        )
     }
 
-    override fun discussionAllPostsClickedEvent(courseId: String, courseName: String) {
-        logEvent(Event.DISCUSSION_ALL_POSTS_CLICKED, buildMap {
-            put(Key.COURSE_ID.keyName, courseId)
-            put(Key.COURSE_NAME.keyName, courseName)
-        })
+    override fun discussionAllPostsClickedEvent(
+        courseId: String,
+        courseName: String
+    ) {
+        logEvent(
+            Event.DISCUSSION_ALL_POSTS_CLICKED,
+            buildMap {
+                put(Key.COURSE_ID.keyName, courseId)
+                put(Key.COURSE_NAME.keyName, courseName)
+            }
+        )
     }
 
-    override fun discussionFollowingClickedEvent(courseId: String, courseName: String) {
-        logEvent(Event.DISCUSSION_FOLLOWING_CLICKED, buildMap {
-            put(Key.COURSE_ID.keyName, courseId)
-            put(Key.COURSE_NAME.keyName, courseName)
-        })
+    override fun discussionFollowingClickedEvent(
+        courseId: String,
+        courseName: String
+    ) {
+        logEvent(
+            Event.DISCUSSION_FOLLOWING_CLICKED,
+            buildMap {
+                put(Key.COURSE_ID.keyName, courseId)
+                put(Key.COURSE_NAME.keyName, courseName)
+            }
+        )
     }
 
     override fun discussionTopicClickedEvent(
-        courseId: String, courseName: String, topicId: String, topicName: String,
+        courseId: String,
+        courseName: String,
+        topicId: String,
+        topicName: String,
     ) {
-        logEvent(Event.DISCUSSION_TOPIC_CLICKED, buildMap {
-            put(Key.COURSE_ID.keyName, courseId)
-            put(Key.COURSE_NAME.keyName, courseName)
-            put(Key.TOPIC_ID.keyName, topicId)
-            put(Key.TOPIC_NAME.keyName, topicName)
-        })
+        logEvent(
+            Event.DISCUSSION_TOPIC_CLICKED,
+            buildMap {
+                put(Key.COURSE_ID.keyName, courseId)
+                put(Key.COURSE_NAME.keyName, courseName)
+                put(Key.TOPIC_ID.keyName, topicId)
+                put(Key.TOPIC_NAME.keyName, topicName)
+            }
+        )
     }
 }