Skip to content

ServerKit is a lightweight, modern server control panel for managing web applications, databases, and services on your VPS or dedicated server. Built with Python/Flask backend and React frontend.

4.4 KB
Raw Blame
# Bucket: PER-APP. Reads require app access (can_access_app); the
# enable/sync/redeploy/destroy mutations require write access (can_edit_app),
# replacing the old panel-wide @developer_required.
"""PR Preview Environments API.

Mounted by the host at ``/api/v1/apps`` so every route here is nested under an
application id, e.g. ``GET /api/v1/apps/<app_id>/previews``.
"""
from flask import Blueprint, jsonify
from flask_jwt_extended import jwt_required

from app.models.application_preview import ApplicationPreview
from app.services.preview_service import PreviewService
from app.api._access import require_app
from app.api._request import json_object
from app.middleware.rbac import developer_required
from app.services.previews.requests import enqueue, validate_request
from app.services.previews.plan import PreviewError
from app.exceptions import ValidationError

previews_bp = Blueprint('previews', __name__)


@previews_bp.route('/<int:app_id>/previews', methods=['GET'])
@jwt_required()
def list_previews(app_id):
    """List the non-destroyed previews for an application (newest first)."""
    app = require_app(app_id, conceal=True)
    previews = ApplicationPreview.query.filter(
        ApplicationPreview.application_id == app_id,
        ApplicationPreview.status != ApplicationPreview.STATUS_DESTROYED,
    ).order_by(ApplicationPreview.pr_number.desc()).all()
    return jsonify({'previews': [p.to_dict() for p in previews]}), 200


@previews_bp.route('/<int:app_id>/previews/settings', methods=['GET'])
@jwt_required()
def get_preview_settings(app_id):
    """Return the per-app preview settings (defaults when never configured)."""
    app = require_app(app_id, conceal=True)
    settings = PreviewService.get_settings(app_id)
    return jsonify(settings.to_dict()), 200


@previews_bp.route('/<int:app_id>/previews/settings', methods=['PUT'])
@jwt_required()
def update_preview_settings(app_id):
    """Enable/disable previews and set the domain template + TTL for an app."""
    app = require_app(app_id, write=True, conceal=True)
    data = json_object(optional=True)
    try:
        result = PreviewService.enable_previews(app_id, data)
    except ValueError as exc:
        raise ValidationError(str(exc)) from exc
    return jsonify(result), 200


@previews_bp.route('/<int:app_id>/previews/sync', methods=['POST'])
@jwt_required()
def sync_previews(app_id):
    """Reconcile this app's previews against its open PRs (best-effort)."""
    app = require_app(app_id, write=True, conceal=True)
    result = PreviewService.sync_previews(app_id)
    status = 400 if result.get('error') else 200
    return jsonify(result), status


@previews_bp.route('/<int:app_id>/previews/<int:preview_id>/redeploy', methods=['POST'])
@jwt_required()
def redeploy_preview(app_id, preview_id):
    """Re-provision a preview for the same PR (idempotent update-in-place)."""
    app = require_app(app_id, write=True, conceal=True)
    preview = ApplicationPreview.query.filter_by(
        id=preview_id, application_id=app_id).first()
    if not preview:
        return jsonify({'error': 'Preview not found'}), 404
    job = enqueue(app_id, {
        'pr_number': preview.pr_number, 'branch': preview.branch,
        'pr_title': preview.pr_title, 'commit_sha': preview.commit_sha,
    })
    return jsonify({'status': 'queued', 'job_id': job.id}), 202



@previews_bp.route('/<int:app_id>/previews/<int:preview_id>', methods=['DELETE'])
@jwt_required()
def destroy_preview(app_id, preview_id):
    """Tear down and mark a preview destroyed."""
    app = require_app(app_id, write=True, conceal=True)
    preview = ApplicationPreview.query.filter_by(
        id=preview_id, application_id=app_id).first()
    if not preview:
        return jsonify({'error': 'Preview not found'}), 404
    job = enqueue(app_id, {'pr_number': preview.pr_number}, action='destroy')
    return jsonify({'status': 'queued', 'job_id': job.id}), 202


@previews_bp.route('/<int:app_id>/previews', methods=['POST'])
@developer_required
def create_preview(app_id):
    """Queue a pinned same-repository preview (also supports API-key CI callers)."""
    app = require_app(app_id, write=True, conceal=True)
    data = json_object()
    try:
        job = enqueue(app_id, validate_request(app, data))
    except (PreviewError, TypeError, ValueError) as exc:
        raise ValidationError(str(exc) or 'Invalid preview request') from exc
    return jsonify({'status': 'queued', 'job_id': job.id}), 202