Multitenant backend

.github/workflows/cd.yml

@@ -4,6 +4,7 @@ on:
     branches:
       - stable
       - master
+      - multitenant-deploy
     paths:
       - 'config/**'
       - 'lib/**'
@@ -53,9 +54,7 @@ jobs:
         run: |
           mix deps.get
       - name: mix release
-        run: |
-          rm -f _build/prod/cadet-0.0.1.tar.gz
-          mix release
+        run: mix release --overwrite
       - name: Create release
         uses: marvinpinto/action-automatic-releases@latest
         with:

config/dev.secrets.exs.example

@@ -26,6 +26,17 @@ config :cadet,
     #      # You may need to write your own claim extractor for other providers
     #      claim_extractor: Cadet.Auth.Providers.CognitoClaimExtractor
     #    }},
+    # # To use authentication with GitHub
+    # "github" =>
+    #   {Cadet.Auth.Providers.GitHub,
+    #    %{
+    #       # A map of GitHub client_id => client_secret
+    #       clients: %{
+    #         "client_id" => "client_secret"
+    #       },
+    #       token_url: "https://github.com/login/oauth/access_token",
+    #       user_api: "https://api.github.com/user"
+    #    }},
     "test" =>
       {Cadet.Auth.Providers.Config,
        [

config/test.exs

@@ -52,22 +52,22 @@ config :cadet,
            token: "admin_token",
            code: "admin_code",
            name: "Test Admin",
-           username: "admin",
-           role: :admin
+           username: "admin"
+           #  role: :admin
          },
          %{
            token: "staff_token",
            code: "staff_code",
            name: "Test Staff",
-           username: "staff",
-           role: :staff
+           username: "staff"
+           #  role: :staff
          },
          %{
            token: "student_token",
            code: "student_code",
-           name: "Test Student",
-           username: "student",
-           role: :student
+           name: "student 1",
+           username: "E1234564"
+           #  role: :student
          }
        ]}
   },

deployment/init.sh

@@ -8,9 +8,9 @@
 set -euxo pipefail
 
 BASEDIR=/opt/cadet
-PKGURL='https://github.com/source-academy/cadet/releases/download/latest-stable/cadet-0.0.1.tar.gz'
+PKGURL='https://github.com/source-academy/cadet/releases/download/latest-multitenant-deploy/cadet-0.0.1.tar.gz'
 PKGPATH='/run/cadet-init/cadet-0.0.1.tar.gz'
-SVCURL=${SVCURL:-'https://raw.githubusercontent.com/source-academy/cadet/stable/deployment/cadet.service'}
+SVCURL=${SVCURL:-'https://raw.githubusercontent.com/source-academy/cadet/multitenant-deploy/deployment/cadet.service'}
 SVCPATH='/etc/systemd/system/cadet.service'
 
 if [ "$EUID" -ne 0 ]; then

lib/cadet/accounts/accounts.ex

@@ -6,25 +6,16 @@ defmodule Cadet.Accounts do
 
   import Ecto.Query
 
-  alias Cadet.Accounts.{Query, User}
+  alias Cadet.Accounts.{Query, User, CourseRegistration}
   alias Cadet.Auth.Provider
 
   @doc """
   Register new User entity using Cadet.Accounts.Form.Registration
 
   Returns {:ok, user} on success, otherwise {:error, changeset}
   """
