Merge branch 'refactor/approval_pending_user_field' into 'develop'

Change user.approval_pending field to user.is_approved

See merge request pleroma/pleroma!3090
This commit is contained in:
feld 2021-01-18 19:58:30 +00:00
commit ed84210da3
34 changed files with 75 additions and 55 deletions

View File

@ -10,6 +10,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
- **Breaking:** Changed `mix pleroma.user toggle_confirmed` to `mix pleroma.user confirm` - **Breaking:** Changed `mix pleroma.user toggle_confirmed` to `mix pleroma.user confirm`
- **Breaking**: AdminAPI changed User field `confirmation_pending` to `is_confirmed` - **Breaking**: AdminAPI changed User field `confirmation_pending` to `is_confirmed`
- **Breaking**: AdminAPI changed User field `approval_pending` to `is_approved`
- Polls now always return a `voters_count`, even if they are single-choice. - Polls now always return a `voters_count`, even if they are single-choice.
- Admin Emails: The ap id is used as the user link in emails now. - Admin Emails: The ap id is used as the user link in emails now.
- Improved registration workflow for email confirmation and account approval modes. - Improved registration workflow for email confirmation and account approval modes.

View File

@ -112,7 +112,7 @@ defmodule Pleroma.User do
field(:is_locked, :boolean, default: false) field(:is_locked, :boolean, default: false)
field(:is_confirmed, :boolean, default: true) field(:is_confirmed, :boolean, default: true)
field(:password_reset_pending, :boolean, default: false) field(:password_reset_pending, :boolean, default: false)
field(:approval_pending, :boolean, default: false) field(:is_approved, :boolean, default: true)
field(:registration_reason, :string, default: nil) field(:registration_reason, :string, default: nil)
field(:confirmation_token, :string, default: nil) field(:confirmation_token, :string, default: nil)
field(:default_scope, :string, default: "public") field(:default_scope, :string, default: "public")
@ -288,7 +288,7 @@ def binary_id(%User{} = user), do: binary_id(user.id)
@spec account_status(User.t()) :: account_status() @spec account_status(User.t()) :: account_status()
def account_status(%User{deactivated: true}), do: :deactivated def account_status(%User{deactivated: true}), do: :deactivated
def account_status(%User{password_reset_pending: true}), do: :password_reset_pending def account_status(%User{password_reset_pending: true}), do: :password_reset_pending
def account_status(%User{local: true, approval_pending: true}), do: :approval_pending def account_status(%User{local: true, is_approved: false}), do: :approval_pending
def account_status(%User{local: true, is_confirmed: false}) do def account_status(%User{local: true, is_confirmed: false}) do
if Config.get([:instance, :account_activation_required]) do if Config.get([:instance, :account_activation_required]) do
@ -711,16 +711,16 @@ def register_changeset(struct, params \\ %{}, opts \\ []) do
opts[:confirmed] opts[:confirmed]
end end
need_approval? = approved? =
if is_nil(opts[:need_approval]) do if is_nil(opts[:approved]) do
Config.get([:instance, :account_approval_required]) !Config.get([:instance, :account_approval_required])
else else
opts[:need_approval] opts[:approved]
end end
struct struct
|> confirmation_changeset(set_confirmation: confirmed?) |> confirmation_changeset(set_confirmation: confirmed?)
|> approval_changeset(need_approval: need_approval?) |> approval_changeset(set_approval: approved?)
|> cast(params, [ |> cast(params, [
:bio, :bio,
:raw_bio, :raw_bio,
@ -814,14 +814,14 @@ def post_register_action(%User{is_confirmed: false} = user) do
end end
end end
def post_register_action(%User{approval_pending: true} = user) do def post_register_action(%User{is_approved: false} = user) do
with {:ok, _} <- send_user_approval_email(user), with {:ok, _} <- send_user_approval_email(user),
{:ok, _} <- send_admin_approval_emails(user) do {:ok, _} <- send_admin_approval_emails(user) do
{:ok, user} {:ok, user}
end end
end end
def post_register_action(%User{approval_pending: false, is_confirmed: true} = user) do def post_register_action(%User{is_approved: true, is_confirmed: true} = user) do
with {:ok, user} <- autofollow_users(user), with {:ok, user} <- autofollow_users(user),
{:ok, _} <- autofollowing_users(user), {:ok, _} <- autofollowing_users(user),
{:ok, user} <- set_cache(user), {:ok, user} <- set_cache(user),
@ -1624,8 +1624,8 @@ def approve(users) when is_list(users) do
end) end)
end end
def approve(%User{approval_pending: true} = user) do def approve(%User{is_approved: false} = user) do
with chg <- change(user, approval_pending: false), with chg <- change(user, is_approved: true),
{:ok, user} <- update_and_set_cache(chg) do {:ok, user} <- update_and_set_cache(chg) do
post_register_action(user) post_register_action(user)
{:ok, user} {:ok, user}
@ -1684,7 +1684,7 @@ def purge_user_changeset(user) do
is_locked: false, is_locked: false,
is_confirmed: true, is_confirmed: true,
password_reset_pending: false, password_reset_pending: false,
approval_pending: false, is_approved: true,
registration_reason: nil, registration_reason: nil,
confirmation_token: nil, confirmation_token: nil,
domain_blocks: [], domain_blocks: [],
@ -2327,9 +2327,8 @@ def confirmation_changeset(user, set_confirmation: confirmed?) do
end end
@spec approval_changeset(User.t(), keyword()) :: Changeset.t() @spec approval_changeset(User.t(), keyword()) :: Changeset.t()
def approval_changeset(user, need_approval: need_approval?) do def approval_changeset(user, set_approval: approved?) do
params = if need_approval?, do: %{approval_pending: true}, else: %{approval_pending: false} cast(user, %{is_approved: approved?}, [:is_approved])
cast(user, params, [:approval_pending])
end end
def add_pinnned_activity(user, %Pleroma.Activity{id: id}) do def add_pinnned_activity(user, %Pleroma.Activity{id: id}) do

View File

@ -138,7 +138,7 @@ defp compose_query({:external, _}, query), do: location_query(query, false)
defp compose_query({:active, _}, query) do defp compose_query({:active, _}, query) do
User.restrict_deactivated(query) User.restrict_deactivated(query)
|> where([u], u.approval_pending == false) |> where([u], u.is_approved == true)
end end
defp compose_query({:legacy_active, _}, query) do defp compose_query({:legacy_active, _}, query) do
@ -159,7 +159,7 @@ defp compose_query({:confirmation_pending, bool}, query) do
end end
defp compose_query({:need_approval, _}, query) do defp compose_query({:need_approval, _}, query) do
where(query, [u], u.approval_pending) where(query, [u], u.is_approved == false)
end end
defp compose_query({:unconfirmed, _}, query) do defp compose_query({:unconfirmed, _}, query) do

View File

@ -78,7 +78,7 @@ def render("show.json", %{user: user}) do
"roles" => User.roles(user), "roles" => User.roles(user),
"tags" => user.tags || [], "tags" => user.tags || [],
"is_confirmed" => user.is_confirmed, "is_confirmed" => user.is_confirmed,
"approval_pending" => user.approval_pending, "is_approved" => user.is_approved,
"url" => user.uri || user.ap_id, "url" => user.uri || user.ap_id,
"registration_reason" => user.registration_reason, "registration_reason" => user.registration_reason,
"actor_type" => user.actor_type "actor_type" => user.actor_type

View File

@ -0,0 +1,20 @@
# Pleroma: A lightweight social networking server
# Copyright © 2017-2020 Pleroma Authors <https://pleroma.social/>
# SPDX-License-Identifier: AGPL-3.0-only
defmodule Pleroma.Repo.Migrations.RefactorApprovalPendingUserField do
use Ecto.Migration
def up do
# Flip the values before we change the meaning of the column
execute("UPDATE users SET approval_pending = NOT approval_pending;")
execute("ALTER TABLE users RENAME COLUMN approval_pending TO is_approved;")
execute("ALTER TABLE users ALTER COLUMN is_approved SET DEFAULT true;")
end
def down do
execute("UPDATE users SET is_approved = NOT is_approved;")
execute("ALTER TABLE users RENAME COLUMN is_approved TO approval_pending;")
execute("ALTER TABLE users ALTER COLUMN approval_pending SET DEFAULT false;")
end
end

View File

@ -1 +1 @@
<!DOCTYPE html><html><head><meta charset=utf-8><meta http-equiv=X-UA-Compatible content="IE=edge,chrome=1"><meta name=renderer content=webkit><meta name=viewport content="width=device-width,initial-scale=1,maximum-scale=1,user-scalable=no"><title>Admin FE</title><link rel="shortcut icon" href=favicon.ico><link href=chunk-elementUI.f77689d7.css rel=stylesheet><link href=chunk-libs.5cf7f50a.css rel=stylesheet><link href=app.6fb984d1.css rel=stylesheet></head><body><div id=app></div><script type=text/javascript src=static/js/runtime.52fd11cf.js></script><script type=text/javascript src=static/js/chunk-elementUI.21957ec8.js></script><script type=text/javascript src=static/js/chunk-libs.5ca2c8e8.js></script><script type=text/javascript src=static/js/app.3e54b198.js></script></body></html> <!DOCTYPE html><html><head><meta charset=utf-8><meta http-equiv=X-UA-Compatible content="IE=edge,chrome=1"><meta name=renderer content=webkit><meta name=viewport content="width=device-width,initial-scale=1,maximum-scale=1,user-scalable=no"><title>Admin FE</title><link rel="shortcut icon" href=favicon.ico><link href=chunk-elementUI.f77689d7.css rel=stylesheet><link href=chunk-libs.5cf7f50a.css rel=stylesheet><link href=app.6fb984d1.css rel=stylesheet></head><body><div id=app></div><script type=text/javascript src=static/js/runtime.5c1034c4.js></script><script type=text/javascript src=static/js/chunk-elementUI.21957ec8.js></script><script type=text/javascript src=static/js/chunk-libs.5ca2c8e8.js></script><script type=text/javascript src=static/js/app.01bfc983.js></script></body></html>

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

View File

@ -694,7 +694,7 @@ test "it creates unapproved user" do
{:ok, user} = Repo.insert(changeset) {:ok, user} = Repo.insert(changeset)
assert user.approval_pending refute user.is_approved
assert user.registration_reason == "I'm a cool guy :)" assert user.registration_reason == "I'm a cool guy :)"
end end
@ -1388,17 +1388,17 @@ test "hide a user's statuses from timelines and notifications" do
describe "approve" do describe "approve" do
test "approves a user" do test "approves a user" do
user = insert(:user, approval_pending: true) user = insert(:user, is_approved: false)
assert true == user.approval_pending refute user.is_approved
{:ok, user} = User.approve(user) {:ok, user} = User.approve(user)
assert false == user.approval_pending assert user.is_approved
end end
test "approves a list of users" do test "approves a list of users" do
unapproved_users = [ unapproved_users = [
insert(:user, approval_pending: true), insert(:user, is_approved: false),
insert(:user, approval_pending: true), insert(:user, is_approved: false),
insert(:user, approval_pending: true) insert(:user, is_approved: false)
] ]
{:ok, users} = User.approve(unapproved_users) {:ok, users} = User.approve(unapproved_users)
@ -1406,7 +1406,7 @@ test "approves a list of users" do
assert Enum.count(users) == 3 assert Enum.count(users) == 3
Enum.each(users, fn user -> Enum.each(users, fn user ->
assert false == user.approval_pending assert user.is_approved
end) end)
end end
@ -1414,7 +1414,7 @@ test "it sends welcome email if it is set" do
clear_config([:welcome, :email, :enabled], true) clear_config([:welcome, :email, :enabled], true)
clear_config([:welcome, :email, :sender], "tester@test.me") clear_config([:welcome, :email, :sender], "tester@test.me")
user = insert(:user, approval_pending: true) user = insert(:user, is_approved: false)
welcome_user = insert(:user, email: "tester@test.me") welcome_user = insert(:user, email: "tester@test.me")
instance_name = Pleroma.Config.get([:instance, :name]) instance_name = Pleroma.Config.get([:instance, :name])
@ -1432,7 +1432,7 @@ test "it sends welcome email if it is set" do
test "approving an approved user does not trigger post-register actions" do test "approving an approved user does not trigger post-register actions" do
clear_config([:welcome, :email, :enabled], true) clear_config([:welcome, :email, :enabled], true)
user = insert(:user, approval_pending: false) user = insert(:user, is_approved: true)
User.approve(user) User.approve(user)
ObanHelpers.perform_all() ObanHelpers.perform_all()
@ -1465,9 +1465,9 @@ test "confirms a list of users" do
end) end)
end end
test "sends approval emails when `approval_pending: true`" do test "sends approval emails when `is_approved: false`" do
admin = insert(:user, is_admin: true) admin = insert(:user, is_admin: true)
user = insert(:user, is_confirmed: false, approval_pending: true) user = insert(:user, is_confirmed: false, is_approved: false)
User.confirm(user) User.confirm(user)
ObanHelpers.perform_all() ObanHelpers.perform_all()
@ -1494,7 +1494,7 @@ test "sends approval emails when `approval_pending: true`" do
end end
test "confirming a confirmed user does not trigger post-register actions" do test "confirming a confirmed user does not trigger post-register actions" do
user = insert(:user, is_confirmed: true, approval_pending: true) user = insert(:user, is_confirmed: true, is_approved: false)
User.confirm(user) User.confirm(user)
ObanHelpers.perform_all() ObanHelpers.perform_all()
@ -1591,7 +1591,7 @@ test "deactivates user when activation is not required", %{user: user} do
end end
test "delete/1 when approval is pending deletes the user" do test "delete/1 when approval is pending deletes the user" do
user = insert(:user, approval_pending: true) user = insert(:user, is_approved: false)
{:ok, job} = User.delete(user) {:ok, job} = User.delete(user)
{:ok, _} = ObanHelpers.perform(job) {:ok, _} = ObanHelpers.perform(job)
@ -1618,7 +1618,7 @@ test "delete/1 purges a user when they wouldn't be fully deleted" do
is_locked: true, is_locked: true,
is_confirmed: false, is_confirmed: false,
password_reset_pending: true, password_reset_pending: true,
approval_pending: true, is_approved: false,
registration_reason: "ahhhhh", registration_reason: "ahhhhh",
confirmation_token: "qqqq", confirmation_token: "qqqq",
domain_blocks: ["lain.com"], domain_blocks: ["lain.com"],
@ -1660,7 +1660,7 @@ test "delete/1 purges a user when they wouldn't be fully deleted" do
is_locked: false, is_locked: false,
is_confirmed: true, is_confirmed: true,
password_reset_pending: false, password_reset_pending: false,
approval_pending: false, is_approved: true,
registration_reason: nil, registration_reason: nil,
confirmation_token: nil, confirmation_token: nil,
domain_blocks: [], domain_blocks: [],
@ -1755,10 +1755,10 @@ test "returns :deactivated for deactivated user" do
end end
test "returns :approval_pending for unapproved user" do test "returns :approval_pending for unapproved user" do
user = insert(:user, local: true, approval_pending: true) user = insert(:user, local: true, is_approved: false)
assert User.account_status(user) == :approval_pending assert User.account_status(user) == :approval_pending
user = insert(:user, local: true, is_confirmed: false, approval_pending: true) user = insert(:user, local: true, is_confirmed: false, is_approved: false)
assert User.account_status(user) == :approval_pending assert User.account_status(user) == :approval_pending
end end
end end

