Merge pull request #2101 from auslin-aot/sync/7-6-2024-develop-to-per…

…mission-matrix

🔗[Sync]  Develop to permission matrix

forms-flow-api/migrations/versions/77d8b68e6c1f_users_table.py

@@ -0,0 +1,69 @@
+"""Users table
+
+Revision ID: 77d8b68e6c1f
+Revises: f1599a5bd658
+Create Date: 2024-05-30 16:01:37.273907
+
+"""
+from alembic import op
+import sqlalchemy as sa
+from sqlalchemy.dialects import postgresql
+
+# revision identifiers, used by Alembic.
+revision = '77d8b68e6c1f'
+down_revision = 'f1599a5bd658'
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.create_table('user',
+    sa.Column('id', sa.Integer(), nullable=False),
+    sa.Column('user_name', sa.String(length=50), nullable=False),
+    sa.Column('default_filter', sa.Integer(), nullable=True),
+    sa.Column('locale', sa.String(), nullable=True, comment='language code'),
+    sa.Column('tenant', sa.String(), nullable=True, comment='tenant key'),
+    sa.Column('created', sa.DateTime(), nullable=False),
+    sa.Column('modified', sa.DateTime(), nullable=True),
+    sa.Column('created_by', sa.String(), nullable=False),
+    sa.Column('modified_by', sa.String(), nullable=True),
+    sa.ForeignKeyConstraint(['default_filter'], ['filter.id'], ondelete='SET NULL'),
+    sa.PrimaryKeyConstraint('id'),
+    sa.UniqueConstraint('user_name', 'tenant', name='uq_tenant_user_name')
+    )
+    op.alter_column('themes', 'logo_type',
+               existing_type=sa.VARCHAR(length=100),
+               type_=sa.String(length=50),
+               existing_nullable=False)
+    op.alter_column('themes', 'logo_data',
+               existing_type=sa.VARCHAR(),
+               comment='logo_data contain a base64 or a URL.',
+               existing_nullable=False)
+    op.alter_column('themes', 'theme',
+               existing_type=postgresql.JSON(astext_type=sa.Text()),
+               comment='Json data',
+               existing_nullable=False)
+    op.create_unique_constraint('uq_tenant', 'themes', ['tenant'])
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_constraint('uq_tenant', 'themes', type_='unique')
+    op.alter_column('themes', 'theme',
+               existing_type=postgresql.JSON(astext_type=sa.Text()),
+               comment=None,
+               existing_comment='Json data',
+               existing_nullable=False)
+    op.alter_column('themes', 'logo_data',
+               existing_type=sa.VARCHAR(),
+               comment=None,
+               existing_comment='logo_data contain a base64 or a URL.',
+               existing_nullable=False)
+    op.alter_column('themes', 'logo_type',
+               existing_type=sa.String(length=50),
+               type_=sa.VARCHAR(length=100),
+               existing_nullable=False)
+    op.drop_table('user')
+    # ### end Alembic commands ###

forms-flow-api/src/formsflow_api/models/__init__.py

@@ -11,6 +11,7 @@
 from .form_process_mapper import FormProcessMapper
 from .process import Process, ProcessStatus, ProcessType
 from .theme import Themes
+from .user import User
 
 __all__ = [
     "db",
@@ -28,4 +29,5 @@
     "ProcessType",
     "ProcessStatus",
     "Themes",
+    "User",
 ]

forms-flow-api/src/formsflow_api/models/theme.py

@@ -1,6 +1,6 @@
 """This manages theme Database Models."""
 
-from sqlalchemy import JSON
+from sqlalchemy import JSON, UniqueConstraint
 
 from .audit_mixin import AuditDateTimeMixin, AuditUserMixin
 from .base_model import BaseModel
@@ -18,7 +18,8 @@ class Themes(AuditDateTimeMixin, AuditUserMixin, BaseModel, db.Model):
     )
     application_title = db.Column(db.String(50), nullable=False)
     theme = db.Column(JSON, nullable=False, comment="Json data")
-    tenant = db.Column(db.String(20), nullable=True, unique=True)
+    tenant = db.Column(db.String(20), nullable=True)
+    __table_args__ = (UniqueConstraint("tenant", name="uq_tenant"),)
 
     @classmethod
     def create_theme(cls, theme_info: dict):

forms-flow-api/src/formsflow_api/models/user.py

