feat: add user preferences service

.devcontainer/docker-compose.yml

@@ -35,6 +35,8 @@ services:
       POSTGRES_USER: renku
       POSTGRES_DB: renku
       POSTGRES_PASSWORD: renku
+    ports:
+      - 5432:5432
 
     # Add "forwardPorts": ["5432"] to **devcontainer.json** to forward PostgreSQL locally.
     # (Adding the "ports" property to this file will not forward from a Codespace.)

.github/workflows/test_publish.yml

@@ -5,11 +5,12 @@ on:
     branches:
       - main
     tags:
-      - 'v*'
+      - "v*"
   pull_request:
     branches:
-      - 'main'
-      - 'hotfix/**'
+      - "main"
+      - "hotfix/**"
+      - "feat-add-user-preferences"
 
 jobs:
   test:

Makefile

@@ -3,6 +3,7 @@
 schemas:
 	poetry run datamodel-codegen --input components/renku_data_services/crc/api.spec.yaml --input-file-type openapi --output-model-type pydantic_v2.BaseModel --output components/renku_data_services/crc/apispec.py --use-double-quotes --target-python-version 3.11 --collapse-root-models --field-constraints --strict-nullable --base-class renku_data_services.crc.apispec_base.BaseAPISpec
 	poetry run datamodel-codegen --input components/renku_data_services/storage/api.spec.yaml --input-file-type openapi --output-model-type pydantic_v2.BaseModel --output components/renku_data_services/storage/apispec.py --use-double-quotes --target-python-version 3.11 --collapse-root-models --field-constraints --strict-nullable --base-class renku_data_services.storage.apispec_base.BaseAPISpec
+	poetry run datamodel-codegen --input components/renku_data_services/user_preferences/api.spec.yaml --input-file-type openapi --output-model-type pydantic_v2.BaseModel --output components/renku_data_services/user_preferences/apispec.py --use-double-quotes --target-python-version 3.11 --collapse-root-models --field-constraints --strict-nullable --base-class renku_data_services.user_preferences.apispec_base.BaseAPISpec
 
 style_checks:
 	poetry check

bases/renku_data_services/data_api/app.py

@@ -14,6 +14,7 @@
 )
 from renku_data_services.data_api.config import Config
 from renku_data_services.storage.blueprints import StorageBP, StorageSchemaBP
+from renku_data_services.user_preferences.blueprints import UserPreferencesBP
 
 
 def register_all_handlers(app: Sanic, config: Config) -> Sanic:
@@ -57,6 +58,12 @@ def register_all_handlers(app: Sanic, config: Config) -> Sanic:
         authenticator=config.gitlab_authenticator,
     )
     storage_schema = StorageSchemaBP(name="storage_schema", url_prefix=url_prefix)
+    user_preferences = UserPreferencesBP(
+        name="user_preferences",
+        url_prefix=url_prefix,
+        user_preferences_repo=config.user_preferences_repo,
+        authenticator=config.authenticator,
+    )
     misc = MiscBP(name="misc", url_prefix=url_prefix, apispec=config.spec, version=config.version)
     app.blueprint(
         [
@@ -68,6 +75,7 @@ def register_all_handlers(app: Sanic, config: Config) -> Sanic:
             user_resource_pools.blueprint(),
             storage.blueprint(),
             storage_schema.blueprint(),
+            user_preferences.blueprint(),
             misc.blueprint(),
         ]
     )

bases/renku_data_services/data_api/config.py

@@ -12,6 +12,7 @@
 import renku_data_services.base_models as base_models
 import renku_data_services.crc
 import renku_data_services.storage
+import renku_data_services.user_preferences
 from renku_data_services import errors
 from renku_data_services.crc import models
 from renku_data_services.crc.db import ResourcePoolRepository, UserRepository
@@ -25,6 +26,7 @@
 from renku_data_services.k8s.quota import QuotaRepository
 from renku_data_services.migrations.core import DataRepository
 from renku_data_services.storage.db import StorageRepository
+from renku_data_services.user_preferences.db import UserPreferencesRepository
 from renku_data_services.users.dummy import DummyAuthenticator, DummyUserStore
 from renku_data_services.users.gitlab import GitlabAuthenticator
 from renku_data_services.users.keycloak import KcUserStore, KeycloakAuthenticator
