def simulate_coaching_emails(
user_proto: user_pb2.User, *,
database: mongo.NoPiiMongoDatabase,
attempts: int = 200, retry_after_fail: bool = False) -> Iterator[email_pb2.EmailSent]:
"""Compute the email coaching schedule."""
instant = now.get()
# Complete the user's proto with mandatory fields.
if not user_proto.HasField('registered_at'):
user_proto.registered_at.FromDatetime(instant)
if not user_proto.profile.coaching_email_frequency:
user_proto.profile.coaching_email_frequency = email_pb2.EMAIL_MAXIMUM
if not user_proto.projects:
user_proto.projects.add()
for attempt in range(attempts):
campaign_id = send_focus_email_to_user(
'ghost', user_proto, database=database, instant=instant)
if attempt and not campaign_id and not retry_after_fail:
# No more email to send.
# Note that the first call might not return a campaign ID as we do not send focus emails
# right away.
return
if campaign_id:
yield user_proto.emails_sent[-1]
instant = user_proto.send_coaching_email_after.ToDatetime()
if instant.hour > _FOCUS_EMAIL_SENDING_TIME or \
instant.hour == _FOCUS_EMAIL_SENDING_TIME and instant.minute:
instant += datetime.timedelta(days=1)
instant = instant.replace(hour=9, minute=0)
def _update_returning_user(
user_data: user_pb2.User, force_update: bool = False, has_set_email: bool = False) \
-> timestamp_pb2.Timestamp:
if user_data.HasField('requested_by_user_at_date'):
start_of_day = now.get().replace(hour=0,
minute=0,
second=0,
microsecond=0)
if user_data.requested_by_user_at_date.ToDatetime() >= start_of_day:
if force_update:
_save_low_level(user_data)
return user_data.requested_by_user_at_date
else:
last_connection = timestamp_pb2.Timestamp()
last_connection.CopyFrom(user_data.requested_by_user_at_date)
else:
last_connection = user_data.registered_at
if user_data.profile.email:
user_data.hashed_email = auth.hash_user_email(user_data.profile.email)
if has_set_email:
base_url = parse.urljoin(flask.request.base_url, '/')[:-1]
advisor.maybe_send_late_activation_emails(
user_data, flask.current_app.config['DATABASE'], base_url)
user_data.requested_by_user_at_date.FromDatetime(now.get())
# No need to pollute our DB with super precise timestamps.
user_data.requested_by_user_at_date.nanos = 0
_save_low_level(user_data)
return last_connection
def _compute_user_data(self, user: user_pb2.User) -> Dict[str, Any]:
if not user.HasField('registered_at'):
user.registered_at.GetCurrentTime()
self._user_db.user.drop()
self._user_db.user.insert_one(json_format.MessageToDict(user))
sync_user_elasticsearch.main(self.mock_elasticsearch, [
'--registered-from', '2017-07', '--no-dry-run', '--disable-sentry'
])
kwargs = self.mock_elasticsearch.create.call_args[1]
return typing.cast(Dict[str, Any], json.loads(kwargs.pop('body')))
def _copy_unmodifiable_fields(previous_user_data: user_pb2.User,
user_data: user_pb2.User) -> None:
"""Copy unmodifiable fields.
Some fields cannot be changed by the API: we only copy over the fields
from the previous state.
"""
if _is_test_user(user_data):
# Test users can do whatever they want.
return
for field in ('features_enabled', 'last_email_sent_at'):
typed_field = typing.cast(
Literal['features_enabled', 'last_email_sent_at'], field)
if previous_user_data.HasField(typed_field):
getattr(user_data, typed_field).CopyFrom(
getattr(previous_user_data, typed_field))
else:
user_data.ClearField(typed_field)
def send_focus_email_to_user(
action: 'campaign.Action', user: user_pb2.User, *, dry_run_email: Optional[str] = None,
database: mongo.NoPiiMongoDatabase,
users_database: Optional[mongo.UsersDatabase] = None,
eval_database: Optional[mongo.NoPiiMongoDatabase] = None,
instant: datetime.datetime,
restricted_campaigns: Optional[Set[mailjet_templates.Id]] = None) \
-> Optional[mailjet_templates.Id]:
"""Try to send a focus email to the user and returns the campaign ID."""
if user.profile.coaching_email_frequency == email_pb2.EMAIL_NONE:
return None
if not user.HasField('send_coaching_email_after'):
send_coaching_email_after = _compute_next_coaching_email_date(user)
if send_coaching_email_after > instant:
user.send_coaching_email_after.FromDatetime(send_coaching_email_after)
if user.user_id and action != 'ghost' and users_database:
users_database.user.update_one(
{'_id': objectid.ObjectId(user.user_id)}, {'$set': {
'sendCoachingEmailAfter': proto.datetime_to_json_string(
send_coaching_email_after,
),
}})
return None
# Compute next send_coaching_email_after.
next_send_coaching_email_after = instant + _compute_duration_to_next_coaching_email(user)
focus_emails_sent: Set[mailjet_templates.Id] = set()
last_focus_email_sent = None
for email_sent in user.emails_sent:
if email_sent.campaign_id not in _FOCUS_CAMPAIGNS:
continue
last_focus_email_sent = email_sent
focus_emails_sent.add(typing.cast(mailjet_templates.Id, email_sent.campaign_id))
project = scoring.ScoringProject(
user.projects[0] if user.projects else project_pb2.Project(),
user, database, instant,
)
possible_campaigns = get_possible_campaigns(database, restricted_campaigns)
campaigns_scores = {
campaign_id: (
project.score(possible_campaign.scoring_model)
if possible_campaign.scoring_model else 2
)
for campaign_id, possible_campaign in possible_campaigns.items()
}
focus_emails_project_score_zero = {
campaign for campaign, score in campaigns_scores.items() if not score
}
potential_campaigns = _shuffle(
possible_campaigns.keys() - focus_emails_sent - focus_emails_project_score_zero,
last_focus_email_sent, campaigns_scores,
user.profile.coaching_email_frequency)
for campaign_id in potential_campaigns:
if _FOCUS_CAMPAIGNS[campaign_id].send_mail(
user, database=database, users_database=users_database, eval_database=eval_database,
action=action, dry_run_email=dry_run_email,
mongo_user_update={'$set': {
'sendCoachingEmailAfter': proto.datetime_to_json_string(
next_send_coaching_email_after,
),
}}, now=instant):
user.send_coaching_email_after.FromDatetime(next_send_coaching_email_after)
return campaign_id
# No focus email was supported: it seems that we have sent all the
# ones we had. However maybe in the future we'll add more focus
# emails so let's wait the same amount of time we have waited until
# this email (this makes to wait 1 period, then 2, 4, …).
last_coaching_email_sent_at = \
_compute_last_coaching_email_date(user, user.registered_at.ToDatetime())
send_coaching_email_after = instant + (instant - last_coaching_email_sent_at)
user.send_coaching_email_after.FromDatetime(send_coaching_email_after)
if user.user_id and action != 'ghost' and users_database:
logging.debug('No more available focus email for "%s"', user.user_id)
users_database.user.update_one({'_id': objectid.ObjectId(user.user_id)}, {'$set': {
'sendCoachingEmailAfter': proto.datetime_to_json_string(send_coaching_email_after),
}})
return None
def send_focus_email_to_user(
action: 'campaign.Action', user: user_pb2.User, *, dry_run_email: Optional[str] = None,
database: pymongo.database.Database, users_database: pymongo.database.Database,
instant: datetime.datetime) -> Optional[str]:
"""Try to send a focus email to the user and returns the campaign ID."""
if not user.HasField('send_coaching_email_after'):
send_coaching_email_after = _compute_next_coaching_email_date(user)
if send_coaching_email_after > instant:
user.send_coaching_email_after.FromDatetime(send_coaching_email_after)
if user.user_id:
users_database.user.update_one(
{'_id': objectid.ObjectId(user.user_id)}, {'$set': {
'sendCoachingEmailAfter': proto.datetime_to_json_string(
send_coaching_email_after,
),
}})
return None
# Compute next send_coaching_email_after.
next_send_coaching_email_after = instant + _compute_duration_to_next_coaching_email(user)
focus_emails_sent = set()
last_focus_email_sent = None
for email_sent in user.emails_sent:
if email_sent.campaign_id not in _FOCUS_CAMPAIGNS:
continue
last_focus_email_sent = email_sent
focus_emails_sent.add(email_sent.campaign_id)
last_one_was_big = last_focus_email_sent and \
_FOCUS_CAMPAIGNS[last_focus_email_sent.campaign_id].is_big_focus
potential_campaigns = sorted(
_POTENTIAL_CAMPAIGNS - focus_emails_sent,
key=lambda c: (
1 if _FOCUS_CAMPAIGNS[c].is_big_focus == last_one_was_big else 0,
random.random(),
)
)
for campaign_id in potential_campaigns:
if _FOCUS_CAMPAIGNS[campaign_id].send_mail(
campaign_id, user, database=database, users_database=users_database, action=action,
dry_run_email=dry_run_email,
mongo_user_update={'$set': {
'sendCoachingEmailAfter': proto.datetime_to_json_string(
next_send_coaching_email_after,
),
}}, now=instant):
user.send_coaching_email_after.FromDatetime(next_send_coaching_email_after)
return campaign_id
# No focus email was supported: it seems that we have sent all the
# ones we had. However maybe in the future we'll add more focus
# emails so let's wait the same amount of time we have waited until
# this email (this makes to wait 1 period, then 2, 4, …).
last_coaching_email_sent_at = typing.cast(
datetime.datetime,
_compute_last_coaching_email_date(user, user.registered_at.ToDatetime()))
send_coaching_email_after = instant + (instant - last_coaching_email_sent_at)
user.send_coaching_email_after.FromDatetime(send_coaching_email_after)
if user.user_id and action != 'ghost':
logging.debug('No more available focus email for "%s"', user.user_id)
users_database.user.update_one({'_id': objectid.ObjectId(user.user_id)}, {'$set': {
'sendCoachingEmailAfter': proto.datetime_to_json_string(send_coaching_email_after),
}})
return None