browsertrix/backend/btrixcloud/migrations/migration_0001_archives_to_orgs.py
2023-01-25 17:46:10 -08:00

123 lines
3.9 KiB
Python

"""
Migration 0001 - Archives to Orgs
"""
import os
from pymongo.errors import OperationFailure
from btrixcloud.k8s.k8sapi import K8sAPI
class Migration:
"""Migration class."""
COLLECTIONS_AID_TO_OID = [
"collections",
"crawl_configs",
"crawls",
"invites",
"profiles",
]
MIGRATION_VERSION = "0001"
def __init__(self, mdb):
self.mdb = mdb
async def get_db_version(self):
"""Get current db version from database."""
db_version = None
version_collection = self.mdb["version"]
version_record = await version_collection.find_one()
if not version_record:
return db_version
try:
db_version = version_record["version"]
except KeyError:
pass
return db_version
async def set_db_version(self):
"""Set db version to version_number."""
version_collection = self.mdb["version"]
await version_collection.find_one_and_update(
{}, {"$set": {"version": self.MIGRATION_VERSION}}, upsert=True
)
async def migrate_up_needed(self):
"""Verify migration up is needed and return boolean indicator."""
db_version = await self.get_db_version()
print(f"Current database version before migration: {db_version}")
print(f"Migration available to apply: {self.MIGRATION_VERSION}")
# Databases from prior to migrations will not have a version set.
if not db_version:
return True
if db_version < self.MIGRATION_VERSION:
return True
return False
async def migrate_up(self):
"""Perform migration up."""
# Rename archives collection to organizations
org_collection = self.mdb["archives"]
try:
await org_collection.rename("organizations", dropTarget=True)
except OperationFailure as err:
print(f"Error renaming archives to organizations: {err}")
# Rename aid fields to oid
for collection in self.COLLECTIONS_AID_TO_OID:
current_coll = self.mdb[collection]
await current_coll.update_many({}, {"$rename": {"aid": "oid"}})
# Update k8s configmaps
k8s_api_instance = K8sAPI()
crawler_namespace = os.environ.get("CRAWLER_NAMESPACE") or "crawlers"
config_map = await k8s_api_instance.core_api.list_namespaced_config_map(
namespace=crawler_namespace
)
for item in config_map.items:
item_name = item.metadata.name
try:
org_id = item.data["ARCHIVE_ID"]
except KeyError:
continue
item.data["ORG_ID"] = org_id
try:
item.data.pop("ARCHIVE_ID")
except KeyError:
pass
item.metadata.labels["btrix.org"] = org_id
try:
item.metadata.labels.pop("btrix.archive")
except KeyError:
pass
await k8s_api_instance.core_api.patch_namespaced_config_map(
name=item_name, namespace=crawler_namespace, body=item
)
def migrate_down(self):
"""Perform migration down."""
raise NotImplementedError("Downward migrations not yet added")
async def run(self):
"""Run migrations."""
if await self.migrate_up_needed():
print("Performing migration up", flush=True)
try:
await self.migrate_up()
await self.set_db_version()
except OperationFailure as err:
print(f"Error running migration {self.MIGRATION_VERSION}: {err}")
return False
else:
print("No migration to apply - skipping", flush=True)
return False
print(f"Database successfully migrated to {self.MIGRATION_VERSION}", flush=True)
return True