Re: [tor-bugs] #22512 [Metrics/metrics-lib]: Add enums for keywords used in exit lists, Torperf measurement results, bridge pool assignments, and soon sanitized web logs

[Tor Bug Tracker & Wiki]

#22512: Add enums for keywords used in exit lists, Torperf measurement results,
bridge pool assignments, and soon sanitized web logs
-+--
 Reporter:  karsten  |  Owner:  metrics-team
 Type:  enhancement  | Status:  new
 Priority:  Medium   |  Milestone:
Component:  Metrics/metrics-lib  |Version:
 Severity:  Normal   | Resolution:
 Keywords:   |  Actual Points:
Parent ID:   | Points:
 Reviewer:   |Sponsor:
-+--

Old description:

> We recently introduced the `Key` enum with keywords contained in relay
> descriptors, sanitized bridge descriptors, and sanitized bridge pool
> assignments.  We did not include keywords in exit lists and Torperf
> measurement results, and in retrospect we should have excluded sanitized
> bridge pool assignments there.
>
> The reason why each data source should have its own enum is that naming
> conventions might vary in terms of upper/lower case and word separators.
> For example, Tor descriptors use `lower-case-keywords`, exit lists
> contain `CamelCase`, and Torperf/OnionPerf use
> `ALL_UPPER_CASE_WITH_UNDERSCORES`.  There could be conflicts for keywords
> like `source` vs. `SOURCE`.

New description:

 Todo derived from the discussion in comments 1 to 4:

 Add keywords for all descriptors to `Key` enum.
 Use a one letter prefix for keywords from non-Tor data sources.
 First step: determine the best letter for each non-Tor source.


 Original summary: We recently introduced the `Key` enum with keywords
 contained in relay descriptors, sanitized bridge descriptors, and
 sanitized bridge pool assignments.  We did not include keywords in exit
 lists and Torperf measurement results, ~~and in retrospect we should have
 excluded sanitized bridge pool assignments there.~~

 ~~The reason why each data source should have its own enum is that naming
 conventions might vary in terms of upper/lower case and word separators.
 For example, Tor descriptors use `lower-case-keywords`, exit lists contain
 `CamelCase`, and Torperf/OnionPerf use `ALL_UPPER_CASE_WITH_UNDERSCORES`.
 There could be conflicts for keywords like `source` vs. `SOURCE`.~~

--

Comment (by iwakeh):

 True!  I added the new todos to the summary for easier reference.

--
Ticket URL: 
Tor Bug Tracker & Wiki 
The Tor Project: anonymity online
___
tor-bugs mailing list
tor-bugs@lists.torproject.org
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs

Re: [tor-bugs] #22512 [Metrics/metrics-lib]: Add enums for keywords used in exit lists, Torperf measurement results, bridge pool assignments, and soon sanitized web logs

[Tor Bug Tracker & Wiki]

#22512: Add enums for keywords used in exit lists, Torperf measurement results,
bridge pool assignments, and soon sanitized web logs
-+--
 Reporter:  karsten  |  Owner:  metrics-team
 Type:  enhancement  | Status:  new
 Priority:  Medium   |  Milestone:
Component:  Metrics/metrics-lib  |Version:
 Severity:  Normal   | Resolution:
 Keywords:   |  Actual Points:
Parent ID:   | Points:
 Reviewer:   |Sponsor:
-+--

Comment (by karsten):

 Works for me.  In any case, prefixing Tor keywords can be done really
 easily, and it only affects the implementation, not the interface.  If we
 ever decide to also prefix Tor keywords, we can just do it.

--
Ticket URL: 
Tor Bug Tracker & Wiki 
The Tor Project: anonymity online
___
tor-bugs mailing list
tor-bugs@lists.torproject.org
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs

Re: [tor-bugs] #22512 [Metrics/metrics-lib]: Add enums for keywords used in exit lists, Torperf measurement results, bridge pool assignments, and soon sanitized web logs

[Tor Bug Tracker & Wiki]

#22512: Add enums for keywords used in exit lists, Torperf measurement results,
bridge pool assignments, and soon sanitized web logs
-+--
 Reporter:  karsten  |  Owner:  metrics-team
 Type:  enhancement  | Status:  new
 Priority:  Medium   |  Milestone:
Component:  Metrics/metrics-lib  |Version:
 Severity:  Normal   | Resolution:
 Keywords:   |  Actual Points:
Parent ID:   | Points:
 Reviewer:   |Sponsor:
-+--

Comment (by iwakeh):

 Single letter is fine.
 As most Tor keywords are defined already and I assume there are more Tor
 related ones than non-Tor, I'd prefix non-Tor descriptors.  This would
 also accommodate non-Tor keywords from different data sources that
 overlap.

