# # This file is distributed under the MIT License. See LICENSE.md for details. # import asyncio import json import logging from base64 import b64decode from concurrent.futures import ThreadPoolExecutor from dataclasses import dataclass from functools import partial from pathlib import Path from typing import AsyncGenerator, Awaitable, Callable, Optional, ParamSpec, TypeVar from starlette.datastructures import UploadFile from ariadne import MutationType, ObjectType, QueryType, ScalarType, SubscriptionType, UnionType from ariadne import make_executable_schema, upload_scalar from revng.internal.api.errors import DocumentError, Error, SimpleError from revng.internal.api.manager import Manager from revng.internal.api.target import Target from .multiqueue import MultiQueue from .util import produce_serializer @dataclass class Invalidation: commitIndex: int # noqa: N815 invalidations: str # This executor is used to offload most of the work from the GraphQL handler. # One might wonder why this is needed since the `Manager` API has a global # lock; the reason is that, without offloading the work to another thread the # asyncio loop does not release, so the uvicorn request handler hangs. executor = ThreadPoolExecutor(4) invalidation_queue: MultiQueue[Invalidation] = MultiQueue() T = TypeVar("T") P = ParamSpec("P") # Python runs all coroutines in the same event loop (which is handled by a single thread) # The scheduling is done cooperatively, so once a coroutine starts executing it will run until # the first call to `await` or `return`. # This can work poorly if there are long-running sync function that are executed, since those block # the event loop. To remedy this we use a separate thread to run these functions so that the event # loop can run other coroutines in the meantime. def run_in_executor(function: Callable[P, T], *args: P.args, **kwargs: P.kwargs) -> Awaitable[T]: loop = asyncio.get_event_loop() return loop.run_in_executor(executor, partial(function, *args, **kwargs)) @dataclass class Diff: diff: str @dataclass class Produced: result: str @dataclass class CommitIndexError: expectedIndex: int # noqa: N815 query = QueryType() mutation = MutationType() subscription = SubscriptionType() analysis_result_type = UnionType("AnalysisResult") produce_result_type = UnionType("ProduceResult") simple_error_type = ObjectType("SimpleError") simple_error_type.set_alias("errorType", "error_type") document_error_type = ObjectType("DocumentError") document_error_type.set_alias("errorType", "error_type") document_error_type.set_alias("locationType", "location_type") bigint_scalar = ScalarType("BigInt", serializer=str, value_parser=int) @query.field("produce") async def resolve_produce( obj, info, *, step: str, container: str, targetList: str, # noqa: N803 onlyIfReady=False, # noqa: N803 index: int, ): manager: Manager = info.context["manager"] index_lock: asyncio.Lock = info.context["index_lock"] async with index_lock: current_index = await run_in_executor(manager.get_context_commit_index) if current_index != index: return CommitIndexError(current_index) targets = targetList.split(",") result = await run_in_executor( manager.produce_target, step, targets, container, onlyIfReady ) if isinstance(result, Error): return result.unwrap() else: return Produced(produce_serializer(result)) @query.field("produceArtifacts") async def resolve_produce_artifacts( obj, info, *, step: str, paths: Optional[str] = None, onlyIfReady=False, # noqa: N803 index: int, ): manager: Manager = info.context["manager"] index_lock: asyncio.Lock = info.context["index_lock"] async with index_lock: current_index = await run_in_executor(manager.get_context_commit_index) if current_index != index: return CommitIndexError(current_index) targets = paths.split(",") if paths is not None else None result = await run_in_executor( manager.produce_target, step, targets, only_if_ready=onlyIfReady ) if isinstance(result, Error): return result.unwrap() else: return Produced(produce_serializer(result)) @query.field("targets") async def resolve_targets(_, info, *, step: str, container: str): manager: Manager = info.context["manager"] targets = await run_in_executor(manager.get_targets, step, container) return await run_in_executor(lambda: [t.as_dict() for t in targets]) @query.field("target") async def resolve_target(_, info, *, step: str, container: str, target: str) -> Optional[Target]: manager: Manager = info.context["manager"] result = await run_in_executor(manager.deserialize_target, f"{step}/{container}/{target}") return result.as_dict() if result is not None else None @query.field("getGlobal") async def resolve_get_global(_, info, *, name: str) -> str: manager: Manager = info.context["manager"] return await run_in_executor(manager.get_global, name) @query.field("pipelineDescription") async def resolve_pipeline_description(_, info) -> str: manager: Manager = info.context["manager"] return await run_in_executor(manager.get_pipeline_description) @query.field("contextCommitIndex") async def resolve_context_commit_index(_, info) -> int: manager: Manager = info.context["manager"] return await run_in_executor(manager.get_context_commit_index) @mutation.field("save") async def resolve_save(_, info) -> bool: manager: Manager = info.context["manager"] return await run_in_executor(manager.save) @mutation.field("uploadB64") async def resolve_upload_b64(_, info, *, input: str, container: str): # noqa: A002 manager: Manager = info.context["manager"] index_lock: asyncio.Lock = info.context["index_lock"] async with index_lock: invalidations = await run_in_executor(manager.set_input, container, b64decode(input)) index = await run_in_executor(manager.get_context_commit_index) await invalidation_queue.send(Invalidation(index, str(invalidations))) logging.info(f"Saved file for container {container}") return True @mutation.field("uploadFile") async def resolve_upload_file(_, info, *, file: UploadFile, container: str): manager: Manager = info.context["manager"] index_lock: asyncio.Lock = info.context["index_lock"] async with index_lock: contents = await file.read() invalidations = await run_in_executor(manager.set_input, container, contents) index = await run_in_executor(manager.get_context_commit_index) await invalidation_queue.send(Invalidation(index, str(invalidations))) logging.info(f"Saved file for container {container}") return True @mutation.field("runAnalysis") async def resolve_run_analysis( _, info, *, step: str, analysis: str, containerToTargets: str | None = None, # noqa: N803 options: str | None = None, index: int, ): manager: Manager = info.context["manager"] index_lock: asyncio.Lock = info.context["index_lock"] async with index_lock: current_index = await run_in_executor(manager.get_context_commit_index) if current_index != index: return CommitIndexError(current_index) target_map = json.loads(containerToTargets) if containerToTargets is not None else {} parse_options = json.loads(options) if options is not None else {} result = await run_in_executor( manager.run_analysis, step, analysis, target_map, parse_options ) if result: real_result = result.unwrap() new_index = await run_in_executor(manager.get_context_commit_index) await invalidation_queue.send(Invalidation(new_index, str(real_result.invalidations))) return Diff(json.dumps(real_result.result)) else: return result.error.unwrap() @mutation.field("runAnalysesList") async def resolve_run_analyses_list(_, info, *, name: str, options: str | None = None, index: int): manager: Manager = info.context["manager"] index_lock: asyncio.Lock = info.context["index_lock"] async with index_lock: current_index = await run_in_executor(manager.get_context_commit_index) if current_index != index: return CommitIndexError(current_index) parse_options = json.loads(options) if options is not None else {} result = await run_in_executor(manager.run_analyses_list, name, parse_options) if result: real_result = result.unwrap() new_index = await run_in_executor(manager.get_context_commit_index) await invalidation_queue.send(Invalidation(new_index, str(real_result.invalidations))) return Diff(json.dumps(real_result.result)) else: return result.error.unwrap() @analysis_result_type.type_resolver def resolve_analysis_result(obj, *_): if isinstance(obj, SimpleError): return "SimpleError" elif isinstance(obj, DocumentError): return "DocumentError" elif isinstance(obj, CommitIndexError): return "IndexError" elif isinstance(obj, Diff): return "Diff" else: raise ValueError("Unknown Analysis result") @produce_result_type.type_resolver def resolve_produce_result(obj, *_): if isinstance(obj, SimpleError): return "SimpleError" elif isinstance(obj, DocumentError): return "DocumentError" elif isinstance(obj, CommitIndexError): return "IndexError" elif isinstance(obj, Produced): return "Produced" else: raise ValueError("Unknown Produce result") @subscription.source("invalidations") async def invalidations_generator(_, info) -> AsyncGenerator[Invalidation, None]: with invalidation_queue.stream() as stream: async for message in stream: yield message @subscription.field("invalidations") async def invalidations(message: Invalidation, info): return message def get_schema(): schema_file = (Path(__file__).parent.resolve()) / "schema.graphql" return make_executable_schema( schema_file.read_text(), query, mutation, subscription, upload_scalar, bigint_scalar, analysis_result_type, produce_result_type, simple_error_type, document_error_type, )