Skip to content

compute top page origins for each collection #2483

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

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open
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
3 changes: 3 additions & 0 deletions backend/btrixcloud/colls.py
Original file line number Diff line number Diff line change
Expand Up @@ -705,6 +705,8 @@ async def update_collection_counts_and_tags(self, collection_id: UUID):

unique_page_count = await self.page_ops.get_unique_page_count(crawl_ids)

top_page_origins = await self.page_ops.get_top_page_origins(crawl_ids)

await self.collections.find_one_and_update(
{"_id": collection_id},
{
Expand All @@ -715,6 +717,7 @@ async def update_collection_counts_and_tags(self, collection_id: UUID):
"totalSize": total_size,
"tags": sorted_tags,
"preloadResources": preload_resources,
"topPageOrigins": top_page_origins,
}
},
)
Expand Down
12 changes: 12 additions & 0 deletions backend/btrixcloud/models.py
Original file line number Diff line number Diff line change
Expand Up @@ -1415,6 +1415,14 @@ class PreloadResource(BaseModel):
crawlId: str


# ============================================================================
class OriginCount(BaseModel):
"""Origin Count"""

origin: str
count: int


# ============================================================================
class Collection(BaseMongoModel):
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we include topPageOrigins in the base Collection model too, since we're storing it there? Might be useful for e.g. org import/export to have it on the base model.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, perhaps can rename this to domains internally too? We can strip out the https:// with the regex too, but maybe useful to keep since RWP does treat them separately..

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah not a bad idea to rename internally, and I would keep the prefix I think

"""Org collection structure"""
Expand Down Expand Up @@ -1513,6 +1521,8 @@ class CollOut(BaseMongoModel):
pagesQueryUrl: str = ""
downloadUrl: Optional[str] = None

topPageOrigins: List[OriginCount] = []


# ============================================================================
class PublicCollOut(BaseMongoModel):
Expand Down Expand Up @@ -1548,6 +1558,8 @@ class PublicCollOut(BaseMongoModel):

allowPublicDownload: bool = True

topPageOrigins: List[OriginCount] = []


# ============================================================================
class UpdateColl(BaseModel):
Expand Down
24 changes: 24 additions & 0 deletions backend/btrixcloud/pages.py
Original file line number Diff line number Diff line change
Expand Up @@ -923,6 +923,30 @@ async def get_unique_page_count(self, crawl_ids: List[str]) -> int:
res = await cursor.to_list(1)
return res[0].get("urls") if res else 0

async def get_top_page_origins(
self, crawl_ids: List[str]
) -> List[dict[str, str | int]]:
"""Get count of top page origins across all archived items"""
cursor = self.pages.aggregate(
[
{"$match": {"crawl_id": {"$in": crawl_ids}}},
{
"$addFields": {
"origin": {
"$regexFind": {
"input": "$url",
"regex": "^https?://([^/]+)",
}
}
}
},
{"$group": {"_id": "$origin.match", "count": {"$count": {}}}},
{"$sort": {"count": -1}},
]
)
res = await cursor.to_list(10)
return [{"origin": x.get("_id"), "count": x.get("count")} for x in res]

async def set_archived_item_page_counts(self, crawl_id: str):
"""Store archived item page and unique page counts in crawl document"""
page_count = await self.pages.count_documents({"crawl_id": crawl_id})
Expand Down
32 changes: 32 additions & 0 deletions backend/test/test_collections.py
Original file line number Diff line number Diff line change
Expand Up @@ -563,6 +563,10 @@ def test_add_upload_to_collection(crawler_auth_headers, default_org_id):
assert data["dateEarliest"]
assert data["dateLatest"]
assert data["defaultThumbnailName"]
assert data["topPageOrigins"]
for origin in data["topPageOrigins"]:
assert origin["origin"]
assert origin["count"]

