User invites #1351

begedin · 2017-12-28T17:51:24Z

What's in this PR?

This PR adds API support for UserInvite creation and claims.

The Issue this is referring to specifies that we should be adding an InvitedUser model, but UserInvite seems more consistent in naming, so I opted for that.

Creation of user invites

we have a new controller for this, as well as a new endpoint
we differentiate between a plain invite and an invite created to invite a user to a project
when creating a plain invite, the user is authorized to do so if they are the inviter, with no other conditions
when creating a project invite, the user needs to be an inviter, and additionally, they need to be of a high enough membership in the specified project, in order to invite a user with a specified role
- pending users and contributors (?) can't do anything
- admins can invite other pending (not useful) and contributor users
- owners can do the same as admins and also invite other admin users
during creation of the invite, we require an email and also validate that a user account with that email doesn't exist already

Claiming of user invites

This is done through the user controller create action. The user creation was extracted into Accounts.create/1 and a new, special clause matches against a payload holding an "invite_id" key, to differentiate from normal account creation.

When claiming the invite we

try to load the invite by specified id - can fail and renders a 404 if it does
create the user (this can fail with a validation error if the user has been created regularly since the invite was created)
create a project user if a project and role are specified by the invite
associate invite with created user through invitee

The user controller is where we track any claimed invites.

Suggested issues to create

Add an extra step to normal account creation, which claims all invites associated with the created user's email
Add the same extra step to invite claim account creation, which claims all invites other than the one currently being claimed.
Add support for inviting existing users to project

References

Closes #1350

joshsmith · 2017-12-28T22:34:27Z

lib/code_corps/model/user_invite.ex

+
+  schema "user_invites" do
+    field :email, :string, null: false
+    field :role, :string, default: "contributor"


This shouldn't have a default because it's possible for an invite to not be for a project.

joshsmith · 2017-12-28T22:34:46Z

priv/repo/migrations/20171228163712_add_user_invites.exs

+    create table(:user_invites) do
+      add :email, :string, null: false
+      add :name, :string, null: true
+      add :role, :string, null: true, default: "contributor"


Same here re: default.

joshsmith · 2017-12-28T22:35:12Z

priv/repo/structure.sql

-- Dumped from database version 10.1
-- Dumped by pg_dump version 10.1
+-- Dumped from database version 10.0
+-- Dumped by pg_dump version 10.0


Can we see if there's a way to avoid the db version numbering while still getting the benefits of the structure.sql?

I'm not seeing any documented way of doing so with mix ecto.dump

joshsmith · 2017-12-28T22:36:26Z

lib/code_corps/accounts/user_invites.ex

+    %UserInvite{}
+    |> Changeset.cast(params, [:email, :name, :role, :inviter_id, :project_id])
+    |> Changeset.validate_required([:email, :inviter_id])
+    |> Changeset.validate_inclusion(:role, ~w(contributor admin owner))


Ideally we would source the role types from the ProjectUser.

joshsmith · 2017-12-28T22:37:22Z

lib/code_corps/accounts/user_invites.ex

+
+        if count > 0 do
+          changeset |> Changeset.add_error(:email, "Already associated with a project member")
+        else


I think the requirement wasn't quite clear here: we want to be sure that the email is not associated with a User.

Several questions then

will a project admin/owner ever be able to invite an existing codecorps user to their project?

would that not create a UserInvite and create something else? Maybe a ProjectUser record with a status of "invited"?

what happens in the following scenario:

invite is created for a "mike@mail.com"

later, independently, a user registers with that email

even later, that same user tries to claim the invite

joshsmith · 2017-12-28T22:37:57Z

lib/code_corps/accounts/user_invites.ex

+  end
+
+  @spec claim_invite(map) :: {:ok, User.t}
+  def claim_invite(%{} = params) do


We'll need to accommodate invites for projects and general invites to Code Corps.

Right now, the code sort of does that. It will

create a user

join that user with the project, provided the project and role are specified

assign that user to the assignee

I'm guessing an email will also be involved, which should be pluggable into this process

joshsmith · 2017-12-28T22:38:39Z

lib/code_corps/accounts/user_invites.ex

