Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

"New member joined your organization" email #3509

Merged
merged 16 commits into from
May 24, 2021
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion latest_migrations.manifest
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ auth: 0011_update_proxy_permissions
axes: 0006_remove_accesslog_trusted
contenttypes: 0002_remove_content_type_name
ee: 0002_hook
posthog: 0129_merge_20210223_0757
posthog: 0130_member_joined_email_invite
rest_hooks: 0002_swappable_hook_model
sessions: 0001_initial
social_django: 0008_partial_timestamp
7 changes: 5 additions & 2 deletions posthog/api/organization_invite.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@

class OrganizationInviteSerializer(serializers.ModelSerializer):
created_by = UserSerializer(many=False, read_only=True)
used_by = UserSerializer(many=False, read_only=True)

class Meta:
model = OrganizationInvite
Expand All @@ -27,13 +28,14 @@ class Meta:
"emailing_attempt_made",
"is_expired",
"created_by",
"used_by",
"created_at",
"updated_at",
"used_at",
]
read_only_fields = [
"id",
"created_at",
"updated_at",
"used_at",
"emailing_attempt_made",
]
extra_kwargs = {"target_email": {"required": True, "allow_null": False}}
Expand Down Expand Up @@ -82,6 +84,7 @@ class OrganizationInviteViewSet(
def get_queryset(self):
return (
self.filter_queryset_by_parents_lookups(super().get_queryset())
.filter(used_at__isnull=True)
.select_related("created_by")
.order_by(self.ordering)
)
Expand Down
39 changes: 39 additions & 0 deletions posthog/migrations/0130_member_joined_email_invite.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Generated by Django 3.0.11 on 2021-02-26 02:05

import django.db.models.deletion
from django.conf import settings
from django.db import migrations, models


class Migration(migrations.Migration):

dependencies = [
("posthog", "0129_merge_20210223_0757"),
]

operations = [
migrations.RemoveField(model_name="organizationinvite", name="updated_at",),
migrations.AddField(model_name="organizationinvite", name="used_at", field=models.DateTimeField(null=True),),
migrations.AddField(
model_name="organizationinvite",
name="used_by",
field=models.ForeignKey(
null=True,
on_delete=django.db.models.deletion.SET_NULL,
related_name="organization_invites_used",
related_query_name="organization_invite_used",
to=settings.AUTH_USER_MODEL,
),
),
migrations.AlterField(
model_name="organizationinvite",
name="created_by",
field=models.ForeignKey(
null=True,
on_delete=django.db.models.deletion.SET_NULL,
related_name="organization_invites_created",
related_query_name="organization_invite_created",
to=settings.AUTH_USER_MODEL,
),
),
]
31 changes: 25 additions & 6 deletions posthog/models/organization.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
from django.utils import timezone
from rest_framework import exceptions

from posthog.email import is_email_available
from posthog.utils import mask_email_address

from .utils import UUIDModel, sane_repr
Expand Down Expand Up @@ -181,16 +182,23 @@ class OrganizationInvite(UUIDModel):
created_by: models.ForeignKey = models.ForeignKey(
"posthog.User",
on_delete=models.SET_NULL,
related_name="organization_invites",
related_query_name="organization_invite",
related_name="organization_invites_created",
related_query_name="organization_invite_created",
null=True,
)
used_by: models.ForeignKey = models.ForeignKey(
"posthog.User",
on_delete=models.SET_NULL,
related_name="organization_invites_used",
related_query_name="organization_invite_used",
null=True,
)
emailing_attempt_made: models.BooleanField = models.BooleanField(default=False)
created_at: models.DateTimeField = models.DateTimeField(auto_now_add=True)
updated_at: models.DateTimeField = models.DateTimeField(auto_now=True)
used_at: models.DateTimeField = models.DateTimeField(null=True)
emailing_attempt_made: models.BooleanField = models.BooleanField(default=False)

def validate(self, *, user: Any = None, email: Optional[str] = None) -> None:
_email = email or (hasattr(user, "email") and user.email)
_email = email or getattr(user, "email", None)

if _email and _email != self.target_email:
raise exceptions.ValidationError(
Expand All @@ -199,6 +207,11 @@ def validate(self, *, user: Any = None, email: Optional[str] = None) -> None:
code="invalid_recipient",
)

if self.used_at is not None:
raise exceptions.ValidationError(
"This invite has already been used. Please ask your admin for a new one.", code="used",
)

if self.is_expired():
raise exceptions.ValidationError(
"This invite has expired. Please ask your admin for a new one.", code="expired",
Expand All @@ -221,7 +234,13 @@ def use(self, user: Any, *, prevalidated: bool = False) -> None:
if not prevalidated:
self.validate(user=user)
user.join(organization=self.organization)
OrganizationInvite.objects.filter(target_email__iexact=self.target_email).delete()
if is_email_available(with_absolute_urls=True):
from posthog.tasks.email import send_member_join

send_member_join.apply_async(kwargs={"invite_id": self.id}, countdown=10)
self.used_by = user
self.used_at = timezone.now()
self.save()

def is_expired(self) -> bool:
"""Check if invite is older than INVITE_DAYS_VALIDITY days."""
Expand Down
28 changes: 23 additions & 5 deletions posthog/tasks/email.py
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
import datetime
import logging
from typing import Optional
from typing import Optional, Sequence, cast

from posthog.celery import app
from posthog.email import EmailMessage, is_email_available
from posthog.models import Event, OrganizationInvite, PersonDistinctId, Team
from posthog.models import Event, Organization, OrganizationInvite, PersonDistinctId, Team, User
from posthog.templatetags.posthog_filters import compact_number
from posthog.utils import get_previous_week

Expand Down Expand Up @@ -113,9 +113,9 @@ def _send_weekly_email_report_for_team(team_id: int) -> None:
@app.task(max_retries=1)
def send_invite(invite_id: str) -> None:
campaign_key: str = f"invite_email_{invite_id}"
invite: OrganizationInvite = OrganizationInvite.objects.select_related("created_by").select_related(
"organization"
).get(id=invite_id)
invite: OrganizationInvite = OrganizationInvite.objects.select_related("created_by", "organization").get(
id=invite_id
)
message = EmailMessage(
campaign_key=campaign_key,
subject=f"{invite.created_by.first_name} invited you to join {invite.organization.name} on PostHog",
Expand All @@ -124,3 +124,21 @@ def send_invite(invite_id: str) -> None:
)
message.add_recipient(email=invite.target_email)
message.send()


@app.task(max_retries=1)
def send_member_join(invite_id: str) -> None:
invite: OrganizationInvite = OrganizationInvite.objects.select_related(
"created_by", "used_by", "organization"
).prefetch_related("organization__members").get(id=invite_id)
campaign_key: str = f"member_join_email_{invite.id}"
message = EmailMessage(
campaign_key=campaign_key,
subject=f"{invite.used_by.first_name} joined you at {invite.organization.name} on PostHog",
template_name="member_join",
template_context={"invite": invite},
)
for user in invite.organization.members.all():
if user.id != invite.used_by_id: # Don't send this email to the new member themselves
message.add_recipient(email=user.email, name=user.first_name)
message.send()
40 changes: 40 additions & 0 deletions posthog/templates/email/member_join.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
{% extends "email/base.html" %} {% load posthog_assets %} {% load posthog_filters %} {% block main %}
<style type="text/css">
.hero-image {
max-width: 100%;
margin-top: 32px;
margin-bottom: 32px;
text-align: center;
}
</style>
<div class="container">
<div class="section">
<h1 class="mb">{{ invite.used_by.first_name }} just joined you at {{ invite.organization.name }} on PostHog</h1>
<p>
{{ invite.used_by.first_name }} (<a href="mailto:{{ invite.used_by.email }}">{{ invite.used_by.email }}</a>) had been invited by {{ invite.created_by.first_name }} (<a href="mailto:{{ invite.used_by.email }}">{{ invite.created_by.email }}</a>).
</p>
<p>
Undestand your users <i>together</i> with PostHog. Built the best product with product analytics.
</p>
<div class="mb mt text-center">
<a class="button" href="{% absolute_uri %}/organization/members">Go to {{ invite.organization.name }} members list</a>
</div>
<div class="mt">
<p>
If the button above does not work, paste the following link into your browser:<br />
<a href="{% absolute_uri %}/organization/members">{% absolute_uri %}/organization/members</a>
</p>
</div>
</div>
</div>
{% endblock %} {% block footer %}
<div>
If you believe this message isn't intended for you, please delete it. If you have any questions, you can also reply
to this email.
</div>
<div class="socialLinks spacingTop">
<a href="https://github.com/posthog/">GitHub</a><span>|</span><a href="https://twitter.com/posthoghq">Twitter</a
><span>|</span><a href="https://medium.com/posthog">Medium</a><span>|</span
><a href="https://posthog.com/slack">Slack</a>
</div>
{% endblock %}