Skip to content

Commit 8456d9e

Browse files
authored
feat(specs): support algoliaDefined ordering in external sources (#7212)
Signed-off-by: Anca Iordache <809903+aiordache@users.noreply.github.com>
1 parent fec5d34 commit 8456d9e

2 files changed

Lines changed: 43 additions & 14 deletions

File tree

‎specs/composition/common/schemas/components/source/External.yml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,6 @@ baseExternalSource:
1616
- index
1717

1818
externalOrdering:
19-
description: Ordering to apply on the injected items coming from the external source. 'default' means the items will be ordered as they are in the index (natural relevance) in the smart group. 'userDefined' means the order in which the objectIDs are provided in the run request payload will be preserved in the smart group.
20-
enum: ['default', 'userDefined']
21-
default: 'default'
19+
description: Ordering to apply on the injected items coming from the external source. 'algoliaDefined' means the items will be ordered as they are in the index (natural relevance) in the smart group. 'userDefined' means the order in which the objectIDs are provided in the run request payload will be preserved in the smart group.
20+
enum: ['algoliaDefined', 'default', 'userDefined']
21+
default: 'algoliaDefined'

‎tests/output/go/tests/manual/composition_oneof_test.go‎

Lines changed: 40 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -28,17 +28,46 @@ func TestInjectedItemSource_UnmarshalSearchSource(t *testing.T) {
2828
func TestInjectedItemSource_UnmarshalExternalSource(t *testing.T) {
2929
t.Parallel()
3030

31-
input := `{"external": {"index": "sponsored", "ordering": "userDefined"}}`
32-
33-
var source composition.InjectedItemSource
34-
35-
err := json.Unmarshal([]byte(input), &source)
36-
require.NoError(t, err)
37-
38-
require.NotNil(t, source.InjectedItemExternalSource, "expected External Source to be set")
39-
require.Nil(t, source.InjectedItemSearchSource, "expected Search Source to be nil")
40-
require.Nil(t, source.InjectedItemRecommendSource, "expected RecommendSource to be nil")
41-
require.Equal(t, "sponsored", source.InjectedItemExternalSource.External.Index)
31+
orderingUserDefined := "userDefined"
32+
orderingDefault := "default"
33+
orderingAlgoliaDefined := "algoliaDefined"
34+
35+
for name, testcase := range map[string]struct {
36+
input string
37+
expectedIndex string
38+
expectedOrdering *string
39+
}{
40+
"nominal": {
41+
input: `{"external": {"index": "sponsored"}}`,
42+
expectedIndex: "sponsored",
43+
},
44+
"with-default-ordering": {
45+
input: `{"external": {"index": "sponsored", "ordering": "default"}}`,
46+
expectedIndex: "sponsored",
47+
expectedOrdering: &orderingDefault,
48+
},
49+
"with-userDefined-ordering": {
50+
input: `{"external": {"index": "sponsored", "ordering": "userDefined"}}`,
51+
expectedIndex: "sponsored",
52+
expectedOrdering: &orderingUserDefined,
53+
},
54+
"with-algoliaDefined-ordering": {
55+
input: `{"external": {"index": "sponsored", "ordering": "algoliaDefined"}}`,
56+
expectedIndex: "sponsored",
57+
expectedOrdering: &orderingAlgoliaDefined,
58+
},
59+
} {
60+
t.Run(name, func(t *testing.T) {
61+
var source composition.InjectedItemSource
62+
err := json.Unmarshal([]byte(testcase.input), &source)
63+
require.NoError(t, err)
64+
require.NotNil(t, source.InjectedItemExternalSource, "expected External Source to be set")
65+
require.Nil(t, source.InjectedItemSearchSource, "expected Search Source to be nil")
66+
require.Nil(t, source.InjectedItemRecommendSource, "expected RecommendSource to be nil")
67+
require.Equal(t, testcase.expectedIndex, source.InjectedItemExternalSource.External.Index)
68+
require.EqualValues(t, testcase.expectedOrdering, source.InjectedItemExternalSource.External.Ordering)
69+
})
70+
}
4271
}
4372

4473
func TestInjectedItemSource_UnmarshalRecommendSource(t *testing.T) {

0 commit comments

Comments
 (0)