Remove database

app.py

@@ -20,7 +20,6 @@ from gradio_webhooks import GradioWebhookApp, WebhookPayload
 from huggingface_hub import login
 from huggingface_hub.utils import RepositoryNotFoundError
 from ui import generate_ui
-from database import is_space_registered
 
 login(token=os.getenv("HF_TOKEN"))
 
@@ -35,8 +34,6 @@ async def post_webhook(payload: WebhookPayload, task_queue: BackgroundTasks):
         raise HTTPException(400, f"Must be a Space, not {payload.repo.type}")
 
     space_id = payload.repo.name
-    if not is_space_registered(space_id):
-        return "Space not in the watchlist."
 
     has_task = False
     if (
@@ -97,7 +94,7 @@ async def post_webhook(payload: WebhookPayload, task_queue: BackgroundTasks):
             "Task scheduled to sync/delete Space", status_code=status.HTTP_202_ACCEPTED
         )
     else:
-        return Response("No task scheduled", status_code=status.HTTP_202_ACCEPTED)
+        return Response("No task scheduled", status_code=status.HTTP_200_OK)
 
 
 def is_pr_synced(space_id: str, pr_num: int) -> bool:
@@ -214,19 +211,19 @@ Following the creation of this PR, an ephemeral Space [{ci_space_id}](https://hu
 
 If your Space requires configuration (secrets or upgraded hardware), you must duplicate the ephemeral Space to your account and configure the settings by yourself. You are responsible of making sure that the changes introduced in the PR are not harmful (leak secrets, run malicious scripts,...).
 
-_(This is an automated message. To disable me, please unregister using [this form](https://huggingface.co/spaces/spaces-ci-bot/webhook).)_
+_(This is an automated message.)_
 """
 
 NOTIFICATION_TEMPLATE_UPDATE = """\
 Following new commits that happened in this PR, the ephemeral Space [{ci_space_id}](https://huggingface.co/spaces/{ci_space_id}) has been updated.
 
-_(This is an automated message. To disable me, please unregister using [this form](https://huggingface.co/spaces/spaces-ci-bot/webhook).)_
+_(This is an automated message.)_
 """
 
 NOTIFICATION_TEMPLATE_DELETE = """\
 PR is now merged/closed. The ephemeral Space has been deleted.
 
-_(This is an automated message. To disable me, please unregister using [this form](https://huggingface.co/spaces/spaces-ci-bot/webhook).)_
+_(This is an automated message.)_
 """
 
 

database.py

@@ -1,75 +0,0 @@
-from huggingface_hub import hf_hub_download, upload_file, space_info
-from huggingface_hub.utils import HfHubHTTPError
-from pathlib import Path
-from typing import Set
-
-DATABASE_REPO_ID = "spaces-ci-bot/webhook"
-DATABASE_FILE = "registered_spaces.txt"
-
-MAX_NB_ATTEMPTS = 10
-
-
-def is_space_existing(space_id: str) -> bool:
-    try:
-        space_info(repo_id=space_id)
-        return True
-    except HfHubHTTPError:
-        return False
-
-
-def is_space_registered(space_id: str) -> bool:
-    return space_id in get_registered_spaces()
-
-
-def get_registered_spaces() -> Set[str]:
-    return _read_database(_get_latest_file())
-
-
-def update_status(space_id: str, should_watch: bool) -> None:
-    nb_attempts = 0
-    while True:
-        # Get registered spaces
-        filepath = _get_latest_file()
-        registered_spaces = _read_database(filepath)
-
-        # Do nothing if:
-        # - need to register and already registered
-        # - need to unregister and already not registered
-        if (should_watch and space_id in registered_spaces) or (
-            not should_watch and space_id not in registered_spaces
-        ):
-            return
-
-        # Else, (un)register new space
-        latest_revision = filepath.parent.name
-        if should_watch:
-            registered_spaces.add(space_id)
-        else:
-            registered_spaces.remove(space_id)
-
-        # Re-upload database and ensure no concurrent call happened
-        try:
-            nb_attempts += 1
-            upload_file(
-                path_in_repo=DATABASE_FILE,
-                repo_id=DATABASE_REPO_ID,
-                repo_type="dataset",
-                path_or_fileobj="\n".join(sorted(registered_spaces)).encode(),
-                commit_message=(
-                    f"Register {space_id}" if should_watch else f"Unregister {space_id}"
-                ),
-                parent_commit=latest_revision,  # ensure consistency
-            )
-            return
-        except HfHubHTTPError:
-            # Retry X times before giving up (in case multiple registrations at the same time)
-            if nb_attempts == MAX_NB_ATTEMPTS:
-                raise
-
-
-def _read_database(filepath: Path) -> Set[str]:
-    return set(filepath.read_text().split())
-
-
-def _get_latest_file() -> Path:
-    return Path(hf_hub_download(DATABASE_REPO_ID, DATABASE_FILE, repo_type="dataset"))

ui.py

@@ -1,82 +1,40 @@
 import gradio as gr
-from enum import Enum
-from database import is_space_existing, is_space_registered, update_status
 
 
 TITLE = "⚙️ Spaces CI Bot ⚙️"
+
 DESCRIPTION = """
-Welcome! This app lets you register a Space on the CI Bot's watchlist.
+Welcome to the Spaces CI Bot!
 
-Once your Space is on the list, any PR opened will be deployed as an ephemeral Space. Any changes pushed to the PRs will trigger a re-deployment. Once the PR is merged, the ephemeral Space is
-deleted.
+You are a few clicks away from having the CI Bot configured on your Spaces. No code or maintenance is required: simply configure a webhook and you're done! 🚀
 
-If your Space requires configuration (secrets or upgraded hardware), you must duplicate the ephemeral Space to your account and configure the settings by yourself. You are responsible of making sure that the changes introduced in the PR are not harmful (leak secrets, run malicious scripts,...).
-"""
+## Things to know
 
+- You can enable the CI Bot for a single Space or globally for all Spaces of a user/organization. You do not need to own the Space to enable the CI Bot on it.
+- When a PR is opened on a watched Space, an ephemeral Space is deployed with the changes.
+- Any changes pushed to a PR will trigger a re-deployment. Once the PR is merged, the ephemeral Space is deleted.
+- If your Space requires configuration (secrets or upgraded hardware), you must duplicate the ephemeral Space to your account and configure the settings by yourself. You are responsible of making sure that the changes introduced in the PR are not harmful (leak secrets, run malicious scripts,...).
+- The Bot is still in beta. Feel free to give us feedback in the [Community tab](https://huggingface.co/datasets/spaces-ci-bot/webhook/discussions).
 
-class Action(Enum):
-    REGISTER = "Enable CI Bot"
-    UNREGISTER = "Disable CI Bot"
-    CHECK_STATUS = "Check status"
+## Instructions 
 
+#### 1. Go to your [settings page](https://huggingface.co/settings/webhooks) > "Add a new webhook"
+#### 2. Configure your webhook (see image below)
+1. Filter which user, organization or Space you want to watch. It can be a Space you own or not. In this example, all Spaces from `Wauplin` are watched.
+2. Set the webhook URL to <https://spaces-ci-bot-webhook.hf.space/webhook>.
+3. Make sure to watch both "repo changes" and "community"
 
-def gradio_fn(space_id: str, action: str) -> str:
-    if not is_space_existing(space_id):
-        return f"""## Error
-        Could not find Space '**{space_id}**' on the Hub.
-        Please make sure you are trying to register a public repository.
-        """
+![](https://huggingface.co/spaces/spaces-ci-bot/webhook/resolve/main/configure_webhook.jpg)
 
-    registered = is_space_registered(space_id)
-    if action == Action.REGISTER.value:
-        if registered:
-            return f"""## Did nothing
-            The Space '**{space_id}**' is already in the watchlist. Any PR opened on
-            this repository will trigger an ephemeral Space.
-            """
-        else:
-            update_status(space_id, should_watch=True)
-            return f"""## Success
-            The Space '**{space_id}**' has been added to the watchlist. Any PR opened on
-            this repository will trigger an ephemeral Space.
-            """
-    elif action == Action.UNREGISTER.value:
-        if not registered:
-            return f"""## Did nothing
-            The Space '**{space_id}**' is currently not in the watchlist.
-            """
-        else:
-            update_status(space_id, should_watch=False)
-            return f"""## Success
-            The Space '**{space_id}**' has been removed from the watchlist.
-            """
-    elif action == Action.CHECK_STATUS.value:
-        if registered:
-            return f"""## Watched
-            The Space '**{space_id}**' is already in the watchlist. Any PR opened on
-            this repository will trigger an ephemeral Space.
-            """
-        else:
-            return f"""## Not watched
-            The Space '**{space_id}**' is currently not in the watchlist.
-            """
-    else:
-        return f"**Error:** action {action} not implemented."
+#### 3. "Create webhook" > You are done!
+
+Existing PRs will get an ephemeral Space as soon as you push at least one commit to the repository.
+"""
 
 
 def generate_ui() -> gr.Blocks:
-    return gr.Interface(
-        fn=gradio_fn,
-        inputs=[
-            gr.Textbox(lines=1, placeholder="username/my_cool_space", label="Space ID"),
-            gr.Radio(
-                [action.value for action in Action],
-                value=Action.REGISTER.value,
-                label="What should I do?",
-            ),
-        ],
-        outputs=[gr.Markdown()],
-        title=TITLE,
-        description=DESCRIPTION,
-        allow_flagging="never",
-    )
+    ui = gr.Blocks()
+    with ui:
+        gr.Markdown(f"<h1 style='text-align: center; margin-bottom: 1rem'>{TITLE}</h1>")
+        gr.Markdown(DESCRIPTION)
+    return ui