+
+  @spec claim_new_user(map) :: {:ok, User.t}
+  defp claim_new_user(%{} = params) do
+    %User{} |> User.registration_changeset(params) |> Repo.insert


Not sure if this will change, but in all the 1.6 auto-formatting I've seen everything uses (), so Repo.insert().

joshsmith · 2017-12-29T21:10:41Z

Several questions then

will a project admin/owner ever be able to invite an existing codecorps user to their project?

would that not create a UserInvite and create something else? Maybe a ProjectUser record with a status of "invited"?

Yes, they would be able to invite an existing user. But this would be simply a ProjectUser with a different status, as you suggested. There wouldn't be a need for a UserInvite in this case. I'm not sure of a better name to represent the idea, but the invite is to someone who is not yet a user.

what happens in the following scenario:

invite is created for a "mike@mail.com"

later, independently, a user registers with that email

even later, that same user tries to claim the invite

Hadn't thought of this. Ideally upon registration we would look through the UserInvite table and create any ProjectUser records, thereby "claiming" the invite. And again ideally, we would then let a user know that an invite is claimed when they go to a URL with the invite id in the query params, and we would also have a status for such a claim that differentiates it from a sign up with the invite context.

- Add UserInvite schema and model - Add Accounts.UserInvites subcontext - Add Accounts.create_invite tests

- Add Accounts.claim_invite/1 tests - Add validation step to Accounts.create_invite, to ensure invitee is not a member of the project already

- includes tracking of event

- required refactoring of Accounts.create and Accounts.UserInvites.claim_invite

begedin · 2018-01-03T11:08:43Z

lib/code_corps/accounts/accounts.ex

+  end
+  def create(%{} = params) do
+    %User{} |> User.registration_changeset(params) |> Repo.insert()
+  end


We needed to extract creation into a context. I didn't have a better idea other than this multiple clause approach to differentiate between plain account creation and an invite claim.

begedin · 2018-01-03T11:10:41Z

lib/code_corps/model/project_user.ex

