fix: build failed with unreplaced title variables (wraft#182)

* fix: build fail with unreplaced title variables

* fix(auth): handle missing token error

* feat: add query by name in instance approval indexing

* fix: safely handle nil document titles

* chore: update version to 0.6.5 and display it on the index page

---------

Co-authored-by: Salsabeel <[email protected]>

Author: Faheemvc

lib/wraft_doc/documents/documents.ex

@@ -1341,14 +1341,14 @@ defmodule WraftDoc.Documents do
          task
        ) do
     qr_code = Task.await(task)
-    page_title = instance.serialized["title"]
+    page_title = format_title(instance.serialized["title"])
 
     header =
       header
       |> Assets.find_asset_header_values(layout, instance)
       |> concat_strings("qrcode: #{qr_code} \n")
       |> concat_strings("path: #{mkdir}\n")
-      |> concat_strings("title: #{page_title}\n")
+      |> concat_strings("title: \"#{page_title}\"\n")
       |> concat_strings("organisation_name: #{organisation_name}\n")
       |> concat_strings("author_name: #{name}\n")
       |> concat_strings("author_email: #{email}\n")
@@ -1388,6 +1388,16 @@ defmodule WraftDoc.Documents do
     """
   end
 
+  defp format_title(nil), do: ""
+
+  defp format_title(title) when is_binary(title) do
+    title
+    |> String.replace("[", "\[")
+    |> String.replace("]", "\]")
+  end
+
+  defp format_title(title), do: to_string(title)
+
   defp add_margin(header, nil), do: header
 
   defp add_margin(header, %{top: top, bottom: bottom, left: left, right: right}),
@@ -2184,7 +2194,10 @@ defmodule WraftDoc.Documents do
     Repo.paginate(query, params)
   end
 
-  def list_pending_approvals(%User{id: user_id, current_org_id: org_id} = _current_user, params) do
+  def list_pending_approvals(
+        %User{id: user_id, current_org_id: org_id} = _current_user,
+        params
+      ) do
     next_state_query =
       from(s in State,
         where:
@@ -2201,6 +2214,7 @@ defmodule WraftDoc.Documents do
 
     Instance
     |> where([i], i.approval_status == false)
+    |> maybe_filter_by_title(params)
     |> join(:inner, [i], s in State,
       on: s.id == i.state_id and s.organisation_id == ^org_id,
       as: :state
@@ -2220,6 +2234,21 @@ defmodule WraftDoc.Documents do
     |> Repo.paginate(params)
   end
 
+  defp maybe_filter_by_title(query, %{"name" => name})
+       when is_binary(name) and name != "" do
+    where(
+      query,
+      [i],
+      fragment(
+        "LOWER(?->>'title') LIKE LOWER(?)",
+        i.serialized,
+        ^"%#{name}%"
+      )
+    )
+  end
+
+  defp maybe_filter_by_title(query, _params), do: query
+
   @doc """
   Retrieves dashboard statistics for the current organization.
 

lib/wraft_doc_web/auth/auth_error_handler.ex

@@ -1,17 +1,22 @@
 defmodule WraftDocWeb.Guardian.AuthErrorHandler do
   @moduledoc """
-  Error handler for Guradian.
+  Error handler for Guardian.
   """
   import Plug.Conn
 
   def auth_error(conn, {:invalid_token, _reason}, _opts) do
-    body = Jason.encode!(%{message: "Token is either expired or invalid. Login again."})
-    conn |> put_resp_content_type("application/json") |> send_resp(401, body)
+    body = Jason.encode!(%{errors: "Token is either expired or invalid. Login again."})
+    conn |> put_resp_content_type("application/json") |> send_resp(401, body) |> halt()
+  end
+
+  def auth_error(conn, {:unauthenticated, _reason}, _opts) do
+    body = Jason.encode!(%{errors: "Unauthorized. Please provide valid authentication."})
+    conn |> put_resp_content_type("application/json") |> send_resp(401, body) |> halt()
   end
 
   def auth_error(conn, {type, _reason}, _opts) do