@@ -73,6 +75,7 @@ class Config:
     user_repo: UserRepository
     rp_repo: ResourcePoolRepository
     storage_repo: StorageRepository
+    user_preferences_repo: UserPreferencesRepository
     user_store: base_models.UserStore
     authenticator: base_models.Authenticator
     gitlab_authenticator: base_models.Authenticator
@@ -94,7 +97,11 @@ def __post_init__(self):
         with open(spec_file, "r") as f:
             storage_spec = safe_load(f)
 
-        self.spec = merge_api_specs(crc_spec, storage_spec)
+        spec_file = Path(renku_data_services.user_preferences.__file__).resolve().parent / "api.spec.yaml"
+        with open(spec_file, "r") as f:
+            user_preferences_spec = safe_load(f)
+
+        self.spec = merge_api_specs(crc_spec, storage_spec, user_preferences_spec)
 
         if self.default_resource_pool_file is not None:
             with open(self.default_resource_pool_file, "r") as f:
@@ -190,10 +197,15 @@ def from_env(cls):
             sync_sqlalchemy_url=sync_sqlalchemy_url,
             async_sqlalchemy_url=async_sqlalchemy_url,
         )
+        user_preferences_repo = UserPreferencesRepository(
+            sync_sqlalchemy_url=sync_sqlalchemy_url,
+            async_sqlalchemy_url=async_sqlalchemy_url,
+        )
         return cls(
             user_repo=user_repo,
             rp_repo=rp_repo,
             storage_repo=storage_repo,
+            user_preferences_repo=user_preferences_repo,
             version=version,
             authenticator=authenticator,
             gitlab_authenticator=gitlab_authenticator,

bases/renku_data_services/data_api/main.py

@@ -22,6 +22,7 @@ def create_app() -> Sanic:
         # specified below with the main_process_start decorator do not run.
         run_migrations_for_app("resource_pools", config.rp_repo)
         run_migrations_for_app("storage", config.rp_repo)
+        run_migrations_for_app("user_preferences", config.user_preferences_repo)
         config.rp_repo.initialize(config.default_resource_pool)
     app = register_all_handlers(app, config)
 
@@ -30,6 +31,7 @@ async def do_migrations(*_):
         logger.info("running migrations")
         run_migrations_for_app("resource_pools", config.rp_repo)
         run_migrations_for_app("storage", config.rp_repo)
+        run_migrations_for_app("user_preferences", config.user_preferences_repo)
         config.rp_repo.initialize(config.default_resource_pool)
 
     @app.before_server_start

components/renku_data_services/migrations/alembic.ini

@@ -68,6 +68,10 @@ config_class = renku_data_services.data_api.config
 script_location = renku_data_services:storage_migrations
 config_class = renku_data_services.data_api.config
 
+[user_preferences]
+script_location = renku_data_services:user_preferences_migrations
+config_class = renku_data_services.data_api.config
+
 [post_write_hooks]
 # post_write_hooks defines scripts or Python functions that are run
 # on newly generated revision scripts.  See the documentation for further

components/renku_data_services/user_preferences/__init__.py

@@ -0,0 +1 @@
+"""Blueprints for user preferences."""

components/renku_data_services/user_preferences/api.spec.yaml

@@ -0,0 +1,142 @@
+---
+openapi: 3.0.2
+info:
+  title: Renku user preferences services
+  description: |
+    Services that provide information about user preferences.
+  version: v1
+servers:
+  - url: /api/data
+  - url: /ui-server/api/data
+paths:
+  /user_preferences:
+    get:
+      summary: Get user preferences for the currently logged in user
+      responses:
+        "200":
+          description: The user preferences
+          content:
+            "application/json":
+              schema:
+                $ref: "#/components/schemas/UserPreferences"
+        "404":
+          description: The user has no preferences saved
+          content:
+            "application/json":
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        default:
+          $ref: "#/components/responses/Error"
+      tags:
+        - user_preferences
+  "/user_preferences/pinned_projects":
+    post:
+      summary: Add a pinned project
+      requestBody:
+        required: true
+        content:
+          "application/json":
+            schema:
+              $ref: "#/components/schemas/AddPinnedProject"
+      responses:
+        "200":
+          description: The updated user preferences
+          content:
+            "application/json":
+              schema:
+                $ref: "#/components/schemas/UserPreferences"
+        default:
+          $ref: "#/components/responses/Error"
+      tags:
+        - user_preferences
+    delete:
+      summary: Remove a pinned project
+      parameters:
+        - in: query
+          name: project_slug
+          required: true
+          schema:
+            type: string
+      responses:
+        "200":
+          description: The updated user preferences
+          content:
+            "application/json":
+              schema:
+                $ref: "#/components/schemas/UserPreferences"
+        default:
+          $ref: "#/components/responses/Error"
+      tags:
+        - user_preferences
+
+components:
+  schemas:
+    UserPreferences:
+      type: object
+      description: The object containing user preferences
+      additionalProperties: false
+      properties:
+        user_id:
+          $ref: "#/components/schemas/UserId"
+        pinned_projects:
+          $ref: "#/components/schemas/PinnedProjects"
+      required: ["user_id", "pinned_projects"]
+    UserId:
+      type: string
+      description: The unique identifier for a user
+      minLength: 3
+      example: "user-id-example"
+    PinnedProjects:
+      type: object
+      description: The list of projects a user has pinned on their dashboard
+      properties:
+        project_slugs:
+          type: array
+          items:
+            $ref: "#/components/schemas/ProjectSlug"
+    ProjectSlug:
+      type: string
+      description: The slug used to identify a project
+      minLength: 3
+      example: "user/my-project"
+    AddPinnedProject:
+      type: object
+      additionalProperties: false
+      properties:
+        project_slug:
+          $ref: "#/components/schemas/ProjectSlug"
+      required: ["project_slug"]
+    ErrorResponse:
+      type: object
+      properties:
+        error:
+          type: object
+          properties:
+            code:
+              type: integer
+              minimum: 0
+              exclusiveMinimum: true
+              example: 1404
+            detail:
+              type: string
+              example: "A more detailed optional message showing what the problem was"
+            message:
+              type: string
+              example: "Something went wrong - please try again later"
+          required: ["code", "message"]
+      required: ["error"]
+
+  responses:
+    Error:
+      description: The schema for all 4xx and 5xx responses
+      content:
+        "application/json":
+          schema:
+            $ref: "#/components/schemas/ErrorResponse"
+  securitySchemes:
+    oidc:
+      type: openIdConnect
+      openIdConnectUrl: /auth/realms/Renku/.well-known/openid-configuration
+security:
+  - oidc:
+      - openid

components/renku_data_services/user_preferences/apispec.py

@@ -0,0 +1,46 @@
+# generated by datamodel-codegen:
+#   filename:  api.spec.yaml
+#   timestamp: 2023-11-01T09:29:32+00:00
+
+from __future__ import annotations
+
+from typing import List, Optional
+
+from pydantic import ConfigDict, Field, RootModel
+
+from renku_data_services.user_preferences.apispec_base import BaseAPISpec
+
+
+class ProjectSlug(RootModel):
+    root: str = Field(..., description="The slug used to identify a project", example="user/my-project", min_length=3)
+
+
+class AddPinnedProject(BaseAPISpec):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    project_slug: str = Field(
+        ..., description="The slug used to identify a project", example="user/my-project", min_length=3
+    )
+
+
+class Error(BaseAPISpec):
+    code: int = Field(..., example=1404, gt=0)
+    detail: Optional[str] = Field(None, example="A more detailed optional message showing what the problem was")
+    message: str = Field(..., example="Something went wrong - please try again later")
+
+
+class ErrorResponse(BaseAPISpec):
+    error: Error
+
+
+class PinnedProjects(BaseAPISpec):
+    project_slugs: Optional[List[ProjectSlug]] = None
+
+
+class UserPreferences(BaseAPISpec):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    user_id: str = Field(..., description="The unique identifier for a user", example="user-id-example", min_length=3)
+    pinned_projects: PinnedProjects

components/renku_data_services/user_preferences/apispec_base.py

@@ -0,0 +1,22 @@
+"""Base models for API specifications."""
+from pydantic import BaseModel, Extra, Field
+
+
+class BaseAPISpec(BaseModel):
+    """Base API specification."""
+
+    class Config:
+        """Enables orm mode for pydantic."""
+
+        from_attributes = True
+
+
+class PinnedProjectFilter(BaseAPISpec):
+    """The schema for the query parameters used to filter pinned projects."""
+
+    class Config:
+        """Configuration."""
+
+        extra = Extra.ignore
+
+    project_slug: str = Field()