separate flags

FerretDB · AlekSi · Nov 20, 2023 · Nov 9, 2023 · Nov 9, 2023 · Nov 9, 2023
commit 84ad078b5d4f56a9b03acdc6d12d7169a015a78e
diff --git a/Taskfile.yml b/Taskfile.yml
@@ -10,6 +10,7 @@ vars:
   SHARD_TOTAL: 1
   DISABLE_FILTER_PUSHDOWN: false
   ENABLE_SORT_PUSHDOWN: false
+  ENABLE_UNSAFE_SORT_PUSHDOWN: false
   TEST_RUN: ""
   TEST_TIMEOUT: 35m
   BENCH_TIME: 5s
@@ -219,6 +220,7 @@ tasks:
         -compat-url='mongodb://username:password@127.0.0.1:47018/?tls=true&tlsCertificateKeyFile=../build/certs/client.pem&tlsCaFile=../build/certs/rootCA-cert.pem'
         -disable-filter-pushdown={{.DISABLE_FILTER_PUSHDOWN}}
         -enable-sort-pushdown={{.ENABLE_SORT_PUSHDOWN}}
+        -enable-unsafe-sort-pushdown={{.ENABLE_UNSAFE_SORT_PUSHDOWN}}
 
   test-integration-sqlite:
     desc: "Run integration tests for `sqlite` backend"
@@ -245,6 +247,7 @@ tasks:
         -compat-url='mongodb://username:password@127.0.0.1:47018/?tls=true&tlsCertificateKeyFile=../build/certs/client.pem&tlsCaFile=../build/certs/rootCA-cert.pem'
         -disable-filter-pushdown={{.DISABLE_FILTER_PUSHDOWN}}
         -enable-sort-pushdown={{.ENABLE_SORT_PUSHDOWN}}
+        -enable-unsafe-sort-pushdown={{.ENABLE_UNSAFE_SORT_PUSHDOWN}}
 
   test-integration-hana:
     desc: "Run integration tests for `hana` handler"
@@ -271,6 +274,7 @@ tasks:
         -compat-url='mongodb://username:password@127.0.0.1:47018/?tls=true&tlsCertificateKeyFile=../build/certs/client.pem&tlsCaFile=../build/certs/rootCA-cert.pem'
         -disable-filter-pushdown={{.DISABLE_FILTER_PUSHDOWN}}
         -enable-sort-pushdown={{.ENABLE_SORT_PUSHDOWN}}
+        -enable-unsafe-sort-pushdown={{.ENABLE_UNSAFE_SORT_PUSHDOWN}}
 
   test-integration-mongodb:
     desc: "Run integration tests for MongoDB"

