diff --git a/CHANGELOG.md b/CHANGELOG.md index c6dd52468..078860995 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -18,6 +18,7 @@ All notable changes to this project will be documented in this file. - Validate domain format on site creation plausible/analytics#427 - Improve settings UX and design plausible/analytics#412 - Improve site listing UX and design plausible/analytics#438 +- Improve onboarding UX and design plausible/analytics#441 ### Fixed - Do not error when activating an already activated account plausible/analytics#370 diff --git a/config/config.exs b/config/config.exs index 553269240..edddcbc64 100644 --- a/config/config.exs +++ b/config/config.exs @@ -120,7 +120,9 @@ extra_cron = [ # Every 10 minutes {"*/10 * * * *", Plausible.Workers.ProvisionSslCertificates}, # Every 15 minutes - {"*/15 * * * *", Plausible.Workers.SpikeNotifier} + {"*/15 * * * *", Plausible.Workers.SpikeNotifier}, + # Every day at midnight + {"0 0 * * *", Plausible.Workers.CleanEmailVerificationCodes} ] base_queues = [rotate_salts: 1] @@ -133,7 +135,8 @@ extra_queues = [ trial_notification_emails: 1, schedule_email_reports: 1, send_email_reports: 1, - spike_notifications: 1 + spike_notifications: 1, + clean_email_verification_codes: 1 ] config :plausible, Oban, diff --git a/lib/plausible/auth/auth.ex b/lib/plausible/auth/auth.ex index aba2c0715..c08d3e6e5 100644 --- a/lib/plausible/auth/auth.ex +++ b/lib/plausible/auth/auth.ex @@ -3,6 +3,41 @@ defmodule Plausible.Auth do alias Plausible.Auth alias Plausible.Stats.Clickhouse, as: Stats + def issue_email_verification(user) do + Repo.update_all(from(c in "email_verification_codes", where: c.user_id == ^user.id), [set: [user_id: nil]]) + + code = Repo.one(from(c in "email_verification_codes", where: is_nil(c.user_id), select: c.code, limit: 1)) + + Repo.update_all(from(c in "email_verification_codes", where: c.code == ^code), [set: [user_id: user.id, issued_at: Timex.now()]]) + + code + end + + defp is_expired?(activation_code_issued) do + Timex.before?(activation_code_issued, Timex.shift(Timex.now(), hours: -4)) + end + + def verify_email(user, code) do + found_code = Repo.one( + from c in "email_verification_codes", + where: c.user_id == ^user.id, + where: c.code == ^code, + select: %{code: c.code, issued: c.issued_at} + ) + + cond do + is_nil(found_code) -> {:error, :incorrect} + is_expired?(found_code[:issued]) -> {:error, :expired} + true -> + {:ok, _} = Ecto.Multi.new + |> Ecto.Multi.update(:user, Plausible.Auth.User.changeset(user, %{email_verified: true})) + |> Ecto.Multi.update_all(:codes, from(c in "email_verification_codes", where: c.user_id == ^user.id), [set: [user_id: nil]]) + |> Repo.transaction + + :ok + end + end + def create_user(name, email) do %Auth.User{} |> Auth.User.new(%{name: name, email: email}) diff --git a/lib/plausible/auth/token.ex b/lib/plausible/auth/token.ex index 3720a339c..cbf0ecfeb 100644 --- a/lib/plausible/auth/token.ex +++ b/lib/plausible/auth/token.ex @@ -11,15 +11,4 @@ defmodule Plausible.Auth.Token do max_age: @one_hour_in_seconds ) end - - def sign_activation(name, email) do - Phoenix.Token.sign(PlausibleWeb.Endpoint, "activation", %{ - name: name, - email: email - }) - end - - def verify_activation(token) do - Phoenix.Token.verify(PlausibleWeb.Endpoint, "activation", token, max_age: @one_day_in_seconds) - end end diff --git a/lib/plausible/auth/user.ex b/lib/plausible/auth/user.ex index 4339560ce..7a6874ca4 100644 --- a/lib/plausible/auth/user.ex +++ b/lib/plausible/auth/user.ex @@ -8,13 +8,16 @@ defmodule Plausible.Auth.User do use Ecto.Schema import Ecto.Changeset + @required [:email, :name, :password, :password_confirmation] schema "users" do field :email, :string field :password_hash field :password, :string, virtual: true + field :password_confirmation, :string, virtual: true field :name, :string field :last_seen, :naive_datetime field :trial_expiry_date, :date + field :email_verified, :boolean has_many :site_memberships, Plausible.Site.Membership has_many :sites, through: [:site_memberships, :site] @@ -26,16 +29,19 @@ defmodule Plausible.Auth.User do def new(user, attrs \\ %{}) do user - |> cast(attrs, [:email, :name]) - |> validate_required([:email, :name]) + |> cast(attrs, @required) + |> validate_required(@required) + |> validate_length(:password, min: 6, message: "has to be at least 6 characters") + |> validate_confirmation(:password) + |> hash_password() |> change(trial_expiry_date: Timex.today() |> Timex.shift(days: 30)) |> unique_constraint(:email) end def changeset(user, attrs \\ %{}) do user - |> cast(attrs, [:email, :name]) - |> validate_required([:email, :name]) + |> cast(attrs, [:email, :name, :email_verified]) + |> validate_required([:email, :name, :email_verified]) |> unique_constraint(:email) end @@ -48,4 +54,10 @@ defmodule Plausible.Auth.User do |> validate_length(:password, min: 6, message: "has to be at least 6 characters") |> cast(%{password_hash: hash}, [:password_hash]) end + + def hash_password(%{errors: [], changes: changes} = changeset) do + hash = Plausible.Auth.Password.hash(changes[:password]) + change(changeset, password_hash: hash) + end + def hash_password(changeset), do: changeset end diff --git a/lib/plausible_web/controllers/auth_controller.ex b/lib/plausible_web/controllers/auth_controller.ex index 10a3be1ba..44bbacff0 100644 --- a/lib/plausible_web/controllers/auth_controller.ex +++ b/lib/plausible_web/controllers/auth_controller.ex @@ -25,22 +25,20 @@ defmodule PlausibleWeb.AuthController do end def register(conn, params) do - user = Plausible.Auth.User.changeset(%Plausible.Auth.User{}, params["user"]) + user = Plausible.Auth.User.new(%Plausible.Auth.User{}, params["user"]) if PlausibleWeb.Captcha.verify(params["h-captcha-response"]) do - case Ecto.Changeset.apply_action(user, :insert) do + case Repo.insert(user) do {:ok, user} -> - token = Auth.Token.sign_activation(user.name, user.email) - url = PlausibleWeb.Endpoint.url() <> "/claim-activation?token=#{token}" - Logger.info(url) - email_template = PlausibleWeb.Email.activation_email(user, url) + code = Auth.issue_email_verification(user) + Logger.info("VERIFICATION CODE: #{code}") + email_template = PlausibleWeb.Email.activation_email(user, code) Plausible.Mailer.send_email(email_template) conn - |> render("register_success.html", - email: user.email, - layout: {PlausibleWeb.LayoutView, "focus.html"} - ) + |> put_session(:current_user_id, user.id) + |> put_resp_cookie("logged_in", "true", http_only: false) + |> redirect(to: "/activate") {:error, changeset} -> render(conn, "register_form.html", @@ -57,37 +55,52 @@ defmodule PlausibleWeb.AuthController do end end - def claim_activation_link(conn, %{"token" => token}) do - case Auth.Token.verify_activation(token) do - {:ok, %{name: name, email: email}} -> - case Auth.create_user(name, email) do - {:ok, user} -> - PlausibleWeb.Email.welcome_email(user) - |> Plausible.Mailer.send_email() + def activate_form(conn, _params) do + user = conn.assigns[:current_user] - user_activated_account(conn, user) + has_code = Repo.exists?( + from c in "email_verification_codes", + where: c.user_id == ^user.id + ) - {:error, %Ecto.Changeset{errors: [email: {"has already been taken", _}]}} -> - user = Auth.find_user_by(email: email) - user_activated_account(conn, user) + render(conn, "activate.html", has_pin: has_code, layout: {PlausibleWeb.LayoutView, "focus.html"}) + end - {:error, changeset} -> - send_resp(conn, 400, inspect(changeset.errors)) - end + def activate(conn, %{"code" => code}) do + user = conn.assigns[:current_user] + {code, ""} = Integer.parse(code) - {:error, :expired} -> - render_error(conn, 401, "Your token has expired. Please request another activation link.") + case Auth.verify_email(user, code) do + :ok -> + PlausibleWeb.Email.welcome_email(user) + |> Plausible.Mailer.send_email() - {:error, _} -> - render_error(conn, 400, "Your token is invalid. Please request another activation link.") + redirect(conn, to: "/sites/new") + {:error, :incorrect} -> + render(conn, "activate.html", + error: "Incorrect activation code", + has_pin: true, + layout: {PlausibleWeb.LayoutView, "focus.html"} + ) + {:error, :expired} -> + render(conn, "activate.html", + error: "Code is expired, please request another one", + has_pin: false, + layout: {PlausibleWeb.LayoutView, "focus.html"} + ) end end - defp user_activated_account(conn, user) do + def request_activation_code(conn, _params) do + user = conn.assigns[:current_user] + pin = Auth.issue_email_verification(user) + + email_template = PlausibleWeb.Email.activation_email(user, pin) + Plausible.Mailer.send_email(email_template) + conn - |> put_session(:current_user_id, user.id) - |> put_resp_cookie("logged_in", "true", http_only: false) - |> redirect(to: "/password") + |> put_flash(:success, "Activation code was sent to #{user.email}") + |> redirect(to: "/activate") end def password_reset_request_form(conn, _) do diff --git a/lib/plausible_web/controllers/site_controller.ex b/lib/plausible_web/controllers/site_controller.ex index 6d973450c..3f07de4b6 100644 --- a/lib/plausible_web/controllers/site_controller.ex +++ b/lib/plausible_web/controllers/site_controller.ex @@ -19,9 +19,15 @@ defmodule PlausibleWeb.SiteController do end def new(conn, _params) do + current_user = conn.assigns[:current_user] changeset = Plausible.Site.changeset(%Plausible.Site{}) - render(conn, "new.html", changeset: changeset, layout: {PlausibleWeb.LayoutView, "focus.html"}) + is_first_site = !Repo.exists?( + from sm in Plausible.Site.Membership, + where: sm.user_id == ^current_user.id + ) + + render(conn, "new.html", changeset: changeset, is_first_site: is_first_site, layout: {PlausibleWeb.LayoutView, "focus.html"}) end def create_site(conn, %{"site" => site_params}) do @@ -36,21 +42,34 @@ defmodule PlausibleWeb.SiteController do |> redirect(to: "/#{URI.encode_www_form(site.domain)}/snippet") {:error, :site, changeset, _} -> + is_first_site = !Repo.exists?( + from sm in Plausible.Site.Membership, + where: sm.user_id == ^user.id + ) + render(conn, "new.html", changeset: changeset, + is_first_site: is_first_site, layout: {PlausibleWeb.LayoutView, "focus.html"} ) end end def add_snippet(conn, %{"website" => website}) do + user = conn.assigns[:current_user] site = Sites.get_for_user!(conn.assigns[:current_user].id, website) |> Repo.preload(:custom_domain) + is_first_site = !Repo.exists?( + from sm in Plausible.Site.Membership, + where: sm.user_id == ^user.id + and sm.site_id != ^site.id + ) + conn |> assign(:skip_plausible_tracking, true) - |> render("snippet.html", site: site, layout: {PlausibleWeb.LayoutView, "focus.html"}) + |> render("snippet.html", site: site, is_first_site: is_first_site, layout: {PlausibleWeb.LayoutView, "focus.html"}) end def new_goal(conn, %{"website" => website}) do diff --git a/lib/plausible_web/email.ex b/lib/plausible_web/email.ex index 6e0fe6c12..f89c6b3f9 100644 --- a/lib/plausible_web/email.ex +++ b/lib/plausible_web/email.ex @@ -6,12 +6,12 @@ defmodule PlausibleWeb.Email do Application.get_env(:plausible, :mailer_email) end - def activation_email(user, link) do + def activation_email(user, code) do base_email() - |> to(user.email) + |> to(user) |> tag("activation-email") - |> subject("Activate your Plausible free trial") - |> render("activation_email.html", name: user.name, link: link) + |> subject("#{code} is your Plausible email verification code") + |> render("activation_email.html", user: user, code: code) end def welcome_email(user) do base_email() diff --git a/lib/plausible_web/plugs/require_account.ex b/lib/plausible_web/plugs/require_account.ex index 9df89095a..250bcce8d 100644 --- a/lib/plausible_web/plugs/require_account.ex +++ b/lib/plausible_web/plugs/require_account.ex @@ -6,13 +6,20 @@ defmodule PlausibleWeb.RequireAccountPlug do end def call(conn, _opts) do - case conn.assigns[:current_user] do - nil -> + user = conn.assigns[:current_user] + + cond do + is_nil(user) -> Plug.Conn.put_session(conn, :login_dest, conn.request_path) |> Phoenix.Controller.redirect(to: "/login") |> halt - _email -> + not user.email_verified -> + conn + |> Phoenix.Controller.redirect(to: "/activate") + |> halt + + true -> conn end end diff --git a/lib/plausible_web/router.ex b/lib/plausible_web/router.ex index a74765b88..2e0014046 100644 --- a/lib/plausible_web/router.ex +++ b/lib/plausible_web/router.ex @@ -77,7 +77,9 @@ defmodule PlausibleWeb.Router do get "/register", AuthController, :register_form post "/register", AuthController, :register - get "/claim-activation", AuthController, :claim_activation_link + get "/activate", AuthController, :activate_form + post "/activate/request-code", AuthController, :request_activation_code + post "/activate", AuthController, :activate get "/login", AuthController, :login_form post "/login", AuthController, :login get "/password/request-reset", AuthController, :password_reset_request_form diff --git a/lib/plausible_web/templates/auth/_onboarding_steps.html.eex b/lib/plausible_web/templates/auth/_onboarding_steps.html.eex new file mode 100644 index 000000000..c685d3a71 --- /dev/null +++ b/lib/plausible_web/templates/auth/_onboarding_steps.html.eex @@ -0,0 +1,39 @@ +
- Don't have an account? <%= link("Register", to: "/register") %> instead. + Don't have an account? <%= link("Register", to: "/register", class: "underline text-gray-800") %> instead.
<% end %> <% end %> diff --git a/lib/plausible_web/templates/auth/register_form.html.eex b/lib/plausible_web/templates/auth/register_form.html.eex index d046269ba..14a4dce4f 100644 --- a/lib/plausible_web/templates/auth/register_form.html.eex +++ b/lib/plausible_web/templates/auth/register_form.html.eex @@ -3,69 +3,63 @@No spam, guaranteed.
- <%= email_input f, :email, class: "transition bg-gray-100 appearance-none border border-transparent rounded w-full p-2 text-gray-700 leading-normal appearance-none focus:outline-none focus:bg-white focus:border-gray-300", placeholder: "example@email.com" %> - <%= error_tag f, :email %> + <%= error_tag f, :name %> +No spam, guaranteed.
+Min 6 characters
+- Already have an account? <%= link("Log in", to: "/login", class: "underline text-gray-800") %> instead. -
+ <%= if PlausibleWeb.Captcha.enabled?() do %> ++ Already have an account? <%= link("Log in", to: "/login", class: "underline text-gray-800") %> instead. +
+ <% end %> ++ <%= get_flash(@conn, :error_title) || "Error" %> +
++ <%= get_flash(@conn, :error) %> +
+diff --git a/lib/plausible_web/templates/site/new.html.eex b/lib/plausible_web/templates/site/new.html.eex index 3a1f4b787..a15e0e2c1 100644 --- a/lib/plausible_web/templates/site/new.html.eex +++ b/lib/plausible_web/templates/site/new.html.eex @@ -1,27 +1,36 @@ -<%= form_for @changeset, "/sites", [class: "max-w-md w-full mx-auto bg-white shadow-lg rounded px-8 pt-6 pb-8 mb-4 mt-8"], fn f -> %> -
Just the naked domain without www or https://
To make sure we agree on what 'today' means
+To make sure we agree on what 'today' means
-Paste this snippet in the <head> of your website.
Paste this snippet in the <head> of your website.
+
Need to see the snippet again? <%= link("Click here", to: "/#{URI.encode_www_form(@site.domain)}/snippet")%>
- Not working? Contact support@plausible.io to get set up
+ Not working? Contact support@plausible.io to get set up