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,17 +201,19 @@ 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.")
-                background_pool.submit(sync_ci_space, space_id=space_id, pr_num=discussion.num)
+                background_pool.submit(sync_ci_space, space_id=space_id, pr_num=discussion.num, skip_config=False)
         if discussion.status == "merged" or discussion.status == "closed":
             ci_space_id = _get_ci_space_id(space_id=space_id, pr_num=discussion.num)
             if repo_exists(repo_id=ci_space_id, repo_type="space"):
                 # Found a PR for which the CI space has not been deleted
                 print(f"Recovery. Found a closed PR with an active CI space: {discussion.url}. Deleting it.")
-                background_pool.submit(delete_ci_space, space_id=space_id, pr_num=discussion.num)
+                background_pool.submit(delete_ci_space, space_id=space_id, pr_num=discussion.num, notify=True)
 
 
 ###
@@ -246,16 +251,20 @@ 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 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)
+            task_queue.add_task(sync_ci_space, space_id=space_id, pr_num=payload.discussion.num, skip_config=False)
             has_task = True
     elif (
         # Means "a PR has been merged or closed"
@@ -265,11 +274,7 @@ async def trigger_ci_on_pr(payload: WebhookPayload, task_queue: BackgroundTasks)
         and payload.discussion.isPullRequest
         and (payload.discussion.status == "merged" or payload.discussion.status == "closed")
     ):
-        task_queue.add_task(
-            delete_ci_space,
-            space_id=space_id,
-            pr_num=payload.discussion.num,
-        )
+        task_queue.add_task(delete_ci_space, space_id=space_id, pr_num=payload.discussion.num, notify=True)
         has_task = True
     elif (
         # Means "some content has been pushed to the Space" (any branch)
@@ -278,10 +283,10 @@ 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)
+                    task_queue.add_task(sync_ci_space, space_id=space_id, pr_num=discussion.num, skip_config=False)
                     has_task = True
 
     if has_task:
@@ -312,9 +317,9 @@ def is_pr_synced(space_id: str, pr_num: int) -> bool:
     return last_synced_sha == last_pr_sha
 
 
-def sync_ci_space(space_id: str, pr_num: int) -> None:
+def sync_ci_space(space_id: str, pr_num: int, skip_config: bool = False) -> None:
     print(f"New task: sync ephemeral env for {space_id} (PR {pr_num})")
-    if is_pr_synced(space_id=space_id, pr_num=pr_num):
+    if is_pr_synced(space_id=space_id, pr_num=pr_num) and not skip_config:
         print("Already synced. Nothing to do.")
         return
 
@@ -325,11 +330,13 @@ def sync_ci_space(space_id: str, pr_num: int) -> None:
 
     # Configure ephemeral Space if trusted author
     is_configured = False
-    if is_new:
+    if not skip_config and is_new:
         is_configured = configure_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"))
+    snapshot_path = Path(
+        snapshot_download(repo_id=space_id, revision=f"refs/pr/{pr_num}", repo_type="space", force_download=True)
+    )
 
     # Overwrite README file in cache (/!\)
     readme_path = snapshot_path / "README.md"
@@ -351,7 +358,9 @@ def sync_ci_space(space_id: str, pr_num: int) -> None:
     readme_path.unlink(missing_ok=True)
 
     # Post a comment on the PR
-    if is_new and is_configured:
+    if is_new and skip_config:
+        notify_pr(space_id=space_id, pr_num=pr_num, action="untrusted_pr")
+    elif is_new and is_configured:
         notify_pr(space_id=space_id, pr_num=pr_num, action="created_and_configured")
     elif is_new:
         notify_pr(space_id=space_id, pr_num=pr_num, action="created_not_configured")
@@ -381,7 +390,14 @@ def create_ephemeral_space(space_id: str, pr_num: int) -> bool:
             raise
 
 
-def configure_ephemeral_space(space_id: str, pr_num: int) -> bool:
+##
+# configure_ephemeral_space logic
+# if a pr is made by a trusted author or an author trusts a pr
+# => we configure the ephemeral space
+##
+
+
+def configure_ephemeral_space(space_id: str, pr_num: int, trusted_pr=False) -> bool:
     # Config values
     ci_space_id = _get_ci_space_id(space_id=space_id, pr_num=pr_num)
     trusted_authors: List[str] = EPHEMERAL_SPACES_CONFIG["trusted_authors"]
@@ -392,25 +408,25 @@ def configure_ephemeral_space(space_id: str, pr_num: int) -> bool:
 
     # Check if trusted author
     details = get_discussion_details(repo_id=space_id, repo_type="space", discussion_num=pr_num)
-    if details.author not in trusted_authors:
-        return False  # not a trusted author => do NOT set secrets, hardware, storage, etc.
-
-    # 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)
+    if details.author in trusted_authors or trusted_pr is True:
+        # 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)
 
-    # 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)
-
-    return True
+        return True
+    else:
+        return False
 
 
-def delete_ci_space(space_id: str, pr_num: int) -> None:
+def delete_ci_space(space_id: str, pr_num: int, notify: bool = True) -> None:
     print(f"New task: delete ephemeral env for {space_id} (PR {pr_num})")
 
     # Delete
@@ -422,13 +438,17 @@ def delete_ci_space(space_id: str, pr_num: int) -> None:
         return
 
     # Notify about deletion
-    notify_pr(space_id=space_id, pr_num=pr_num, action="deleted")
+    if notify is True:
+        # This logic is adaped across multiple functions so we will not always notify the pr
+        notify_pr(space_id=space_id, pr_num=pr_num, action="deleted")
 
 
 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 +459,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.format(ci_space_id=ci_space_id)
+    elif action == "untrusted_pr":
+        comment = NOTIFICATION_TEMPLATE_UNTRUSTED_PR.format(ci_space_id=ci_space_id)
     else:
         raise ValueError(f"Status {action} not handled.")
 
@@ -449,6 +473,42 @@ def _get_ci_space_id(space_id: str, pr_num: int) -> str:
     return f"{space_id}-ci-pr-{pr_num}"
 
 
+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
+    delete_ci_space(space_id=space_id, pr_num=pr_num, notify=False)
+    # create a new synced ephemeral space
+    sync_ci_space(space_id=space_id, pr_num=pr_num, skip_config=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)
+    # If last commit is not by a trusted author we rebuild it
+    for event in details.events[::-1]:
+        if event.type == "commit":
+            if event._event["author"]["name"] not in EPHEMERAL_SPACES_CONFIG["trusted_authors"]:
+                rebuild_space(space_id=space_id, pr_num=discussion.num)
+            else:
+                return
+
+
+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":
+            configure_ephemeral_space(space_id=space_id, pr_num=pr_num, trusted_pr=True)
+            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)
+
+
 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 +531,19 @@ 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.
+You can access the ephemeral Space at [{ci_space_id}](https://huggingface.co/spaces/{ci_space_id}).
+Trust status will be revoked 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.
+You can access this PR's ephemeral Space at [{ci_space_id}](https://huggingface.co/spaces/{ci_space_id}).
+_(This is an automated message.)_
+"""
+
 ### TO MOVE TO ITS OWN MODULE
 # Taken from https://github.com/huggingface/huggingface_hub/issues/1808#issuecomment-1802341663