Skip to content

feat(specs): add compositions deduplication setting #5418

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

Merged
merged 7 commits into from
Oct 2, 2025
+378 −31
Merged

feat(specs): add compositions deduplication setting #5418

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
3d93cf1
add deduplication field
ben-kalmus Sep 30, 2025
e3cc3d5
add comp rule test
ben-kalmus Sep 30, 2025
7f1c198
improve setting description
ben-kalmus Sep 30, 2025
0ea81d5
add batch tests
ben-kalmus Sep 30, 2025
91d2c0d
add required field for positioning
ben-kalmus Sep 30, 2025
c84299a
rename injected item key
ben-kalmus Oct 1, 2025
de01c21
modify injected item key
ben-kalmus Oct 1, 2025
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
24 changes: 24 additions & 0 deletions specs/composition/common/schemas/components/CompositionBehavior.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,16 @@ compositionBehavior:
maxItems: 2
items:
$ref: '#/injectedItem'
deduplication:
title: deduplication
type: object
additionalProperties: false
description: Deduplication configures the methods used to resolve duplicate items between main search results and injected group results.
properties:
positioning:
$ref: '#/dedupPositioning'
required:
- positioning
required:
- main
required:
Expand Down Expand Up @@ -91,3 +101,17 @@ injectedItemSource:
oneOf:
- $ref: './InjectionSource.yml#/SearchSource'
- $ref: './InjectionSource.yml#/ExternalSource'

dedupPositioning:
type: string
enum:
- highest
- highestInjected
description: |
Deduplication positioning configures how a duplicate result should be resolved between an injected item and main search results.
Current configuration supports:
- 'highest': always select the item in the highest position, and remove duplicates that appear lower in the results.
- 'highestInjected': duplicate result will be moved to its highest possible injected position, but not higher.
If a duplicate appears higher in main search results, it will be removed to stay it's intended group position (which could be lower than main).
example: highest
default: highestInjected
89 changes: 83 additions & 6 deletions tests/CTS/requests/composition/multipleBatch.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,9 +62,7 @@
}
},
{
"skipLanguages": [
"kotlin"
],
"skipLanguages": ["kotlin"],
"parameters": {
"requests": [
{
Expand Down Expand Up @@ -147,9 +145,7 @@
}
},
{
"skipLanguages": [
"kotlin"
],
"skipLanguages": ["kotlin"],
"parameters": {
"requests": [
{
Expand Down Expand Up @@ -312,5 +308,86 @@
]
}
}
},
{
"skipLanguages": ["kotlin"],
"parameters": {
"requests": [
{
"action": "upsert",
"body": {
"objectID": "my-compo",
"name": "my composition",
"behavior": {
"injection": {
"main": {
"source": {
"search": {
"index": "foo"
}
}
},
"injectedItems": [
{
"key": "injectedItem1",
"source": {
"search": {
"index": "foo"
}
},
"position": 2,
"length": 1
}
],
"deduplication": {
"positioning": "highest"
}
}
}
}
}
]
},
"request": {
"path": "/1/compositions/*/batch",
"method": "POST",
"body": {
"requests": [
{
"action": "upsert",
"body": {
"objectID": "my-compo",
"name": "my composition",
"behavior": {
"injection": {
"main": {
"source": {
"search": {
"index": "foo"
}
}
},
"injectedItems": [
{
"key": "injectedItem1",
"source": {
"search": {
"index": "foo"
}
},
"position": 2,
"length": 1
}
],
"deduplication": {
"positioning": "highest"
}
}
}
}
}
]
}
}
}
]
79 changes: 76 additions & 3 deletions tests/CTS/requests/composition/putComposition.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,9 +134,7 @@
}
},
{
"skipLanguages": [
"kotlin"
],
"skipLanguages": ["kotlin"],
"parameters": {
"compositionID": "my-metadata-compo",
"composition": {
Expand Down Expand Up @@ -288,5 +286,80 @@
}
}
}
},
{
"parameters": {
"compositionID": "my-compo",
"composition": {
"objectID": "my-compo",
"name": "my composition",
"behavior": {
"injection": {
"main": {
"source": {
"search": {
"index": "foo",
"params": {
"filters": "brand:adidas"
}
}
}
},
"injectedItems": [
{
"key": "injectedItem1",
"source": {
"search": {
"index": "foo"
}
},
"position": 2,
"length": 1
}
],
"deduplication": {
"positioning": "highest"
}
}
}
}
},
"request": {
"path": "/1/compositions/my-compo",
"method": "PUT",
"body": {
"objectID": "my-compo",
"name": "my composition",
"behavior": {
"injection": {
"main": {
"source": {
"search": {
"index": "foo",
"params": {
"filters": "brand:adidas"
}
}
}
},
"injectedItems": [
{
"key": "injectedItem1",
"source": {
"search": {
"index": "foo"
}
},
"position": 2,
"length": 1
}
],
"deduplication": {
"positioning": "highest"
}
}
}
}
}
}
]
102 changes: 91 additions & 11 deletions tests/CTS/requests/composition/putCompositionRule.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,9 +78,7 @@
}
},
{
"skipLanguages": [
"kotlin"
],
"skipLanguages": ["kotlin"],
"parameters": {
"compositionID": "compositionID",
"objectID": "rule-with-metadata",
Expand Down Expand Up @@ -197,10 +195,7 @@
"compositionRule": {
"objectID": "rule-with-exernal-source",
"description": "my description",
"tags": [
"tag1",
"tag2"
],
"tags": ["tag1", "tag2"],
"enabled": true,
"validity": [
{
Expand Down Expand Up @@ -258,10 +253,7 @@
"body": {
"objectID": "rule-with-exernal-source",
"description": "my description",
"tags": [
"tag1",
"tag2"
],
"tags": ["tag1", "tag2"],
"enabled": true,
"validity": [
{
Expand Down Expand Up @@ -313,5 +305,93 @@
}
}
}
},
{
"parameters": {
"compositionID": "compositionID",
"objectID": "rule-with-deduplication",
"compositionRule": {
"objectID": "rule-with-deduplication",
"description": "my description",
"enabled": true,
"conditions": [
{
"anchoring": "contains",
"pattern": "harry"
}
],
"consequence": {
"behavior": {
"injection": {
"main": {
"source": {
"search": {
"index": "my-index"
}
}
},
"injectedItems": [
{
"key": "injectedItem",
"source": {
"search": {
"index": "my-index"
}
},
"position": 0,
"length": 3
}
],
"deduplication": {
"positioning": "highestInjected"
}
}
}
}
}
},
"request": {
"path": "/1/compositions/compositionID/rules/rule-with-deduplication",
"method": "PUT",
"body": {
"objectID": "rule-with-deduplication",
"description": "my description",
"enabled": true,
"conditions": [
{
"anchoring": "contains",
"pattern": "harry"
}
],
"consequence": {
"behavior": {
"injection": {
"main": {
"source": {
"search": {
"index": "my-index"
}
}
},
"injectedItems": [
{
"key": "injectedItem",
"source": {
"search": {
"index": "my-index"
}
},
"position": 0,
"length": 3
}
],
"deduplication": {
"positioning": "highestInjected"
}
}
}
}
}
}
}
]
Loading