1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186
|
// Copyright (C) MongoDB, Inc. 2017-present.
//
// Licensed under the Apache License, Version 2.0 (the "License"); you may
// not use this file except in compliance with the License. You may obtain
// a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
package mtest
import (
"context"
"errors"
"fmt"
"net"
"sync"
"time"
"go.mongodb.org/mongo-driver/mongo/options"
"go.mongodb.org/mongo-driver/x/bsonx/bsoncore"
)
// ProxyMessage represents a sent/received pair of parsed wire messages.
type ProxyMessage struct {
ServerAddress string
CommandName string
Sent *SentMessage
Received *ReceivedMessage
}
// proxyDialer is a ContextDialer implementation that wraps a net.Dialer and records the messages sent and received
// using connections created through it.
type proxyDialer struct {
*net.Dialer
sync.Mutex
messages []*ProxyMessage
// sentMap temporarily stores the message sent to the server using the requestID so it can map requests to their
// responses.
sentMap sync.Map
// addressTranslations maps dialed addresses to the remote addresses reported by the created connections if they
// differ. This can happen if a connection is dialed to a host name, in which case the reported remote address will
// be the resolved IP address.
addressTranslations sync.Map
}
var _ options.ContextDialer = (*proxyDialer)(nil)
func newProxyDialer() *proxyDialer {
return &proxyDialer{
Dialer: &net.Dialer{Timeout: 30 * time.Second},
}
}
func newProxyErrorWithWireMsg(wm []byte, err error) error {
return fmt.Errorf("proxy error for wiremessage %v: %w", wm, err)
}
// DialContext creates a new proxyConnection.
func (p *proxyDialer) DialContext(ctx context.Context, network, address string) (net.Conn, error) {
netConn, err := p.Dialer.DialContext(ctx, network, address)
if err != nil {
return netConn, err
}
// If the connection's remote address does not match the dialed address, store it in the translations map for
// future look-up. Use the remote address as they key because that's what we'll have access to in the connection's
// Read/Write functions.
if remoteAddress := netConn.RemoteAddr().String(); remoteAddress != address {
p.addressTranslations.Store(remoteAddress, address)
}
proxy := &proxyConn{
Conn: netConn,
dialer: p,
}
return proxy, nil
}
func (p *proxyDialer) storeSentMessage(wm []byte) error {
p.Lock()
defer p.Unlock()
// Create a copy of the wire message so it can be parsed/stored and will not be affected if the wm slice is
// changed by the driver.
wmCopy := copyBytes(wm)
parsed, err := parseSentMessage(wmCopy)
if err != nil {
return err
}
p.sentMap.Store(parsed.RequestID, parsed)
return nil
}
func (p *proxyDialer) storeReceivedMessage(wm []byte, addr string) error {
p.Lock()
defer p.Unlock()
serverAddress := addr
if translated, ok := p.addressTranslations.Load(addr); ok {
serverAddress = translated.(string)
}
// Create a copy of the wire message so it can be parsed/stored and will not be affected if the wm slice is
// changed by the driver. Parse the incoming message and get the corresponding outgoing message.
wmCopy := copyBytes(wm)
parsed, err := parseReceivedMessage(wmCopy)
if err != nil {
return err
}
mapValue, ok := p.sentMap.Load(parsed.ResponseTo)
if !ok {
return errors.New("no sent message found")
}
sent := mapValue.(*SentMessage)
p.sentMap.Delete(parsed.ResponseTo)
// Store the parsed message pair.
msgPair := &ProxyMessage{
// The command name is always the first key in the command document.
CommandName: sent.Command.Index(0).Key(),
ServerAddress: serverAddress,
Sent: sent,
Received: parsed,
}
p.messages = append(p.messages, msgPair)
return nil
}
// Messages returns a slice of proxied messages. This slice is a copy of the messages proxied so far and will not be
// updated for messages proxied after this call.
func (p *proxyDialer) Messages() []*ProxyMessage {
p.Lock()
defer p.Unlock()
copiedMessages := make([]*ProxyMessage, len(p.messages))
copy(copiedMessages, p.messages)
return copiedMessages
}
// proxyConn is a net.Conn that wraps a network connection. All messages sent/received through a proxyConn are stored
// in the associated proxyDialer and are forwarded over the wrapped connection. Errors encountered when parsing and
// storing wire messages are wrapped to add context, while errors returned from the underlying network connection are
// forwarded without wrapping.
type proxyConn struct {
net.Conn
dialer *proxyDialer
}
// Write stores the given message in the proxyDialer associated with this connection and forwards the message to the
// server.
func (pc *proxyConn) Write(wm []byte) (n int, err error) {
if err := pc.dialer.storeSentMessage(wm); err != nil {
wrapped := fmt.Errorf("error storing sent message: %w", err)
return 0, newProxyErrorWithWireMsg(wm, wrapped)
}
return pc.Conn.Write(wm)
}
// Read reads the message from the server into the given buffer and stores the read message in the proxyDialer
// associated with this connection.
func (pc *proxyConn) Read(buffer []byte) (int, error) {
n, err := pc.Conn.Read(buffer)
if err != nil {
return n, err
}
// The driver reads wire messages in two phases: a four-byte read to get the length of the incoming wire message
// and a (length-4) byte read to get the message itself. There's nothing to be stored during the initial four-byte
// read because we can calculate the length from the rest of the message.
if len(buffer) == 4 {
return 4, nil
}
// The buffer contains the entire wire message except for the length bytes. Re-create the full message by appending
// buffer to the end of a four-byte slice and using UpdateLength to set the length bytes.
idx, wm := bsoncore.ReserveLength(nil)
wm = append(wm, buffer...)
wm = bsoncore.UpdateLength(wm, idx, int32(len(wm[idx:])))
if err := pc.dialer.storeReceivedMessage(wm, pc.RemoteAddr().String()); err != nil {
wrapped := fmt.Errorf("error storing received message: %w", err)
return 0, newProxyErrorWithWireMsg(wm, wrapped)
}
return n, nil
}
|