Skip to content

fix: remove mongodb advanced options and ignore legacy params #654

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
LordofAvernus wants to merge 1 commit into from
Closed

fix: remove mongodb advanced options and ignore legacy params #654

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions internal/dms/service/db_service.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,9 @@ func (d *DMSService) UpdateDBService(ctx context.Context, req *dmsV2.UpdateDBSer
return err
}
for _, additionalParam := range req.DBService.AdditionalParams {
if isDeprecatedMongoAdditionalParam(req.DBService.DBType, additionalParam.Name) {
continue
}
if isRedisConnectionModeParam(req.DBService.DBType, additionalParam.Name) {
if err := setRedisConnectionModeParam(&additionalParams, additionalParam.Value); err != nil {
return err
Expand Down Expand Up @@ -122,6 +125,9 @@ func (d *DMSService) CheckDBServiceIsConnectableById(ctx context.Context, req *d

var additionParams []*dmsCommonV1.AdditionalParam
for _, item := range dbService.AdditionalParams {
if isDeprecatedMongoAdditionalParam(dbService.DBType, item.Key) {
continue
}
additionParams = append(additionParams, &dmsCommonV1.AdditionalParam{
Name: item.Key,
Value: item.Value,
Expand Down Expand Up @@ -259,6 +265,9 @@ func (d *DMSService) AddDBService(ctx context.Context, req *dmsV1.AddDBServiceRe
return nil, err
}
for _, additionalParam := range req.DBService.AdditionalParams {
if isDeprecatedMongoAdditionalParam(req.DBService.DBType, additionalParam.Name) {
continue
}
if isRedisConnectionModeParam(req.DBService.DBType, additionalParam.Name) {
if err := setRedisConnectionModeParam(&additionalParams, additionalParam.Value); err != nil {
return nil, err
Expand Down Expand Up @@ -329,6 +338,9 @@ func (d *DMSService) AddDBServiceV2(ctx context.Context, req *dmsV2.AddDBService
return nil, err
}
for _, additionalParam := range req.DBService.AdditionalParams {
if isDeprecatedMongoAdditionalParam(req.DBService.DBType, additionalParam.Name) {
continue
}
if isRedisConnectionModeParam(req.DBService.DBType, additionalParam.Name) {
if err := setRedisConnectionModeParam(&additionalParams, additionalParam.Value); err != nil {
return nil, err
Expand Down
19 changes: 19 additions & 0 deletions internal/dms/service/mongo_legacy_params.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
package service

import "strings"

// Deprecated Mongo additional_params removed from plugin meta; ignore if still present on old datasources/requests.
var deprecatedMongoAdditionalParams = map[string]struct{}{
"auth_mechanism": {},
"tls": {},
"tls_skip_verify": {},
"direct_connection": {},
}

func isDeprecatedMongoAdditionalParam(dbType, name string) bool {
if !strings.EqualFold(dbType, "MongoDB") {
return false
}
_, ok := deprecatedMongoAdditionalParams[name]
return ok
}
27 changes: 4 additions & 23 deletions internal/sql_workbench/service/sql_workbench_service.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -861,13 +861,9 @@ type datasourceBaseInfo struct {
}

const (
mongoDefaultDatabaseParam = "default_database"
mongoAuthDatabaseParam = "auth_source"
mongoAuthMechanismParam = "auth_mechanism"
mongoReplicaSetParam = "replica_set"
mongoTLSEnabledParam = "tls"
mongoDirectConnectionParam = "direct_connection"
mongoTLSSkipVerifyParam = "tls_skip_verify"
mongoDefaultDatabaseParam = "default_database"
mongoAuthDatabaseParam = "auth_source"
mongoReplicaSetParam = "replica_set"
redisDefaultDatabaseParam = "default_database"
)

Expand Down Expand Up @@ -1039,25 +1035,10 @@ func buildMongoDatasourceOptions(dbService *biz.DBService) (*string, interface{}
if authDB := dbService.AdditionalParams.GetParam(mongoAuthDatabaseParam).String(); authDB != "" {
jdbcParams["authSource"] = authDB
}
if authMechanism := dbService.AdditionalParams.GetParam(mongoAuthMechanismParam).String(); authMechanism != "" {
jdbcParams["authMechanism"] = authMechanism
}
// Legacy keys auth_mechanism / tls / tls_skip_verify / direct_connection are ignored if present.
if replicaSet := dbService.AdditionalParams.GetParam(mongoReplicaSetParam).String(); replicaSet != "" {
jdbcParams["replicaSet"] = replicaSet
}
if tlsParam := dbService.AdditionalParams.GetParam(mongoTLSEnabledParam); tlsParam != nil && tlsParam.String() != "" {
if tlsParam.Bool() {
jdbcParams["tls"] = "true"
} else {
jdbcParams["tls"] = "false"
}
}
if dbService.AdditionalParams.GetParam(mongoDirectConnectionParam).Bool() {
jdbcParams["directConnection"] = true
}
if dbService.AdditionalParams.GetParam(mongoTLSSkipVerifyParam).Bool() {
jdbcParams["tlsInsecure"] = true
}

if len(jdbcParams) == 0 {
return defaultSchema, nil, nil
Expand Down
37 changes: 22 additions & 15 deletions internal/sql_workbench/service/sql_workbench_service_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -217,11 +217,11 @@ func Test_buildMongoDatasourceOptions(t *testing.T) {
AdditionalParams: pkgParams.Params{
&pkgParams.Param{Key: mongoDefaultDatabaseParam, Value: defaultDB, Type: pkgParams.ParamTypeString},
&pkgParams.Param{Key: mongoAuthDatabaseParam, Value: "admin", Type: pkgParams.ParamTypeString},
&pkgParams.Param{Key: mongoAuthMechanismParam, Value: "SCRAM-SHA-256", Type: pkgParams.ParamTypeString},
&pkgParams.Param{Key: "auth_mechanism", Value: "SCRAM-SHA-256", Type: pkgParams.ParamTypeString},
&pkgParams.Param{Key: mongoReplicaSetParam, Value: "rs0", Type: pkgParams.ParamTypeString},
&pkgParams.Param{Key: mongoTLSEnabledParam, Value: "true", Type: pkgParams.ParamTypeBool},
&pkgParams.Param{Key: mongoDirectConnectionParam, Value: "true", Type: pkgParams.ParamTypeBool},
&pkgParams.Param{Key: mongoTLSSkipVerifyParam, Value: "true", Type: pkgParams.ParamTypeBool},
&pkgParams.Param{Key: "tls", Value: "true", Type: pkgParams.ParamTypeBool},
&pkgParams.Param{Key: "direct_connection", Value: "true", Type: pkgParams.ParamTypeBool},
&pkgParams.Param{Key: "tls_skip_verify", Value: "true", Type: pkgParams.ParamTypeBool},
},
})
if defaultSchema == nil || *defaultSchema != defaultDB {
Expand All @@ -233,32 +233,39 @@ func Test_buildMongoDatasourceOptions(t *testing.T) {
if jdbcParams["authSource"] != "admin" {
t.Fatalf("unexpected authSource: %#v", jdbcParams["authSource"])
}
if jdbcParams["authMechanism"] != "SCRAM-SHA-256" {
t.Fatalf("unexpected authMechanism: %#v", jdbcParams["authMechanism"])
}
if jdbcParams["replicaSet"] != "rs0" {
t.Fatalf("unexpected replicaSet: %#v", jdbcParams["replicaSet"])
}
if jdbcParams["tls"] != "true" {
t.Fatalf("unexpected tls: %#v", jdbcParams["tls"])
if _, ok := jdbcParams["authMechanism"]; ok {
t.Fatalf("authMechanism must be ignored, got %#v", jdbcParams)
}
if jdbcParams["directConnection"] != true || jdbcParams["tlsInsecure"] != true {
t.Fatalf("unexpected jdbc params: %#v", jdbcParams)
if _, ok := jdbcParams["tls"]; ok {
t.Fatalf("tls must be ignored, got %#v", jdbcParams)
}
if _, ok := jdbcParams["directConnection"]; ok {
t.Fatalf("directConnection must be ignored, got %#v", jdbcParams)
}
if _, ok := jdbcParams["tlsInsecure"]; ok {
t.Fatalf("tlsInsecure must be ignored, got %#v", jdbcParams)
}
}

func Test_buildMongoDatasourceOptions_tlsOnly(t *testing.T) {
func Test_buildMongoDatasourceOptions_authAndReplicaOnly(t *testing.T) {
_, propertiesValue, jdbcParams := buildMongoDatasourceOptions(&biz.DBService{
DBType: string(pkgConst.DBTypeMongoDB),
AdditionalParams: pkgParams.Params{
&pkgParams.Param{Key: mongoTLSEnabledParam, Value: "true", Type: pkgParams.ParamTypeBool},
&pkgParams.Param{Key: mongoAuthDatabaseParam, Value: "admin", Type: pkgParams.ParamTypeString},
&pkgParams.Param{Key: mongoReplicaSetParam, Value: "rs0", Type: pkgParams.ParamTypeString},
},
})
if propertiesValue != nil {
t.Fatalf("expected nil properties, got %#v", propertiesValue)
}
if jdbcParams["tls"] != "true" {
t.Fatalf("expected tls in jdbcUrlParameters when only tls is configured, got %#v", jdbcParams)
if jdbcParams["authSource"] != "admin" || jdbcParams["replicaSet"] != "rs0" {
t.Fatalf("unexpected jdbc params: %#v", jdbcParams)
}
if len(jdbcParams) != 2 {
t.Fatalf("expected only authSource+replicaSet, got %#v", jdbcParams)
}
}

Expand Down