[tor-commits] [tor/master] Add a comment explaining reachability vs bandwidth self-tests

[nickm at torproject.org]

commit 5d956d797bb42156eae8fa3063c68bccbc6734e7
Author: Nick Mathewson <nickm at torproject.org>
Date:   Wed Jul 1 10:33:27 2020 -0400

    Add a comment explaining reachability vs bandwidth self-tests
    
    This is in response to a question about why we don't always log
    orport self-tests as reachability tests.
    
    I'm not 100% convinced that bandwidth self-tests are still useful,
    but that's an issue for another day. :)
---
 src/feature/relay/selftest.c | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/src/feature/relay/selftest.c b/src/feature/relay/selftest.c
index 6420b29fb..101704e1c 100644
--- a/src/feature/relay/selftest.c
+++ b/src/feature/relay/selftest.c
@@ -259,6 +259,9 @@ router_do_orport_reachability_checks(const routerinfo_t *me,
              !orport_reachable ? "reachability" : "bandwidth",
              family_name, fmt_addrport(&ei->addr, ei->port));
     if (!orport_reachable) {
+      /* This is only a 'reachability test' if we don't already think that
+       * the port is reachable.  If we _do_ think it's reachable, then
+       * it counts as a 'bandwidth test'. */
       inform_testing_reachability(&ei->addr, ei->port, false);
     }
     circuit_launch_by_extend_info(CIRCUIT_PURPOSE_TESTING, ei,