f4f3ed7c42
The code that is now into the tracex package was written a long time ago, so let's start to make it more in line with the coding style of packages that were written more recently. I didn't apply all the changes I'd like to apply in a single diff and for now I am committing just this diff. Broadly, what we need to do is: 1. improve documentation 2. ~always use pointer receivers (object receives have the issue that they are not mutable by accident meaning that you can mutate them but their state do not change after the call returns, which is potentially a source of bugs in case you later refactor to use a pointer receiver, so always use pointer receivers) 3. ~always avoid embedding (let's say we want to avoid embedding for types we define and it's instead fine to embed types that are defined in the stdlib: if later we add a new method, we will not see a broken build and we'll probably forget to add the new method to all wrappers -- conversely, if we're wrapping rather than embedding, we'll see a broken build and act accordingly) 4. prefer unit tests and group tests by type being tested rather than using a flat structure for tests There's a coverage slippage that I'll compensate in a follow-up diff where I'll focus on unit testing. Reference issue: https://github.com/ooni/probe/issues/2121 |
||
|---|---|---|
| .. | ||
| atomicx | ||
| bytecounter | ||
| cmd | ||
| engine | ||
| fakefill | ||
| fsx | ||
| httpx | ||
| humanize | ||
| kvstore | ||
| legacy/assetsdir | ||
| measurex | ||
| mlablocate | ||
| mlablocatev2 | ||
| model | ||
| multierror | ||
| netxlite | ||
| platform | ||
| ptx | ||
| randx | ||
| runtimex | ||
| scrubber | ||
| shellx | ||
| stuninput | ||
| torlogs | ||
| tunnel | ||
| tutorial | ||
| version | ||
| README.md | ||
Directory github.com/ooni/probe-cli/internal
This directory contains private Go packages.
As a reminder, you can always check the Go documentation of a package by using
go doc -all ./internal/$package
where $package is the name of the package.
Some notable packages: