Sponsor 31

Title - Modularization work

Contract time: December 1, 2018 - November 30, 2019


The key deliverables of the modularization project are:

● Refactored architecture for how Tor modules should communicate, designed to reduce module complexity and maintenance burden.

● Architectural documentation for how Tor modules work with one another, covering both the actuality and the refactored architecture.

● New architecture for several key Tor modules.

● Improved testing for those modules.

● Improved documentation for those modules.


  1. Determine how to best refactor modules to make them more resilient,segregated, and automatically testable. (288 hours) -- March 2019

1.1. Identify pieces that we have to refactor. (96 hours)

1.2. Draft initial design for each piece. (192 hours)

  1. Identify which parts of the codebase are most important to refactor first. (256 hours) -- April and August 2019

2.1. Discuss which parts to refactor first. (16 hours)

2.2. Research and discuss automated tooling. (48 hours)

2.3. Design tooling as needed. (48 hours)

2.4. Repeat the same tasks 2.1, 2.2 and 2.3 after milestone 4 is completed. (144 hours)

  1. Revise the system of interactions between modules to improve usability and maintainability. (88 hours) -- May 2019

3.1. Review publisher/subscriber design that Tor uses. (16 hours)

3.2. Implement refactoring. (72 hours)

  1. Create and deploy plan to incorporate refactored modules. (184 hours) -- August 2019

4.1. For each module and each architectural change, form a plan to apply that change to that module. This plan should include increased testing, if the module's test coverage is not already high. (160 hours)

4.2. For each plan formed in 4.1, deploy that plan. (24 hours)

  1. Create documentation for how Tor modules work with one another with both old and new architecture. (432 hours) -- December 2018

5.1. Update module documentation and incorporate into Tor. (96 hours)

5.2. Document existing refactoring. (144 hours)

5.3. Document new elements. (144 hours)

5.4. For modules we are not refactoring, document important interactions. (48 hours)


(email from funder) When you complete a set of milestones and are ready to invoice for them, you will also need to submit a short report to Mehan (mehan@…) that details your progress against the milestones. Things you might include are how the work went relative to your expectations, any technical tradeoffs required in completing the milestones, any new issues you discovered as part of the work and explanations for any changes you made to the original scope of work. The report need be no longer than 1-2 pages of bullet points and can be submitted via email; here's an example milestone report from PyPl. Upon completion of the final milestones, we will also require a short blog post detailing what you were able to accomplish using your MOSS award. Here’s a sample blog post to help give you a sense of what we’re looking for.

Report 1 due 9/30/19 for milestones 1-4

Last modified 11 days ago Last modified on Jan 11, 2019, 3:54:37 PM