rework: update test, benchmarks and existing examples.

Trendyol · Sep 4, 2024 · c0e7f8c · c0e7f8c
1 parent 9179961
commit c0e7f8c
Show file tree

Hide file tree

Showing 5 changed files with 111 additions and 64 deletions.
diff --git a/benchmarks/complex_example_test.go b/benchmarks/complex_example_test.go
@@ -30,18 +30,16 @@ func createComplexQuery(id int) map[string]any {
 				es.Exists("blocks.reason.id"),
 			).
 			MinimumShouldMatch(1).
-			Boost(3.14),
-	)
-	query.Size(100)
-	query.From(5000)
-	query.Sort(
-		es.Sort("modifiedDate").Order(order.Desc),
-		es.Sort("name").Order(order.Asc),
-		es.Sort("indexedAt").Order(order.Asc),
-	)
-	query.Source().
-		Includes("id", "type", "indexedAt", "chapters").
-		Excludes("private.key", "cipher")
+			Boost(3.14)).
+		Size(100).
+		From(5000).
+		Sort(
+			es.Sort("modifiedDate").Order(order.Desc),
+			es.Sort("name").Order(order.Asc),
+			es.Sort("indexedAt").Order(order.Asc),
+		).
+		SourceIncludes("id", "type", "indexedAt", "chapters").
+		SourceExcludes("private.key", "cipher")
 
 	return query
 }

diff --git a/benchmarks/conditional_example_test.go b/benchmarks/conditional_example_test.go
@@ -28,16 +28,13 @@ func createConditionalQuery(items []int) map[string]any {
 			).
 			MustNot(
 				es.Exists("blocks.reason.id"),
-			),
-	).
+			)).
 		Size(100).
 		Sort(
 			es.Sort("modifiedDate").Order(order.Desc),
-		)
-
-	query.Source().
-		Includes("id", "type", "indexedAt", "chapters").
-		Excludes("private.key")
+		).
+		SourceIncludes("id", "type", "indexedAt", "chapters").
+		SourceExcludes("private.key")
 
 	return query
 }

diff --git a/benchmarks/intermediate_example_test.go b/benchmarks/intermediate_example_test.go
@@ -20,14 +20,10 @@ func createIntermediateQuery(id int) map[string]any {
 			).
 			Filter(
 				es.Terms("type", "DOC", "FILE"),
-			),
-	)
-	query.Size(45)
-	query.Sort(
-		es.Sort("name").Order(order.Asc),
-	)
-	query.Source().
-		Includes("id", "type", "indexedAt", "chapters")
+			)).
+		Size(45).
+		Sort(es.Sort("name").Order(order.Asc)).
+		SourceIncludes("id", "type", "indexedAt", "chapters")
 
 	return query
 }

diff --git a/es/query_test.go b/es/query_test.go
@@ -79,7 +79,7 @@ func Test_NewQuery_Bool_should_create_json_with_bool_field_inside_query(t *testi
 	assert.Equal(t, "{\"query\":{\"bool\":{}}}", bodyJSON)
 }
 
