fix(webconnectivitylte): use scope for endpoint IDs (#1507)

We use scope for endpoint IDs. This helps to reduce churn when running
`./script/updateminipipeline.bash`.

Part of ooni/probe#2677

internal/experiment/webconnectivitylte/cleartextflow.go

@@ -14,7 +14,6 @@ import (
 	"net/http"
 	"net/url"
 	"sync"
-	"sync/atomic"
 	"time"
 
 	"github.com/ooni/probe-cli/v3/internal/logx"
@@ -39,7 +38,7 @@ type CleartextFlow struct {
 	Depth int64
 
 	// IDGenerator is the MANDATORY atomic int64 to generate task IDs.
-	IDGenerator *atomic.Int64
+	IDGenerator *IDGenerator
 
 	// Logger is the MANDATORY logger to use.
 	Logger model.Logger
@@ -87,7 +86,7 @@ type CleartextFlow struct {
 // Start starts this task in a background goroutine.
 func (t *CleartextFlow) Start(ctx context.Context) {
 	t.WaitGroup.Add(1)
-	index := t.IDGenerator.Add(1)
+	index := t.IDGenerator.NewIDForEndpointCleartext()
 	go func() {
 		defer t.WaitGroup.Done() // synchronize with the parent
 		t.Run(ctx, index)

internal/experiment/webconnectivitylte/cleartextflow_test.go

@@ -5,7 +5,6 @@ import (
 	"errors"
 	"net/http"
 	"sync"
-	"sync/atomic"
 	"testing"
 	"time"
 
@@ -16,7 +15,7 @@ func TestCleartextFlow_Run(t *testing.T) {
 	type fields struct {
 		Address         string
 		DNSCache        *DNSCache
-		IDGenerator     *atomic.Int64
+		IDGenerator     *IDGenerator
 		Logger          model.Logger
 		NumRedirects    *NumRedirects
 		TestKeys        *TestKeys

internal/experiment/webconnectivitylte/dnsresolvers.go

@@ -13,7 +13,6 @@ import (
 	"net/http"
 	"net/url"
 	"sync"
-	"sync/atomic"
 	"time"
 
 	"github.com/ooni/probe-cli/v3/internal/logx"
@@ -38,7 +37,7 @@ type DNSResolvers struct {
 	Depth int64
 
 	// IDGenerator is the MANDATORY atomic int64 to generate task IDs.
-	IDGenerator *atomic.Int64
+	IDGenerator *IDGenerator
 
 	// Logger is the MANDATORY logger to use.
 	Logger model.Logger
@@ -209,7 +208,7 @@ func (t *DNSResolvers) lookupHostSystem(parentCtx context.Context, out chan<- []
 	defer lookpCancel()
 
 	// create trace's index
-	index := t.IDGenerator.Add(1)
+	index := t.IDGenerator.NewIDForGetaddrinfo()
 
 	// create trace
 	trace := measurexlite.NewTrace(index, t.ZeroTime, fmt.Sprintf("depth=%d", t.Depth))
@@ -236,7 +235,7 @@ func (t *DNSResolvers) lookupHostUDP(parentCtx context.Context, udpAddress strin
 	defer lookpCancel()
 
 	// create trace's index
-	index := t.IDGenerator.Add(1)
+	index := t.IDGenerator.NewIDForDNSOverUDP()
 
 	// create trace
 	trace := measurexlite.NewTrace(index, t.ZeroTime, fmt.Sprintf("depth=%d", t.Depth))
@@ -325,7 +324,7 @@ func (t *DNSResolvers) lookupHostDNSOverHTTPS(parentCtx context.Context, out cha
 	defer lookpCancel()
 
 	// create trace's index
-	index := t.IDGenerator.Add(1)
+	index := t.IDGenerator.NewIDForDNSOverHTTPS()
 
 	// create trace
 	trace := measurexlite.NewTrace(index, t.ZeroTime, fmt.Sprintf("depth=%d", t.Depth))

internal/experiment/webconnectivitylte/idgenerator.go

@@ -0,0 +1,67 @@
+package webconnectivitylte
+
+import "sync/atomic"
+
+const (
+	idGeneratorGetaddrinfoOffset       = 0
+	idGeneratorDNSOverUDPOffset        = 10_000
+	idGeneratorDNSOverHTTPSOffset      = 20_000
+	idGeneratorEndpointCleartextOffset = 30_000
+	idGeneratorEndpointSecureOffset    = 40_000
+)
+
+// IDGenerator helps with generating IDs that neatly fall into namespaces.
+//
+// The zero value is invalid, please use [NewIDGenerator].
+type IDGenerator struct {
+	// getaddrinfo generates IDs for getaddrinfo.
+	getaddrinfo *atomic.Int64
+
+	// dnsOverUDP generates IDs for DNS-over-UDP lookups.
+	dnsOverUDP *atomic.Int64
+
+	// dnsOverHTTPS generates IDs for DNS-over-HTTPS lookups.
+	dnsOverHTTPS *atomic.Int64
+
+	// endpointCleartext generates IDs for endpoints using HTTP.
+	endpointCleartext *atomic.Int64
+
+	// endpointSecure generates IDs for endpoints using HTTPS.
+	endpointSecure *atomic.Int64
+}
+
+// NewIDGenerator creates a new [*IDGenerator] instance.
+func NewIDGenerator() *IDGenerator {
+	return &IDGenerator{
+		getaddrinfo:       &atomic.Int64{},
+		dnsOverUDP:        &atomic.Int64{},
+		dnsOverHTTPS:      &atomic.Int64{},
+		endpointCleartext: &atomic.Int64{},
+		endpointSecure:    &atomic.Int64{},
+	}
+}
+
+// NewIDForGetaddrinfo returns a new ID for a getaddrinfo lookup.
+func (idgen *IDGenerator) NewIDForGetaddrinfo() int64 {
+	return idgen.getaddrinfo.Add(1) + idGeneratorGetaddrinfoOffset
+}
+
+// NewIDForDNSOverUDP returns a new ID for a DNS-over-UDP lookup.
+func (idgen *IDGenerator) NewIDForDNSOverUDP() int64 {
+	return idgen.dnsOverUDP.Add(1) + idGeneratorDNSOverUDPOffset
+}
+
+// NewIDForDNSOverHTTPS returns a new ID for a DNS-over-HTTPS lookup.
+func (idgen *IDGenerator) NewIDForDNSOverHTTPS() int64 {
+	return idgen.dnsOverHTTPS.Add(1) + idGeneratorDNSOverHTTPSOffset
+}
+
+// NewIDForEndpointCleartext returns a new ID for a cleartext endpoint operation.
+func (idgen *IDGenerator) NewIDForEndpointCleartext() int64 {
+	return idgen.endpointCleartext.Add(1) + idGeneratorEndpointCleartextOffset
+}
+
+// NewIDForEndpointSecure returns a new ID for a secure endpoint operation.
+func (idgen *IDGenerator) NewIDForEndpointSecure() int64 {
+	return idgen.endpointSecure.Add(1) + idGeneratorEndpointSecureOffset
+}

internal/experiment/webconnectivitylte/measurer.go

@@ -9,7 +9,6 @@ import (
 	"errors"
 	"net/http/cookiejar"
 	"sync"
-	"sync/atomic"
 
 	"github.com/ooni/probe-cli/v3/internal/experiment/webconnectivity"
 	"github.com/ooni/probe-cli/v3/internal/inputparser"
@@ -84,7 +83,6 @@ func (m *Measurer) Run(ctx context.Context, args *model.ExperimentArgs) error {
 	tk.ClientResolver = sess.ResolverIP()
 
 	// create variables required to run parallel tasks
-	idGenerator := &atomic.Int64{}
 	wg := &sync.WaitGroup{}
 
 	// create cookiejar
@@ -109,7 +107,7 @@ func (m *Measurer) Run(ctx context.Context, args *model.ExperimentArgs) error {
 		DNSCache:     NewDNSCache(),
 		Depth:        0,
 		Domain:       URL.Hostname(),
-		IDGenerator:  idGenerator,
+		IDGenerator:  NewIDGenerator(),
 		Logger:       sess.Logger(),
 		NumRedirects: NewNumRedirects(5),
 		TestKeys:     tk,

internal/experiment/webconnectivitylte/secureflow.go

@@ -15,7 +15,6 @@ import (
 	"net/http"
 	"net/url"
 	"sync"
-	"sync/atomic"
 	"time"
 
 	"github.com/ooni/probe-cli/v3/internal/logx"
@@ -40,7 +39,7 @@ type SecureFlow struct {
 	Depth int64
 
 	// IDGenerator is the MANDATORY atomic int64 to generate task IDs.
-	IDGenerator *atomic.Int64
+	IDGenerator *IDGenerator
 
 	// Logger is the MANDATORY logger to use.
 	Logger model.Logger
@@ -94,7 +93,7 @@ type SecureFlow struct {
 // Start starts this task in a background goroutine.
 func (t *SecureFlow) Start(ctx context.Context) {
 	t.WaitGroup.Add(1)
-	index := t.IDGenerator.Add(1)
+	index := t.IDGenerator.NewIDForEndpointSecure()
 	go func() {
 		defer t.WaitGroup.Done() // synchronize with the parent
 		t.Run(ctx, index)

internal/experiment/webconnectivitylte/secureflow_test.go

@@ -5,7 +5,6 @@ import (
 	"errors"
 	"net/http"
 	"sync"
-	"sync/atomic"
 	"testing"
 	"time"
 
@@ -16,7 +15,7 @@ func TestSecureFlow_Run(t *testing.T) {
 	type fields struct {
 		Address         string
 		DNSCache        *DNSCache
-		IDGenerator     *atomic.Int64
+		IDGenerator     *IDGenerator
 		Logger          model.Logger
 		NumRedirects    *NumRedirects
 		TestKeys        *TestKeys

internal/minipipeline/testdata/webconnectivity/generated/badSSLWithExpiredCertificate/analysis.json

@@ -7,18 +7,18 @@
   },
   "DNSLookupSuccess": [
     1,
-    2
+    10001
   ],
   "DNSLookupSuccessWithInvalidAddresses": [],
   "DNSLookupSuccessWithValidAddress": [
     1,
-    2
+    10001
   ],
   "DNSLookupSuccessWithBogonAddresses": [],
   "DNSLookupSuccessWithInvalidAddressesClassic": [],
   "DNSLookupSuccessWithValidAddressClassic": [
     1,
-    2
+    10001
   ],
   "DNSLookupUnexpectedFailure": [],
   "DNSLookupUnexplainedFailure": [],
@@ -33,7 +33,7 @@
   "TCPConnectUnexplainedFailureDuringWebFetch": [],
   "TCPConnectUnexplainedFailureDuringConnectivityCheck": [],
   "TLSHandshakeExpectedFailure": [
-    3
+    40001
   ],
   "TLSHandshakeUnexpectedFailure": [],
   "TLSHandshakeUnexpectedFailureDuringWebFetch": [],
@@ -56,7 +56,7 @@
       "TagDepth": 0,
       "Type": 2,
       "Failure": "ssl_invalid_certificate",
-      "TransactionID": 3,
+      "TransactionID": 40001,
       "TagFetchBody": true,
       "DNSTransactionID": 1,
       "DNSDomain": "expired.badssl.com",
@@ -70,7 +70,7 @@
       "IPAddress": "104.154.89.105",
       "IPAddressASN": 396982,
       "IPAddressBogon": false,
-      "EndpointTransactionID": 3,
+      "EndpointTransactionID": 40001,
       "EndpointProto": "tcp",
       "EndpointPort": "443",
       "EndpointAddress": "104.154.89.105:443",
@@ -103,9 +103,9 @@
       "TagDepth": 0,
       "Type": 0,
       "Failure": "",
-      "TransactionID": 2,
+      "TransactionID": 10001,
       "TagFetchBody": null,
-      "DNSTransactionID": 2,
+      "DNSTransactionID": 10001,
       "DNSDomain": "expired.badssl.com",
       "DNSLookupFailure": "",
       "DNSQueryType": "A",
@@ -197,9 +197,9 @@
       "TagDepth": 0,
       "Type": 0,
       "Failure": "dns_no_answer",
-      "TransactionID": 2,
+      "TransactionID": 10001,
       "TagFetchBody": null,
-      "DNSTransactionID": 2,
+      "DNSTransactionID": 10001,
       "DNSDomain": "expired.badssl.com",
       "DNSLookupFailure": "dns_no_answer",
       "DNSQueryType": "AAAA",

internal/minipipeline/testdata/webconnectivity/generated/badSSLWithExpiredCertificate/analysis_classic.json

@@ -30,7 +30,7 @@
   "TCPConnectUnexplainedFailureDuringWebFetch": [],
   "TCPConnectUnexplainedFailureDuringConnectivityCheck": [],
   "TLSHandshakeExpectedFailure": [
-    3
+    40001
   ],
   "TLSHandshakeUnexpectedFailure": [],
   "TLSHandshakeUnexpectedFailureDuringWebFetch": [],
@@ -53,7 +53,7 @@
       "TagDepth": 0,
       "Type": 2,
       "Failure": "ssl_invalid_certificate",
-      "TransactionID": 3,
+      "TransactionID": 40001,
       "TagFetchBody": true,
       "DNSTransactionID": 1,
       "DNSDomain": "expired.badssl.com",
@@ -67,7 +67,7 @@
       "IPAddress": "104.154.89.105",
       "IPAddressASN": 396982,
       "IPAddressBogon": false,
-      "EndpointTransactionID": 3,
+      "EndpointTransactionID": 40001,
       "EndpointProto": "tcp",
       "EndpointPort": "443",
       "EndpointAddress": "104.154.89.105:443",