[tor-bugs] #11084 [Tor Weather]: Define criteria for sending out welcome mails using Onionoo's details documents

[Tor Bug Tracker & Wiki]

#11084: Define criteria for sending out welcome mails using Onionoo's details
documents
-----------------------------+-------------------------
 Reporter:  karsten          |          Owner:  karsten
     Type:  enhancement      |         Status:  new
 Priority:  normal           |      Milestone:
Component:  Tor Weather      |        Version:
 Keywords:  weather-rewrite  |  Actual Points:
Parent ID:                   |         Points:
-----------------------------+-------------------------
 The current Weather sends out welcome mails to operators of new relays.
 From the design document:

 """
 The database backing Tor Weather stores information about every router
 seen in consensus within the past year (or for as long as Tor Weather has
 been running, whichever is shorter). If a router in the database is
 flagged as stable, its operator has not been sent a welcome email, and its
 operator is not subscribed to Tor Weather, the router operator's email is
 parsed from the contact field in the descriptor file for that node. A
 welcome email containing information about Tor Weather is sent to these
 node operators if an email address was successfully parsed.

 The welcome email thanks the operator for his/her contribution and
 encourages the operator to subscribe to Tor Weather. If the router allows
 exits to port 80, information is appended to the email containing links to
 legal help for exit relay operators.

 The welcome emails are not a subscribable notification type and are sent
 to all new, stable relay operators who a) haven't subscribed to Tor
 Weather and b) provide a parsable (by our standards) email address in the
 contact field of their configuration file.

 The welcome email is intended for new stable relay operators. To avoid
 sending the welcome email to long-term relay operators at startup, a
 48-hour delay period has been implemented immediately following
 deployment. Any relays added to the database within the first 48-hours
 following deployment are exempt from the welcome email. That way, the
 operators who are emailed should largely be new to the network, and relay
 operators who have been running for a while shouldn't get the welcome
 email.
 """

 I ''think'' we can implement this with Onionoo's current details
 documents:

  - Only consider relays with `first_seen > our_deployment_time` to exclude
 relays that were already around before Weather was (re-)deployed.
  - Only consider relays with `Stable` in `flags` to exclude (currently)
 non-stable relays.
  - Attempt to parse the email address from `contact`.
  - Only send out a new welcome mail if we didn't send one before.
 Remember that we sent a welcome mail now.
  - Delete all entries from the database with a timestamp more than 6
 months ago.
  - In fact, remember that cutoff time and only consider relays with
 `first_seen > max(our_deployment_time, cutoff_time)`.

 So, I guess what I want to say is that we probably don't need a special
 field in Onionoo that says when the relay first obtained the Stable flag.
 Unless we need it?

 Let's keep this ticket open until we have good criteria and maybe even
 until we have implement them in a welcome-mail-sending script.

--
Ticket URL: <https://trac.torproject.org/projects/tor/ticket/11084>
Tor Bug Tracker & Wiki <https://trac.torproject.org/>
The Tor Project: anonymity online