Merge branch 'master' into dependabot/hex/ex_aws_s3-2.5.2

Author: RichDom2185

.credo.exs

@@ -94,7 +94,7 @@
         {Credo.Check.Readability.SpaceAfterCommas},
         {Credo.Check.Refactor.DoubleBooleanNegation},
         {Credo.Check.Refactor.CondStatements},
-        {Credo.Check.Refactor.CyclomaticComplexity},
+        {Credo.Check.Refactor.CyclomaticComplexity, max_complexity: 10},
         {Credo.Check.Refactor.FunctionArity},
         {Credo.Check.Refactor.LongQuoteBlocks},
         {Credo.Check.Refactor.MatchInCondition},

.github/workflows/cd.yml

@@ -5,6 +5,7 @@ on:
       - stable
       - master
       - deploy
+      - deploy-stg
     paths:
       - "config/**"
       - "lib/**"
@@ -28,16 +29,16 @@ jobs:
       OTP_VERSION: 25.3.2
     steps:
       - uses: rlespinasse/[email protected]
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Cache deps
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         with:
           path: deps
           key: ${{ runner.os }}-mix-${{ hashFiles(format('{0}{1}', github.workspace, '/mix.lock')) }}
           restore-keys: |
             ${{ runner.os }}-mix-
       - name: Cache _build
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         with:
           path: |
             _build

.github/workflows/ci.yml

@@ -37,16 +37,16 @@ jobs:
         # needed because the postgres container does not provide a healthcheck
         options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Cache deps
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         with:
           path: deps
           key: ${{ runner.os }}-mix-${{ hashFiles(format('{0}{1}', github.workspace, '/mix.lock')) }}
           restore-keys: |
             ${{ runner.os }}-mix-
       - name: Cache _build
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         with:
           path: |
             _build

.gitignore

@@ -110,6 +110,10 @@ erl_crash.dump
 # VSCode Elixir language support
 .elixir_ls/
 
+# IDEs
+.idea
+.vscode
+
 .env
 
 # Generated lexer

.iex.exs

@@ -1,5 +1,5 @@
 import Ecto.Query
 alias Cadet.Repo
-alias Cadet.Accounts.User
+alias Cadet.Accounts.{User, Team, TeamMember}
 alias Cadet.Assessments.{Answer, Assessment, Question, Submission}
 alias Cadet.Courses.Group

README.md

@@ -62,6 +62,12 @@ It is probably okay to use a different version of PostgreSQL or Erlang/OTP, but
    $ sudo service postgresql restart
    ```
 
+   By default, the database is populated with 10 students and 5 assessments. Each student will have a submission to the corresponding submission. This can be changed in `priv/repo/seeds.exs` with the variables `number_of_students`, `number_of_assessments` and `number_of_questions`. Save the changes and run:
+
+   ```bash
+   $ mix ecto.reset
+   ```
+
 4. Run the server on your local machine
 
    ```bash
@@ -141,7 +147,7 @@ Where there is a conflict between the two, the first one (lexmag) shall be the o
 
 ## Entity-Relationship Diagram
 
