33de701263
* refactor(atomicx): move outside the engine package
After merging probe-engine into probe-cli, my impression is that we have
too much unnecessary nesting of packages in this repository.
The idea of this commit and of a bunch of following commits will instead
be to reduce the nesting and simplify the structure.
While there, improve the documentation.
* fix: always use the atomicx package
For consistency, never use sync/atomic and always use ./internal/atomicx
so we can just grep and make sure we're not risking to crash if we make
a subtle mistake on a 32 bit platform.
While there, mention in the contributing guidelines that we want to
always prefer the ./internal/atomicx package over sync/atomic.
* fix(atomicx): remove unnecessary constructor
We don't need a constructor here. The default constructed `&Int64{}`
instance is already usable and the constructor does not add anything to
what we are doing, rather it just creates extra confusion.
* cleanup(atomicx): we are not using Float64
Because atomicx.Float64 is unused, we can safely zap it.
* cleanup(atomicx): simplify impl and improve tests
We can simplify the implementation by using defer and by letting
the Load() method call Add(0).
We can improve tests by making many goroutines updated the
atomic int64 value concurrently.
* refactor(fsx): can live in the ./internal pkg
Let us reduce the amount of nesting. While there, ensure that the
package only exports the bare minimum, and improve the documentation
of the tests, to ease reading the code.
* refactor: move runtimex to ./internal
* refactor: move shellx into the ./internal package
While there, remove unnecessary dependency between packages.
While there, specify in the contributing guidelines that
one should use x/sys/execabs instead of os/exec.
* refactor: move ooapi into the ./internal pkg
* refactor(humanize): move to ./internal and better docs
* refactor: move platform to ./internal
* refactor(randx): move to ./internal
* refactor(multierror): move into the ./internal pkg
* refactor(kvstore): all kvstores in ./internal
Rather than having part of the kvstore inside ./internal/engine/kvstore
and part in ./internal/engine/kvstore.go, let us put every piece of code
that is kvstore related into the ./internal/kvstore package.
* fix(kvstore): always return ErrNoSuchKey on Get() error
It should help to use the kvstore everywhere removing all the
copies that are lingering around the tree.
* sessionresolver: make KVStore mandatory
Simplifies implementation. While there, use the ./internal/kvstore
package rather than having our private implementation.
* fix(ooapi): use the ./internal/kvstore package
* fix(platform): better documentation
57 lines
1.7 KiB
Go
57 lines
1.7 KiB
Go
// Package ooapi contains a client for the OONI API. We
|
|
// automatically generate the code in this package from the
|
|
// apimodel and internal/generator packages.
|
|
//
|
|
// Usage
|
|
//
|
|
// You need to create a Client. Make sure you set all
|
|
// the mandatory fields. You will then have a function
|
|
// for every supported OONI API. This function will
|
|
// take in input a context and a request. You need to
|
|
// fill the request, of course. The return value is
|
|
// either a response or an error.
|
|
//
|
|
// If an API requires login, we will automatically
|
|
// perform the login. If an API uses caching, we will
|
|
// automatically use the cache.
|
|
//
|
|
// See the example describing auto-login for more information
|
|
// on how to use auto-login.
|
|
//
|
|
// Design
|
|
//
|
|
// Most of the code in this package is auto-generated from the
|
|
// data model in ./apimodel and the definition of APIs provided
|
|
// by ./internal/generator/spec.go.
|
|
//
|
|
// We keep the generated files up-to-date by running
|
|
//
|
|
// go generate ./...
|
|
//
|
|
// We have tests that ensure that the definition of the API
|
|
// used here is reasonably close to the server's one.
|
|
//
|
|
// Testing
|
|
//
|
|
// The following command
|
|
//
|
|
// go test ./...
|
|
//
|
|
// will, among other things, ensure that the our API spec
|
|
// is consistent with the server's one. Running
|
|
//
|
|
// go test -short ./...
|
|
//
|
|
// will exclude most (slow) integration tests.
|
|
//
|
|
// Architecture
|
|
//
|
|
// The ./apimodel package contains the definition of request
|
|
// and response messages. We rely on tagging to specify how
|
|
// we should encode and decode messages.
|
|
//
|
|
// The ./internal/generator contains code to generate most
|
|
// code in this package. In particular, the spec.go file is
|
|
// the specification of the APIs.
|
|
package ooapi
|