-  def register(attrs = %{username: username}, role) when is_binary(username) do
-    attrs |> Map.put(:role, role) |> insert_or_update_user()
-  end
-
-  @doc """
-  Creates User entity with specified attributes.
-  """
-  def create_user(attrs \\ %{}) do
-    %User{}
-    |> User.changeset(attrs)
-    |> Repo.insert()
+  def register(attrs = %{username: username}) when is_binary(username) do
+    attrs |> insert_or_update_user()
   end
 
   @doc """
@@ -53,58 +44,79 @@ defmodule Cadet.Accounts do
     Repo.get(User, id)
   end
 
+  @get_all_role ~w(admin staff)a
   @doc """
   Returns users matching a given set of criteria.
   """
-  def get_users(filter \\ []) do
-    User
-    |> join(:left, [u], g in assoc(u, :group))
-    |> preload([u, g], group: g)
-    |> get_users(filter)
+  def get_users_by(filter \\ [], %CourseRegistration{course_id: course_id, role: role})
+      when role in @get_all_role do
+    CourseRegistration
+    |> where([cr], cr.course_id == ^course_id)
+    |> join(:inner, [cr], u in assoc(cr, :user))
+    |> preload([cr, u], user: u)
+    |> join(:left, [cr, u], g in assoc(cr, :group))
+    |> preload([cr, u, g], group: g)
+    |> get_users_helper(filter)
   end
 
-  defp get_users(query, []), do: Repo.all(query)
+  defp get_users_helper(query, []), do: Repo.all(query)
 
-  defp get_users(query, [{:group, group} | filters]),
-    do: query |> where([u, g], g.name == ^group) |> get_users(filters)
+  defp get_users_helper(query, [{:group, group} | filters]),
+    do: query |> where([cr, u, g], g.name == ^group) |> get_users_helper(filters)
 
-  defp get_users(query, [filter | filters]), do: query |> where(^[filter]) |> get_users(filters)
+  defp get_users_helper(query, [filter | filters]),
+    do: query |> where(^[filter]) |> get_users_helper(filters)
 
   @spec sign_in(String.t(), Provider.token(), Provider.provider_instance()) ::
           {:error, :bad_request | :forbidden | :internal_server_error, String.t()} | {:ok, any}
   @doc """
   Sign in using given user ID
   """
   def sign_in(username, token, provider) do
-    case Repo.one(Query.username(username)) do
-      nil ->
-        # user is not registered in our database
-        with {:ok, role} <- Provider.get_role(provider, token),
-             {:ok, name} <- Provider.get_name(provider, token),
-             {:ok, _} <- register(%{name: name, username: username}, role) do
-          sign_in(username, name, token)
-        else
-          {:error, :invalid_credentials, err} ->
-            {:error, :forbidden, err}
-
-          {:error, :upstream, err} ->
-            {:error, :bad_request, err}
-
-          {:error, _err} ->
-            {:error, :internal_server_error}
-        end
-
-      user ->
-        {:ok, user}
+    user = username |> Query.username() |> Repo.one()
+
+    if is_nil(user) or is_nil(user.name) do
+      # user is not registered in our database or does not have a name
+      # (accounts pre-created by instructors do not have a name, and has to be fetched
+      #  from the auth provider during sign_in)
+      with {:ok, name} <- Provider.get_name(provider, token),
+           {:ok, _} <- register(%{name: name, username: username}) do
+        sign_in(username, name, token)
+      else
+        {:error, :invalid_credentials, err} ->
+          {:error, :forbidden, err}
+
+        {:error, :upstream, err} ->
+          {:error, :bad_request, err}
+
+        {:error, _err} ->
+          {:error, :internal_server_error}
+      end
+    else
+      {:ok, user}
     end
   end
 
-  def update_game_states(user = %User{}, new_game_state = %{}) do
-    case user
-         |> User.changeset(%{game_states: new_game_state})
-         |> Repo.update() do
-      result = {:ok, _} -> result
-      {:error, changeset} -> {:error, {:internal_server_error, full_error_messages(changeset)}}
+  def update_latest_viewed(user = %User{id: user_id}, latest_viewed_course_id)
+      when is_ecto_id(latest_viewed_course_id) do
+    CourseRegistration
+    |> where(user_id: ^user_id)
+    |> where(course_id: ^latest_viewed_course_id)
+    |> Repo.one()
+    |> case do
+      nil ->
+        {: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, _} ->
+            result
+
+          {:error, changeset} ->
+            {:error, {:internal_server_error, full_error_messages(changeset)}}
+        end
     end
   end
 end

lib/cadet/accounts/course_registration.ex

@@ -0,0 +1,31 @@
+defmodule Cadet.Accounts.CourseRegistration do
+  @moduledoc """
+  The mapping table representing the registration of a user to a course.
+  """
+  use Cadet, :model
+
+  alias Cadet.Accounts.{Role, User}
+  alias Cadet.Courses.{Course, Group}
+
+  schema "course_registrations" do
+    field(:role, Role)
+    field(:game_states, :map)
+
+    belongs_to(:group, Group)
+    belongs_to(:user, User)
+    belongs_to(:course, Course)
+
+    timestamps()
+  end
+
+  @required_fields ~w(user_id course_id role)a
+  @optional_fields ~w(game_states group_id)a
+
+  def changeset(course_registration, params \\ %{}) do
+    course_registration
+    |> cast(params, @optional_fields ++ @required_fields)
+    |> add_belongs_to_id_from_model([:user, :group, :course], params)
+    |> validate_required(@required_fields)
+    |> unique_constraint(:user_id, name: :course_registrations_user_id_course_id_index)
+  end
+end