[FEATURE-BRANCH] feat: add Webhooks

argilla-server/.env.dev

@@ -1,2 +1,4 @@
+OBJC_DISABLE_INITIALIZE_FORK_SAFETY=YES # Needed by RQ to work with forked processes on MacOS
 ALEMBIC_CONFIG=src/argilla_server/alembic.ini
+ARGILLA_AUTH_SECRET_KEY=8VO7na5N/jQx+yP/N+HlE8q51vPdrxqlh6OzoebIyko= # With this we avoid using a different key every time the server is reloaded
 ARGILLA_DATABASE_URL=sqlite+aiosqlite:///${HOME}/.argilla/argilla.db?check_same_thread=False

argilla-server/.env.test

@@ -1 +1,2 @@
 ARGILLA_DATABASE_URL=sqlite+aiosqlite:///${HOME}/.argilla/argilla-test.db?check_same_thread=False
+ARGILLA_REDIS_URL=redis://localhost:6379/1 # Using a different Redis database for testing

argilla-server/CHANGELOG.md

@@ -16,6 +16,13 @@ These are the section headers that we use:
 
 ## [Unreleased]()
 
+### Added
+
+- Added new endpoints to create, update, ping and delete webhooks. ([#5453](https:/argilla-io/argilla/pull/5453))
+- Added new webhook events when responses are created, updated, deleted. ([#5468](https:/argilla-io/argilla/pull/5468))
+- Added new webhook events when datasets are created, updated, deleted or published. ([#5468](https:/argilla-io/argilla/pull/5468))
+- Added new webhook events when records are created, updated, deleted or completed. ([#5489](https:/argilla-io/argilla/pull/5489))
+
 ### Removed
 
 - Removed name pattern validation for Workspaces, Datasets, and Users. ([#5575](https:/argilla-io/argilla/pull/5575))

argilla-server/docker/argilla-hf-spaces/Dockerfile

@@ -60,7 +60,6 @@ ENV ELASTIC_CONTAINER=true
 ENV ES_JAVA_OPTS="-Xms1g -Xmx1g"
 
 ENV ARGILLA_HOME_PATH=/data/argilla
-ENV BACKGROUND_NUM_WORKERS=2
 ENV REINDEX_DATASETS=1
 
 CMD ["/bin/bash", "start.sh"]

argilla-server/docker/argilla-hf-spaces/Procfile

@@ -1,4 +1,5 @@
 elastic: /usr/share/elasticsearch/bin/elasticsearch
 redis: /usr/bin/redis-server
-worker: sleep 30; rq worker-pool --num-workers ${BACKGROUND_NUM_WORKERS}
+worker_high: sleep 30; rq worker-pool --num-workers 2 high
+worker_low: sleep 30; rq worker-pool --num-workers 1 low
 argilla: sleep 30; /bin/bash start_argilla_server.sh

argilla-server/pyproject.toml

@@ -59,6 +59,8 @@ dependencies = [
  "typer >= 0.6.0, < 0.10.0", # spaCy only supports typer<0.10.0
  "packaging>=23.2",
  "psycopg2-binary>=2.9.9",
+ # For Webhooks
+ "standardwebhooks>=1.0.0",
  # For Telemetry
  "huggingface_hub>=0.13,<1",
 ]
@@ -103,6 +105,8 @@ test = [
  "datasets > 1.17.0,!= 2.3.2",
  "spacy>=3.5.0,<3.7.0",
  "pytest-randomly>=3.15.0",
+ # For mocking httpx requests and responses
+ "respx>=0.21.1",
 ]
 
 [tool.pytest.ini_options]

argilla-server/src/argilla_server/alembic/versions/6ed1b8bf8e08_create_webhooks_table.py

@@ -0,0 +1,50 @@
+# Copyright 2021-present, the Recognai S.L. team.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""create webhooks table
+
+Revision ID: 6ed1b8bf8e08
+Revises: 237f7c674d74
+Create Date: 2024-09-02 11:41:57.561655
+
+"""
+
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision = "6ed1b8bf8e08"
+down_revision = "237f7c674d74"
+branch_labels = None
+depends_on = None
+
+
+def upgrade() -> None:
+ op.create_table(
+ "webhooks",
+ sa.Column("id", sa.Uuid(), nullable=False),
+ sa.Column("url", sa.Text(), nullable=False),
+ sa.Column("secret", sa.Text(), nullable=False),
+ sa.Column("events", sa.JSON(), nullable=False),
+ sa.Column("enabled", sa.Boolean(), nullable=False, server_default=sa.text("true")),
+ sa.Column("description", sa.Text(), nullable=True),
+ sa.Column("inserted_at", sa.DateTime(), nullable=False),
+ sa.Column("updated_at", sa.DateTime(), nullable=False),
+ sa.PrimaryKeyConstraint("id"),
+ )
+
+
+def downgrade() -> None:
+ op.drop_table("webhooks")

argilla-server/src/argilla_server/api/handlers/v1/datasets/records_bulk.py

@@ -26,7 +26,6 @@
 from argilla_server.models import Dataset, User
 from argilla_server.search_engine import SearchEngine, get_search_engine
 from argilla_server.security import auth
-from argilla_server.telemetry import TelemetryClient, get_telemetry_client
 
 router = APIRouter()
 
@@ -43,7 +42,6 @@ async def create_dataset_records_bulk(
  db: AsyncSession = Depends(get_async_db),
  search_engine: SearchEngine = Depends(get_search_engine),
  current_user: User = Security(auth.get_current_user),
- telemetry_client: TelemetryClient = Depends(get_telemetry_client),
 ):
  dataset = await Dataset.get_or_raise(
  db,
@@ -58,9 +56,7 @@ async def create_dataset_records_bulk(
 
  await authorize(current_user, DatasetPolicy.create_records(dataset))
 
- records_bulk = await CreateRecordsBulk(db, search_engine).create_records_bulk(dataset, records_bulk_create)
-
- return records_bulk
+ return await CreateRecordsBulk(db, search_engine).create_records_bulk(dataset, records_bulk_create)
 
 
 @router.put("/datasets/{dataset_id}/records/bulk", response_model=RecordsBulk)
@@ -71,7 +67,6 @@ async def upsert_dataset_records_bulk(
  db: AsyncSession = Depends(get_async_db),
  search_engine: SearchEngine = Depends(get_search_engine),
  current_user: User = Security(auth.get_current_user),
- telemetry_client: TelemetryClient = Depends(get_telemetry_client),
 ):
  dataset = await Dataset.get_or_raise(
  db,
@@ -86,9 +81,4 @@ async def upsert_dataset_records_bulk(
 
  await authorize(current_user, DatasetPolicy.upsert_records(dataset))
 
- records_bulk = await UpsertRecordsBulk(db, search_engine).upsert_records_bulk(dataset, records_bulk_create)
-
- updated = len(records_bulk.updated_item_ids)
- created = len(records_bulk.items) - updated
-
- return records_bulk
+ return await UpsertRecordsBulk(db, search_engine).upsert_records_bulk(dataset, records_bulk_create)