View File

@ -429,7 +429,7 @@ test "allows to force-unfollow another user", %{admin: admin, conn: conn} do
describe "GET /api/pleroma/admin/users" do describe "GET /api/pleroma/admin/users" do
test "renders users array for the first page", %{conn: conn, admin: admin} do test "renders users array for the first page", %{conn: conn, admin: admin} do
user = insert(:user, local: false, tags: ["foo", "bar"]) user = insert(:user, local: false, tags: ["foo", "bar"])
user2 = insert(:user, approval_pending: true, registration_reason: "I'm a chill dude") user2 = insert(:user, is_approved: false, registration_reason: "I'm a chill dude")
conn = get(conn, "/api/pleroma/admin/users?page=1") conn = get(conn, "/api/pleroma/admin/users?page=1")
@ -444,7 +444,7 @@ test "renders users array for the first page", %{conn: conn, admin: admin} do
user2, user2,
%{ %{
"local" => true, "local" => true,
"approval_pending" => true, "is_approved" => false,
"registration_reason" => "I'm a chill dude", "registration_reason" => "I'm a chill dude",
"actor_type" => "Person" "actor_type" => "Person"
} }
@ -638,7 +638,7 @@ test "only unconfirmed users", %{conn: conn} do
sad_user = insert(:user, nickname: "sadboy", is_confirmed: false) sad_user = insert(:user, nickname: "sadboy", is_confirmed: false)
old_user = insert(:user, nickname: "oldboy", is_confirmed: false) old_user = insert(:user, nickname: "oldboy", is_confirmed: false)
insert(:user, nickname: "happyboy", approval_pending: false) insert(:user, nickname: "happyboy", is_approved: true)
insert(:user, is_confirmed: true) insert(:user, is_confirmed: true)
result = result =
@ -650,7 +650,7 @@ test "only unconfirmed users", %{conn: conn} do
Enum.map([old_user, sad_user], fn user -> Enum.map([old_user, sad_user], fn user ->
user_response(user, %{ user_response(user, %{
"is_confirmed" => false, "is_confirmed" => false,
"approval_pending" => false "is_approved" => true
}) })
end) end)
|> Enum.sort_by(& &1["nickname"]) |> Enum.sort_by(& &1["nickname"])
@ -662,18 +662,18 @@ test "only unapproved users", %{conn: conn} do
user = user =
insert(:user, insert(:user,
nickname: "sadboy", nickname: "sadboy",
approval_pending: true, is_approved: false,
registration_reason: "Plz let me in!" registration_reason: "Plz let me in!"
) )
insert(:user, nickname: "happyboy", approval_pending: false) insert(:user, nickname: "happyboy", is_approved: true)
conn = get(conn, "/api/pleroma/admin/users?filters=need_approval") conn = get(conn, "/api/pleroma/admin/users?filters=need_approval")
users = [ users = [
user_response( user_response(
user, user,
%{"approval_pending" => true, "registration_reason" => "Plz let me in!"} %{"is_approved" => false, "registration_reason" => "Plz let me in!"}
) )
] ]
@ -816,8 +816,8 @@ test "load users with tags list", %{conn: conn} do
end end
test "`active` filters out users pending approval", %{token: token} do test "`active` filters out users pending approval", %{token: token} do
insert(:user, approval_pending: true) insert(:user, is_approved: false)
%{id: user_id} = insert(:user, approval_pending: false) %{id: user_id} = insert(:user, is_approved: true)
%{id: admin_id} = token.user %{id: admin_id} = token.user
conn = conn =
@ -913,8 +913,8 @@ test "PATCH /api/pleroma/admin/users/deactivate", %{admin: admin, conn: conn} do
end end
test "PATCH /api/pleroma/admin/users/approve", %{admin: admin, conn: conn} do test "PATCH /api/pleroma/admin/users/approve", %{admin: admin, conn: conn} do
user_one = insert(:user, approval_pending: true) user_one = insert(:user, is_approved: false)
user_two = insert(:user, approval_pending: true) user_two = insert(:user, is_approved: false)
conn = conn =
patch( patch(
@ -924,7 +924,7 @@ test "PATCH /api/pleroma/admin/users/approve", %{admin: admin, conn: conn} do
) )
response = json_response(conn, 200) response = json_response(conn, 200)
assert Enum.map(response["users"], & &1["approval_pending"]) == [false, false] assert Enum.map(response["users"], & &1["is_approved"]) == [true, true]
log_entry = Repo.one(ModerationLog) log_entry = Repo.one(ModerationLog)
@ -961,7 +961,7 @@ defp user_response(user, attrs \\ %{}) do
"avatar" => User.avatar_url(user) |> MediaProxy.url(), "avatar" => User.avatar_url(user) |> MediaProxy.url(),
"display_name" => HTML.strip_tags(user.name || user.nickname), "display_name" => HTML.strip_tags(user.name || user.nickname),
"is_confirmed" => true, "is_confirmed" => true,
"approval_pending" => false, "is_approved" => true,
"url" => user.ap_id, "url" => user.ap_id,
"registration_reason" => nil, "registration_reason" => nil,
"actor_type" => "Person" "actor_type" => "Person"