-Generated with [DBeaver](https://dbeaver.io/) on 03 June 2022
+Generated with [DBeaver](https://dbeaver.io/) on 19 May 2024
 
 ![Entity-Relationship Diagram for cadet](schema.png)
 

config/cadet.exs.example

@@ -56,6 +56,15 @@ config :cadet,
     #      # You may need to write your own claim extractor for other providers
     #      claim_extractor: Cadet.Auth.Providers.CognitoClaimExtractor
     #    }},
+
+    # # Example SAML authentication with NUS Student IdP
+    # "test_saml" =>
+    #   {Cadet.Auth.Providers.SAML,
+    #    %{
+    #      assertion_extractor: Cadet.Auth.Providers.NusstuAssertionExtractor,
+    #      client_redirect_url: "http://cadet.frontend:8000/login/callback"
+    #    }},
+
     "test" =>
       {Cadet.Auth.Providers.Config,
        [
@@ -142,3 +151,29 @@ config :cadet,
 # You may also want to change the timezone used for scheduled jobs
 # config :cadet, Cadet.Jobs.Scheduler,
 #   timezone: "Asia/Singapore",
+
+# # Additional configuration for SAML authentication
+# # For more details, see https://github.com/handnot2/samly
+# config :samly, Samly.Provider,
+#   idp_id_from: :path_segment,
+#   service_providers: [
+#     %{
+#       id: "source-academy-backend",
+#       certfile: "example_path/certfile.pem",
+#       keyfile: "example_path/keyfile.pem"
+#     }
+#   ],
+#   identity_providers: [
+#     %{
+#       id: "student",
+#       sp_id: "source-academy-backend",
+#       base_url: "https://example_backend/sso",
+#       metadata_file: "student_idp_metadata.xml"
+#     },
+#     %{
+#       id: "staff",
+#       sp_id: "source-academy-backend",
+#       base_url: "https://example_backend/sso",
+#       metadata_file: "staff_idp_metadata.xml"
+#     }
+#   ]

config/dev.secrets.exs.example

@@ -29,6 +29,15 @@ config :cadet,
     #       token_url: "https://github.com/login/oauth/access_token",
     #       user_api: "https://api.github.com/user"
     #    }},
+
+    # # Example SAML authentication with NUS Student IdP
+    # "test_saml" =>
+    #   {Cadet.Auth.Providers.SAML,
+    #    %{
+    #      assertion_extractor: Cadet.Auth.Providers.NusstuAssertionExtractor,
+    #      client_redirect_url: "http://cadet.frontend:8000/login/callback"
+    #    }},
+
     "test" =>
       {Cadet.Auth.Providers.Config,
        [
@@ -87,5 +96,39 @@ config :cadet,
     # ws_endpoint_address: "ws://hostname:port"
   ]
 
-config :sentry,
-  dsn: "https://public_key/sentry.io/somethingsomething"
+  config :openai,
+  # find it at https://platform.openai.com/account/api-keys
+  api_key: "the actual api key",
+  # For source academy deployment, leave this as empty string.Ingeneral could find it at https://platform.openai.com/account/org-settings under "Organization ID".
+  organization_key: "",
+  # optional, passed to [HTTPoison.Request](https://hexdocs.pm/httpoison/HTTPoison.Request.html) options
+  http_options: [recv_timeout: 170_0000]
+
+# config :sentry,
+#   dsn: "https://public_key/sentry.io/somethingsomething"
+
+# # Additional configuration for SAML authentication
+# # For more details, see https://github.com/handnot2/samly
+# config :samly, Samly.Provider,
+#   idp_id_from: :path_segment,
+#   service_providers: [
+#     %{
+#       id: "source-academy-backend",
+#       certfile: "example_path/certfile.pem",
+#       keyfile: "example_path/keyfile.pem"
+#     }
+#   ],
+#   identity_providers: [
+#     %{
+#       id: "student",
+#       sp_id: "source-academy-backend",
+#       base_url: "https://example_backend/sso",
+#       metadata_file: "student_idp_metadata.xml"
+#     },
+#     %{
+#       id: "staff",
+#       sp_id: "source-academy-backend",
+#       base_url: "https://example_backend/sso",
+#       metadata_file: "staff_idp_metadata.xml"
+#     }
+#   ]

config/test.exs

@@ -68,7 +68,13 @@ config :cadet,
            username: "E1234564"
            #  role: :student
          }
-       ]}
+       ]},
+    "saml" =>
+      {Cadet.Auth.Providers.SAML,
+       %{
+         assertion_extractor: Cadet.Auth.Providers.NusstfAssertionExtractor,
+         client_redirect_url: "https://cadet.frontend/login/callback"
+       }}
   },
   autograder: [
     lambda_name: "dummy"

lib/cadet/accounts/notification_type.ex

@@ -3,12 +3,12 @@ import EctoEnum
 defenum(Cadet.Accounts.NotificationType, :notification_type, [
   # Notifications for new assessments
   :new,
-  # Notifications for autograded assessments
-  :autograded,
-  # Notifications for manually graded assessments
-  :graded,
   # Notifications for unsubmitted submissions
   :unsubmitted,
   # Notifications for submitted assessments
-  :submitted
+  :submitted,
+  # Notifications for published grades
+  :published_grading,
+  # Notifications for unpublished grades
+  :unpublished_grading
 ])

lib/cadet/accounts/notifications.ex

@@ -8,7 +8,7 @@ defmodule Cadet.Accounts.Notifications do
   import Ecto.Query
 
   alias Cadet.Repo
-  alias Cadet.Accounts.{Notification, CourseRegistration, CourseRegistration}
+  alias Cadet.Accounts.{Notification, CourseRegistration, CourseRegistration, Team, TeamMember}
   alias Cadet.Assessments.Submission
   alias Ecto.Multi
 
@@ -145,43 +145,96 @@ defmodule Cadet.Accounts.Notifications do
           {:ok, Ecto.Schema.t()} | {:error, Ecto.Changeset.t()}
   def handle_unsubmit_notifications(assessment_id, student = %CourseRegistration{})
       when is_ecto_id(assessment_id) do
-    # Fetch and delete all notifications of :autograded and :graded
+    # Fetch and delete all notifications of :unpublished_grading
     # Add new notification :unsubmitted
 
     Notification
     |> where(course_reg_id: ^student.id)
     |> where(assessment_id: ^assessment_id)
-    |> where([n], n.type in ^[:autograded, :graded])
+    |> where([n], n.type in ^[:unpublished_grading])
     |> Repo.delete_all()
 
     write(%{
       type: :unsubmitted,
-      role: student.role,
+      role: :student,
       course_reg_id: student.id,
       assessment_id: assessment_id
     })
   end
 
   @doc """
-  Writes a notification that a student's submission has been
-  graded successfully. (for the student)
+  Function that handles notifications when a submission grade is unpublished.
+  Deletes all :published notifications and adds a new :unpublished_grading notification.
   """
-  @spec write_notification_when_graded(integer(), any()) ::
+  @spec handle_unpublish_grades_notifications(integer(), CourseRegistration.t()) ::
           {:ok, Ecto.Schema.t()} | {:error, Ecto.Changeset.t()}
-  def write_notification_when_graded(submission_id, type) when type in [:graded, :autograded] do
-    submission =
-      Submission
-      |> Repo.get_by(id: submission_id)
+  def handle_unpublish_grades_notifications(assessment_id, student = %CourseRegistration{})
+      when is_ecto_id(assessment_id) do
+    Notification
+    |> where(course_reg_id: ^student.id)
+    |> where(assessment_id: ^assessment_id)
+    |> where([n], n.type in ^[:published_grading])
+    |> Repo.delete_all()
 
     write(%{
-      type: type,
+      type: :unpublished_grading,
       read: false,
       role: :student,
-      course_reg_id: submission.student_id,
-      assessment_id: submission.assessment_id
+      course_reg_id: student.id,
+      assessment_id: assessment_id
     })
   end
 
+  @doc """
+  Writes a notification that a student's submission has been
+  graded successfully. (for the student)
+  """
+  @spec write_notification_when_published(integer(), any()) ::
+          {:ok, Ecto.Schema.t()} | {:error, Ecto.Changeset.t()}
+  def write_notification_when_published(submission_id, type) when type in [:published_grading] do
+    case Repo.get(Submission, submission_id) do
+      nil ->
+        {:error, %Ecto.Changeset{}}
+
+      submission ->
+        case submission.student_id do
+          nil ->
+            team = Repo.get(Team, submission.team_id)
+
+            query =
+              from(t in Team,
+                join: tm in TeamMember,
+                on: t.id == tm.team_id,
+                join: cr in CourseRegistration,
+                on: tm.student_id == cr.id,
+                where: t.id == ^team.id,
+                select: cr.id
+              )
+
+            team_members = Repo.all(query)
+
+            Enum.each(team_members, fn tm_id ->
+              write(%{
+                type: type,
+                read: false,
+                role: :student,
+                course_reg_id: tm_id,
+                assessment_id: submission.assessment_id
+              })
+            end)
+
+          student_id ->
+            write(%{
+              type: type,
+              read: false,
+              role: :student,
+              course_reg_id: student_id,
+              assessment_id: submission.assessment_id
+            })
+        end
+    end
+  end
+
   @doc """
   Writes a notification to all students that a new assessment is available.
   """
@@ -223,7 +276,29 @@ defmodule Cadet.Accounts.Notifications do
   @spec write_notification_when_student_submits(Submission.t()) ::
           {:ok, Ecto.Schema.t()} | {:error, Ecto.Changeset.t()}
   def write_notification_when_student_submits(submission = %Submission{}) do
-    avenger_id = get_avenger_id_of(submission.student_id)
+    id =
+      case submission.student_id do
+        nil ->
+          team_id = submission.team_id
+
+          team =
+            Repo.one(
+              from(t in Team,
+                where: t.id == ^team_id,
+                preload: [:team_members]
+              )
+            )
+
+          # Does not matter if team members have different Avengers
+          # Just require one of them to be notified of the submission
+          s_id = team.team_members |> hd() |> Map.get(:student_id)
+          s_id
+
+        _ ->
+          submission.student_id
+      end
+
+    avenger_id = get_avenger_id_of(id)
 
     if is_nil(avenger_id) do
       {:ok, nil}