add command to deply a pr

README.md

@@ -51,7 +51,7 @@ The goal is to improve developer experience by making the review process as lean
 
 ```py
 # requirements.txt
-gradio-space-ci @ git+https://huggingface.co/spaces/Wauplin/gradio-space-ci@0.2.2
+gradio-space-ci @ git+https://huggingface.co/spaces/Wauplin/gradio-space-ci@0.2.3
 ```
 
 2. Set `HF_TOKEN` as a Space secret.
@@ -110,7 +110,7 @@ Add the following line to it:
 
 ```bash
 # requirements.txt
-gradio-space-ci @ git+https://huggingface.co/spaces/Wauplin/gradio-space-ci@0.2.2
+gradio-space-ci @ git+https://huggingface.co/spaces/Wauplin/gradio-space-ci@0.2.3
 ```
 
 ### 2. Add a user token as `HF_TOKEN` secret

RELEASE.md

@@ -1,3 +1,7 @@
+## 0.2.3
+
+- Deploy on "draft" PRs as well, not just "open" PRs.
+
 ## 0.2.2
 
 - Install `huggingface_hub>=0.21.1` now that 0.21 have been released.

open_pr.py

@@ -27,7 +27,7 @@ This PR enables Space CI on your Space. **Gradio Space CI is a tool to create ep
 
 ---
 This is an automated PR created with https://huggingface.co/spaces/Wauplin/gradio-space-ci.