-    body = Jason.encode!(%{message: to_string(type)})
-    conn |> put_resp_content_type("application/json") |> send_resp(401, body)
+    body = Jason.encode!(%{errors: to_string(type)})
+    conn |> put_resp_content_type("application/json") |> send_resp(401, body) |> halt()
   end
 
   def auth_error(conn, {:error, :no_user}) do

lib/wraft_doc_web/auth/current_organisation.ex

@@ -36,8 +36,19 @@ defmodule WraftDocWeb.CurrentOrganisation do
   end
 
   defp process_jwt_org(conn) do
-    %{"organisation_id" => org_id} = current_claims(conn)
+    case current_claims(conn) do
+      nil ->
+        conn
+
+      %{"organisation_id" => org_id} ->
+        load_organisation_and_roles(conn, org_id)
+
+      _claims ->
+        conn
+    end
+  end
 
+  defp load_organisation_and_roles(conn, org_id) do
     case Repo.get(Organisation, org_id) do
       nil ->
         AuthErrorHandler.auth_error(conn, {:error, :no_org})

lib/wraft_doc_web/auth/current_user.ex

@@ -27,9 +27,10 @@ defmodule WraftDocWeb.CurrentUser do
   end
 
   defp maybe_add_auth_type(%{params: params} = conn) do
-    conn
-    |> current_claims()
-    |> add_type_to_params(conn, params)
+    case current_claims(conn) do
+      nil -> conn
+      claims -> add_type_to_params(claims, conn, params)
+    end
   end
 
   defp add_type_to_params(%{"type" => type}, conn, params),
@@ -39,16 +40,15 @@ defmodule WraftDocWeb.CurrentUser do
     do: conn
 
   defp add_current_user(conn) do
-    conn
-    |> current_resource()
-    |> case do
-      nil -> AuthErrorHandler.auth_error(conn, {:error, :no_user})
-      email -> get_user(email)
-    end
-    |> case do
-      %Plug.Conn{} = conn -> conn
-      nil -> AuthErrorHandler.auth_error(conn, {:error, :no_user})
-      user -> assign(conn, :current_user, preload_user_data(user))
+    case current_resource(conn) do
+      nil ->
+        conn
+
+      email ->
+        case get_user(email) do
+          nil -> AuthErrorHandler.auth_error(conn, {:error, :no_user})
+          user -> assign(conn, :current_user, preload_user_data(user))
+        end
     end
   end
 

lib/wraft_doc_web/controllers/page_controller.ex

@@ -2,6 +2,7 @@ defmodule WraftDocWeb.PageController do
   use WraftDocWeb, :controller
 
   def index(conn, _params) do
-    render(conn, "index.html")
+    version = Application.spec(:wraft_doc, :vsn) |> to_string()
+    render(conn, "index.html", version: version)
   end
 end

lib/wraft_doc_web/templates/page/index.html.heex

@@ -80,6 +80,7 @@
       </div>
       <h1>Wraft</h1>
       <p>> Wraft is an open-source document lifecycle management software</p>
+      <p style="margin-top: 1rem; font-size: 0.9rem; opacity: 0.8;">Version: <%= @version %></p>
     </div>
   </body>
 </html>

mix.exs