+  """
+  @spec roles :: list(String.t())
+  def roles do
+    ~w{pending contributor admin owner}


Did an auto-formatting of the file as I was making the roles function public (to be used when validating a UserInvite

begedin · 2018-01-03T11:13:00Z

lib/code_corps_web/controllers/user_controller.ex

+    :stripe_platform_customer,
+    :user_categories,
+    :user_roles,
+    :user_skills
  ]

  def preload(data) do


Another auto-formatting of file as I was modifying the create function. Actual changes are in the function above.

begedin · 2018-01-03T12:34:42Z

lib/code_corps/accounts/user_invites.ex

+      [_role, _project_id] ->
+        changeset
+    end
+  end


I'm hoping there's a shorter way to write this, but couldn't think of anything.

begedin · 2018-01-03T12:47:15Z

@joshsmith I think this is finally in a mergeable state. There are issues to be created to expand this further, pending feedback, but other than that, I think our initial bases are covered. I'll update the PR description with the current state of the PR

joshsmith · 2018-01-10T19:14:21Z

@begedin remember to explicitly re-request a review from me so that it will show up in my reviews.

begedin · 2018-01-22T07:19:16Z

Additional tracking to implement here:

When an invite gets created
- current_user.id |> track("Created User Invite", user_invite)
- user_invite.email |> track("User Invited", user_invite)
- if invite is for project as well
  - current_user.id |> track("Invited to Project", user_invite)
  - user_invite.email |> track("Invited to Project (Invitee)", user_invite)
When an invite gets claimed
- current_user.id |> track("Claimed User Invite", user_invite)
- user_invite.email |> track("User Invited", user_invite)
- if invite is for project as well
  - current_user.id |> track("Invited to Project", user_invite)
  - user_invite.email |> track("Invited to Project (Invitee)", user_invite)

I actually think the project specific ones could be ignored. For those, we would could have funnels with custom events instead, since the distinct_id is the same as the regular event and the difference is in the project_id property being present or not.

I'm not sure if we might also need a

user_invite.project_id |> track("Invited to Project", user_invite)

begedin · 2018-01-22T07:20:05Z

@joshsmith I got a question on tracking based on info from #1364

The rest of the code is good for another review.

joshsmith requested changes Dec 28, 2017

View reviewed changes

begedin force-pushed the user-invites branch from 49c50ca to 231f337 Compare December 29, 2017 18:15

begedin added 9 commits January 2, 2018 18:40

Add Accounts.create_invite

df090d7

- Add UserInvite schema and model - Add Accounts.UserInvites subcontext - Add Accounts.create_invite tests

Add Accounts.claim_invite/1

6c6d22e

- Add Accounts.claim_invite/1 tests - Add validation step to Accounts.create_invite, to ensure invitee is not a member of the project already

Switch Accounts.claim_invite to accept a params map

c9ce8fc

Use ProjectUser as provider of valid roles for UserInvite validation

bf72b97

Remove default "contributor" role from UserInvite

3aa1a0f

Add tests for project user invite

9e137ca

Update user requirement on create to prevent invite of existing users

21fe4d4

Add invite claim support to user controller

00d2646

Refactor account creation by extracting into Accounts context

64246b9

begedin force-pushed the user-invites branch from b43e632 to 64246b9 Compare January 2, 2018 17:40

begedin added 9 commits January 2, 2018 19:08

Add policy and tests

c56eee7

Clean up formatting in UserController

2969154

Fix moduledoc in Policy.ConversationPart

93a6d67

Add UserInviteView and tests

36eacd2

Correct Policy.UserInvite behavior

cba0b7a

Add inviter_id support to Plugs.IdsToInteger

88b103b

Add UserInvite support to CodeCorps.Policy.can?

d7a7b1d

Add UserInviteController with create endpoint and associated tests

461c8a4

- includes tracking of event

Track UserInvite claim

776a9dd

- required refactoring of Accounts.create and Accounts.UserInvites.claim_invite

begedin commented Jan 3, 2018

View reviewed changes

Format CodeCorps.UserInvite

bb1f4c2

begedin commented Jan 3, 2018

View reviewed changes

begedin added 3 commits January 3, 2018 13:19

Move invite claim tracking to controller

561dfe2

Assume new user when claiming invite

d639acb

Add helper to SegmentTraitsBuilder for improved clarity

1145d37

begedin commented Jan 3, 2018

View reviewed changes

Render 404 on user creation if invite specified but not found

b60e8a5

begedin added the needs code review label Jan 3, 2018

This was referenced Jan 3, 2018

Send email when an invite is created #1361

Open

Add route to fulfill invites code-corps/code-corps-ember#1679

Open

joshsmith self-requested a review January 10, 2018 19:13

begedin mentioned this pull request Jan 22, 2018

Track project events #1364

Merged

begedin added the question label Jan 22, 2018

begedin force-pushed the develop branch 18 times, most recently from e075407 to 6d6cc63 Compare February 12, 2018 16:17

begedin closed this Jul 5, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

User invites #1351

User invites #1351

begedin commented Dec 28, 2017 •

edited

joshsmith Dec 28, 2017

joshsmith Dec 28, 2017

joshsmith Dec 28, 2017

begedin Dec 29, 2017

joshsmith Dec 28, 2017

joshsmith Dec 28, 2017

begedin Dec 29, 2017

joshsmith Dec 28, 2017

begedin Dec 29, 2017

joshsmith Dec 28, 2017

joshsmith commented Dec 29, 2017

begedin Jan 3, 2018

begedin Jan 3, 2018

begedin Jan 3, 2018

begedin Jan 3, 2018

begedin commented Jan 3, 2018

joshsmith commented Jan 10, 2018

begedin commented Jan 22, 2018

begedin commented Jan 22, 2018

User invites #1351

User invites #1351

Conversation

begedin commented Dec 28, 2017 • edited

What's in this PR?

Creation of user invites

Claiming of user invites

Suggested issues to create

References

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

joshsmith commented Dec 29, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

begedin commented Jan 3, 2018

joshsmith commented Jan 10, 2018

begedin commented Jan 22, 2018

begedin commented Jan 22, 2018

begedin commented Dec 28, 2017 •

edited