Merge pull request #76 from TykTechnologies/TT-8978

[TT-8978] Fixing CosmosDB URL bug

persistent/internal/driver/mgo/life_cycle.go

@@ -24,7 +24,7 @@ type lifeCycle struct {
 
 // Connect connects to the mongo database given the ClientOpts.
 func (lc *lifeCycle) Connect(opts *types.ClientOpts) error {
-	opts.ConnectionString = helper.ParsePassword(opts.ConnectionString)
+	opts.ConnectionString = helper.EncodeConnectionString(opts.ConnectionString)
 
 	dialInfo, err := mgo.ParseURL(opts.ConnectionString)
 	if err != nil {

persistent/internal/driver/mongo/life_cycle.go

@@ -31,7 +31,7 @@ func (lc *lifeCycle) Connect(opts *types.ClientOpts) error {
 	var err error
 	var client *mongo.Client
 
-	opts.ConnectionString = helper.ParsePassword(opts.ConnectionString)
+	opts.ConnectionString = helper.EncodeConnectionString(opts.ConnectionString)
 
 	// we check if the connection string is valid before building the connOpts.
 	cs, err := connstring.ParseAndValidate(opts.ConnectionString)

persistent/internal/helper/functions.go

@@ -27,15 +27,21 @@ func IsCosmosDB(connectionString string) bool {
 		strings.Contains(connectionString, "AccountKey=")
 }
 
-// ParsePassword parses the password from the connection string and URL encodes it.
-// It's useful when the password contains special characters.
+// EncodeConnectionString URL encodes the password and the username from the connection string.
+// It's useful when they contains special characters.
 // Example: mongodb://user:p@ssword@localhost:27017/db -> mongodb://user:p%40word@40localhost:27017/db
 // If there's any conflict, the function returns the original connection string.
-func ParsePassword(connectionString string) string {
-	// Find the last '@' (the delimiter between credentials and host)
-	at := strings.LastIndex(connectionString, "@")
+func EncodeConnectionString(connectionString string) string {
+	// Find the last '@' before the last ':' (the delimiter between credentials and host)
+	// we use ':' since the URL can contain '@' characters after the port number
+	at := findLastAtBeforeLastColon(connectionString)
 	if at == -1 {
-		return connectionString
+		// If there's no ':' in the connection string, we use the last '@' as delimiter
+		at = findLastAt(connectionString)
+		// If there's no '@' in the connection string, we return the original connection string
+		if at == -1 {
+			return connectionString
+		}
 	}
 
 	credentialsAndScheme := connectionString[:at]
@@ -62,8 +68,27 @@ func ParsePassword(connectionString string) string {
 	// URL encode the password
 	encodedPassword := url.QueryEscape(password)
 
+	encodedUsername := url.QueryEscape(username)
+
 	// Construct the new connection string
-	newConnectionString := fmt.Sprintf("%s://%s:%s@%s", scheme, username, encodedPassword, hostAndDB)
+	newConnectionString := fmt.Sprintf("%s://%s:%s@%s", scheme, encodedUsername, encodedPassword, hostAndDB)
 
 	return newConnectionString
 }
+
+func findLastAtBeforeLastColon(str string) int {
+	lastColon := strings.LastIndex(str, ":")
+	if lastColon == -1 {
+		return -1
+	}
+
+	subStr := str[:lastColon]
+
+	lastAt := strings.LastIndex(subStr, "@")
+
+	return lastAt
+}
+
+func findLastAt(str string) int {
+	return strings.LastIndex(str, "@")
+}

persistent/internal/helper/functions_test.go

@@ -62,7 +62,7 @@ func TestIsCosmosDB(t *testing.T) {
 	}
 }
 
-func TestParsePassword(t *testing.T) {
+func TestEncodeConnectionString(t *testing.T) {
 	tests := []struct {
 		name               string
 		originalConnString string
@@ -80,8 +80,8 @@ func TestParsePassword(t *testing.T) {
 		},
 		{
 			name:               "valid connection string with @ and /",
-			originalConnString: "mongodb://user:p@sswor/d@localhost:27017/test",
-			expectedConnString: "mongodb://user:p%40sswor%2Fd@localhost:27017/test",
+			originalConnString: "mongodb://u=s@r:p@sswor/d@localhost:27017/test",
+			expectedConnString: "mongodb://u%3Ds%40r:p%40sswor%2Fd@localhost:27017/test",
 		},
 		{
 			name:               "valid connection string with @ and / and '?' outside of the credentials part",
@@ -138,11 +138,16 @@ func TestParsePassword(t *testing.T) {
 			originalConnString: "mongodb://user:password@localhost:27017",
 			expectedConnString: "mongodb://user:password@localhost:27017",
 		},
+		{
+			name:               "cosmosdb url",
+			originalConnString: "mongodb://4-0-qa:zFAQ==@4-0-qa.azure:10/a1?maxIdleTimeMS=120000&appName=@4-testing@",
+			expectedConnString: "mongodb://4-0-qa:zFAQ%3D%3D@4-0-qa.azure:10/a1?maxIdleTimeMS=120000&appName=@4-testing@",
+		},
 	}
 
 	for _, test := range tests {
 		t.Run(test.name, func(t *testing.T) {
-			connString := ParsePassword(test.originalConnString)
+			connString := EncodeConnectionString(test.originalConnString)
 			assert.Equal(t, test.expectedConnString, connString)
 		})
 	}