-For more details about Space CI, checkout [this page]](https://huggingface.co/spaces/Wauplin/gradio-space-ci/blob/main/README.md).
+For more details about Space CI, checkout [this page](https://huggingface.co/spaces/Wauplin/gradio-space-ci/blob/main/README.md).
 If you find any issues, please report here: https://huggingface.co/spaces/Wauplin/gradio-space-ci/discussions
 
 Feel free to ignore this PR.
@@ -61,7 +61,7 @@ def open_pr(space_id_or_url: str, oauth_token: gr.OAuthToken | None) -> str:
     else:
         requirements = ""
     if "gradio-space-ci" not in requirements:
-        requirements += "\ngradio-space-ci @ git+https://huggingface.co/spaces/Wauplin/gradio-space-ci@0.2.2\n"
+        requirements += "\ngradio-space-ci @ git+https://huggingface.co/spaces/Wauplin/gradio-space-ci@0.2.3\n"
 
     # 2. Configure CI in README.md
     card = SpaceCard.load(api.hf_hub_download(repo_id=space_id, repo_type="space", filename="README.md"))

src/gradio_space_ci/__init__.py

@@ -38,4 +38,4 @@ else:
     from .webhook import enable_space_ci  # noqa: F401
 
 
-__version__ = "0.2.2"
+__version__ = "0.2.3"

src/gradio_space_ci/webhook.py

@@ -54,6 +54,9 @@ if SPACE_ID is not None:  # If running in a Space (i.e. not locally)
 
 EPHEMERAL_SPACES_CONFIG: Dict[str, Any] = {}
 
+# Draft and open PRs are considered as active (in opposition to closed and merged PRs)
+ACTIVE_PR_STATUS = ("draft", "open")
+
 
 def enable_space_ci() -> None:
     """Enable Space CI for the current Space based on config from the README.md file.
@@ -198,7 +201,9 @@ background_pool = ThreadPoolExecutor(max_workers=1)
 def recover_after_restart(space_id: str) -> None:
     print("Looping through PRs to check if any needs to be synced.")
     for discussion in get_repo_discussions(repo_id=space_id, repo_type="space", discussion_type="pull_request"):
-        if discussion.status == "open":
+        if discussion.status in ACTIVE_PR_STATUS:
+            # check pr trust status
+            handle_modification(space_id=space_id, discussion=discussion)
             if not is_pr_synced(space_id=space_id, pr_num=discussion.num):
                 # Found a PR that is not yet synced
                 print(f"Recovery. Found an open PR that is not synced: {discussion.url}. Syncing it.")
@@ -246,13 +251,17 @@ async def trigger_ci_on_pr(payload: WebhookPayload, task_queue: BackgroundTasks)
 
     has_task = False
     if (
-        # Means "a new PR has been opened"
+        # Means "a new PR has been opened" or a new comment
         payload.event.scope.startswith("discussion")
         and payload.event.action == "create"
         and payload.discussion is not None
         and payload.discussion.isPullRequest
-        and payload.discussion.status == "open"
+        and payload.discussion.status in ACTIVE_PR_STATUS
     ):
+        # A comment, is it by a command ?
+        if payload.event.scope == "discussion.comment":
+            handle_command(space_id=space_id, payload=payload)
+        # Always sync (in case the space was sleeping or building)
         if not is_pr_synced(space_id=space_id, pr_num=payload.discussion.num):
             # New PR! Sync task scheduled
             task_queue.add_task(sync_ci_space, space_id=space_id, pr_num=payload.discussion.num)
@@ -278,7 +287,7 @@ async def trigger_ci_on_pr(payload: WebhookPayload, task_queue: BackgroundTasks)
         # New repo change. Is it a commit on a PR?
         # => loop through all PRs and check if new changes happened
         for discussion in get_repo_discussions(repo_id=space_id, repo_type="space"):
-            if discussion.is_pull_request and discussion.status == "open":
+            if discussion.is_pull_request and discussion.status in ACTIVE_PR_STATUS:
                 if not is_pr_synced(space_id=space_id, pr_num=discussion.num):
                     # Found a PR that is not yet synced
                     task_queue.add_task(sync_ci_space, space_id=space_id, pr_num=discussion.num)
@@ -428,7 +437,9 @@ def delete_ci_space(space_id: str, pr_num: int) -> None:
 def notify_pr(
     space_id: str,
     pr_num: int,
-    action: Literal["created_not_configured", "created_and_configured", "updated", "deleted"],
+    action: Literal[
+        "created_not_configured", "created_and_configured", "updated", "deleted", "trusted_pr", "untrusted_pr"
+    ],
 ) -> None:
     ci_space_id = _get_ci_space_id(space_id=space_id, pr_num=pr_num)
     if action == "created_not_configured":
@@ -439,6 +450,10 @@ def notify_pr(
         comment = NOTIFICATION_TEMPLATE_UPDATED.format(ci_space_id=ci_space_id)
     elif action == "deleted":
         comment = NOTIFICATION_TEMPLATE_DELETED
+    elif action == "trusted_pr":
+        comment = NOTIFICATION_TEMPLATE_TRUSTED_PR
+    elif action == "untrusted_pr":
+        comment = NOTIFICATION_TEMPLATE_UNTRUSTED_PR
     else:
         raise ValueError(f"Status {action} not handled.")
 
@@ -449,6 +464,84 @@ def _get_ci_space_id(space_id: str, pr_num: int) -> str:
     return f"{space_id}-ci-pr-{pr_num}"
 
 
+def set_config(space_id: str, pr_num: str) -> None:
+    """a function to set the ephemerial space config"""
+    variables: Dict[str, str] = EPHEMERAL_SPACES_CONFIG["variables"]
+    secrets: Dict[str, str] = EPHEMERAL_SPACES_CONFIG["secrets"]
+    hardware: Optional[SpaceHardware] = EPHEMERAL_SPACES_CONFIG["hardware"]
+    storage: Optional[SpaceHardware] = EPHEMERAL_SPACES_CONFIG["storage"]
+    ci_space_id = _get_ci_space_id(space_id=space_id, pr_num=pr_num)
+    # Configure space
+    for key, value in variables.items():
+        add_space_variable(ci_space_id, key, value)
+    for key, value in secrets.items():
+        add_space_secret(ci_space_id, key, value)
+
+    # Request hardware/storage for space
+    if hardware is not None and hardware != SpaceHardware.CPU_BASIC:
+        request_space_hardware(ci_space_id, hardware, sleep_time=5 * 60)  # sleep after 5min on PR Spaces with GPU
+    if storage is not None:
+        request_space_storage(ci_space_id, storage)
+
+
+def rebuild_space(space_id: str, pr_num: int) -> None:
+    "a function to rebuild the ephemeral space without config"
+    # This is useful to cut down on resource usage and to remove tokens from
+    # the ephemeral space
+    ci_space_id = _get_ci_space_id(space_id=space_id, pr_num=pr_num)
+    try:
+        delete_repo(repo_id=ci_space_id, repo_type="space")
+    except RepositoryNotFoundError:
+        pass
+    create_ephemeral_space(space_id=space_id, pr_num=pr_num)
+    # Download space codebase from PR revision
+    snapshot_path = Path(snapshot_download(repo_id=space_id, revision=f"refs/pr/{pr_num}", repo_type="space"))
+
+    # Overwrite README file in cache (/!\)
+    readme_path = snapshot_path / "README.md"
+    card = RepoCard.load(readme_path)
+    setattr(card.data, "synced_sha", snapshot_path.name)  # latest sha
+    card.data.title = f"{card.data.title} (ephemeral #{pr_num})"
+    card.save(readme_path)
+
+    # Sync space codebase with PR revision
+    upload_folder(
+        repo_id=ci_space_id,
+        repo_type="space",
+        commit_message=f"Sync CI Space with PR {pr_num}.",
+        folder_path=snapshot_path,
+        delete_patterns="*",
+    )
+
+    # Delete readme file from cache (just in case)
+    readme_path.unlink(missing_ok=True)
+
+
+def handle_modification(space_id: str, discussion: Any) -> None:
+    ci_space_id = _get_ci_space_id(space_id=space_id, pr_num=discussion.num)
+    if not repo_exists(ci_space_id):
+        return
+    details = get_discussion_details(repo_id=space_id, repo_type="space", discussion_num=discussion.num)
+    event_author = details.events[-1]._event["author"]["name"]  # username of that event
+    if event_author not in EPHEMERAL_SPACES_CONFIG["trusted_authors"]:
+        # Untrusted author, we rebuild the space
+        rebuild_space(space_id=space_id, pr_num=discussion.num)
+
+
+def handle_command(space_id: str, payload: WebhookPayload) -> None:
+    """when a trusted author writes a command we handle it"""
+    pr_num = payload.discussion.num
+    details = get_discussion_details(repo_id=space_id, repo_type="space", discussion_num=pr_num)
+    event_author = details.events[-1]._event["author"]["name"]  # username of that event
+    if event_author in EPHEMERAL_SPACES_CONFIG["trusted_authors"]:
+        if payload.comment.content == "/trust_pr":
+            set_config(space_id=space_id, pr_num=pr_num)
+            notify_pr(space_id=space_id, pr_num=pr_num, action="trusted_pr")
+        elif payload.comment.content == "/untrust_pr":
+            rebuild_space(space_id=space_id, pr_num=pr_num)
+            notify_pr(space_id=space_id, pr_num=pr_num, action="untrusted_pr")
+
+
 NOTIFICATION_TEMPLATE_CREATED_AND_CONFIGURED = """\
 Following the creation of this PR, an ephemeral Space [{ci_space_id}](https://huggingface.co/spaces/{ci_space_id}) has been started. Any changes pushed to this PR will be synced with the test Space.
 Since this PR has been created by a trusted author, the ephemeral Space has been configured with the correct hardware, storage, and secrets.
@@ -471,6 +564,17 @@ PR is now merged/closed. The ephemeral Space has been deleted.
 _(This is an automated message.)_
 """
 
+NOTIFICATION_TEMPLATE_TRUSTED_PR = """\
+This PR has been granted temporary trust status Thus granting it with the appropriate approriate hardware, storage, and secrets.
+Trust status will be revokeduser either when a trusted author uses `/untrust_pr` command or when new commits are pushed to this PR.
+_(This is an automated message.)_
+"""
+
+NOTIFICATION_TEMPLATE_UNTRUSTED_PR = """\
+This PR has been untrusted. Thus resetting all hardware, storage, and secrets.
+_(This is an automated message.)_
+"""
+
 ### TO MOVE TO ITS OWN MODULE
 # Taken from https://github.com/huggingface/huggingface_hub/issues/1808#issuecomment-1802341663