[metrics-bugs] #28615 [Metrics/Library]: Additional @type annotation

[Tor Bug Tracker & Wiki]

#28615: Additional @type annotation
-----------------------------+------------------------------
 Reporter:  atagar           |          Owner:  metrics-team
     Type:  enhancement      |         Status:  new
 Priority:  Medium           |      Milestone:
Component:  Metrics/Library  |        Version:
 Severity:  Normal           |     Resolution:
 Keywords:                   |  Actual Points:
Parent ID:                   |         Points:
 Reviewer:                   |        Sponsor:
-----------------------------+------------------------------

Comment (by teor):

 Replying to [comment:14 atagar]:
 > > except with truncated descriptor digests if tor is using
 microdescriptors and without w lines.

 And maybe missing some other lines, and maybe with some other format
 quirks.
 The missing "w" line was an example.

 > Is this somthing we want to codify in our spec? Ticket #24110 is still
 open, and in re-reading that it sounds to me like...
 >
 >   * Router status entries vended though the control port have 'r' lines
 with a microdescriptor rather than a server descriptor digest.
 >
 >   * It sounds like we're unaware of anything that referrences these
 erronious digests, so fixing is probably fine.
 >
 > Am I wrong? Is referrencing the microdescriptor digest either desirable
 or necessary?
 >
 > Sorry if I'm missing something!

 We don't know if any code depends on the digest here, but if it does, it's
 terribly fragile, because it will break when UseMicrodescriptors changes.

 We could look at this function at our hackfest next week. It will need a
 refactor before we make any changes. I'll put it on our list.

 > > atagar, would you mind starting a patch?
 >
 > {{{
 > @type detached-signature 1.0
 >
 >   Detached signature as per section 3.10 of the dir-spec,
 >   and downloadable for DistSeconds every consensus freshness
 >   period (usually five minutes each hour) via the
 >   '/tor/status-vote/next/consensus-signatures' resource.
 >
 > @type network-status-entry-3 1.0
 >
 >   Individual router status entry from an unflavored v3
 >   network status document. These are available from
 >   Tor's control port 'GETINFO ns/*' commands and NS
 >   events.
 >
 > @type bandwidth-file 1.2
 >
 >   Bandwidth authority metrics as defined in the
 >   bandwidth-file-spec [1]. These are available from
 >   a DirPort's '/tor/status-vote/next/bandwidth' url
 >   and CollecTor. [3]
 >
 >
 > [1] https://gitweb.torproject.org/torspec.git/tree/bandwidth-file-
 spec.txt
 > [2] Both are pending
 https://trac.torproject.org/projects/tor/ticket/21377
 > }}}

 5/6 bandwidth authorities are still using version 1.0 of the bandwidth
 file format, because they run torflow.

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