diff --git a/cmd/ferretdb/main.go b/cmd/ferretdb/main.go
@@ -86,9 +86,10 @@ var cli struct {
 	Test struct {
 		RecordsDir string `default:"" help:"Testing: directory for record files."`
 
-		DisableFilterPushdown bool `default:"false" help:"Experimental: disable filter pushdown."`
-		EnableSortPushdown    bool `default:"false" help:"Experimental: enable sort pushdown."`
-		EnableOplog           bool `default:"false" help:"Experimental: enable capped collections, tailable cursors and OpLog." hidden:""`
+		DisableFilterPushdown    bool `default:"false" help:"Experimental: disable filter pushdown."`
+		EnableSortPushdown       bool `default:"false" help:"Experimental: enable sort pushdown."`
+		EnableUnsafeSortPushdown bool `default:"false" help:"Experimental: enable unsafe sort pushdown."`
+		EnableOplog              bool `default:"false" help:"Experimental: enable capped collections, tailable cursors and OpLog." hidden:""`
 
 		//nolint:lll // for readability
 		Telemetry struct {
@@ -381,9 +382,10 @@ func run() {
 		HANAURL: hanaFlags.HANAURL,
 
 		TestOpts: registry.TestOpts{
-			DisableFilterPushdown: cli.Test.DisableFilterPushdown,
-			EnableSortPushdown:    cli.Test.EnableSortPushdown,
-			EnableOplog:           cli.Test.EnableOplog,
+			DisableFilterPushdown:    cli.Test.DisableFilterPushdown,
+			EnableSortPushdown:       cli.Test.EnableSortPushdown,
+			EnableUnsafeSortPushdown: cli.Test.EnableUnsafeSortPushdown,
+			EnableOplog:              cli.Test.EnableOplog,
 		},
 	})
 	if err != nil {

diff --git a/integration/setup/listener.go b/integration/setup/listener.go
@@ -159,9 +159,10 @@
 		HANAURL:       *hanaURLF,
 
 		TestOpts: registry.TestOpts{
-			DisableFilterPushdown: *disableFilterPushdownF,
-			EnableSortPushdown:    *enableSortPushdownF,
-			EnableOplog:           true,
+			DisableFilterPushdown:    *disableFilterPushdownF,
+			EnableSortPushdown:       *enableSortPushdownF,
+			EnableUnsafeSortPushdown: *enableUnsafeSortPushdownF,
+			EnableOplog:              true,
 		},
 	}
 	h, err := registry.NewHandler(handler, handlerOpts)
@@ -184,6 +185,10 @@
 		tb.Fatal("Both -target-tls and -target-unix-socket are set.")
 	}
 
+	if *enableSortPushdownF && *enableUnsafeSortPushdownF {
+		tb.Fatal("Both -enable-sort-pushdown and -enable-unsafe-sort-pushdown are set.")
+	}
+
 	switch {
 	case *targetTLSF:
 		listenerOpts.TLS = "127.0.0.1:0"

diff --git a/integration/setup/setup.go b/integration/setup/setup.go
@@ -59,8 +59,9 @@ var (
 	debugSetupF = flag.Bool("debug-setup", false, "enable debug logs for tests setup")
 	logLevelF   = zap.LevelFlag("log-level", zap.DebugLevel, "log level for tests")
 
-	disableFilterPushdownF = flag.Bool("disable-filter-pushdown", false, "disable filter pushdown")
-	enableSortPushdownF    = flag.Bool("enable-sort-pushdown", false, "enable sort pushdown")
+	disableFilterPushdownF    = flag.Bool("disable-filter-pushdown", false, "disable filter pushdown")
+	enableSortPushdownF       = flag.Bool("enable-sort-pushdown", false, "enable sort pushdown")
+	enableUnsafeSortPushdownF = flag.Bool("enable-unsafe-sort-pushdown", false, "enable unsafe sort pushdown")
 )
 
 // Other globals.

diff --git a/internal/handlers/registry/hana.go b/internal/handlers/registry/hana.go
@@ -34,9 +34,10 @@
 			ConnMetrics:   opts.ConnMetrics,
 			StateProvider: opts.StateProvider,
 
-			DisableFilterPushdown: opts.DisableFilterPushdown,
-			EnableSortPushdown:    opts.EnableSortPushdown,
-			EnableOplog:           opts.EnableOplog,
+			DisableFilterPushdown:    opts.DisableFilterPushdown,
+			EnableSortPushdown:       opts.EnableSortPushdown,
+			EnableUnsafeSortPushdown: opts.EnableUnsafeSortPushdown,
+			EnableOplog:              opts.EnableOplog,
 		}
 
 		return sqlite.New(handlerOpts)

diff --git a/internal/handlers/registry/postgresql.go b/internal/handlers/registry/postgresql.go
@@ -30,9 +30,10 @@ func init() {
 			ConnMetrics:   opts.ConnMetrics,
 			StateProvider: opts.StateProvider,
 
-			DisableFilterPushdown: opts.DisableFilterPushdown,
-			EnableSortPushdown:    opts.EnableSortPushdown,
-			EnableOplog:           opts.EnableOplog,
+			DisableFilterPushdown:    opts.DisableFilterPushdown,
+			EnableSortPushdown:       opts.EnableSortPushdown,
+			EnableUnsafeSortPushdown: opts.EnableUnsafeSortPushdown,
+			EnableOplog:              opts.EnableOplog,
 		}
 
 		return sqlite.New(handlerOpts)

diff --git a/internal/handlers/registry/registry.go b/internal/handlers/registry/registry.go
@@ -55,9 +55,10 @@ type NewHandlerOpts struct {
 
 // TestOpts represents experimental configuration options.
 type TestOpts struct {
-	DisableFilterPushdown bool
-	EnableSortPushdown    bool
-	EnableOplog           bool
+	DisableFilterPushdown    bool
+	EnableSortPushdown       bool
+	EnableUnsafeSortPushdown bool
+	EnableOplog              bool
 }
 
 // NewHandler constructs a new handler.

diff --git a/internal/handlers/registry/sqlite.go b/internal/handlers/registry/sqlite.go
@@ -30,9 +30,10 @@ func init() {
 			ConnMetrics:   opts.ConnMetrics,
 			StateProvider: opts.StateProvider,
 
-			DisableFilterPushdown: opts.DisableFilterPushdown,
-			EnableSortPushdown:    opts.EnableSortPushdown,
-			EnableOplog:           opts.EnableOplog,
+			DisableFilterPushdown:    opts.DisableFilterPushdown,
+			EnableSortPushdown:       opts.EnableSortPushdown,
+			EnableUnsafeSortPushdown: opts.EnableUnsafeSortPushdown,
+			EnableOplog:              opts.EnableOplog,
 		}
 
 		return sqlite.New(handlerOpts)

@@ -269,7 +269,7 @@ func (h *Handler) MsgAggregate(ctx context.Context, msg *wire.OpMsg) (*wire.OpMs
 		}
 
 		// Skip sorting if there are more than one sort parameters
-		if h.EnableSortPushdown && sort.Len() == 1 {
+		if h.EnableUnsafeSortPushdown && sort.Len() == 1 {
 			var order types.SortType
 
 			k := sort.Keys()[0]

@@ -88,7 +88,7 @@ func (h *Handler) MsgExplain(ctx context.Context, msg *wire.OpMsg) (*wire.OpMsg,
 	}
 
 	// Skip sorting if there are more than one sort parameters
-	if h.EnableSortPushdown && params.Sort.Len() == 1 {
+	if (h.EnableSortPushdown || h.EnableUnsafeSortPushdown) && params.Sort.Len() == 1 {
 		var order types.SortType
 
 		k := params.Sort.Keys()[0]
@@ -107,10 +107,10 @@ func (h *Handler) MsgExplain(ctx context.Context, msg *wire.OpMsg) (*wire.OpMsg,
 
 	// Limit pushdown is not applied if:
 	//  - `filter` is set, it must fetch all documents to filter them in memory;
-	//  - `sort` is set but `EnableSortPushdown` is not set, it must fetch all documents
+	//  - `sort` is set but `EnableUnsafeSortPushdown` is not set, it must fetch all documents
 	//  and sort them in memory;
 	//  - `skip` is non-zero value, skip pushdown is not supported yet.
-	if params.Filter.Len() == 0 && (params.Sort.Len() == 0 || h.EnableSortPushdown) && params.Skip == 0 {
+	if params.Filter.Len() == 0 && (params.Sort.Len() == 0 || h.EnableUnsafeSortPushdown) && params.Skip == 0 {
 		qp.Limit = params.Limit
 	}
 

diff --git a/internal/handlers/sqlite/msg_find.go b/internal/handlers/sqlite/msg_find.go
@@ -113,7 +113,7 @@ func (h *Handler) MsgFind(ctx context.Context, msg *wire.OpMsg) (*wire.OpMsg, er
 	}
 
 	// Skip sorting if there are more than one sort parameters
-	if h.EnableSortPushdown && params.Sort.Len() == 1 {
+	if (h.EnableSortPushdown || h.EnableUnsafeSortPushdown) && params.Sort.Len() == 1 {
 		var order types.SortType
 
 		k := params.Sort.Keys()[0]
@@ -132,10 +132,10 @@ func (h *Handler) MsgFind(ctx context.Context, msg *wire.OpMsg) (*wire.OpMsg, er
 
 	// Limit pushdown is not applied if:
 	//  - `filter` is set, it must fetch all documents to filter them in memory;
-	//  - `sort` is set but `EnableSortPushdown` is not set, it must fetch all documents
+	//  - `sort` is set but `EnableUnsafeSortPushdown` is not set, it must fetch all documents
 	//  and sort them in memory;
 	//  - `skip` is non-zero value, skip pushdown is not supported yet.
-	if params.Filter.Len() == 0 && (params.Sort.Len() == 0 || h.EnableSortPushdown) && params.Skip == 0 {
+	if params.Filter.Len() == 0 && (params.Sort.Len() == 0 || h.EnableUnsafeSortPushdown) && params.Skip == 0 {
 		qp.Limit = params.Limit
 	}
 

diff --git a/internal/handlers/sqlite/sqlite.go b/internal/handlers/sqlite/sqlite.go
@@ -53,9 +53,10 @@ type NewOpts struct {
 	StateProvider *state.Provider
 
 	// test options
-	DisableFilterPushdown bool
-	EnableSortPushdown    bool
-	EnableOplog           bool
+	DisableFilterPushdown    bool
+	EnableSortPushdown       bool
+	EnableUnsafeSortPushdown bool
+	EnableOplog              bool
 }
 
 // New returns a new handler.