# Verify it was added
r = requests.get(
Expand Down Expand Up @@ -625,6 +629,10 @@ def test_list_collections(
assert first_coll["dateEarliest"]
assert first_coll["dateLatest"]
assert first_coll["defaultThumbnailName"]
assert first_coll["topPageOrigins"]
for origin in first_coll["topPageOrigins"]:
assert origin["origin"]
assert origin["count"]

second_coll = [coll for coll in items if coll["name"] == SECOND_COLLECTION_NAME][0]
assert second_coll["id"]
Expand All @@ -641,6 +649,10 @@ def test_list_collections(
assert second_coll["access"] == "private"
assert second_coll["dateEarliest"]
assert second_coll["dateLatest"]
assert second_coll["topPageOrigins"]
for origin in second_coll["topPageOrigins"]:
assert origin["origin"]
assert origin["count"]


def test_list_pages_in_collection(crawler_auth_headers, default_org_id):
Expand Down Expand Up @@ -1137,6 +1149,10 @@ def test_list_public_collections(
assert collection["pageCount"] > 0
assert collection["uniquePageCount"] > 0
assert collection["totalSize"] > 0
assert collection["topPageOrigins"]
for origin in collection["topPageOrigins"]:
assert origin["origin"]
assert origin["count"]

# Test non-existing slug - it should return a 404 but not reveal
# whether or not an org exists with that slug
Expand Down Expand Up @@ -1329,6 +1345,10 @@ def test_list_public_colls_home_url_thumbnail():
assert coll["pageCount"] > 0
assert coll["uniquePageCount"] > 0
assert coll["totalSize"] > 0
assert coll["topPageOrigins"]
for origin in coll["topPageOrigins"]:
assert origin["origin"]
assert origin["count"]

for field in non_public_fields:
assert field not in coll
Expand Down Expand Up @@ -1380,6 +1400,10 @@ def test_get_public_collection(default_org_id):
assert coll["pageCount"] > 0
assert coll["uniquePageCount"] > 0
assert coll["totalSize"] > 0
assert coll["topPageOrigins"]
for origin in coll["topPageOrigins"]:
assert origin["origin"]
assert origin["count"]

for field in NON_PUBLIC_COLL_FIELDS:
assert field not in coll
Expand Down Expand Up @@ -1462,6 +1486,10 @@ def test_get_public_collection_unlisted(crawler_auth_headers, default_org_id):
assert coll["totalSize"] > 0
assert coll["defaultThumbnailName"] == "orange-default.avif"
assert coll["allowPublicDownload"]
assert coll["topPageOrigins"]
for origin in coll["topPageOrigins"]:
assert origin["origin"]
assert origin["count"]

for field in NON_PUBLIC_COLL_FIELDS:
assert field not in coll
Expand Down Expand Up @@ -1504,6 +1532,10 @@ def test_get_public_collection_unlisted_org_profile_disabled(
assert coll["totalSize"] > 0
assert coll["defaultThumbnailName"] == "orange-default.avif"
assert coll["allowPublicDownload"]
assert coll["topPageOrigins"]
for origin in coll["topPageOrigins"]:
assert origin["origin"]
assert origin["count"]

for field in NON_PUBLIC_COLL_FIELDS:
assert field not in coll
Expand Down
16 changes: 16 additions & 0 deletions frontend/src/layouts/collections/metadataColumn.ts
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,22 @@ export function metadataColumn(collection?: Collection | PublicCollection) {
label: metadata.totalSize,
render: (col) => `${localize.bytes(col.totalSize)}`,
})}
${when(collection?.topPageOrigins.length, () =>
metadataItem({
label: metadata.topPageDomains,
render: (col) =>
html` <table>
${col.topPageOrigins.map(
(x) => html`
<tr>
<td class="whitespace-nowrap">${x.origin}</td>
<td class="pl-4">${localize.number(x.count)}</td>
</tr>
`,
)}
</table>`,
}),
)}
</btrix-desc-list>
`;
}
1 change: 1 addition & 0 deletions frontend/src/strings/collections/metadata.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,5 @@ export const metadata = {
uniquePageCount: msg("Unique Pages in Collection"),
pageCount: msg("Total Pages Crawled"),
totalSize: msg("Collection Size"),
topPageDomains: msg("Top Page Domains"),
};
6 changes: 6 additions & 0 deletions frontend/src/types/collection.ts
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,12 @@ export const publicCollectionSchema = z.object({
crawlCount: z.number(),
uniquePageCount: z.number(),
pageCount: z.number(),
topPageOrigins: z.array(
z.object({
origin: z.string(),
count: z.number(),
}),
),
totalSize: z.number(),
allowPublicDownload: z.boolean(),
homeUrl: z.string().url().nullable(),
Expand Down
Loading