refactor(netx): towards removing connid, dialid, etc (#369)

I have verified that experiment/tor does not depend on this
functionality, therefore we can safely remove it.

Part of https://github.com/ooni/probe-engine/issues/897

internal/engine/netx/dialer/dns_test.go

@@ -6,10 +6,7 @@ import (
 	"io"
 	"net"
 	"testing"
-	"time"
 
-	"github.com/ooni/probe-cli/v3/internal/engine/legacy/netx/handlers"
-	"github.com/ooni/probe-cli/v3/internal/engine/legacy/netx/modelx"
 	"github.com/ooni/probe-cli/v3/internal/engine/netx/dialer"
 	"github.com/ooni/probe-cli/v3/internal/engine/netx/errorx"
 	"github.com/ooni/probe-cli/v3/internal/engine/netx/mockablex"
@@ -117,46 +114,8 @@ func TestDNSDialerDialForManyIPSuccess(t *testing.T) {
 	conn.Close()
 }
 
-func TestDNSDialerDialSetsDialID(t *testing.T) {
-	saver := &handlers.SavingHandler{}
-	ctx := modelx.WithMeasurementRoot(context.Background(), &modelx.MeasurementRoot{
-		Beginning: time.Now(),
-		Handler:   saver,
-	})
-	dialer := dialer.DNSDialer{Dialer: dialer.EmitterDialer{
-		Dialer: mockablex.Dialer{
-			MockDialContext: func(ctx context.Context, network string, address string) (net.Conn, error) {
-				return &mockablex.Conn{
-					MockClose: func() error {
-						return nil
-					},
-					MockLocalAddr: func() net.Addr {
-						return &net.TCPAddr{}
-					},
-				}, nil
-			},
-		},
-	}, Resolver: MockableResolver{
-		Addresses: []string{"1.1.1.1", "8.8.8.8"},
-	}}
-	conn, err := dialer.DialContext(ctx, "tcp", "dot.dns:853")
-	if err != nil {
-		t.Fatal("expected nil error here")
-	}
-	if conn == nil {
-		t.Fatal("expected non-nil conn")
-	}
-	conn.Close()
-	events := saver.Read()
-	if len(events) != 2 {
-		t.Fatal("unexpected number of events")
-	}
-	for _, ev := range events {
-		if ev.Connect != nil && ev.Connect.DialID == 0 {
-			t.Fatal("unexpected DialID")
-		}
-	}
-}
+// TODO(bassosimone): remove the dialID etc since the only
+// test still using legacy/netx does not care.
 
 func TestReduceErrors(t *testing.T) {
 	t.Run("no errors", func(t *testing.T) {

internal/engine/netx/dialer/emitter.go

@@ -1,103 +0,0 @@
-package dialer
-
-import (
-	"context"
-	"net"
-	"time"
-
-	"github.com/ooni/probe-cli/v3/internal/engine/legacy/netx/dialid"
-	"github.com/ooni/probe-cli/v3/internal/engine/legacy/netx/modelx"
-	"github.com/ooni/probe-cli/v3/internal/engine/legacy/netx/transactionid"
-)
-
-// EmitterDialer is a Dialer that emits events
-type EmitterDialer struct {
-	Dialer
-}
-
-// DialContext implements Dialer.DialContext
-func (d EmitterDialer) DialContext(ctx context.Context, network, address string) (net.Conn, error) {
-	start := time.Now()
-	conn, err := d.Dialer.DialContext(ctx, network, address)
-	stop := time.Now()
-	root := modelx.ContextMeasurementRootOrDefault(ctx)
-	root.Handler.OnMeasurement(modelx.Measurement{
-		Connect: &modelx.ConnectEvent{
-			ConnID:                 safeConnID(network, conn),
-			DialID:                 dialid.ContextDialID(ctx),
-			DurationSinceBeginning: stop.Sub(root.Beginning),
-			Error:                  err,
-			Network:                network,
-			RemoteAddress:          address,
-			SyscallDuration:        stop.Sub(start),
-			TransactionID:          transactionid.ContextTransactionID(ctx),
-		},
-	})
-	if err != nil {
-		return nil, err
-	}
-	return EmitterConn{
-		Conn:      conn,
-		Beginning: root.Beginning,
-		Handler:   root.Handler,
-		ID:        safeConnID(network, conn),
-	}, nil
-}
-
-// EmitterConn is a net.Conn used to emit events
-type EmitterConn struct {
-	net.Conn
-	Beginning time.Time
-	Handler   modelx.Handler
-	ID        int64
-}
-
-// Read implements net.Conn.Read
-func (c EmitterConn) Read(b []byte) (n int, err error) {
-	start := time.Now()
-	n, err = c.Conn.Read(b)
-	stop := time.Now()
-	c.Handler.OnMeasurement(modelx.Measurement{
-		Read: &modelx.ReadEvent{
-			ConnID:                 c.ID,
-			DurationSinceBeginning: stop.Sub(c.Beginning),
-			Error:                  err,
-			NumBytes:               int64(n),
-			SyscallDuration:        stop.Sub(start),
-		},
-	})
-	return
-}
-
-// Write implements net.Conn.Write
-func (c EmitterConn) Write(b []byte) (n int, err error) {
-	start := time.Now()
-	n, err = c.Conn.Write(b)
-	stop := time.Now()
-	c.Handler.OnMeasurement(modelx.Measurement{
-		Write: &modelx.WriteEvent{
-			ConnID:                 c.ID,
-			DurationSinceBeginning: stop.Sub(c.Beginning),
-			Error:                  err,
-			NumBytes:               int64(n),
-			SyscallDuration:        stop.Sub(start),
-		},
-	})
-	return
-}
-
-// Close implements net.Conn.Close
-func (c EmitterConn) Close() (err error) {
-	start := time.Now()
-	err = c.Conn.Close()
-	stop := time.Now()
-	c.Handler.OnMeasurement(modelx.Measurement{
-		Close: &modelx.CloseEvent{
-			ConnID:                 c.ID,
-			DurationSinceBeginning: stop.Sub(c.Beginning),
-			Error:                  err,
-			SyscallDuration:        stop.Sub(start),
-		},
-	})
-	return
-}

internal/engine/netx/dialer/emitter_test.go

@@ -1,189 +0,0 @@
-package dialer_test
-
-import (
-	"context"
-	"errors"
-	"io"
-	"net"
-	"testing"
-	"time"
-
-	"github.com/ooni/probe-cli/v3/internal/engine/legacy/netx/dialid"
-	"github.com/ooni/probe-cli/v3/internal/engine/legacy/netx/handlers"
-	"github.com/ooni/probe-cli/v3/internal/engine/legacy/netx/modelx"
-	"github.com/ooni/probe-cli/v3/internal/engine/legacy/netx/transactionid"
-	"github.com/ooni/probe-cli/v3/internal/engine/netx/dialer"
-	"github.com/ooni/probe-cli/v3/internal/engine/netx/mockablex"
-)
-
-func TestEmitterFailure(t *testing.T) {
-	ctx := dialid.WithDialID(context.Background())
-	saver := &handlers.SavingHandler{}
-	ctx = modelx.WithMeasurementRoot(ctx, &modelx.MeasurementRoot{
-		Beginning: time.Now(),
-		Handler:   saver,
-	})
-	ctx = transactionid.WithTransactionID(ctx)
-	d := dialer.EmitterDialer{Dialer: mockablex.Dialer{
-		MockDialContext: func(ctx context.Context, network string, address string) (net.Conn, error) {
-			return nil, io.EOF
-		},
-	}}
-	conn, err := d.DialContext(ctx, "tcp", "www.google.com:443")
-	if !errors.Is(err, io.EOF) {
-		t.Fatal("not the error we expected")
-	}
-	if conn != nil {
-		t.Fatal("expected a nil conn here")
-	}
-	events := saver.Read()
-	if len(events) != 1 {
-		t.Fatal("unexpected number of events saved")
-	}
-	if events[0].Connect == nil {
-		t.Fatal("expected non nil Connect")
-	}
-	conninfo := events[0].Connect
-	if conninfo.ConnID != 0 {
-		t.Fatal("unexpected ConnID value")
-	}
-	emitterCheckConnectEventCommon(t, conninfo, io.EOF)
-}
-
-func emitterCheckConnectEventCommon(
-	t *testing.T, conninfo *modelx.ConnectEvent, err error) {
-	if conninfo.DialID == 0 {
-		t.Fatal("unexpected DialID value")
-	}
-	if conninfo.DurationSinceBeginning == 0 {
-		t.Fatal("unexpected DurationSinceBeginning value")
-	}
-	if !errors.Is(conninfo.Error, err) {
-		t.Fatal("unexpected Error value")
-	}
-	if conninfo.Network != "tcp" {
-		t.Fatal("unexpected Network value")
-	}
-	if conninfo.RemoteAddress != "www.google.com:443" {
-		t.Fatal("unexpected Network value")
-	}
-	if conninfo.SyscallDuration == 0 {
-		t.Fatal("unexpected SyscallDuration value")
-	}
-	if conninfo.TransactionID == 0 {
-		t.Fatal("unexpected TransactionID value")
-	}
-}
-
-func TestEmitterSuccess(t *testing.T) {
-	ctx := dialid.WithDialID(context.Background())
-	saver := &handlers.SavingHandler{}
-	ctx = modelx.WithMeasurementRoot(ctx, &modelx.MeasurementRoot{
-		Beginning: time.Now(),
-		Handler:   saver,
-	})
-	ctx = transactionid.WithTransactionID(ctx)
-	d := dialer.EmitterDialer{Dialer: mockablex.Dialer{
-		MockDialContext: func(ctx context.Context, network string, address string) (net.Conn, error) {
-			return &mockablex.Conn{
-				MockRead: func(b []byte) (int, error) {
-					return 0, io.EOF
-				},
-				MockWrite: func(b []byte) (int, error) {
-					return 0, io.EOF
-				},
-				MockClose: func() error {
-					return io.EOF
-				},
-				MockLocalAddr: func() net.Addr {
-					return &net.TCPAddr{Port: 12345}
-				},
-			}, nil
-		},
-	}}
-	conn, err := d.DialContext(ctx, "tcp", "www.google.com:443")
-	if err != nil {
-		t.Fatal("we expected no error")
-	}
-	if conn == nil {
-		t.Fatal("expected a non-nil conn here")
-	}
-	conn.Read(nil)
-	conn.Write(nil)
-	conn.Close()
-	events := saver.Read()
-	if len(events) != 4 {
-		t.Fatal("unexpected number of events saved")
-	}
-	if events[0].Connect == nil {
-		t.Fatal("expected non nil Connect")
-	}
-	conninfo := events[0].Connect
-	if conninfo.ConnID == 0 {
-		t.Fatal("unexpected ConnID value")
-	}
-	emitterCheckConnectEventCommon(t, conninfo, nil)
-	if events[1].Read == nil {
-		t.Fatal("expected non nil Read")
-	}
-	emitterCheckReadEvent(t, events[1].Read)
-	if events[2].Write == nil {
-		t.Fatal("expected non nil Write")
-	}
-	emitterCheckWriteEvent(t, events[2].Write)
-	if events[3].Close == nil {
-		t.Fatal("expected non nil Close")
-	}
-	emitterCheckCloseEvent(t, events[3].Close)
-}
-
-func emitterCheckReadEvent(t *testing.T, ev *modelx.ReadEvent) {
-	if ev.ConnID == 0 {
-		t.Fatal("unexpected ConnID")
-	}
-	if ev.DurationSinceBeginning == 0 {
-		t.Fatal("unexpected DurationSinceBeginning")
-	}
-	if !errors.Is(ev.Error, io.EOF) {
-		t.Fatal("unexpected Error")
-	}
-	if ev.NumBytes != 0 {
-		t.Fatal("unexpected NumBytes")
-	}
-	if ev.SyscallDuration == 0 {
-		t.Fatal("unexpected SyscallDuration")
-	}
-}
-
-func emitterCheckWriteEvent(t *testing.T, ev *modelx.WriteEvent) {
-	if ev.ConnID == 0 {
-		t.Fatal("unexpected ConnID")
-	}
-	if ev.DurationSinceBeginning == 0 {
-		t.Fatal("unexpected DurationSinceBeginning")
-	}
-	if !errors.Is(ev.Error, io.EOF) {
-		t.Fatal("unexpected Error")
-	}
-	if ev.NumBytes != 0 {
-		t.Fatal("unexpected NumBytes")
-	}
-	if ev.SyscallDuration == 0 {
-		t.Fatal("unexpected SyscallDuration")
-	}
-}
-
-func emitterCheckCloseEvent(t *testing.T, ev *modelx.CloseEvent) {
-	if ev.ConnID == 0 {
-		t.Fatal("unexpected ConnID")
-	}
-	if ev.DurationSinceBeginning == 0 {
-		t.Fatal("unexpected DurationSinceBeginning")
-	}
-	if !errors.Is(ev.Error, io.EOF) {
-		t.Fatal("unexpected Error")
-	}
-	if ev.SyscallDuration == 0 {
-		t.Fatal("unexpected SyscallDuration")
-	}
-}