[BUGFIX] validate client credentials to make error messages clearer (#5384)

# Description
<!-- Please include a summary of the changes and the related issue.
Please also include relevant motivation and context. List any
dependencies that are required for this change. -->

This PR improves error messaging when users pass incorrect credentials
to the `Argilla` client. It does these things:
- adds a custom credentials exception
- logs the user details when client is successfully inited
- raise the custom exception when above fails

Closes #<issue_number>

**Type of change**
<!-- Please delete options that are not relevant. Remember to title the
PR according to the type of change -->

- Bug fix (non-breaking change which fixes an issue)


**How Has This Been Tested**
<!-- Please add some reference about how your feature has been tested.
-->
No new tests.

**Checklist**
<!-- Please go over the list and make sure you've taken everything into
account -->

- I added relevant documentation
- I followed the style guidelines of this project
- I did a self-review of my code
- I made corresponding changes to the documentation
- I confirm My changes generate no new warnings
- I have added tests that prove my fix is effective or that my feature
works
- I have added relevant notes to the CHANGELOG.md file (See
https://keepachangelog.com/)

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: burtenshaw

argilla-server/pdm.lock

@@ -56,6 +56,7 @@ dependencies = [
     # for CLI
     "typer >= 0.6.0, < 0.10.0", # spaCy only supports typer<0.10.0
     "packaging>=23.2",
+    "psycopg2-binary>=2.9.9",
 ]
 
 [project.optional-dependencies]

argilla-server/pyproject.toml

@@ -17,6 +17,8 @@
 from typing import Optional
 
 import httpx
+from argilla._exceptions._api import UnauthorizedError
+from argilla._exceptions._client import ArgillaCredentialsError
 
 from argilla._api import HTTPClientConfig, create_http_client
 from argilla._api._datasets import DatasetsAPI
@@ -127,6 +129,11 @@ def __init__(
 
         self.api = ArgillaAPI(self.http_client)
 
+        try:
+            self._validate_connection()
+        except UnauthorizedError as e:
+            raise ArgillaCredentialsError() from e
+
     ##############################
     # Utility methods
     ##############################
@@ -135,3 +142,8 @@ def log(self, message: str, level: int = logging.INFO) -> None:
         class_name = self.__class__.__name__
         message = f"{class_name}: {message}"
         logging.log(level=level, msg=message)
+
+    def _validate_connection(self) -> None:
+        user = self.api.users.get_me()
+        message = f"Logged in as {user.username} with the role {user.role}"
+        self.log(message=message, level=logging.INFO)

argilla/src/argilla/_api/_client.py

@@ -13,6 +13,7 @@
 # limitations under the License.
 
 from argilla._exceptions._api import *  # noqa: F403
+from argilla._exceptions._client import *  # noqa: F403
 from argilla._exceptions._metadata import *  # noqa: F403
 from argilla._exceptions._serialization import *  # noqa: F403
 from argilla._exceptions._settings import *  # noqa: F403

argilla/src/argilla/_exceptions/__init__.py

@@ -0,0 +1,20 @@
+# Copyright 2024-present, Argilla, Inc.
+#
+# 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.
+
+from argilla._exceptions._base import ArgillaError
+
+
+class ArgillaCredentialsError(ArgillaError):
+    def __init__(self, message: str = "Credentials (api_key and/or api_url) are invalid") -> None:
+        super().__init__(message)

argilla/src/argilla/_exceptions/_client.py

@@ -19,3 +19,24 @@
 #     argilla.DEFAULT_HTTP_CLIENT = mock_client
 
 #     return mock_client
+
+import pytest
+from unittest.mock import patch
+from httpx import Timeout
+from argilla import Argilla
+
+
+@pytest.fixture(autouse=True)
+def mock_validate_connection():
+    with patch("argilla._api._client.APIClient._validate_connection") as mocked_validator:
+        yield mocked_validator
+
+
+# Example usage in a test module
+def test_create_default_client(mock_validate_connection):
+    http_client = Argilla().http_client
+
+    assert http_client is not None
+    assert http_client.base_url == "http://localhost:6900"
+    assert http_client.timeout == Timeout(60)
+    assert http_client.headers["X-Argilla-Api-Key"] == "argilla.apikey"