--
Ticket URL: 
Tor Bug Tracker & Wiki 
The Tor Project: anonymity online
___
tor-bugs mailing list
tor-bugs@lists.torproject.org
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs

Re: [tor-bugs] #22512 [Metrics/metrics-lib]: Add enums for keywords used in exit lists, Torperf measurement results, bridge pool assignments, and soon sanitized web logs

[Tor Bug Tracker & Wiki]

#22512: Add enums for keywords used in exit lists, Torperf measurement results,
bridge pool assignments, and soon sanitized web logs
-+--
 Reporter:  karsten  |  Owner:  metrics-team
 Type:  enhancement  | Status:  new
 Priority:  Medium   |  Milestone:
Component:  Metrics/metrics-lib  |Version:
 Severity:  Normal   | Resolution:
 Keywords:   |  Actual Points:
Parent ID:   | Points:
 Reviewer:   |Sponsor:
-+--

Comment (by karsten):

 Ah, good point.  How about we add a single-letter source prefix as in
 `T_NETWORK_STATUS_VERSION("network-status-version")` where `T_` would
 stand for "'''T'''or descriptor"?

--
Ticket URL: 
Tor Bug Tracker & Wiki 
The Tor Project: anonymity online
___
tor-bugs mailing list
tor-bugs@lists.torproject.org
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs

Re: [tor-bugs] #22512 [Metrics/metrics-lib]: Add enums for keywords used in exit lists, Torperf measurement results, bridge pool assignments, and soon sanitized web logs

[Tor Bug Tracker & Wiki]

#22512: Add enums for keywords used in exit lists, Torperf measurement results,
bridge pool assignments, and soon sanitized web logs
-+--
 Reporter:  karsten  |  Owner:  metrics-team
 Type:  enhancement  | Status:  new
 Priority:  Medium   |  Milestone:
Component:  Metrics/metrics-lib  |Version:
 Severity:  Normal   | Resolution:
 Keywords:   |  Actual Points:
Parent ID:   | Points:
 Reviewer:   |Sponsor:
-+--

Comment (by iwakeh):

 Right, all descriptor parsing should make use of the `Key` keywords.

 Some things to consider:
 There is no inheritance between enums.  So, the ease of use in all
 descriptor parsing code would be lost with different Key-enums.  When
 using only the general `Enum` the `.keyword` and other features of
 `Key` are lost.
 This yields toward the "adding more Key enums approach" instead of
 separate Enums.

 There are no naming conventions yet (only implicitly).  The possible
 naming problems suppose certain rules which were not introduced directly.
 A working set of naming convention rules could be started with the aim of
 only using one `Key` enum.  If there are similar `Key` names as in the
 example above using 'source' a prefix could be added.  It should be ok to
 not have a strict translation rule from the actual keyword to the enum
 name; only keep it heuristically close.

--
Ticket URL: 
Tor Bug Tracker & Wiki 
The Tor Project: anonymity online
___
tor-bugs mailing list
tor-bugs@lists.torproject.org
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs

[tor-bugs] #22512 [Metrics/metrics-lib]: Add enums for keywords used in exit lists, Torperf measurement results, bridge pool assignments, and soon sanitized web logs

[Tor Bug Tracker & Wiki]

#22512: Add enums for keywords used in exit lists, Torperf measurement results,
bridge pool assignments, and soon sanitized web logs
-+--
 Reporter:  karsten  |  Owner:  metrics-team
 Type:  enhancement  | Status:  new
 Priority:  Medium   |  Milestone:
Component:  Metrics/metrics-lib  |Version:
 Severity:  Normal   |   Keywords:
Actual Points:   |  Parent ID:
   Points:   |   Reviewer:
  Sponsor:   |
-+--
 We recently introduced the `Key` enum with keywords contained in relay
 descriptors, sanitized bridge descriptors, and sanitized bridge pool
 assignments.  We did not include keywords in exit lists and Torperf
 measurement results, and in retrospect we should have excluded sanitized
 bridge pool assignments there.

 The reason why each data source should have its own enum is that naming
 conventions might vary in terms of upper/lower case and word separators.
 For example, Tor descriptors use `lower-case-keywords`, exit lists contain
 `CamelCase`, and Torperf/OnionPerf use `ALL_UPPER_CASE_WITH_UNDERSCORES`.
 There could be conflicts for keywords like `source` vs. `SOURCE`.

--
Ticket URL: 
Tor Bug Tracker & Wiki 
The Tor Project: anonymity online
___
tor-bugs mailing list
tor-bugs@lists.torproject.org
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs