273b70bacc
## Checklist - [x] I have read the [contribution guidelines](https://github.com/ooni/probe-cli/blob/master/CONTRIBUTING.md) - [x] reference issue for this pull request: https://github.com/ooni/probe/issues/1885 - [x] related ooni/spec pull request: N/A Location of the issue tracker: https://github.com/ooni/probe ## Description This PR contains a set of changes to move important interfaces and data types into the `./internal/model` package. The criteria for including an interface or data type in here is roughly that the type should be important and used by several packages. We are especially interested to move more interfaces here to increase modularity. An additional side effect is that, by reading this package, one should be able to understand more quickly how different parts of the codebase interact with each other. This is what I want to move in `internal/model`: - [x] most important interfaces from `internal/netxlite` - [x] everything that was previously part of `internal/engine/model` - [x] mocks from `internal/netxlite/mocks` should also be moved in here as a subpackage
64 lines
1.2 KiB
Go
64 lines
1.2 KiB
Go
package measurex
|
|
|
|
//
|
|
// Logger
|
|
//
|
|
// Code for logging
|
|
//
|
|
|
|
import (
|
|
"fmt"
|
|
"sync"
|
|
"time"
|
|
|
|
"github.com/ooni/probe-cli/v3/internal/model"
|
|
)
|
|
|
|
// NewOperationLogger creates a new logger that logs
|
|
// about an in-progress operation.
|
|
func NewOperationLogger(logger model.Logger, format string, v ...interface{}) *OperationLogger {
|
|
ol := &OperationLogger{
|
|
sighup: make(chan interface{}),
|
|
logger: logger,
|
|
once: &sync.Once{},
|
|
message: fmt.Sprintf(format, v...),
|
|
wg: &sync.WaitGroup{},
|
|
}
|
|
ol.wg.Add(1)
|
|
go ol.logloop()
|
|
return ol
|
|
}
|
|
|
|
// OperationLogger logs about an in-progress operation
|
|
type OperationLogger struct {
|
|
logger model.Logger
|
|
message string
|
|
once *sync.Once
|
|
sighup chan interface{}
|
|
wg *sync.WaitGroup
|
|
}
|
|
|
|
func (ol *OperationLogger) logloop() {
|
|
defer ol.wg.Done()
|
|
timer := time.NewTimer(500 * time.Millisecond)
|
|
defer timer.Stop()
|
|
select {
|
|
case <-timer.C:
|
|
ol.logger.Infof("%s... in progress", ol.message)
|
|
case <-ol.sighup:
|
|
// we'll emit directly in stop
|
|
}
|
|
}
|
|
|
|
func (ol *OperationLogger) Stop(err error) {
|
|
ol.once.Do(func() {
|
|
close(ol.sighup)
|
|
ol.wg.Wait()
|
|
if err != nil {
|
|
ol.logger.Infof("%s... %s", ol.message, err.Error())
|
|
return
|
|
}
|
|
ol.logger.Infof("%s... ok", ol.message)
|
|
})
|
|
}
|