browsertrix/backend/btrixcloud/migrations/migration_0003_mutable_crawl_configs.py
Tessa Walsh 4014d98243
Move pydantic models to separate module + refactor crawl response endpoints to be consistent (#983)
* Move all pydantic models to models.py to avoid circular dependencies
* Include automated crawl details in all-crawls GET endpoints
- ensure /all-crawls endpoint resolves names / firstSeed data same as /crawls endpoint for crawls to ensure consistent frontend display. fields added in get and list all-crawl endpoints for automated
crawls only:
- cid
- name
- description
- firstSeed
- seedCount
- profileName

* Add automated crawl fields to list all-crawls test

* Uncomment mongo readinessProbe

* cleanup CrawlOutWithResources:
- remove 'files' from output model, only resources should be returned
- add _files_to_resources() to simplify computing presigned 'resources' from raw 'files'
- update upload tests to be more consistent, 'files' never present, 'errors' always none

---------

Co-authored-by: Ilya Kreymer <ikreymer@gmail.com>
2023-07-20 13:05:33 +02:00

115 lines
4.4 KiB
Python

"""
Migration 0003 - Mutable crawl configs and crawl revision history
"""
from datetime import datetime
from btrixcloud.models import Crawl, CrawlConfig
from btrixcloud.migrations import BaseMigration, MigrationError
MIGRATION_VERSION = "0003"
class Migration(BaseMigration):
"""Migration class."""
def __init__(self, mdb, migration_version=MIGRATION_VERSION):
super().__init__(mdb, migration_version)
async def migrate_up(self):
"""Perform migration up.
Set new crawl_configs fields and add config details to crawls.
"""
# pylint: disable=too-many-locals, too-many-branches
crawls = self.mdb["crawls"]
crawl_configs = self.mdb["crawl_configs"]
# Return early if there are no configs
crawl_config_results = [res async for res in crawl_configs.find({})]
if not crawl_config_results:
return
utc_now_datetime = datetime.utcnow().replace(microsecond=0, tzinfo=None)
await crawl_configs.update_many(
{"createdBy": None}, [{"$set": {"createdBy": "$userid"}}]
)
await crawl_configs.update_many(
{"modifiedBy": None}, [{"$set": {"modifiedBy": "$userid"}}]
)
await crawl_configs.update_many({}, {"$unset": {"userid": 1}})
await crawl_configs.update_many(
{"created": None}, {"$set": {"created": utc_now_datetime}}
)
await crawl_configs.update_many({}, [{"$set": {"modified": "$created"}}])
await crawl_configs.update_many({}, {"$set": {"rev": 0}})
# Return early if there are no crawls
crawl_results = [res async for res in crawls.find({})]
if not crawl_results:
return
await crawls.update_many({}, {"$set": {"cid_rev": 0}})
for crawl_result in crawl_results:
config_result = await crawl_configs.find_one({"_id": crawl_result["cid"]})
if not config_result:
continue
await crawls.find_one_and_update(
{"_id": crawl_result["_id"]},
{
"$set": {
"config": config_result["config"],
"profileid": config_result.get("profileid"),
"schedule": config_result.get("schedule"),
"crawlTimeout": config_result.get("crawlTimeout"),
"jobType": config_result.get("jobType"),
}
},
)
# Test that migration went as expected
sample_config_result = await crawl_configs.find_one({})
sample_config = CrawlConfig.from_dict(sample_config_result)
if not sample_config.createdBy or (
sample_config.createdBy != sample_config.modifiedBy
):
raise MigrationError(
"Crawl config createdBy and modifiedBy set incorrectly by migration"
)
if sample_config.modified != sample_config.created:
raise MigrationError(
"Crawl config modified set incorrectly by migration - should be equal to created"
)
if sample_config.rev != 0:
raise MigrationError("Crawl config rev set incorrectly by migration")
no_created_results = await crawl_configs.find_one({"created": None})
if no_created_results:
raise MigrationError("Crawl config created not set by migration")
sample_crawl_result = await crawls.find_one({})
sample_crawl = Crawl.from_dict(sample_crawl_result)
if sample_crawl.cid_rev != 0:
raise MigrationError("Crawl cid_rev set incorrectly by migration")
matching_config_result = await crawl_configs.find_one({"_id": sample_crawl.cid})
matching_config = CrawlConfig.from_dict(matching_config_result)
if sample_crawl.profileid != matching_config.profileid:
raise MigrationError(
f"Crawl profileid {sample_crawl.profileid} doesn't match config"
)
if sample_crawl.schedule != matching_config.schedule:
raise MigrationError(
f"Crawl schedule {sample_crawl.schedule} doesn't match config"
)
if sample_crawl.crawlTimeout != matching_config.crawlTimeout:
raise MigrationError(
f"Crawl timeout {sample_crawl.crawlTimeout} doesn't match config"
)
if not sample_crawl.config.seeds:
raise MigrationError("Crawl config missing after migration")