c/ooni-probe-cli
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
6b85dfce88
ooni-probe-cli/internal/netxlite/legacy.go

13 lines
208 B
Go
Raw Normal View History

refactor: start pivoting netx (#396) What do I mean by pivoting? Netx is currently organized by row: ``` | dialer | quicdialer | resolver | ... saving | | | | ... errorwrapping | | | | ... logging | | | | ... mocking/sys | | | | ... ``` Every row needs to implement saving, errorwrapping, logging, mocking (or adapting to the system or to some underlying library). This causes cross package dependencies and, in turn, complexity. For example, we need the `trace` package for supporting saving. And `dialer`, `quickdialer`, et al. need to depend on such a package. The same goes for errorwrapping. This arrangement further complicates testing. For example, I am currently working on https://github.com/ooni/probe/issues/1505 and I realize it need to repeat integration tests in multiple places. Let's say instead we pivot the above matrix as follows: ``` | saving | errorwrapping | logging | ... dialer | | | | ... quicdialer | | | | ... logging | | | | ... mocking/sys | | | | ... ... ``` In this way, now every row contains everything related to a specific action to perform. We can now share code without relying on extra support packages. What's more, we can write tests and, judding from the way in which things are made, it seems we only need integration testing in `errorwrapping` because it's where data quality matters whereas, in all other cases, unit testing is fine. I am going, therefore, to proceed with these changes and "pivot" `netx`. Hopefully, it won't be too painful.
2021-06-23 15:53:12 +02:00
package netxlite
fix(netxlite): prefer composition over embedding (#733) This diff has been extracted and adapted from https://github.com/bassosimone/websteps-illustrated/commit/8848c8c516a40663c2718b1aff271884a116a147 The reason to prefer composition over embedding is that we want the build to break if we add new methods to interfaces we define. If the build does not break, we may forget about wrapping methods we should actually be wrapping. I noticed this issue inside netxlite when I was working on websteps-illustrated and I added support for NS and PTR queries. See https://github.com/ooni/probe/issues/2096 While there, perform comprehensive netxlite code review and apply minor changes and improve the docs.
2022-05-15 19:25:27 +02:00
//
// Legacy code
//
refactor(netxlite): hide details without breaking the rest of the tree (#454) ## Description This PR continues the refactoring of `netx` under the following principles: 1. do not break the rest of the tree and do not engage in extensive tree-wide refactoring yet 2. move under `netxlite` clearly related subpackages (e.g., `iox`, `netxmocks`) 3. move into `internal/netxlite/internal` stuff that is clearly private of `netxlite` 4. hide implementation details in `netxlite` pending new factories 5. refactor `tls` code in `netxlite` to clearly separate `crypto/tls` code from `utls` code After each commit, I run `go test -short -race ./...` locally. Each individual commit explains what it does. I will squash, but this operation will preserve the original commit titles, so this will give further insight on each step. ## Commits * refactor: rename netxmocks -> netxlite/mocks Part of https://github.com/ooni/probe/issues/1591 * refactor: rename quicx -> netxlite/quicx See https://github.com/ooni/probe/issues/1591 * refactor: rename iox -> netxlite/iox Regenerate sources and make sure the tests pass. See https://github.com/ooni/probe/issues/1591. * refactor(iox): move MockableReader to netxlite/mocks See https://github.com/ooni/probe/issues/1591 * refactor(netxlite): generator is an implementation detail See https://github.com/ooni/probe/issues/1591 * refactor(netxlite): separate tls and utls code See https://github.com/ooni/probe/issues/1591 * refactor(netxlite): hide most types but keep old names as legacy With this change we avoid breaking the rest of the tree, but we start hiding some implementation details a bit. Factories will follow. See https://github.com/ooni/probe/issues/1591
2021-09-05 14:49:38 +02:00
// These vars export internal names to legacy ooni/probe-cli code.
doc(netxlite): revamp the documentation (#523) Part of https://github.com/ooni/probe-cli/pull/506. In parallel with tutorials, we also need to make sure we have good documentation.
2021-09-29 20:21:25 +02:00
//
// Deprecated: do not use these names in new code.
refactor(netxlite): hide details without breaking the rest of the tree (#454) ## Description This PR continues the refactoring of `netx` under the following principles: 1. do not break the rest of the tree and do not engage in extensive tree-wide refactoring yet 2. move under `netxlite` clearly related subpackages (e.g., `iox`, `netxmocks`) 3. move into `internal/netxlite/internal` stuff that is clearly private of `netxlite` 4. hide implementation details in `netxlite` pending new factories 5. refactor `tls` code in `netxlite` to clearly separate `crypto/tls` code from `utls` code After each commit, I run `go test -short -race ./...` locally. Each individual commit explains what it does. I will squash, but this operation will preserve the original commit titles, so this will give further insight on each step. ## Commits * refactor: rename netxmocks -> netxlite/mocks Part of https://github.com/ooni/probe/issues/1591 * refactor: rename quicx -> netxlite/quicx See https://github.com/ooni/probe/issues/1591 * refactor: rename iox -> netxlite/iox Regenerate sources and make sure the tests pass. See https://github.com/ooni/probe/issues/1591. * refactor(iox): move MockableReader to netxlite/mocks See https://github.com/ooni/probe/issues/1591 * refactor(netxlite): generator is an implementation detail See https://github.com/ooni/probe/issues/1591 * refactor(netxlite): separate tls and utls code See https://github.com/ooni/probe/issues/1591 * refactor(netxlite): hide most types but keep old names as legacy With this change we avoid breaking the rest of the tree, but we start hiding some implementation details a bit. Factories will follow. See https://github.com/ooni/probe/issues/1591
2021-09-05 14:49:38 +02:00
var (
cleanup(netx): another batch of small/simple cleanups (#789) See https://github.com/ooni/probe/issues/2121
2022-06-02 13:50:34 +02:00
NewResolverSystem = newResolverSystem
refactor(netxlite): hide details without breaking the rest of the tree (#454) ## Description This PR continues the refactoring of `netx` under the following principles: 1. do not break the rest of the tree and do not engage in extensive tree-wide refactoring yet 2. move under `netxlite` clearly related subpackages (e.g., `iox`, `netxmocks`) 3. move into `internal/netxlite/internal` stuff that is clearly private of `netxlite` 4. hide implementation details in `netxlite` pending new factories 5. refactor `tls` code in `netxlite` to clearly separate `crypto/tls` code from `utls` code After each commit, I run `go test -short -race ./...` locally. Each individual commit explains what it does. I will squash, but this operation will preserve the original commit titles, so this will give further insight on each step. ## Commits * refactor: rename netxmocks -> netxlite/mocks Part of https://github.com/ooni/probe/issues/1591 * refactor: rename quicx -> netxlite/quicx See https://github.com/ooni/probe/issues/1591 * refactor: rename iox -> netxlite/iox Regenerate sources and make sure the tests pass. See https://github.com/ooni/probe/issues/1591. * refactor(iox): move MockableReader to netxlite/mocks See https://github.com/ooni/probe/issues/1591 * refactor(netxlite): generator is an implementation detail See https://github.com/ooni/probe/issues/1591 * refactor(netxlite): separate tls and utls code See https://github.com/ooni/probe/issues/1591 * refactor(netxlite): hide most types but keep old names as legacy With this change we avoid breaking the rest of the tree, but we start hiding some implementation details a bit. Factories will follow. See https://github.com/ooni/probe/issues/1591
2021-09-05 14:49:38 +02:00
)
Reference in New Issue Copy Permalink