0c8a5a49b4
- use python-on-whale to use docker cli api directly, creating docker stack for each crawl or profile browser - configure storages via storages.yaml secret - add crawl_job, profile_job, splitting into base and k8s/swarm implementations - split manager into base crawlmanager and k8s/swarm implementations - swarm: load initial scale from db to avoid modifying fixed configs, in k8s, load from configmap - swarm: support scheduled jobs via swarm-cronjob service - remove docker dependencies (aiodocker, apscheduler, scheduling) - swarm: when using local minio, expose via /data/ route in nginx via extra include (in k8s, include dir is empty and routing handled via ingress) - k8s: cleanup minio chart: move init containers to minio.yaml - swarm: stateful set implementation to be consistent with k8s scaling: - don't use service replicas, - create a unique service with '-N' appended and allocate unique volume for each replica - allows crawl containers to be restarted w/o losing data - add volume pruning background service, as volumes can be deleted only after service shuts down fully - watch: fully simplify routing, route via replica index instead of ip for both k8s and swarm - rename network btrix-cloud-net -> btrix-net to avoid conflict with compose network
479 lines
15 KiB
Python
479 lines
15 KiB
Python
""" Profile Management """
|
|
|
|
from typing import Optional, List
|
|
from datetime import datetime
|
|
import uuid
|
|
import os
|
|
|
|
from urllib.parse import urlencode
|
|
|
|
from fastapi import APIRouter, Depends, Request, HTTPException
|
|
from pydantic import BaseModel, UUID4, HttpUrl
|
|
import aiohttp
|
|
|
|
from .archives import Archive
|
|
from .users import User
|
|
|
|
from .db import BaseMongoModel
|
|
from .crawlconfigs import CrawlConfigIdNameOut
|
|
|
|
|
|
BROWSER_EXPIRE = 300
|
|
|
|
# ============================================================================
|
|
class ProfileFile(BaseModel):
|
|
""" file from a crawl """
|
|
|
|
filename: str
|
|
hash: str
|
|
size: int
|
|
|
|
|
|
# ============================================================================
|
|
class Profile(BaseMongoModel):
|
|
""" Browser profile """
|
|
|
|
name: str
|
|
description: Optional[str] = ""
|
|
|
|
userid: UUID4
|
|
aid: UUID4
|
|
|
|
origins: List[str]
|
|
resource: Optional[ProfileFile]
|
|
|
|
created: Optional[datetime]
|
|
|
|
|
|
# ============================================================================
|
|
class ProfileWithCrawlConfigs(Profile):
|
|
""" Profile with list of crawlconfigs useing this profile """
|
|
|
|
crawlconfigs: List[CrawlConfigIdNameOut] = []
|
|
|
|
|
|
# ============================================================================
|
|
class UrlIn(BaseModel):
|
|
""" Request to set url """
|
|
|
|
url: HttpUrl
|
|
|
|
|
|
# ============================================================================
|
|
class ProfileLaunchBrowserIn(UrlIn):
|
|
""" Request to launch new browser for creating profile """
|
|
|
|
profileId: Optional[UUID4]
|
|
|
|
|
|
# ============================================================================
|
|
class BrowserId(BaseModel):
|
|
""" Profile id on newly created profile """
|
|
|
|
browserid: str
|
|
|
|
|
|
# ============================================================================
|
|
class ProfileCreateUpdate(BaseModel):
|
|
""" Profile metadata for committing current browser to profile """
|
|
|
|
browserid: Optional[str]
|
|
name: str
|
|
description: Optional[str] = ""
|
|
|
|
|
|
# ============================================================================
|
|
class ProfileOps:
|
|
""" Profile management """
|
|
|
|
def __init__(self, mdb, crawl_manager):
|
|
self.profiles = mdb["profiles"]
|
|
|
|
self.crawl_manager = crawl_manager
|
|
self.browser_fqdn_suffix = os.environ.get("CRAWLER_FQDN_SUFFIX")
|
|
|
|
self.router = APIRouter(
|
|
prefix="/profiles",
|
|
tags=["profiles"],
|
|
responses={404: {"description": "Not found"}},
|
|
)
|
|
|
|
self.crawlconfigs = None
|
|
|
|
self.shared_profile_storage = os.environ.get("SHARED_PROFILE_STORAGE")
|
|
|
|
def set_crawlconfigs(self, crawlconfigs):
|
|
""" set crawlconfigs ops """
|
|
self.crawlconfigs = crawlconfigs
|
|
|
|
async def create_new_browser(
|
|
self, archive: Archive, user: User, profile_launch: ProfileLaunchBrowserIn
|
|
):
|
|
""" Create new profile """
|
|
if self.shared_profile_storage:
|
|
storage_name = self.shared_profile_storage
|
|
storage = None
|
|
elif archive.storage and archive.storage.type == "default":
|
|
storage_name = None
|
|
storage = archive.storage
|
|
else:
|
|
storage_name = str(archive.id)
|
|
storage = None
|
|
|
|
profile_path = ""
|
|
if profile_launch.profileId:
|
|
profile_path = await self.get_profile_storage_path(
|
|
profile_launch.profileId, archive
|
|
)
|
|
|
|
if not profile_path:
|
|
raise HTTPException(status_code=400, detail="invalid_base_profile")
|
|
|
|
browserid = await self.crawl_manager.run_profile_browser(
|
|
str(user.id),
|
|
str(archive.id),
|
|
url=profile_launch.url,
|
|
storage=storage,
|
|
storage_name=storage_name,
|
|
baseprofile=profile_launch.profileId,
|
|
profile_path=profile_path,
|
|
)
|
|
|
|
if not browserid:
|
|
raise HTTPException(status_code=400, detail="browser_not_created")
|
|
|
|
return BrowserId(browserid=browserid)
|
|
|
|
async def get_profile_browser_url(self, browserid, aid, headers):
|
|
""" get profile browser url """
|
|
json = await self._send_browser_req(browserid, "/target")
|
|
|
|
target_id = json.get("targetId")
|
|
|
|
if not target_id:
|
|
raise HTTPException(status_code=400, detail="browser_not_available")
|
|
|
|
scheme = headers.get("X-Forwarded-Proto") or "http"
|
|
host = headers.get("Host") or "localhost"
|
|
ws_scheme = "wss" if scheme == "https" else "ws"
|
|
|
|
prefix = f"{host}/loadbrowser/{browserid}/devtools"
|
|
|
|
auth_bearer = headers.get("Authorization").split(" ")[1]
|
|
|
|
params = {"panel": "resources"}
|
|
params[
|
|
ws_scheme
|
|
] = f"{prefix}/page/{target_id}?aid={aid}&auth_bearer={auth_bearer}"
|
|
|
|
# pylint: disable=line-too-long
|
|
return {"url": f"{scheme}://{prefix}/inspector.html?{urlencode(params)}"}
|
|
|
|
async def ping_profile_browser(self, browserid):
|
|
""" ping profile browser to keep it running """
|
|
await self.crawl_manager.ping_profile_browser(browserid)
|
|
|
|
json = await self._send_browser_req(browserid, "/ping")
|
|
|
|
return {"success": True, "origins": json.get("origins") or []}
|
|
|
|
async def navigate_profile_browser(self, browserid, urlin: UrlIn):
|
|
""" ping profile browser to keep it running """
|
|
await self._send_browser_req(browserid, "/navigate", "POST", json=urlin.dict())
|
|
|
|
return {"success": True}
|
|
|
|
async def commit_to_profile(
|
|
self,
|
|
browser_commit: ProfileCreateUpdate,
|
|
metadata: dict,
|
|
profileid: uuid.UUID = None,
|
|
):
|
|
""" commit profile and shutdown profile browser """
|
|
|
|
if not profileid:
|
|
profileid = uuid.uuid4()
|
|
|
|
filename_data = {"filename": f"profile-{profileid}.tar.gz"}
|
|
|
|
json = await self._send_browser_req(
|
|
browser_commit.browserid, "/createProfileJS", "POST", json=filename_data
|
|
)
|
|
|
|
try:
|
|
resource = json["resource"]
|
|
except:
|
|
# pylint: disable=raise-missing-from
|
|
raise HTTPException(status_code=400, detail="browser_not_valid")
|
|
|
|
await self.crawl_manager.delete_profile_browser(browser_commit.browserid)
|
|
|
|
profile_file = ProfileFile(
|
|
hash=resource["hash"],
|
|
size=resource["bytes"],
|
|
filename=resource["path"],
|
|
)
|
|
|
|
baseid = metadata.get("btrix.baseprofile")
|
|
if baseid:
|
|
print("baseid", baseid)
|
|
baseid = uuid.UUID(baseid)
|
|
|
|
profile = Profile(
|
|
id=profileid,
|
|
name=browser_commit.name,
|
|
description=browser_commit.description,
|
|
created=datetime.utcnow().replace(microsecond=0, tzinfo=None),
|
|
origins=json["origins"],
|
|
resource=profile_file,
|
|
userid=uuid.UUID(metadata.get("btrix.user")),
|
|
aid=uuid.UUID(metadata.get("btrix.archive")),
|
|
baseid=baseid,
|
|
)
|
|
|
|
await self.profiles.find_one_and_update(
|
|
{"_id": profile.id}, {"$set": profile.to_dict()}, upsert=True
|
|
)
|
|
|
|
return profile
|
|
|
|
async def update_profile_metadata(
|
|
self, profileid: UUID4, update: ProfileCreateUpdate
|
|
):
|
|
""" Update name and description metadata only on existing profile """
|
|
query = {"name": update.name}
|
|
if update.description is not None:
|
|
query["description"] = update.description
|
|
|
|
if not await self.profiles.find_one_and_update(
|
|
{"_id": profileid}, {"$set": query}
|
|
):
|
|
raise HTTPException(status_code=404, detail="profile_not_found")
|
|
|
|
return {"success": True}
|
|
|
|
async def list_profiles(self, archive: Archive):
|
|
""" list all profiles"""
|
|
cursor = self.profiles.find({"aid": archive.id})
|
|
results = await cursor.to_list(length=1000)
|
|
return [Profile.from_dict(res) for res in results]
|
|
|
|
async def get_profile(
|
|
self, profileid: uuid.UUID, archive: Optional[Archive] = None
|
|
):
|
|
""" get profile by id and archive """
|
|
query = {"_id": profileid}
|
|
if archive:
|
|
query["aid"] = archive.id
|
|
|
|
res = await self.profiles.find_one(query)
|
|
if not res:
|
|
raise HTTPException(status_code=404, detail="profile_not_found")
|
|
|
|
return Profile.from_dict(res)
|
|
|
|
async def get_profile_with_configs(
|
|
self, profileid: uuid.UUID, archive: Optional[Archive] = None
|
|
):
|
|
""" get profile for api output, with crawlconfigs """
|
|
|
|
profile = await self.get_profile(profileid, archive)
|
|
|
|
crawlconfigs = await self.get_crawl_configs_for_profile(profileid, archive)
|
|
|
|
return ProfileWithCrawlConfigs(crawlconfigs=crawlconfigs, **profile.dict())
|
|
|
|
async def get_profile_storage_path(
|
|
self, profileid: uuid.UUID, archive: Optional[Archive] = None
|
|
):
|
|
""" return profile path filename (relative path) for given profile id and archive """
|
|
try:
|
|
profile = await self.get_profile(profileid, archive)
|
|
return profile.resource.filename
|
|
# pylint: disable=bare-except
|
|
except:
|
|
return None
|
|
|
|
async def get_profile_name(
|
|
self, profileid: uuid.UUID, archive: Optional[Archive] = None
|
|
):
|
|
""" return profile for given profile id and archive """
|
|
try:
|
|
profile = await self.get_profile(profileid, archive)
|
|
return profile.name
|
|
# pylint: disable=bare-except
|
|
except:
|
|
return None
|
|
|
|
async def get_crawl_configs_for_profile(
|
|
self, profileid: uuid.UUID, archive: Optional[Archive] = None
|
|
):
|
|
""" Get list of crawl config id, names for that use a particular profile """
|
|
|
|
crawlconfig_names = await self.crawlconfigs.get_crawl_config_ids_for_profile(
|
|
profileid, archive
|
|
)
|
|
|
|
return crawlconfig_names
|
|
|
|
async def delete_profile(
|
|
self, profileid: uuid.UUID, archive: Optional[Archive] = None
|
|
):
|
|
""" delete profile, if not used in active crawlconfig """
|
|
profile = await self.get_profile_with_configs(profileid, archive)
|
|
|
|
if len(profile.crawlconfigs) > 0:
|
|
return {"error": "in_use", "crawlconfigs": profile.crawlconfigs}
|
|
|
|
query = {"_id": profileid}
|
|
if archive:
|
|
query["aid"] = archive.id
|
|
|
|
# pylint: disable=fixme
|
|
# todo: delete the file itself!
|
|
# delete profile.pathname
|
|
|
|
res = await self.profiles.delete_one(query)
|
|
if not res or res.deleted_count != 1:
|
|
raise HTTPException(status_code=404, detail="profile_not_found")
|
|
|
|
return {"success": True}
|
|
|
|
async def delete_profile_browser(self, browserid):
|
|
""" delete profile browser immediately """
|
|
if not await self.crawl_manager.delete_profile_browser(browserid):
|
|
raise HTTPException(status_code=404, detail="browser_not_found")
|
|
|
|
return {"success": True}
|
|
|
|
async def _send_browser_req(self, browserid, path, method="GET", json=None):
|
|
""" make request to browser api to get state """
|
|
browser_host = f"browser-{browserid}-0.browser-{browserid}"
|
|
try:
|
|
async with aiohttp.ClientSession() as session:
|
|
async with session.request(
|
|
method,
|
|
f"http://{browser_host}{self.browser_fqdn_suffix}:9223{path}",
|
|
json=json,
|
|
) as resp:
|
|
json = await resp.json()
|
|
|
|
except Exception:
|
|
# pylint: disable=raise-missing-from
|
|
raise HTTPException(status_code=200, detail="waiting_for_browser")
|
|
|
|
return json
|
|
|
|
|
|
# ============================================================================
|
|
# pylint: disable=redefined-builtin,invalid-name,too-many-locals,too-many-arguments
|
|
def init_profiles_api(mdb, crawl_manager, archive_ops, user_dep):
|
|
""" init profile ops system """
|
|
ops = ProfileOps(mdb, crawl_manager)
|
|
|
|
router = ops.router
|
|
|
|
archive_crawl_dep = archive_ops.archive_crawl_dep
|
|
|
|
async def browser_get_metadata(
|
|
browserid: str, archive: Archive = Depends(archive_crawl_dep)
|
|
):
|
|
# if await ops.redis.hget(f"br:{browserid}", "archive") != str(archive.id):
|
|
metadata = await crawl_manager.get_profile_browser_metadata(browserid)
|
|
if metadata.get("btrix.archive") != str(archive.id):
|
|
raise HTTPException(status_code=404, detail="no_such_browser")
|
|
|
|
return metadata
|
|
|
|
async def browser_dep(
|
|
browserid: str, archive: Archive = Depends(archive_crawl_dep)
|
|
):
|
|
await browser_get_metadata(browserid, archive)
|
|
return browserid
|
|
|
|
@router.get("", response_model=List[Profile])
|
|
async def list_profiles(
|
|
archive: Archive = Depends(archive_crawl_dep),
|
|
):
|
|
return await ops.list_profiles(archive)
|
|
|
|
@router.post("", response_model=Profile)
|
|
async def commit_browser_to_new(
|
|
browser_commit: ProfileCreateUpdate,
|
|
archive: Archive = Depends(archive_crawl_dep),
|
|
):
|
|
metadata = await browser_get_metadata(browser_commit.browserid, archive)
|
|
|
|
return await ops.commit_to_profile(browser_commit, metadata)
|
|
|
|
@router.patch("/{profileid}")
|
|
async def commit_browser_to_existing(
|
|
browser_commit: ProfileCreateUpdate,
|
|
profileid: UUID4,
|
|
archive: Archive = Depends(archive_crawl_dep),
|
|
):
|
|
if not browser_commit.browserid:
|
|
await ops.update_profile_metadata(profileid, browser_commit)
|
|
|
|
else:
|
|
metadata = await browser_get_metadata(browser_commit.browserid, archive)
|
|
|
|
await ops.commit_to_profile(browser_commit, metadata, profileid)
|
|
|
|
return {"success": True}
|
|
|
|
@router.get("/{profileid}", response_model=ProfileWithCrawlConfigs)
|
|
async def get_profile(
|
|
profileid: UUID4,
|
|
archive: Archive = Depends(archive_crawl_dep),
|
|
):
|
|
return await ops.get_profile_with_configs(profileid, archive)
|
|
|
|
@router.delete("/{profileid}")
|
|
async def delete_profile(
|
|
profileid: UUID4,
|
|
archive: Archive = Depends(archive_crawl_dep),
|
|
):
|
|
return await ops.delete_profile(profileid, archive)
|
|
|
|
@router.post("/browser", response_model=BrowserId)
|
|
async def create_new(
|
|
profile_launch: ProfileLaunchBrowserIn,
|
|
archive: Archive = Depends(archive_crawl_dep),
|
|
user: User = Depends(user_dep),
|
|
):
|
|
return await ops.create_new_browser(archive, user, profile_launch)
|
|
|
|
@router.post("/browser/{browserid}/ping")
|
|
async def ping_profile_browser(browserid: str = Depends(browser_dep)):
|
|
return await ops.ping_profile_browser(browserid)
|
|
|
|
@router.post("/browser/{browserid}/navigate")
|
|
async def navigate_profile_browser(
|
|
urlin: UrlIn, browserid: str = Depends(browser_dep)
|
|
):
|
|
return await ops.navigate_profile_browser(browserid, urlin)
|
|
|
|
@router.get("/browser/{browserid}")
|
|
async def get_profile_browser_url(
|
|
request: Request,
|
|
browserid: str = Depends(browser_dep),
|
|
archive: Archive = Depends(archive_crawl_dep),
|
|
):
|
|
return await ops.get_profile_browser_url(
|
|
browserid, str(archive.id), request.headers
|
|
)
|
|
|
|
# pylint: disable=unused-argument
|
|
@router.get("/browser/{browserid}/access")
|
|
async def access_check(browserid: str = Depends(browser_dep)):
|
|
return {}
|
|
|
|
@router.delete("/browser/{browserid}")
|
|
async def delete_profile_browser(browserid: str = Depends(browser_dep)):
|
|
return await ops.delete_profile_browser(browserid)
|
|
|
|
archive_ops.router.include_router(router)
|
|
|
|
return ops
|