From 5d92c2ab382ebeb1d66af78decca3f724e6bd9c9 Mon Sep 17 00:00:00 2001 From: Adambomb210 Date: Thu, 19 Nov 2026 16:35:23 -0500 Subject: [PATCH] Fix CodeQL code-scanning alerts - Domain errors carry an explicit `message` (the text written for the person who hit it); routers send that back instead of `str(exc)` (py/stack-trace-exposure). - Redirects to a project build the URL from the project loaded from the database, not the raw path parameter; accepting an invitation redirects to the invitation's own project (py/url-redirection). - A job file's download URL is signed for the file found in the job's listing, not the requested name. - CI workflow declares read-only `permissions` at the top (actions/missing-workflow-permissions). - The dev Weave e2e setup script makes the files holding the dev OAuth secret readable by the owner only. Co-Authored-By: Claude Opus 5.5 --- .github/workflows/ci.yml | 4 + krater/services/compute_files.py | 6 +- krater/services/errors.py | 9 ++- krater/web/app.py | 4 +- krater/web/deps.py | 2 +- krater/web/routers/admin.py | 2 +- krater/web/routers/api.py | 46 +++++------ krater/web/routers/compute.py | 10 +-- krater/web/routers/compute_admin.py | 4 +- krater/web/routers/funders.py | 2 +- krater/web/routers/projects.py | 118 ++++++++++++++-------------- krater/web/routers/runner.py | 6 +- krater/web/routers/updates.py | 2 +- scripts/dev/weave_e2e_setup.py | 3 + tests/services/test_errors.py | 32 ++++++++ 15 files changed, 150 insertions(+), 100 deletions(-) create mode 100644 tests/services/test_errors.py diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 7be1946..4f07ad0 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -4,6 +4,10 @@ on: push: pull_request: +# Least privilege: jobs read the code; one that needs more (the image push) asks for it itself. +permissions: + contents: read + jobs: test: runs-on: ubuntu-latest diff --git a/krater/services/compute_files.py b/krater/services/compute_files.py index c7d5914..4042cfd 100644 --- a/krater/services/compute_files.py +++ b/krater/services/compute_files.py @@ -71,9 +71,11 @@ def list_files(store: ObjectStore, actor: Actor, *, job: ComputeJob) -> list[Job def download_url(store: ObjectStore, actor: Actor, *, job: ComputeJob, area: str, name: str) -> str: """A short-lived URL for one of the job's files. Only for a file that exists, so a name can't reach elsewhere.""" _require(actor, job.project) - if area not in AREAS or not any(f.area == area and f.name == name for f in list_files(store, actor, job=job)): + found = next((f for f in list_files(store, actor, job=job) if f.area == area and f.name == name), None) + if area not in AREAS or found is None: raise NotFound("No such file.") - return store.presign_download(_prefix(job, area) + name, expires=DOWNLOAD_EXPIRES_SECONDS) + # The key comes from the listing, not the request: the URL can only point at a file the job really has. + return store.presign_download(_prefix(job, found.area) + found.name, expires=DOWNLOAD_EXPIRES_SECONDS) def list_downloads(store: ObjectStore, actor: Actor, *, job: ComputeJob) -> list[tuple[JobFile, str]]: diff --git a/krater/services/errors.py b/krater/services/errors.py index 4592457..cae58d0 100644 --- a/krater/services/errors.py +++ b/krater/services/errors.py @@ -9,7 +9,14 @@ class DomainError(Exception): - """Base class for every error raised by a Krater service.""" + """Base class for every error raised by a Krater service. + + `message` is the text written for the person who hit the error, safe to send back to them. Routers show it rather + than `str(exc)`, so a response carries only what a service chose to say.""" + + def __init__(self, message: str = "") -> None: + super().__init__(message) + self.message = message class NotAllowed(DomainError): diff --git a/krater/web/app.py b/krater/web/app.py index 156e084..be35f36 100644 --- a/krater/web/app.py +++ b/krater/web/app.py @@ -145,13 +145,13 @@ def create_app() -> FastAPI: @app.exception_handler(NotAllowed) def _handle_not_allowed(request: Request, exc: NotAllowed): if _is_api(request): - return JSONResponse({"error": str(exc)}, status_code=403) + return JSONResponse({"error": exc.message}, status_code=403) return templates.TemplateResponse(request, "errors/403.html", status_code=403) @app.exception_handler(NotFound) def _handle_not_found(request: Request, exc: NotFound): if _is_api(request): - return JSONResponse({"error": str(exc)}, status_code=404) + return JSONResponse({"error": exc.message}, status_code=404) return templates.TemplateResponse(request, "errors/404.html", status_code=404) # Unknown URLs and the auth dependencies' 403s are plain `HTTPException`s, which FastAPI renders as diff --git a/krater/web/deps.py b/krater/web/deps.py index 0d410cc..051234c 100644 --- a/krater/web/deps.py +++ b/krater/web/deps.py @@ -86,7 +86,7 @@ def fresh_actor( fresh = request.method not in _CACHEABLE_METHODS return user_service.authorize(db_session, weave_client, user, fresh=fresh) except NotAMember as exc: - raise HTTPException(status_code=status.HTTP_403_FORBIDDEN, detail=str(exc)) from exc + raise HTTPException(status_code=status.HTTP_403_FORBIDDEN, detail=exc.message) from exc except WeaveUnavailableError as exc: raise HTTPException(status_code=status.HTTP_503_SERVICE_UNAVAILABLE, detail="Weave is unavailable") from exc diff --git a/krater/web/routers/admin.py b/krater/web/routers/admin.py index 6e75cd5..a5139e7 100644 --- a/krater/web/routers/admin.py +++ b/krater/web/routers/admin.py @@ -141,7 +141,7 @@ def _quilt_action(db_session: Session, request: Request, action, actor: Actor, e action(db_session, actor, row_id=event_id, reason=reason) except (InvalidState, ValidationFailed) as exc: db_session.rollback() - flash(request, str(exc), "error") + flash(request, exc.message, "error") return RedirectResponse("/admin#quilt", status_code=303) db_session.commit() kick_quilt_delivery() diff --git a/krater/web/routers/api.py b/krater/web/routers/api.py index 3a1b077..24abf97 100644 --- a/krater/web/routers/api.py +++ b/krater/web/routers/api.py @@ -113,7 +113,7 @@ def api_actor( try: return user_service.authorize(db_session, weave_client, user, fresh=request.method not in ("GET", "HEAD")) except NotAMember as exc: - raise HTTPException(status_code=status.HTTP_403_FORBIDDEN, detail=str(exc)) from exc + raise HTTPException(status_code=status.HTTP_403_FORBIDDEN, detail=exc.message) from exc except WeaveUnavailableError as exc: raise HTTPException(status_code=status.HTTP_503_SERVICE_UNAVAILABLE, detail="Weave is unavailable") from exc @@ -476,7 +476,7 @@ async def submit( except ConfirmationRequired as exc: db_session.rollback() # Sent again with `"confirm_transfer_cost": true`, the job is queued. - return _error(409, str(exc), confirm="confirm_transfer_cost") + return _error(409, exc.message, confirm="confirm_transfer_cost") except StorageError: db_session.rollback() return _error(503, "Krater's storage didn't answer; try again in a minute.") @@ -485,10 +485,10 @@ async def submit( return _error(422, "Check the job's fields.", fields=exc.errors) except NotAllowed as exc: db_session.rollback() - return _error(403, str(exc)) + return _error(403, exc.message) except (InvalidState, DomainError) as exc: db_session.rollback() - return _error(409, str(exc)) + return _error(409, exc.message) db_session.commit() return {**_job_json(job), "estimate": _estimate_json(db_session, project, job)} @@ -570,7 +570,7 @@ async def begin_input_upload(project_id: uuid.UUID, request: Request, actor: Me, ) except NotAllowed as exc: db_session.rollback() - return _error(403, str(exc)) + return _error(403, exc.message) except ValidationFailed as exc: db_session.rollback() return _error(422, "Check the upload.", fields=exc.errors) @@ -596,7 +596,7 @@ async def complete_input_upload(project_id: uuid.UUID, request: Request, actor: etags=etags, ) except NotAllowed as exc: - return _error(403, str(exc)) + return _error(403, exc.message) except ValidationFailed as exc: return _error(422, "Check the upload.", fields=exc.errors) except StorageError: @@ -610,7 +610,7 @@ def delete_input(project_id: uuid.UUID, name: str, actor: Me, db_session: Db): try: deleted = compute_inputs.delete_input(get_compute_store(), actor, project=project, name=name) except NotAllowed as exc: - return _error(403, str(exc)) + return _error(403, exc.message) except ValidationFailed as exc: return _error(404, exc.errors.get("name", "No such input.")) except StorageError: @@ -632,7 +632,7 @@ def job_logs(job_id: uuid.UUID, actor: Me, db_session: Db, attempt: int | None = get_compute_store(), actor, job=job, attempt=attempt, max_bytes=max(1, min(bytes, 1024 * 1024)) ) except NotAllowed as exc: - return _error(403, str(exc)) + return _error(403, exc.message) except StorageError: return _error(503, "Krater's storage didn't answer; try again in a minute.") if tail is None: @@ -651,7 +651,7 @@ def job_files(job_id: uuid.UUID, actor: Me, db_session: Db): "files": [{"area": f.area, "name": f.name, "size_bytes": f.size_bytes, "url": url} for f, url in downloads] } except NotAllowed as exc: - return _error(403, str(exc)) + return _error(403, exc.message) except StorageError: return _error(503, "Krater's storage didn't answer; try again in a minute.") @@ -670,7 +670,7 @@ def project_files_summary(project_id: uuid.UUID, actor: Me, db_session: Db): try: shown = project_files.summary(db_session, get_compute_store(), actor, project) except NotAllowed as exc: - return _error(403, str(exc)) + return _error(403, exc.message) except StorageError: return _error(503, "Krater's storage didn't answer; try again in a minute.") return { @@ -734,9 +734,9 @@ def workspace_files(project_id: uuid.UUID, workspace_id: uuid.UUID, actor: Me, d _, workspace = _workspace(db_session, actor, project_id, workspace_id) shown, urls = workspaces.downloads(get_compute_store(), workspace) except NotAllowed as exc: - return _error(403, str(exc)) + return _error(403, exc.message) except NotFound as exc: - return _error(404, str(exc)) + return _error(404, exc.message) except StorageError: return _error(503, "Krater's storage didn't answer; try again in a minute.") return { @@ -765,13 +765,13 @@ def delete_workspace(project_id: uuid.UUID, workspace_id: uuid.UUID, actor: Me, count = workspaces.delete(db_session, get_compute_store(), actor, workspace=workspace, now=datetime.now(UTC)) except NotAllowed as exc: db_session.rollback() - return _error(403, str(exc)) + return _error(403, exc.message) except NotFound as exc: db_session.rollback() - return _error(404, str(exc)) + return _error(404, exc.message) except InvalidState as exc: db_session.rollback() - return _error(409, str(exc)) + return _error(409, exc.message) except StorageError: db_session.rollback() return _error(503, "Krater's storage didn't answer; try again in a minute.") @@ -828,10 +828,10 @@ async def post_update(project_id: uuid.UUID, request: Request, actor: Me, db_ses update = project_updates.post(db_session, actor, project=project, body=body["body"]) except NotAllowed as exc: db_session.rollback() - return _error(403, str(exc)) + return _error(403, exc.message) except InvalidState as exc: db_session.rollback() - return _error(409, str(exc)) + return _error(409, exc.message) except ValidationFailed as exc: db_session.rollback() return _error(422, "Check the update.", fields=exc.errors) @@ -866,10 +866,10 @@ def job_action( _ACTIONS[action](db_session, actor, job=job, now=datetime.now(UTC), **extra) except NotAllowed as exc: db_session.rollback() - return _error(403, str(exc)) + return _error(403, exc.message) except (InvalidState, DomainError) as exc: db_session.rollback() - return _error(409, str(exc)) + return _error(409, exc.message) db_session.commit() return _job_json(job) @@ -905,10 +905,10 @@ async def set_secret(project_id: uuid.UUID, name: str, request: Request, actor: return _error(422, "Check the secret.", fields=exc.errors) except NotAllowed as exc: db_session.rollback() - return _error(403, str(exc)) + return _error(403, exc.message) except InvalidState as exc: db_session.rollback() - return _error(409, str(exc)) + return _error(409, exc.message) db_session.commit() return {"name": secret.name, "updated_at": _iso(secret.updated_at)} @@ -920,10 +920,10 @@ def delete_secret(project_id: uuid.UUID, name: str, actor: Me, db_session: Db): project_secrets.delete_secret(db_session, actor, project=project, name=name) except NotAllowed as exc: db_session.rollback() - return _error(403, str(exc)) + return _error(403, exc.message) except NotFound as exc: db_session.rollback() - return _error(404, str(exc)) + return _error(404, exc.message) db_session.commit() return {"deleted": name} diff --git a/krater/web/routers/compute.py b/krater/web/routers/compute.py index 62edf08..3f583d6 100644 --- a/krater/web/routers/compute.py +++ b/krater/web/routers/compute.py @@ -208,7 +208,7 @@ def set_secret( return _index_page(request, db_session, actor, project, errors=exc.errors, posted={"name": name}) except InvalidState as exc: db_session.rollback() - flash(request, str(exc), "error") + flash(request, exc.message, "error") return RedirectResponse(f"/projects/{project.id}/compute", status_code=303) db_session.commit() flash(request, f"Saved {secret.name}. Jobs get it when they next start.", "success") @@ -463,7 +463,7 @@ async def submit_job( ) except ConfirmationRequired as exc: db_session.rollback() - return _form_page(request, db_session, project, weave_client, posted=posted, transfer_warning=str(exc)) + return _form_page(request, db_session, project, weave_client, posted=posted, transfer_warning=exc.message) except (ValidationFailed, ValueError) as exc: db_session.rollback() errors = ( @@ -481,7 +481,7 @@ async def submit_job( return _form_page(request, db_session, project, weave_client, errors=errors, posted=posted, status_code=503) except InvalidState as exc: db_session.rollback() - flash(request, str(exc), "error") + flash(request, exc.message, "error") return RedirectResponse(f"/projects/{project.id}/compute", status_code=303) db_session.commit() flash(request, "Queued. It starts when an offer at or under your price appears.", "success") @@ -775,7 +775,7 @@ def delete_workspace( count = workspaces.delete(db_session, get_compute_store(), actor, workspace=workspace, now=datetime.now(UTC)) except InvalidState as exc: db_session.rollback() - flash(request, str(exc), "error") + flash(request, exc.message, "error") return RedirectResponse(back, status_code=303) db_session.commit() flash(request, f"Deleted the workspace {workspace.name} ({count:,} stored files).", "success") @@ -816,7 +816,7 @@ def job_action( service(db_session, actor, job=job, now=datetime.now(UTC), **extra) except InvalidState as exc: db_session.rollback() - flash(request, str(exc), "error") + flash(request, exc.message, "error") else: db_session.commit() flash(request, message, "success") diff --git a/krater/web/routers/compute_admin.py b/krater/web/routers/compute_admin.py index f7b9553..602d68a 100644 --- a/krater/web/routers/compute_admin.py +++ b/krater/web/routers/compute_admin.py @@ -234,7 +234,7 @@ async def stop_all_compute( return _global_page(request, db_session, switch_errors=exc.errors, switch_reason=reason, status_code=422) except InvalidState as exc: db_session.rollback() - flash(request, str(exc), "error") + flash(request, exc.message, "error") return RedirectResponse("/admin/compute", status_code=303) db_session.commit() if mode == compute_halt.STOP_EMERGENCY: @@ -263,7 +263,7 @@ async def start_all_compute( return _global_page(request, db_session, switch_errors=exc.errors, switch_reason=reason, status_code=422) except InvalidState as exc: db_session.rollback() - flash(request, str(exc), "error") + flash(request, exc.message, "error") return RedirectResponse("/admin/compute", status_code=303) db_session.commit() flash(request, "Compute is back on. Queued jobs start on the next pass, within a minute.", "success") diff --git a/krater/web/routers/funders.py b/krater/web/routers/funders.py index 4b6655e..e8ab1b4 100644 --- a/krater/web/routers/funders.py +++ b/krater/web/routers/funders.py @@ -62,7 +62,7 @@ def ospool_export( funder_packet.record_export(db_session, actor, packet) except FunderPacketUnavailable as exc: db_session.rollback() - flash(request, str(exc), "error") + flash(request, exc.message, "error") return RedirectResponse(PAGE, status_code=303) except ValidationFailed as exc: db_session.rollback() diff --git a/krater/web/routers/projects.py b/krater/web/routers/projects.py index b7dcaec..83b77cb 100644 --- a/krater/web/routers/projects.py +++ b/krater/web/routers/projects.py @@ -185,7 +185,7 @@ def _invalid_state_redirect( db_session: Session, request: Request, project_id: uuid.UUID, exc: InvalidState ) -> RedirectResponse: db_session.rollback() - flash(request, str(exc), "error") + flash(request, exc.message, "error") return _redirect_to_project(project_id) @@ -420,7 +420,7 @@ def edit_draft_form( ): project, draft = _editable(request, db_session, actor, project_id) if draft is None: - return _redirect_to_project(project_id) + return _redirect_to_project(project.id) context = _edit_context(db_session, weave_client, store, actor, project, draft) return templates.TemplateResponse(request, "projects/edit.html", context) @@ -436,7 +436,7 @@ async def update_draft( ): project, draft = _editable(request, db_session, actor, project_id) if draft is None: - return _redirect_to_project(project_id) + return _redirect_to_project(project.id) form = await request.form() if draft.kind is RevisionKind.COMPLETION: @@ -459,7 +459,7 @@ async def update_draft( ) db_session.commit() flash(request, "Draft saved.", "success") - return RedirectResponse(f"/projects/{project_id}/edit", status_code=303) + return RedirectResponse(f"/projects/{project.id}/edit", status_code=303) fill = _fill_from_action(str(form.get("form_action", "save"))) posted = application_form.parse( @@ -497,7 +497,7 @@ def _again(status_code: int): return _again(422) db_session.commit() flash(request, "Draft saved.", "success") - return RedirectResponse(f"/projects/{project_id}/edit", status_code=303) + return RedirectResponse(f"/projects/{project.id}/edit", status_code=303) # -------------------------------------------------------------------------------------------------- @@ -763,7 +763,7 @@ def submit_project( if membership_error is not None: db_session.rollback() flash(request, membership_error, "error") - return _redirect_to_project(project_id) + return _redirect_to_project(project.id) # Ask Weave about the demographics answers now, before `submit` locks the project row, so a slow Weave never holds # the lock. The answer is used after the other checks (below), so a member fixes missing answers first. @@ -787,7 +787,7 @@ def submit_project( ) return templates.TemplateResponse(request, "projects/edit.html", context, status_code=422) except InvalidState as exc: - return _invalid_state_redirect(db_session, request, project_id, exc) + return _invalid_state_redirect(db_session, request, project.id, exc) # The demographics gate runs last, so a member fixes missing answers first. The rollback undoes the submit and # leaves the saved draft as it was. The page links to Weave's form, which sends the member back here. @@ -798,14 +798,14 @@ def submit_project( ) return templates.TemplateResponse(request, "projects/detail.html", context, status_code=409) if isinstance(demographics_error, DemographicsCheckUnavailable): - return _invalid_state_redirect(db_session, request, project_id, demographics_error) + return _invalid_state_redirect(db_session, request, project.id, demographics_error) revision_id = project.current_revision_id def _notify() -> None: slack_notify_revision_submitted.defer(revision_id=str(revision_id)) - return _success_redirect(db_session, request, project_id, "Project submitted for review.", after_commit=_notify) + return _success_redirect(db_session, request, project.id, "Project submitted for review.", after_commit=_notify) @router.post("/projects/{project_id}/submit-completion", dependencies=[Depends(verify_csrf_token)]) @@ -823,7 +823,7 @@ def submit_completion( if membership_error is not None: db_session.rollback() flash(request, membership_error, "error") - return _redirect_to_project(project_id) + return _redirect_to_project(project.id) try: project_service.submit_completion(db_session, actor, project=project) @@ -835,14 +835,14 @@ def submit_completion( ) return templates.TemplateResponse(request, "projects/edit.html", context, status_code=422) except InvalidState as exc: - return _invalid_state_redirect(db_session, request, project_id, exc) + return _invalid_state_redirect(db_session, request, project.id, exc) revision_id = project.current_revision_id def _notify() -> None: slack_notify_revision_submitted.defer(revision_id=str(revision_id)) - return _success_redirect(db_session, request, project_id, "Completion submitted for review.", after_commit=_notify) + return _success_redirect(db_session, request, project.id, "Completion submitted for review.", after_commit=_notify) @router.post("/projects/{project_id}/amend", dependencies=[Depends(verify_csrf_token)]) @@ -856,9 +856,9 @@ def start_amendment( try: project_service.start_amendment(db_session, actor, project=project) except InvalidState as exc: - return _invalid_state_redirect(db_session, request, project_id, exc) + return _invalid_state_redirect(db_session, request, project.id, exc) db_session.commit() - return RedirectResponse(f"/projects/{project_id}/edit", status_code=303) + return RedirectResponse(f"/projects/{project.id}/edit", status_code=303) @router.post("/projects/{project_id}/complete", dependencies=[Depends(verify_csrf_token)]) @@ -872,9 +872,9 @@ def start_completion( try: project_service.start_completion(db_session, actor, project=project) except InvalidState as exc: - return _invalid_state_redirect(db_session, request, project_id, exc) + return _invalid_state_redirect(db_session, request, project.id, exc) db_session.commit() - return RedirectResponse(f"/projects/{project_id}/edit", status_code=303) + return RedirectResponse(f"/projects/{project.id}/edit", status_code=303) @router.post("/projects/{project_id}/withdraw", dependencies=[Depends(verify_csrf_token)]) @@ -897,7 +897,7 @@ def withdraw_project( ) return templates.TemplateResponse(request, "projects/detail.html", context, status_code=422) except InvalidState as exc: - return _invalid_state_redirect(db_session, request, project_id, exc) + return _invalid_state_redirect(db_session, request, project.id, exc) def _notify() -> None: slack_archive_channel.defer(project_id=str(project.id)) @@ -906,7 +906,7 @@ def _notify() -> None: project_id=str(project.id), action="admin_withdraw", actor_sub=actor.user.weave_sub, reason=reason ) - return _success_redirect(db_session, request, project_id, "Project withdrawn.", after_commit=_notify) + return _success_redirect(db_session, request, project.id, "Project withdrawn.", after_commit=_notify) # -------------------------------------------------------------------------------------------------- @@ -935,11 +935,11 @@ def invite_team_member( except WeaveUnavailableError: db_session.rollback() flash(request, "Weave isn't answering, so Krater can't look that person up. Try again shortly.", "error") - return _redirect_to_project(project_id) + return _redirect_to_project(project.id) except InvalidState as exc: - return _invalid_state_redirect(db_session, request, project_id, exc) + return _invalid_state_redirect(db_session, request, project.id, exc) return _success_redirect( - db_session, request, project_id, "Invited. They join the team once they accept on their Krater home page." + db_session, request, project.id, "Invited. They join the team once they accept on their Krater home page." ) @@ -953,15 +953,16 @@ def accept_team_invitation( weave_client: Weave, ): try: - teams.accept(db_session, actor, weave_client, member_id=member_id) + member = teams.accept(db_session, actor, weave_client, member_id=member_id) except InvalidState as exc: - return _invalid_state_redirect(db_session, request, project_id, exc) + project = project_service.get_project(db_session, project_id=project_id) + return _invalid_state_redirect(db_session, request, project.id, exc) return _success_redirect( db_session, request, - project_id, + member.project_id, "You're on the team.", - after_commit=lambda: slack_invite_team.defer(project_id=str(project_id)), + after_commit=lambda: slack_invite_team.defer(project_id=str(member.project_id)), ) @@ -976,7 +977,8 @@ def decline_team_invitation( try: teams.decline(db_session, actor, member_id=member_id) except InvalidState as exc: - return _invalid_state_redirect(db_session, request, project_id, exc) + project = project_service.get_project(db_session, project_id=project_id) + return _invalid_state_redirect(db_session, request, project.id, exc) db_session.commit() flash(request, "Invitation declined.", "success") return RedirectResponse("/", status_code=303) @@ -995,7 +997,7 @@ def remove_team_member( try: left = teams.remove(db_session, actor, project=project, member_id=member_id) except InvalidState as exc: - return _invalid_state_redirect(db_session, request, project_id, exc) + return _invalid_state_redirect(db_session, request, project.id, exc) def remove_from_channel() -> None: if left is not None: @@ -1007,7 +1009,7 @@ def remove_from_channel() -> None: flash(request, "You left the team.", "success") return RedirectResponse("/", status_code=303) return _success_redirect( - db_session, request, project_id, "Removed from the team.", after_commit=remove_from_channel + db_session, request, project.id, "Removed from the team.", after_commit=remove_from_channel ) @@ -1078,7 +1080,7 @@ def record_review( ) return templates.TemplateResponse(request, "projects/detail.html", context, status_code=422) except InvalidState as exc: - return _invalid_state_redirect(db_session, request, project_id, exc) + return _invalid_state_redirect(db_session, request, project.id, exc) revision_id = revision.id @@ -1089,7 +1091,7 @@ def _notify() -> None: slack_archive_channel.defer(project_id=str(project.id)) message = _decision_message(db_session, project, revision, "Review recorded.") - return _success_redirect(db_session, request, project_id, message, after_commit=_notify) + return _success_redirect(db_session, request, project.id, message, after_commit=_notify) # -------------------------------------------------------------------------------------------------- @@ -1153,7 +1155,7 @@ def admin_decide( ) return templates.TemplateResponse(request, "projects/detail.html", context, status_code=422) except InvalidState as exc: - return _invalid_state_redirect(db_session, request, project_id, exc) + return _invalid_state_redirect(db_session, request, project.id, exc) revision_id = revision.id action = "admin_approve" if decision_enum is ReviewDecision.APPROVE else "admin_reject" @@ -1172,7 +1174,7 @@ def _notify() -> None: ) message = _decision_message(db_session, project, revision, "Decision recorded.") - return _success_redirect(db_session, request, project_id, message, after_commit=_notify) + return _success_redirect(db_session, request, project.id, message, after_commit=_notify) @router.post("/projects/{project_id}/admin-funding-hold", dependencies=[Depends(verify_csrf_token)]) @@ -1214,10 +1216,10 @@ def admin_funding_hold( if not actor.is_admin: raise db_session.rollback() # the own-project rule: say so on the page - flash(request, str(exc), "error") - return _redirect_to_project(project_id) + flash(request, exc.message, "error") + return _redirect_to_project(project.id) except InvalidState as exc: - return _invalid_state_redirect(db_session, request, project_id, exc) + return _invalid_state_redirect(db_session, request, project.id, exc) action = funding_holds.AUDIT_CLEAR if hold is None else funding_holds.AUDIT_SET extra = funding_holds.describe_change(previous, hold) @@ -1235,7 +1237,7 @@ def _notify() -> None: message = "Hold cleared. The held budget is added once every team member is verified in Weave." else: message = "Hold cleared." - return _success_redirect(db_session, request, project_id, message, after_commit=_notify) + return _success_redirect(db_session, request, project.id, message, after_commit=_notify) def _parse_ospool_rate(raw: str, errors: dict[str, str]) -> int | None: @@ -1318,10 +1320,10 @@ def admin_record_ospool_grant( ) except NotAllowed as exc: db_session.rollback() # the own-project rule: say so on the page - flash(request, str(exc), "error") - return _redirect_to_project(project_id) + flash(request, exc.message, "error") + return _redirect_to_project(project.id) except InvalidState as exc: - return _invalid_state_redirect(db_session, request, project_id, exc) + return _invalid_state_redirect(db_session, request, project.id, exc) name, since, rate_line = grant.ospool_project_name, grant.counted_from.isoformat(), ospool_grants.rate_text(grant) @@ -1335,7 +1337,7 @@ def _notify() -> None: ) message = f"OSPool grant recorded. Usage under {name} shows here after the next daily import." - return _success_redirect(db_session, request, project_id, message, after_commit=_notify) + return _success_redirect(db_session, request, project.id, message, after_commit=_notify) @router.post("/projects/{project_id}/admin-ospool-valuation", dependencies=[Depends(verify_csrf_token)]) @@ -1377,10 +1379,10 @@ def admin_ospool_valuation( ) except NotAllowed as exc: db_session.rollback() # the own-project rule: say so on the page - flash(request, str(exc), "error") - return _redirect_to_project(project_id) + flash(request, exc.message, "error") + return _redirect_to_project(project.id) except InvalidState as exc: - return _invalid_state_redirect(db_session, request, project_id, exc) + return _invalid_state_redirect(db_session, request, project.id, exc) rate_line = ospool_grants.rate_text(grant) @@ -1394,7 +1396,7 @@ def _notify() -> None: ) message = "Valuation saved. Days already valued keep their price." - return _success_redirect(db_session, request, project_id, message, after_commit=_notify) + return _success_redirect(db_session, request, project.id, message, after_commit=_notify) @router.post("/projects/{project_id}/admin-budget", dependencies=[Depends(verify_csrf_token)]) @@ -1442,13 +1444,13 @@ def admin_adjust_budget( weave_client, project, actor, - errors=exc.errors if isinstance(exc, ValidationFailed) else {"amount_cents": str(exc)}, + errors=exc.errors if isinstance(exc, ValidationFailed) else {"amount_cents": exc.message}, error_form="admin_budget", posted={"amount": amount, "reason": reason}, ) return templates.TemplateResponse(request, "projects/detail.html", context, status_code=422) except InvalidState as exc: - return _invalid_state_redirect(db_session, request, project_id, exc) + return _invalid_state_redirect(db_session, request, project.id, exc) def _notify() -> None: slack_post_admin_override.defer( @@ -1468,7 +1470,7 @@ def _notify() -> None: ) else: message = "Budget increase held until every team member is verified in Weave." - return _success_redirect(db_session, request, project_id, message, after_commit=_notify) + return _success_redirect(db_session, request, project.id, message, after_commit=_notify) @router.post("/projects/{project_id}/admin-reclaim", dependencies=[Depends(verify_csrf_token)]) @@ -1516,7 +1518,7 @@ def admin_reclaim_budget( ) return templates.TemplateResponse(request, "projects/detail.html", context, status_code=422) except InvalidState as exc: - return _invalid_state_redirect(db_session, request, project_id, exc) + return _invalid_state_redirect(db_session, request, project.id, exc) def _notify() -> None: slack_post_admin_override.defer( @@ -1527,7 +1529,7 @@ def _notify() -> None: extra=f"Reclaimed: {amount_cents / 100:.2f}", ) - return _success_redirect(db_session, request, project_id, "Budget reclaimed.", after_commit=_notify) + return _success_redirect(db_session, request, project.id, "Budget reclaimed.", after_commit=_notify) @router.post("/projects/{project_id}/admin-hourly-cap", dependencies=[Depends(verify_csrf_token)]) @@ -1569,13 +1571,13 @@ def admin_set_hourly_cap( if isinstance(exc, NotAllowed) and not actor.is_admin: raise db_session.rollback() - errors = exc.errors if isinstance(exc, ValidationFailed) else {"cap_cents": str(exc)} + errors = exc.errors if isinstance(exc, ValidationFailed) else {"cap_cents": exc.message} context = _build_detail_context( db_session, weave_client, project, actor, errors=errors, error_form="admin_hourly_cap", posted=posted ) return templates.TemplateResponse(request, "projects/detail.html", context, status_code=422) except InvalidState as exc: - return _invalid_state_redirect(db_session, request, project_id, exc) + return _invalid_state_redirect(db_session, request, project.id, exc) new_cap = format_cents(cap_cents if cap_cents is not None else default_cap_cents) described = f"{new_cap}/hour" + (" (the default)" if cap_cents is None else "") @@ -1589,7 +1591,7 @@ def _notify() -> None: extra=f"Hourly cap per launch: {described}", ) - return _success_redirect(db_session, request, project_id, f"Hourly cap set to {described}.", after_commit=_notify) + return _success_redirect(db_session, request, project.id, f"Hourly cap set to {described}.", after_commit=_notify) _COMPLETION_FIELDS = ("title", "repo_url", "write_up", "demo_url", "tags") @@ -1611,7 +1613,7 @@ def _gallery_preview( if draft is None or draft.kind is not RevisionKind.COMPLETION: if draft is not None: flash(request, "Only a completion has a gallery page to preview.", "error") - return _redirect_to_project(project_id) + return _redirect_to_project(project.id) unsaved = values is not None values = values if unsaved else _completion_values(project, draft) # The gallery only ever links to checked links, so the preview doesn't show one it would refuse to save. @@ -1726,7 +1728,7 @@ def presign_screenshot( except ValidationFailed as exc: return JSONResponse({"errors": exc.errors}, status_code=422) except InvalidState as exc: - return JSONResponse({"errors": {"screenshot": str(exc)}}, status_code=409) + return JSONResponse({"errors": {"screenshot": exc.message}}, status_code=409) return JSONResponse({"key": upload.key, "url": upload.post.url, "fields": upload.post.fields}) @@ -1747,7 +1749,7 @@ def confirm_screenshot( return JSONResponse({"errors": exc.errors}, status_code=422) except InvalidState as exc: db_session.rollback() - return JSONResponse({"errors": {"screenshot": str(exc)}}, status_code=409) + return JSONResponse({"errors": {"screenshot": exc.message}}, status_code=409) db_session.commit() return JSONResponse(_image_entry(store, project, key)) @@ -1768,13 +1770,13 @@ def delete_screenshot( except InvalidState as exc: if wants_json: db_session.rollback() - return JSONResponse({"errors": {"screenshot": str(exc)}}, status_code=409) - return _invalid_state_redirect(db_session, request, project_id, exc) + return JSONResponse({"errors": {"screenshot": exc.message}}, status_code=409) + return _invalid_state_redirect(db_session, request, project.id, exc) db_session.commit() if wants_json: return JSONResponse({"removed": key}) flash(request, "Image removed.", "success") - return RedirectResponse(f"/projects/{project_id}/edit", status_code=303) + return RedirectResponse(f"/projects/{project.id}/edit", status_code=303) __all__ = ["router"] diff --git a/krater/web/routers/runner.py b/krater/web/routers/runner.py index a52d068..2a48f40 100644 --- a/krater/web/routers/runner.py +++ b/krater/web/routers/runner.py @@ -36,8 +36,8 @@ def _token(request: Request) -> str: return token.strip() if scheme.lower() == "bearer" else "" -def _deny(exc: Exception) -> JSONResponse: - return JSONResponse({"error": str(exc)}, status_code=403) +def _deny(exc: NotAllowed) -> JSONResponse: + return JSONResponse({"error": exc.message}, status_code=403) async def _body(request: Request) -> dict[str, Any]: @@ -229,7 +229,7 @@ def _files(request: Request, db_session: Session, action): return _deny(exc) except ValidationFailed as exc: db_session.rollback() # lets go of the project's row lock an upload took - return JSONResponse({"error": str(exc), "fields": exc.errors}, status_code=422) + return JSONResponse({"error": exc.message, "fields": exc.errors}, status_code=422) except StorageError: db_session.rollback() return JSONResponse({"error": "Storage is unavailable; try again."}, status_code=503) diff --git a/krater/web/routers/updates.py b/krater/web/routers/updates.py index 74d9a85..d7febf9 100644 --- a/krater/web/routers/updates.py +++ b/krater/web/routers/updates.py @@ -151,7 +151,7 @@ def _refuse(errors: dict[str, str], demographics_url: str | None = None): demographics.require_answered(weave_client, actor.user) except DemographicsRequired as exc: back = f"{get_settings().base_url.rstrip('/')}/projects/{project.id}/updates/new?topup=1" - return _refuse({"form": str(exc), "demographics": "1"}, demographics_url=demographics_form_url(back)) + return _refuse({"form": exc.message, "demographics": "1"}, demographics_url=demographics_form_url(back)) except DemographicsCheckUnavailable as exc: return _invalid_state_redirect(db_session, request, project_id, exc) try: diff --git a/scripts/dev/weave_e2e_setup.py b/scripts/dev/weave_e2e_setup.py index 7c3e276..0eda511 100644 --- a/scripts/dev/weave_e2e_setup.py +++ b/scripts/dev/weave_e2e_setup.py @@ -78,6 +78,9 @@ def write_fixtures(data: dict, *, krater_base_url: str) -> None: "", ] ENV_PATH.write_text("\n".join(env_lines)) + # Both hold the dev OAuth client secret: readable by this user only. + FIXTURE_PATH.chmod(0o600) + ENV_PATH.chmod(0o600) def main() -> None: diff --git a/tests/services/test_errors.py b/tests/services/test_errors.py new file mode 100644 index 0000000..3f09917 --- /dev/null +++ b/tests/services/test_errors.py @@ -0,0 +1,32 @@ +"""`DomainError.message`: the text routers send back to the person, the same words the service raised.""" + +from __future__ import annotations + +from krater.services.errors import ( + ClearanceCheckUnavailable, + DomainError, + InvalidState, + NotFound, + ValidationFailed, + VerificationRequired, +) +from krater.services.funding_holds import FundingHeld, FundingHold + + +def test_message_is_what_the_service_said() -> None: + assert InvalidState("Already submitted.").message == "Already submitted." + assert str(InvalidState("Already submitted.")) == "Already submitted." + + +def test_message_defaults_to_empty() -> None: + assert NotFound().message == "" + assert DomainError().message == "" + + +def test_subclasses_with_their_own_init_keep_their_message() -> None: + failed = ValidationFailed({"title": "Give it a title."}) + assert failed.message == "title: Give it a title." + assert failed.errors == {"title": "Give it a title."} + assert ClearanceCheckUnavailable().message.startswith("Krater couldn't reach Weave") + assert VerificationRequired([("ana", "not verified")]).message.startswith("This project's compute is held") + assert FundingHeld(next(iter(FundingHold))).message == str(FundingHeld(next(iter(FundingHold))))