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

Add updatable QA reviewStatus field to crawls #1575

Merged
merged 2 commits into from Mar 6, 2024
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 14 additions & 0 deletions backend/btrixcloud/models.py
Expand Up @@ -522,6 +522,15 @@ class CrawlFileOut(BaseModel):
expireAt: Optional[str]


# ============================================================================
class ReviewStatus(str, Enum):
"""QA review statuses"""

GOOD = "good"
ACCEPTABLE = "acceptable"
FAILURE = "failure"


# ============================================================================
class BaseCrawl(BaseMongoModel):
"""Base Crawl object (representing crawls, uploads and manual sessions)"""
Expand Down Expand Up @@ -554,6 +563,8 @@ class BaseCrawl(BaseMongoModel):
fileSize: int = 0
fileCount: int = 0

reviewStatus: Optional[ReviewStatus] = None


# ============================================================================
class CollIdName(BaseModel):
Expand Down Expand Up @@ -617,6 +628,8 @@ class CrawlOut(BaseMongoModel):
crawlerChannel: str = "default"
image: Optional[str]

reviewStatus: Optional[ReviewStatus] = None


# ============================================================================
class CrawlOutWithResources(CrawlOut):
Expand All @@ -634,6 +647,7 @@ class UpdateCrawl(BaseModel):
description: Optional[str]
tags: Optional[List[str]]
collectionIds: Optional[List[UUID]]
reviewStatus: Optional[ReviewStatus]


# ============================================================================
Expand Down
37 changes: 37 additions & 0 deletions backend/test/test_run_crawl.py
Expand Up @@ -282,6 +282,43 @@ def test_update_crawl(
assert data["description"] == UPDATED_DESC
assert data["name"] == UPDATED_NAME
assert data["collectionIds"] == UPDATED_COLLECTION_IDS
assert data.get("reviewStatus") is None

# Update reviewStatus and verify
r = requests.patch(
f"{API_PREFIX}/orgs/{default_org_id}/crawls/{admin_crawl_id}",
headers=admin_auth_headers,
json={
"reviewStatus": "good",
},
)
assert r.status_code == 200
data = r.json()
assert data["updated"]

r = requests.get(
f"{API_PREFIX}/orgs/{default_org_id}/crawls/{admin_crawl_id}",
headers=admin_auth_headers,
)
assert r.status_code == 200
assert r.json()["reviewStatus"] == "good"

# Try to update to invalid reviewStatus
r = requests.patch(
f"{API_PREFIX}/orgs/{default_org_id}/crawls/{admin_crawl_id}",
headers=admin_auth_headers,
json={
"reviewStatus": "invalid",
},
)
assert r.status_code == 422

r = requests.get(
f"{API_PREFIX}/orgs/{default_org_id}/crawls/{admin_crawl_id}",
headers=admin_auth_headers,
)
assert r.status_code == 200
assert r.json()["reviewStatus"] == "good"

# Verify deleting works as well
r = requests.patch(
Expand Down