Merge branch 'master' into language-options

Author: tohlh

.credo.exs

@@ -83,7 +83,7 @@
         {Credo.Check.Readability.ModuleNames},
         {Credo.Check.Readability.ParenthesesOnZeroArityDefs},
         {Credo.Check.Readability.ParenthesesInCondition},
-        {Credo.Check.Readability.PredicateFunctionNames},
+        {Credo.Check.Readability.PredicateFunctionNames, exit_status: 0},
         {Credo.Check.Readability.PreferImplicitTry},
         {Credo.Check.Readability.RedundantBlankLines},
         {Credo.Check.Readability.StringSigils},
@@ -94,7 +94,7 @@
         {Credo.Check.Readability.SpaceAfterCommas},
         {Credo.Check.Refactor.DoubleBooleanNegation},
         {Credo.Check.Refactor.CondStatements},
-        {Credo.Check.Refactor.CyclomaticComplexity, max_complexity: 10},
+        {Credo.Check.Refactor.CyclomaticComplexity, max_complexity: 11},
         {Credo.Check.Refactor.FunctionArity},
         {Credo.Check.Refactor.LongQuoteBlocks},
         {Credo.Check.Refactor.MatchInCondition},

.github/workflows/ci.yml

@@ -23,11 +23,11 @@ jobs:
     env:
       MIX_ENV: test
       GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      ELIXIR_VERSION: 1.13.4
-      OTP_VERSION: 25.3.2
+      ELIXIR_VERSION: 1.18.3
+      OTP_VERSION: 27.3.3
     services:
       postgres:
-        image: postgres:14.2
+        image: postgres:17.4
         env:
           POSTGRES_USER: postgres
           POSTGRES_PASSWORD: postgres

README.md

@@ -14,9 +14,9 @@ Cadet is the web application powering Source Academy.
 
 ### System requirements
 
-1. Elixir 1.13.3+ (current version: 1.13.4)
-2. Erlang/OTP 23.2.1+ (current version: 25.3.2)
-3. PostgreSQL 12+ (tested to be working up to 14.5)
+1. Elixir 1.18+ (current version: 1.18.3)
+2. Erlang/OTP 27+ (current version: 27.3.3)
+3. PostgreSQL 12+ (tested to be working up to 17)
 
 It is probably okay to use a different version of PostgreSQL or Erlang/OTP, but using a different version of Elixir may result in differences in e.g. `mix format`.
 

config/prod.exs

@@ -3,6 +3,17 @@ import Config
 # Do not print debug messages in production
 config :logger, level: :info
 
+# Add the CloudWatch logger backend in production
+config :logger, backends: [:console, {Cadet.Logger.CloudWatchLogger, :cloudwatch_logger}]
+
+# Configure CloudWatch Logger
+config :logger, :cloudwatch_logger,
+  level: :info,
+  format: "$time $metadata[$level] $message\n",
+  metadata: [:request_id],
+  log_group: "cadet-logs",
+  log_stream: "#{node()}-#{:os.system_time(:second)}"
+
 # ## SSL Support
 #
 # To get SSL working, you will need to add the `https` key

config/test.exs

@@ -9,7 +9,7 @@ config :cadet, CadetWeb.Endpoint,
 config :cadet, environment: :test
 
 # Print only warnings and errors during test
-config :logger, level: :warn, compile_time_purge_matching: [[level_lower_than: :warn]]
+config :logger, level: :warning, compile_time_purge_matching: [[level_lower_than: :warning]]
 
 config :ex_aws,
   access_key_id: "hello",

lib/cadet/accounts/accounts.ex

@@ -5,6 +5,7 @@ defmodule Cadet.Accounts do
   use Cadet, [:context, :display]
 
   import Ecto.Query
+  require Logger
 
   alias Cadet.Accounts.{Query, User, CourseRegistration}
   alias Cadet.Auth.Provider
@@ -101,23 +102,29 @@ defmodule Cadet.Accounts do
 
   def update_latest_viewed(user = %User{id: user_id}, latest_viewed_course_id)
       when is_ecto_id(latest_viewed_course_id) do
+    Logger.info("Updating latest viewed course for user #{user_id} to #{latest_viewed_course_id}")
+
     CourseRegistration
     |> where(user_id: ^user_id)
     |> where(course_id: ^latest_viewed_course_id)
     |> Repo.one()
     |> case do
       nil ->
+        Logger.error("User #{user_id} is not enrolled in course #{latest_viewed_course_id}")
         {:error, {:bad_request, "user is not in the course"}}
 
       _ ->
         case user
              |> User.changeset(%{latest_viewed_course_id: latest_viewed_course_id})
              |> Repo.update() do
           result = {:ok, _} ->
+            Logger.info("Successfully updated latest viewed course for user")
             result
 
           {:error, changeset} ->
