[tor-bugs] #30255 [Core Tor/sbws]: Add additional bandwidth file headers in sbws 1.2

[Tor Bug Tracker & Wiki]

#30255: Add additional bandwidth file headers in sbws 1.2
---------------------------+-----------------------------------
 Reporter:  teor           |          Owner:  (none)
     Type:  task           |         Status:  new
 Priority:  Medium         |      Milestone:  sbws: 1.2.x-final
Component:  Core Tor/sbws  |        Version:
 Severity:  Normal         |     Resolution:
 Keywords:                 |  Actual Points:
Parent ID:                 |         Points:
 Reviewer:                 |        Sponsor:
---------------------------+-----------------------------------

Comment (by teor):

 Replying to [comment:2 juga]:
 > The problem with small tickets that change the same parts of the code is
 the merge conflicts. Any other solution apart of reviewing them one after
 other in some order?

 Our priority for sbws is maintaining stable software. That's more
 important than writing and merging features quickly.

 Conflicts are often a sign of bad code structure. For each new key, the
 current code structure needs:
 * a key in one place
 * the same key in another place
 * the same key in a third place, with the code that implements the key
 * the same key in five other places, with the code that tests the key

 Here's a structure for this code that would be easier to change:
 * each header key value is added to the state using a line of code
 * each header key value is tested using a line of code (or perhaps two
 lines of code, a set and a test)
 * the rest of the code just accepts whatever is in the state

 Using this structure, merges add additional key value assignments, at the
 end of a list of assignments. After the code is refactored, the merge
 conflicts should be trivial.

 While the code is so complicated, we need to split up sbws features into
 separate pull requests. Small pull requests are easier to review.

 If the pull requests are hard to review, we will struggle to find all the
 bugs in sbws code.

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