[tbb-bugs] #15510 [Tor Browser]: The controller for the circuit-display is not stopped on New Identity

[Tor Bug Tracker & Wiki]

#15510: The controller for the circuit-display is not stopped on New Identity
-------------------------+-------------------------------------------------
     Reporter:  gk       |      Owner:  tbb-team
         Type:  defect   |     Status:  needs_review
     Priority:  normal   |  Milestone:
    Component:  Tor      |    Version:
  Browser                |   Keywords:  tbb-circuit-display,
   Resolution:           |  TorBrowserTeam201503R
Actual Points:           |  Parent ID:
       Points:           |
-------------------------+-------------------------------------------------

Comment (by gk):

 Replying to [comment:2 arthuredelstein]:
 > That fix isn't in the right place -- `bindPrefAndInit`is supposed to be
 a generic utililty function that binds to any pref we choose and calls
 prefHandler(currentPrefValue) whenever the pref changes. It is not
 specific to the controller and it's not designed only for boolean prefs.

 Ugh, yes you are ight. I should have paid more attention while writing the
 patch.

 > My intention was that the controller code is set up to create only one
 instance of the controller, the first time controller(...) is called, and
 just return an extra pointer to the controller with each subsequent call.
 Please see the comment and code at
 https://gitweb.torproject.org/torbutton.git/tree/src/modules/tor-control-
 port.js#n648
 > But it's possible I got this code wrong or the code in tor-circuit-
 display wrong. What was the original symptom you saw?

 If you start Tor Browser and load foo.com you see things like
 {{{
 Torbutton INFO: streamEvent.CircuitID: 2
 }}}
 and other control port related things in the log if you press New
 Identity, say, times and load foo.com you see
 {{{
 Torbutton INFO: streamEvent.CircuitID: 2
 Torbutton INFO: streamEvent.CircuitID: 2
 Torbutton INFO: streamEvent.CircuitID: 2
 Torbutton INFO: streamEvent.CircuitID: 2
 Torbutton INFO: streamEvent.CircuitID: 2
 }}}
 in the log and so on. In other words `stop()` is not called properly and
 shutting the controller explicitly down is needed for some reason.

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