Skip to content
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.

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

DOP-3948 #64

Merged
merged 4 commits into from
Aug 17, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
52 changes: 48 additions & 4 deletions mut/index/SnootyManifest.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,23 @@
logger = logging.getLogger(__name__)


class Facet:
def __init__(self, category: str, value: str, sub_facets: [List[object]]) -> None:
self.category = category
self.value = value
self.sub_facets = None

for sub_facet in sub_facets:
self.sub_facets = self.sub_facets or []
self.sub_facets.append(
Facet(
category=sub_facet["category"],
value=sub_facet["value"],
sub_facets=sub_facet["sub_facets"] or [],
)
)


class ManifestEntry(TypedDict):
slug: str
title: Optional[str]
Expand All @@ -20,14 +37,13 @@ class ManifestEntry(TypedDict):
code: dict
preview: Optional[str]
tags: List[str]
facets: Optional[Dict[str, Any]]
facets: Optional[Dict[str, List[str]]]


class Document:
"""Return indexing data from a page's AST for search purposes."""

def __init__(self, data) -> None:

self.tree = data[0]

self.robots, self.keywords, self.description = self.find_metadata()
Expand Down Expand Up @@ -125,13 +141,41 @@ def derive_preview(self) -> Optional[str]:
return None

def derive_facets(self) -> Optional[Dict[str, Any]]:
logger.debug("finding facets")
"""
Format facets for ManifestEntry from bson entry tree['facets'] if it exists
"""
document_facets: Dict[str, List[str]] = {}
HIERARCHY_KEY = ">"

# recursive function to look within facets.sub_facets<facets[]>
def insert_key_values(facet: Facet, prefix: str = ""):
key = prefix + facet.category
document_facets[key] = document_facets.get(key, [])
document_facets[key].append(facet.value)
if not facet.sub_facets:
return
for sub_facet in facet.sub_facets:
insert_key_values(
sub_facet, key + HIERARCHY_KEY + facet.value + HIERARCHY_KEY
)

def create_facet(facet_entry: object):
facet = Facet(
category=facet_entry["category"],
value=facet_entry["value"],
sub_facets=facet_entry["sub_facets"] or [],
)
insert_key_values(facet)

try:
if self.tree["facets"]:
return self.tree["facets"]
for facet_entry in self.tree["facets"]:
create_facet(facet_entry)
except KeyError:
return None

return document_facets

def find_metadata(self):
logger.debug("Finding metadata")
robots: str = True
Expand Down
7 changes: 6 additions & 1 deletion mut/index/test_SnootyManifest.py
Original file line number Diff line number Diff line change
Expand Up @@ -147,5 +147,10 @@ def test_generate_manifest() -> None:
def test_derive_facets() -> None:
# Test facets derived from page
document = setup_doc(ROOT_PATH, "facet_example.bson")
expected = {"genres": [{"name": "reference"}]}
expected = {
"programming_language": ["cpp"],
"genre": ["reference"],
"target_product": ["atlas"],
"target_product>atlas>sub_product": ["search"],
}
assert document["facets"] == expected
Binary file modified mut/test_data_index/documents/facet_example.bson
Binary file not shown.