-            {:error, {:internal_server_error, full_error_messages(changeset)}}
+            error_msg = full_error_messages(changeset)
+            Logger.error("Failed to update latest viewed course for user: #{error_msg}")
+            {:error, {:internal_server_error, error_msg}}
         end
     end
   end

lib/cadet/accounts/course_registrations.ex

@@ -5,6 +5,7 @@ defmodule Cadet.Accounts.CourseRegistrations do
   use Cadet, [:context, :display]
 
   import Ecto.Query
+  require Logger
 
   alias Cadet.{Repo, Accounts}
   alias Cadet.Accounts.{User, CourseRegistration}
@@ -18,33 +19,69 @@ defmodule Cadet.Accounts.CourseRegistrations do
   # otherwise just use CourseRegistration
 
   def get_user_record(user_id, course_id) when is_ecto_id(user_id) and is_ecto_id(course_id) do
-    CourseRegistration
-    |> where([cr], cr.user_id == ^user_id)
-    |> where([cr], cr.course_id == ^course_id)
-    |> preload(:course)
-    |> preload(:group)
-    |> Repo.one()
+    Logger.info("Retrieving user record for user #{user_id} in course #{course_id}")
+
+    result =
+      CourseRegistration
+      |> where([cr], cr.user_id == ^user_id)
+      |> where([cr], cr.course_id == ^course_id)
+      |> preload(:course)
+      |> preload(:group)
+      |> Repo.one()
+
+    case result do
+      nil ->
+        Logger.error("User record not found for user #{user_id} in course #{course_id}")
+
+      _ ->
+        Logger.info(
+          "Successfully retrieved user record for user #{user_id} in course #{course_id}"
+        )
+    end
+
+    result
   end
 
   def get_user_course(user_id, course_id) when is_ecto_id(user_id) and is_ecto_id(course_id) do
-    CourseRegistration
-    |> where([cr], cr.user_id == ^user_id)
-    |> where([cr], cr.course_id == ^course_id)
-    |> join(:inner, [cr], c in assoc(cr, :course))
-    |> join(:left, [cr, c], ac in assoc(c, :assessment_config))
-    |> preload([cr, c, ac],
-      course: {c, assessment_config: ^from(ac in AssessmentConfig, order_by: [asc: ac.order])}
-    )
-    |> preload(:group)
-    |> Repo.one()
+    Logger.info("Retrieving course details for user #{user_id} in course #{course_id}")
+
+    result =
+      CourseRegistration
+      |> where([cr], cr.user_id == ^user_id)
+      |> where([cr], cr.course_id == ^course_id)
+      |> join(:inner, [cr], c in assoc(cr, :course))
+      |> join(:left, [cr, c], ac in assoc(c, :assessment_config))
+      |> preload([cr, c, ac],
+        course: {c, assessment_config: ^from(ac in AssessmentConfig, order_by: [asc: ac.order])}
+      )
+      |> preload(:group)
+      |> Repo.one()
+
+    case result do
+      nil ->
+        Logger.error("Course details not found for user #{user_id} in course #{course_id}")
+
+      _ ->
+        Logger.info(
+          "Successfully retrieved course details for user #{user_id} in course #{course_id}"
+        )
+    end
+
+    result
   end
 
   def get_courses(%User{id: id}) do
-    CourseRegistration
-    |> where([cr], cr.user_id == ^id)
-    |> join(:inner, [cr], c in assoc(cr, :course))
-    |> preload(:course)
-    |> Repo.all()
+    Logger.info("Retrieving all courses for user #{id}")
+
+    courses =
+      CourseRegistration
+      |> where([cr], cr.user_id == ^id)
+      |> join(:inner, [cr], c in assoc(cr, :course))
+      |> preload(:course)
+      |> Repo.all()
+
+    Logger.info("Retrieved #{length(courses)} courses for user #{id}")
+    courses
   end
 
   def get_admin_courses_count(%User{id: id}) do
@@ -118,6 +155,8 @@ defmodule Cadet.Accounts.CourseRegistrations do
   """
   def enroll_course(params = %{user_id: user_id, course_id: course_id, role: _role})
       when is_ecto_id(user_id) and is_ecto_id(course_id) do
+    Logger.info("Enrolling user #{user_id} in course #{course_id}")
+
     case params |> insert_or_update_course_registration() do
       {:ok, _course_reg} = ok ->
         # Ensures that the user has a latest_viewed_course
@@ -127,9 +166,14 @@ defmodule Cadet.Accounts.CourseRegistrations do
         |> User.changeset(%{latest_viewed_course_id: course_id})
         |> Repo.update()
 
+        Logger.info("Successfully enrolled user #{user_id} in course #{course_id}")
         ok
 
-      {:error, _} = error ->
+      {:error, changeset} = error ->
+        Logger.error(
+          "Failed to enroll user #{user_id} in course #{course_id}: #{full_error_messages(changeset)}"
+        )
+
         error
     end
   end