browsertrix/backend/btrixcloud/migrations/migration_0002_crawlconfig_crawlstats.py
Tessa Walsh 14189b7cfb
Add crawl pages and related API endpoints (#1516)
Fixes #1502 

- Adds pages to database as they get added to Redis during crawl
- Adds migration to add pages to database for older crawls from
pages.jsonl and extraPages.jsonl files in WACZ
- Adds GET, list GET, and PATCH update endpoints for pages
- Adds POST (add), PATCH, and POST (delete) endpoints for page notes,
each with their own id, timestamp, and user info in addition to text
- Adds page_ops methods for 1. adding resources/urls to page, and 2.
adding automated heuristics and supplemental info (mime, type, etc.) to
page (for use in crawl QA job)
- Modifies `Migration` class to accept kwargs so that we can pass in ops
classes as needed for migrations
- Deletes WACZ files and pages from database for failed crawls during
crawl_finished process
- Deletes crawl pages when a crawl is deleted

Note: Requires a crawler version 1.0.0 beta3 or later, with support for
`--writePagesToRedis` to populate pages at crawl completion. Beta 4 is
configured in the test chart, which should be upgraded to stable 1.0.0
when it's released.

Connected to https://github.com/webrecorder/browsertrix-crawler/pull/464

---------

Co-authored-by: Ilya Kreymer <ikreymer@gmail.com>
2024-02-28 12:11:35 -05:00

30 lines
950 B
Python

"""
Migration 0002 - Dropping CrawlConfig crawl stats
"""
from btrixcloud.migrations import BaseMigration
MIGRATION_VERSION = "0002"
class Migration(BaseMigration):
"""Migration class."""
# pylint: disable=unused-argument
def __init__(self, mdb, **kwargs):
super().__init__(mdb, migration_version=MIGRATION_VERSION)
async def migrate_up(self):
"""Perform migration up.
Drop crawl statistics fields from crawl_config collection documents
as these are now generated dynamically from a join as needed in API
endpoints.
"""
crawl_configs = self.mdb["crawl_configs"]
await crawl_configs.update_many({}, {"$unset": {"crawlCount": 1}})
await crawl_configs.update_many({}, {"$unset": {"lastCrawlId": 1}})
await crawl_configs.update_many({}, {"$unset": {"lastCrawlTime": 1}})
await crawl_configs.update_many({}, {"$unset": {"lastCrawlState": 1}})