View File

@ -182,7 +182,7 @@ test "it returns user by email" do
end end
test "it returns unapproved user" do test "it returns unapproved user" do
unapproved = insert(:user, approval_pending: true) unapproved = insert(:user, is_approved: false)
insert(:user) insert(:user)
insert(:user) insert(:user)

View File

@ -1028,7 +1028,7 @@ test "registers and logs in without :account_activation_required / :account_appr
assert user assert user
assert user.is_confirmed assert user.is_confirmed
refute user.approval_pending assert user.is_approved
end end
test "registers but does not log in with :account_activation_required", %{conn: conn} do test "registers but does not log in with :account_activation_required", %{conn: conn} do
@ -1150,7 +1150,7 @@ test "registers but does not log in with :account_approval_required", %{conn: co
user = Repo.get_by(User, email: "lain@example.org") user = Repo.get_by(User, email: "lain@example.org")
assert user.approval_pending refute user.is_approved
assert user.registration_reason == "I'm a cool dude, bro" assert user.registration_reason == "I'm a cool dude, bro"
end end

View File

@ -1041,7 +1041,7 @@ test "rejects token exchange for valid credentials belonging to an unapproved us
user = user =
insert(:user, insert(:user,
password_hash: Pleroma.Password.Pbkdf2.hash_pwd_salt(password), password_hash: Pleroma.Password.Pbkdf2.hash_pwd_salt(password),
approval_pending: true is_approved: false
) )
refute Pleroma.User.account_status(user) == :active refute Pleroma.User.account_status(user) == :active

View File

@ -97,7 +97,7 @@ test "it sends an admin email if :account_approval_required is specified in inst
{:ok, user} = TwitterAPI.register_user(data) {:ok, user} = TwitterAPI.register_user(data)
ObanHelpers.perform_all() ObanHelpers.perform_all()
assert user.approval_pending refute user.is_approved
user_email = Pleroma.Emails.UserEmail.approval_pending_email(user) user_email = Pleroma.Emails.UserEmail.approval_pending_email(user)
admin_email = Pleroma.Emails.AdminEmail.new_unapproved_registration(admin, user) admin_email = Pleroma.Emails.AdminEmail.new_unapproved_registration(admin, user)