Function createBlipTesterWithSpec

rest/utilities_testing.go:1452–1535

createBlipTesterWithSpec creates a blip tester targeting a specific RestTester. Returns an error to allow for testing connection error conditions. Use NewBlipTesterFromSpec for most tests.

(rt *RestTester, spec BlipTesterSpec)

// createBlipTesterWithSpec creates a blip tester targeting a specific RestTester. Returns an error to allow for
// testing connection error conditions. Use NewBlipTesterFromSpec for most tests.
func createBlipTesterWithSpec(rt *RestTester, spec BlipTesterSpec) (*BlipTester, error) {
	bt := &BlipTester{
		restTester: rt,
	}

	if !rt.GetDatabase().OnlyDefaultCollection() {
		bt.useCollections = true
	}

	// Since blip requests all go over the public handler, wrap the public handler with the httptest server
	publicHandler := bt.restTester.TestPublicHandler()

	// Create a _temporary_ test server bound to an actual port that is used to make the blip connection.
	// This is needed because the mock-based approach fails with a "Connection not hijackable" error when
	// trying to do the websocket upgrade.  Since it's only needed to setup the websocket, it can be closed
	// as soon as the websocket is established, hence the defer srv.Close() call.
	srv := httptest.NewServer(publicHandler)
	defer srv.Close()

	// Construct URL to connect to blipsync target endpoint
	destUrl := fmt.Sprintf("%s/%s/_blipsync", srv.URL, rt.GetDatabase().Name)
	u, err := url.Parse(destUrl)
	require.NoError(bt.TB(), err)
	u.Scheme = "ws"

	// If protocols are not set use V3 as a V3 client would
	protocols := spec.blipProtocols
	if len(protocols) == 0 {
		protocols = []string{db.CBMobileReplicationV3.SubprotocolString()}
	}

	origin, err := hostOnlyCORS(bt.restTester.GetDatabase().CORS.Origin)
	if err != nil {
		return nil, err
	}
	// Make BLIP/Websocket connection.  Not specifying cancellation context here as this is a
	// client blip context that doesn't require cancellation-based close
	_, bt.blipContext, err = db.NewSGBlipContextWithProtocols(rt.Context(), "", origin, protocols, nil)
	if err != nil {
		return nil, err
	}

	// Ensure that errors get correctly surfaced in tests
	bt.blipContext.FatalErrorHandler = func(err error) {
		bt.TB().Fatalf("BLIP fatal error: %v", err)
	}
	bt.blipContext.HandlerPanicHandler = func(request, response *blip.Message, err interface{}) {
		stack := debug.Stack()
		bt.TB().Fatalf("Panic while handling %s: %v\n%s", request.Profile(), err, string(stack))
	}

	config := blip.DialOptions{
		URL: u.String(),
	}

	config.HTTPHeader = make(http.Header)
	if len(spec.connectingUsername) > 0 {
		config.HTTPHeader.Add("Authorization", GetBasicAuthHeader(bt.TB(), spec.connectingUsername, RestTesterDefaultUserPassword))