@@ -0,0 +1,70 @@
+"""This manages User Database Models."""
+
+from flask_sqlalchemy.query import Query
+from formsflow_api_utils.utils.user_context import UserContext, user_context
+from sqlalchemy import UniqueConstraint
+
+from .audit_mixin import AuditDateTimeMixin, AuditUserMixin
+from .base_model import BaseModel
+from .db import db
+
+
+class User(AuditDateTimeMixin, AuditUserMixin, BaseModel, db.Model):
+    """This class manages user information."""
+
+    id = db.Column(db.Integer, primary_key=True)
+    user_name = db.Column(db.String(50), nullable=False)
+    default_filter = db.Column(
+        db.Integer, db.ForeignKey("filter.id", ondelete="SET NULL"), nullable=True
+    )
+    locale = db.Column(db.String(), nullable=True, comment="language code")
+    tenant = db.Column(db.String(), nullable=True, comment="tenant key")
+    __table_args__ = (
+        UniqueConstraint("user_name", "tenant", name="uq_tenant_user_name"),
+    )
+
+    @classmethod
+    def create_user(cls, user_data: dict):
+        """Create new user."""
+        assert user_data is not None
+        user = cls()
+        user.created_by = user_data.get("created_by")
+        user.user_name = user_data.get("user_name")
+        user.locale = user_data.get("locale")
+        user.tenant = user_data.get("tenant")
+        user.default_filter = user_data.get("default_filter")
+        user.save()
+        return user
+
+    def update(self, user_data: dict):
+        """Update user data."""
+        self.update_from_dict(
+            [
+                "locale",
+                "tenant",
+                "default_filter",
+            ],
+            user_data,
+        )
+        self.commit()
+
+    @classmethod
+    @user_context
+    def tenant_authorization(cls, query: Query, **kwargs):
+        """Modifies the query to include tenant check if needed."""
+        tenant_auth_query: Query = query
+        user: UserContext = kwargs["user"]
+        tenant_key: str = user.tenant_key
+        if not isinstance(query, Query):
+            raise TypeError("Query object must be of type Query")
+        if tenant_key is not None:
+            tenant_auth_query = tenant_auth_query.filter(cls.tenant == tenant_key)
+        return tenant_auth_query
+
+    @classmethod
+    def get_user_by_user_name(cls, user_name: str = None):
+        """Find user data by username."""
+        assert user_name is not None
+        query = cls.query.filter(cls.user_name == user_name)
+        query = cls.tenant_authorization(query)
+        return query.one_or_none()

forms-flow-api/src/formsflow_api/resources/filter.py

@@ -71,6 +71,14 @@
     },
 )
 
+filter_response_with_default_filter = API.model(
+    "FilterResponse",
+    {
+        "filters": fields.List(fields.Nested(filter_response)),
+        "defaultFilter": fields.String(description="Default filter"),
+    },
+)
+
 
 @cors_preflight("GET, POST, OPTIONS")
 @API.route("", methods=["GET", "POST", "OPTIONS"])
@@ -158,7 +166,7 @@ class UsersFilterList(Resource):
             200: "OK:- Successful request.",
             403: "FORBIDDEN:- Permission denied",
         },
-        model=[filter_response],
+        model=filter_response_with_default_filter,
     )
     def get():
         """

forms-flow-api/src/formsflow_api/resources/user.py

@@ -6,6 +6,7 @@
 from flask_restx import Namespace, Resource, fields
 from formsflow_api_utils.utils import (
     ADMIN_GROUP,
+    REVIEWER_GROUP,
     auth,
     cors_preflight,
     profiletime,
@@ -15,6 +16,7 @@
     TenantUserAddSchema,
     UserlocaleReqSchema,
     UserPermissionUpdateSchema,
+    UserSchema,
     UsersListSchema,
 )
 from formsflow_api.services import KeycloakAdminAPIService, UserService
@@ -67,6 +69,7 @@
 )
 
 locale_put_model = API.model("Locale", {"locale": fields.String()})
+default_filter_model = API.model("DefaulFilter", {"defaultFilter": fields.String()})
 
 
 @cors_preflight("PUT, OPTIONS")
@@ -115,6 +118,29 @@ def put(self) -> dict:
         response = self.client.update_request(url_path=f"users/{user['id']}", data=user)
         if response is None:
             return {"message": "User not found"}, HTTPStatus.NOT_FOUND
+        # Capture "locale" changes in user table
+        UserService.update_user_data({"locale": dict_data["locale"]})
+        return response, HTTPStatus.OK
+
+
+@cors_preflight("POST, OPTIONS")
+@API.route("/default-filter", methods=["OPTIONS", "POST"])
+class UserDefaultFilter(Resource):
+    """Resource to create or update user's default filter."""
+
+    @staticmethod
+    @auth.has_one_of_roles([ADMIN_GROUP, REVIEWER_GROUP])
+    @profiletime
+    @API.doc(body=default_filter_model)
+    @API.response(200, "OK:- Successful request.")
+    @API.response(
+        400,
+        "BAD_REQUEST:- Invalid request.",
+    )
+    def post():
+        """Update the user's default task filter."""
+        data = UserSchema().load(request.get_json())
+        response = UserService().update_user_data(data=data)
         return response, HTTPStatus.OK
 
 

forms-flow-api/src/formsflow_api/schemas/__init__.py

@@ -25,6 +25,7 @@
     TenantUserAddSchema,
     UserlocaleReqSchema,
     UserPermissionUpdateSchema,
+    UserSchema,
     UsersListSchema,
 )
 

forms-flow-api/src/formsflow_api/schemas/process.py

@@ -2,8 +2,9 @@
 
 import json
 
-from marshmallow import EXCLUDE, Schema, fields, validates
 from formsflow_api_utils.exceptions import BusinessException