-////   Object   ////
+////   TrackTotalHits   ////
 
 func Test_Object_should_have_TrackTotalHits_method(t *testing.T) {
 	// Given
@@ -105,6 +105,8 @@ func Test_TrackTotalHits_should_add_track_total_hits_field_into_Object(t *testin
 	assert.True(t, trackTotalHits.(bool))
 }
 
+////   Size   ////
+
 func Test_Object_should_have_Size_method(t *testing.T) {
 	// Given
 	b := es.NewQuery(nil)
@@ -129,6 +131,8 @@ func Test_Size_should_add_size_field_into_Object(t *testing.T) {
 	assert.Equal(t, 123, size.(int))
 }
 
+////   From   ////
+
 func Test_Object_should_have_From_method(t *testing.T) {
 	// Given
 	b := es.NewQuery(nil)
@@ -153,6 +157,8 @@ func Test_From_should_add_from_field_into_Object(t *testing.T) {
 	assert.Equal(t, 1500, from.(int))
 }
 
+////   Sort   ////
+
 func Test_Object_should_have_Sort_method(t *testing.T) {
 	// Given
 	b := es.NewQuery(nil)
@@ -226,85 +232,134 @@ func Test_Sort_should_add_sort_field_into_Object(t *testing.T) {
 	assert.Equal(t, "{\"query\":{},\"sort\":[{\"name\":{\"order\":\"desc\"}}]}", bodyJSON)
 }
 
-func Test_Object_should_have_Source_method(t *testing.T) {
+////   Source   ////
+
+func Test_Object_should_have_SourceIncludes_method(t *testing.T) {
 	// Given
 	b := es.NewQuery(nil)
 
 	// When Then
-	assert.NotNil(t, b.Source)
+	assert.NotNil(t, b.SourceIncludes())
 }
 
-func Test_Source_should_add_source_field_into_Object(t *testing.T) {
+func Test_SourceIncludes_should_add_source_field_with_includes_to_Object(t *testing.T) {
 	// Given
 	query := es.NewQuery(nil)
 
 	// When
 	_, beforeExists := query["_source"]
-	query.Source()
+	query.SourceIncludes("test")
 	source, afterExists := query["_source"]
 
 	// Then
-	assert.NotNil(t, source)
 	assert.False(t, beforeExists)
 	assert.True(t, afterExists)
-	assert.IsTypeString(t, "es.sourceType", source)
+	assert.NotNil(t, source)
+	assert.IsTypeString(t, "es.Object", source)
 	bodyJSON := assert.MarshalWithoutError(t, query)
-	assert.Equal(t, "{\"_source\":{},\"query\":{}}", bodyJSON)
+	assert.Equal(t, "{\"_source\":{\"includes\":[\"test\"]},\"query\":{}}", bodyJSON)
 }
 
-func Test_Source_should_have_Includes_method(t *testing.T) {
+func Test_SourceIncludes_should_apped_includes_when_it_already_exists_in_the_source(t *testing.T) {
 	// Given
-	query := es.NewQuery(nil)
+	query := es.NewQuery(nil).SourceIncludes("first", "second")
 
 	// When
-	source := query.Source()
+	_, beforeExists := query["_source"]
+	query.
+		SourceIncludes("third").
+		SourceIncludes("fourth", "fifth")
+	source, afterExists := query["_source"]
 
 	// Then
+	assert.True(t, beforeExists)
+	assert.True(t, afterExists)
 	assert.NotNil(t, source)
-	assert.IsTypeString(t, "es.sourceType", source)
-	assert.NotNil(t, source.Includes)
+	assert.IsTypeString(t, "es.Object", source)
+	bodyJSON := assert.MarshalWithoutError(t, query)
+	// nolint:golint,lll
+	assert.Equal(t, "{\"_source\":{\"includes\":[\"first\",\"second\",\"third\",\"fourth\",\"fifth\"]},\"query\":{}}", bodyJSON)
 }
 
-func Test_Source_should_have_Excludes_method(t *testing.T) {
+func Test_SourceIncludes_should_not_add_includes_to_Object_when_fields_are_empty(t *testing.T) {
 	// Given
 	query := es.NewQuery(nil)
 
 	// When
-	source := query.Source()
+	_, beforeExists := query["_source"]
+	query.SourceIncludes() // empty
+	source, afterExists := query["_source"]
 
 	// Then
-	assert.NotNil(t, source)
-	assert.IsTypeString(t, "es.sourceType", source)
-	assert.NotNil(t, source.Excludes)
+	assert.False(t, beforeExists)
+	assert.False(t, afterExists)
+	assert.Nil(t, source)
+	bodyJSON := assert.MarshalWithoutError(t, query)
+	assert.Equal(t, "{\"query\":{}}", bodyJSON)
+}
+
+func Test_Object_should_have_SourceExcludes_method(t *testing.T) {
+	// Given
+	b := es.NewQuery(nil)
+
+	// When Then
+	assert.NotNil(t, b.SourceExcludes())
 }
 
-func Test_Source_should_create_json_with_source_field(t *testing.T) {
+func Test_SourceExcludes_should_add_source_field_with_excludes_to_Object(t *testing.T) {
 	// Given
 	query := es.NewQuery(nil)
 
 	// When
-	query.Source().
-		Includes("hello", "world").
-		Excludes("Lorem", "Ipsum")
+	_, beforeExists := query["_source"]
+	query.SourceExcludes("test")
+	source, afterExists := query["_source"]
+
+	// Then
+	assert.False(t, beforeExists)
+	assert.True(t, afterExists)
+	assert.NotNil(t, source)
+	assert.IsTypeString(t, "es.Object", source)
+	bodyJSON := assert.MarshalWithoutError(t, query)
+	assert.Equal(t, "{\"_source\":{\"excludes\":[\"test\"]},\"query\":{}}", bodyJSON)
+}
+
+func Test_SourceExcludes_should_apped_excludes_when_it_already_exists_in_the_source(t *testing.T) {
+	// Given
+	query := es.NewQuery(nil).SourceExcludes("first", "second")
+
+	// When
+	_, beforeExists := query["_source"]
+	query.
+		SourceExcludes("third").
+		SourceExcludes("fourth", "fifth")
+	source, afterExists := query["_source"]
 
+	// Then
+	assert.True(t, beforeExists)
+	assert.True(t, afterExists)
+	assert.NotNil(t, source)
+	assert.IsTypeString(t, "es.Object", source)
 	bodyJSON := assert.MarshalWithoutError(t, query)
-	assert.Equal(t, "{\"_source\":{\"excludes\":[\"Lorem\",\"Ipsum\"],\"includes\":[\"hello\",\"world\"]},\"query\":{}}", bodyJSON)
+	// nolint:golint,lll
+	assert.Equal(t, "{\"_source\":{\"excludes\":[\"first\",\"second\",\"third\",\"fourth\",\"fifth\"]},\"query\":{}}", bodyJSON)
 }
 
-func Test_Source_should_append_existing_fields(t *testing.T) {
+func Test_SourceExcludes_should_not_add_excludes_to_Object_when_fields_are_empty(t *testing.T) {
 	// Given
 	query := es.NewQuery(nil)
 
 	// When
-	query.Source().
-		Includes("hello", "world").
-		Excludes("Lorem", "Ipsum").
-		Includes("golang", "gopher").
-		Excludes("Metallica", "Iron Maiden")
+	_, beforeExists := query["_source"]
+	query.SourceExcludes() // empty
+	source, afterExists := query["_source"]
 
+	// Then
+	assert.False(t, beforeExists)
+	assert.False(t, afterExists)
+	assert.Nil(t, source)
 	bodyJSON := assert.MarshalWithoutError(t, query)
-	// nolint:golint,lll
-	assert.Equal(t, "{\"_source\":{\"excludes\":[\"Lorem\",\"Ipsum\",\"Metallica\",\"Iron Maiden\"],\"includes\":[\"hello\",\"world\",\"golang\",\"gopher\"]},\"query\":{}}", bodyJSON)
+	assert.Equal(t, "{\"query\":{}}", bodyJSON)
 }
 
 func Test_Object_should_have_SourceFalse_method(t *testing.T) {
@@ -333,6 +388,8 @@ func Test_SourceFalse_should_set_source_field_as_false(t *testing.T) {
 	assert.Equal(t, "{\"_source\":false,\"query\":{}}", bodyJSON)
 }
 
+////   Aggs   ////
+
 func Test_Object_should_have_Aggs_method(t *testing.T) {
 	// Given
 	b := es.NewQuery(nil)

diff --git a/example/example.go b/example/example.go
@@ -95,11 +95,10 @@ func buildQuery(id int) es.Object {
 			).
 			Filter(
 				es.Terms("type", "DOC", "FILE"),
-			),
-	)
-	query.Size(45)
-	query.Sort(es.Sort("name").Order(order.Asc))
-	query.Source().
-		Includes("id", "type", "indexedAt", "chapters")
+			)).
+		Size(45).
+		Sort(es.Sort("name").Order(order.Asc)).
+		SourceIncludes("id", "type", "indexedAt", "chapters")
+
 	return query
 }