@@ -5,7 +5,7 @@ defmodule WraftDoc.Mixfile do
   def project do
     [
       app: :wraft_doc,
-      version: "0.6.4",
+      version: "0.6.5",
       elixir: "~> 1.18",
       elixirc_paths: elixirc_paths(Mix.env()),
       compilers: Mix.compilers(),

test/wraft_doc_web/auth/current_organisation_test.exs

@@ -73,13 +73,11 @@ defmodule WraftDocWeb.Auth.CurrentOrganisationTest do
         |> CurrentOrganisation.call([])
 
       assert conn.assigns[:current_user].current_org_id == user.current_org_id
-      # Permissions should be unique and aggregated
       assert length(conn.assigns[:current_user].permissions) == 4
       assert "layout:index" in conn.assigns[:current_user].permissions
       assert "layout:show" in conn.assigns[:current_user].permissions
       assert "layout:create" in conn.assigns[:current_user].permissions
       assert "layout:update" in conn.assigns[:current_user].permissions
-      # Role names should include both roles
       assert length(conn.assigns[:current_user].role_names) == 2
       assert role1.name in conn.assigns[:current_user].role_names
       assert role2.name in conn.assigns[:current_user].role_names
@@ -126,7 +124,6 @@ defmodule WraftDocWeb.Auth.CurrentOrganisationTest do
       {:ok, token, _claims} =
         Guardian.encode_and_sign(user, %{organisation_id: user.current_org_id})
 
-      # Pre-assign user with org_id
       user_with_org = Map.put(user, :current_org_id, organisation.id)
 
       conn =
@@ -135,7 +132,6 @@ defmodule WraftDocWeb.Auth.CurrentOrganisationTest do
         |> assign(:current_user, user_with_org)
         |> CurrentOrganisation.call([])
 
-      # Should keep the existing org_id and not process JWT
       assert conn.assigns[:current_user].current_org_id == organisation.id
       refute conn.halted
     end
@@ -187,14 +183,60 @@ defmodule WraftDocWeb.Auth.CurrentOrganisationTest do
         |> conn_init()
         |> CurrentOrganisation.call([])
 
-      # Should only have role from organisation1
       assert conn.assigns[:current_user].current_org_id == organisation1.id
       assert conn.assigns[:current_user].role_names == [role1.name]
       assert conn.assigns[:current_user].permissions == ["layout:index"]
       refute role2.name in conn.assigns[:current_user].role_names
       refute "layout:show" in conn.assigns[:current_user].permissions
       refute conn.halted
     end
+
+    test "does not halt when no JWT token is provided" do
+      conn =
+        build_conn()
+        |> put_req_header("content-type", "application/json")
+        |> put_resp_content_type("application/json")
+        |> Map.put(:params, %{})
+        |> CurrentOrganisation.call([])
+
+      refute conn.halted
+    end
+
+    test "does not halt when claims are nil" do
+      conn =
+        build_conn()
+        |> put_req_header("content-type", "application/json")
+        |> put_resp_content_type("application/json")
+        |> Map.put(:params, %{})
+        |> Plug.put_current_claims(nil)
+        |> CurrentOrganisation.call([])
+
+      refute conn.halted
+    end
+
+    test "does not halt when claims don't have organisation_id" do
+      user = insert(:user_with_organisation)
+
+      {:ok, token, _claims} =
+        Guardian.encode_and_sign(user, %{some_other_key: "value"})
+
+      conn =
+        build_conn()
+        |> put_req_header("authorization", "Bearer " <> token)
+        |> put_resp_content_type("application/json")
+        |> Map.put(:params, %{})
+        |> then(fn conn ->
+          {:ok, claims} = Guardian.decode_and_verify(token)
+
+          conn
+          |> Plug.put_current_claims(claims)
+          |> Plug.put_current_resource(claims["sub"])
+          |> CurrentUser.call([])
+        end)
+        |> CurrentOrganisation.call([])
+
+      refute conn.halted
+    end
   end
 
   # Private

test/wraft_doc_web/auth/current_user_test.exs

@@ -111,6 +111,32 @@ defmodule WraftDocWeb.Auth.CurrentUserTest do
       assert conn.assigns[:current_user].id == user.id
       refute conn.halted
     end
+
+    test "does not halt when no JWT token is provided" do
+      conn =
+        build_conn()
+        |> put_req_header("content-type", "application/json")
+        |> put_resp_content_type("application/json")
+        |> Map.put(:params, %{})
+        |> CurrentUser.call([])
+
+      refute Map.has_key?(conn.assigns, :current_user)
+      refute conn.halted
+    end
+
+    test "does not halt when claims are nil" do
+      conn =
+        build_conn()
+        |> put_req_header("content-type", "application/json")
+        |> put_resp_content_type("application/json")
+        |> Map.put(:params, %{})
+        |> Plug.put_current_claims(nil)
+        |> Plug.put_current_resource(nil)
+        |> CurrentUser.call([])
+
+      refute Map.has_key?(conn.assigns, :current_user)
+      refute conn.halted
+    end
   end
 
   # Private