+from marshmallow import EXCLUDE, Schema, fields, validates
+
 from formsflow_api.constants import BusinessErrorCode
 from formsflow_api.models import FormProcessMapper
 

forms-flow-api/src/formsflow_api/schemas/user.py

@@ -60,3 +60,17 @@ class Meta:  # pylint: disable=too-few-public-methods
 
     user = fields.Str(data_key="user", required=True)
     roles = fields.List(fields.Nested(AddUserRoleSchema))
+
+
+class UserSchema(Schema):
+    """Schema for user data."""
+
+    class Meta:  # pylint: disable=too-few-public-methods
+        """Exclude unknown fields in the deserialized output."""
+
+        unknown = EXCLUDE
+
+    default_filter = fields.Int(data_key="defaultFilter", allow_none=True)
+    locale = fields.Str(data_key="locale")
+    user_name = fields.Str(data_key="userName", dump_only=True)
+    # tenant = fields.Str(data_key="tenantKey", dump_only=True)

forms-flow-api/src/formsflow_api/services/filter.py

@@ -6,7 +6,7 @@
 from formsflow_api_utils.utils.user_context import UserContext, user_context
 
 from formsflow_api.constants import BusinessErrorCode
-from formsflow_api.models import Filter
+from formsflow_api.models import Filter, User
 from formsflow_api.schemas import FilterSchema
 
 filter_schema = FilterSchema()
@@ -121,7 +121,11 @@ def get_user_filters(**kwargs):
             filter_item["variables"] += [
                 var for var in default_variables if var not in filter_item["variables"]
             ]
-        return filter_data
+        response = {"filters": filter_data}
+        # get user default filter
+        user_data = User.get_user_by_user_name(user_name=user.user_name)
+        response["defaultFilter"] = user_data.default_filter if user_data else None
+        return response
 
     @staticmethod
     @user_context

forms-flow-api/src/formsflow_api/services/user.py

@@ -2,6 +2,11 @@
 
 from typing import Dict, List
 
+from formsflow_api_utils.utils.user_context import UserContext, user_context
+
+from formsflow_api.models import User
+from formsflow_api.schemas import UserSchema
+
 
 class UserService:
     """This class manages keycloak user service."""
@@ -84,3 +89,20 @@ def paginate(self, data, page_number, page_size):
         start_index = (page_number - 1) * page_size
         end_index = start_index + page_size
         return data[start_index:end_index]
+
+    @staticmethod
+    @user_context
+    def update_user_data(data, **kwargs):
+        """Update user data."""
+        user: UserContext = kwargs["user"]
+        user_data = User.get_user_by_user_name(user_name=user.user_name)
+        if user_data:
+            if user_data.tenant is None and user.tenant_key:
+                data["tenant"] = user.tenant_key
+            user_data.update(data)
+        else:
+            data["user_name"] = user.user_name
+            data["tenant"] = user.tenant_key
+            data["created_by"] = user.user_name
+            user_data = User.create_user(data)
+        return UserSchema().dump(user_data)

forms-flow-api/tests/unit/api/test_filter.py

@@ -37,9 +37,9 @@ def test_get_user_filters(app, client, session, jwt):
     # Since reviewer created both filters response will include both.
     response = client.get("/filter/user", headers=headers)
     assert response.status_code == 200
-    assert len(response.json) == 2
-    assert response.json[0].get("name") == "Clerk Task"
-    assert response.json[1].get("name") == "Reviewer Task"
+    assert len(response.json.get("filters")) == 2
+    assert response.json.get("filters")[0].get("name") == "Clerk Task"
+    assert response.json.get("filters")[1].get("name") == "Reviewer Task"
 
 
 def test_filter_update(app, client, session, jwt):

forms-flow-api/tests/unit/api/test_user.py

@@ -1,7 +1,13 @@
 """Test suite for keycloak user API endpoint."""
 
 # from tests import skip_in_ci
-from tests.utilities.base_test import get_locale_update_valid_payload, get_token
+import json
+
+from tests.utilities.base_test import (
+    get_filter_payload,
+    get_locale_update_valid_payload,
+    get_token,
+)
 
 
 class TestKeycloakUserServiceResource:
@@ -68,3 +74,23 @@ def test_keycloak_users_list_invalid_group(app, client, session, jwt):
     headers = {"Authorization": f"Bearer {token}", "content-type": "application/json"}
     rv = client.get("/user?memberOfGroup=test123", headers=headers)
     assert rv.status_code == 400
+
+
+def test_default_filter(app, client, session, jwt):
+    """Test create a filter and update default filter of a user."""
+    token = get_token(jwt, role="formsflow-reviewer", username="reviewer")
+    headers = {"Authorization": f"Bearer {token}", "content-type": "application/json"}
+    # Create filter for clerk role
+    response = client.post(
+        "/filter",
+        headers=headers,
+        json=get_filter_payload(name="Clerk Task", roles=["clerk"]),
+    )
+    assert response.status_code == 201
+    response = client.post(
+        "/user/default-filter",
+        headers=headers,
+        data=json.dumps({"defaultFilter": response.json.get("id")}),
+        content_type="application/json",
+    )
+    assert response.status_code == 200