specal field model and APIs (#1394)

- added new modal special_fields
  - added APIs to perform following operations:
    - Create
    - Update
    - Retrieve
    - Check for existing entry (validate)

Author: salabh-aot

epictrack-api/migrations/versions/03791c319e2b_special_fields.py

@@ -0,0 +1,119 @@
+"""special fields
+
+Revision ID: 03791c319e2b
+Revises: 7a42d4f57279
+Create Date: 2023-12-01 12:39:54.325967
+
+"""
+import sqlalchemy as sa
+from alembic import op
+from sqlalchemy.dialects import postgresql
+
+
+# revision identifiers, used by Alembic.
+revision = '03791c319e2b'
+down_revision = '7a42d4f57279'
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.create_table('special_fields',
+    sa.Column('id', sa.Integer(), autoincrement=True, nullable=False),
+    sa.Column('entity', sa.Enum('PROJECT', 'PROPONENT', 'WORK', name='entityenum'), nullable=False),
+    sa.Column('entity_id', sa.Integer(), nullable=False),
+    sa.Column('field_name', sa.String(length=100), nullable=False),
+    sa.Column('field_value', sa.String(), nullable=False),
+    sa.Column('time_range', postgresql.TSTZRANGE(), nullable=False),
+    sa.Column('created_by', sa.String(length=255), nullable=True),
+    sa.Column('created_at', sa.DateTime(timezone=True), server_default=sa.text("TIMEZONE('utc', CURRENT_TIMESTAMP)"), nullable=True),
+    sa.Column('updated_by', sa.String(length=255), nullable=True),
+    sa.Column('updated_at', sa.DateTime(timezone=True), nullable=True),
+    sa.Column('is_active', sa.Boolean(), server_default='t', nullable=False),
+    sa.Column('is_deleted', sa.Boolean(), server_default='f', nullable=False),
+    sa.PrimaryKeyConstraint('id')
+    )
+    with op.batch_alter_table('special_fields', schema=None) as batch_op:
+        batch_op.create_index('entity_field_index', ['entity', 'entity_id', 'field_name', 'time_range'], unique=False)
+
+    op.create_table('special_fields_history',
+    sa.Column('id', sa.Integer(), autoincrement=False, nullable=False),
+    sa.Column('entity', sa.Enum('PROJECT', 'PROPONENT', 'WORK', name='entityenum'), autoincrement=False, nullable=False),
+    sa.Column('entity_id', sa.Integer(), autoincrement=False, nullable=False),
+    sa.Column('field_name', sa.String(length=100), autoincrement=False, nullable=False),
+    sa.Column('field_value', sa.String(), autoincrement=False, nullable=False),
+    sa.Column('time_range', postgresql.TSTZRANGE(), autoincrement=False, nullable=False),
+    sa.Column('created_by', sa.String(length=255), autoincrement=False, nullable=True),
+    sa.Column('created_at', sa.DateTime(timezone=True), autoincrement=False, nullable=True),
+    sa.Column('updated_by', sa.String(length=255), autoincrement=False, nullable=True),
+    sa.Column('updated_at', sa.DateTime(timezone=True), autoincrement=False, nullable=True),
+    sa.Column('is_active', sa.Boolean(), autoincrement=False, nullable=False),
+    sa.Column('is_deleted', sa.Boolean(), autoincrement=False, nullable=False),
+    sa.Column('pk', sa.Integer(), autoincrement=True, nullable=False),
+    sa.Column('during', postgresql.TSTZRANGE(), nullable=True),
+    sa.PrimaryKeyConstraint('id', 'pk')
+    )
+    with op.batch_alter_table('special_fields_history', schema=None) as batch_op:
+        batch_op.create_index('entity_field_history_index', ['entity', 'entity_id', 'field_name', 'time_range'], unique=False)
+
+    op.drop_table('project_special_fields')
+    with op.batch_alter_table('event_templates', schema=None) as batch_op:
+        batch_op.alter_column('visibility',
+               existing_type=postgresql.ENUM('MANDATORY', 'OPTIONAL', 'HIDDEN', name='eventtemplatevisibilityenum'),
+               comment='Indicate whether the event generated with this template should be        autogenerated  or available for optional events or added in the back end using actions',
+               existing_comment='Indicate whether the event generated with this template should be autogenerated  or available for optional events or added in the back end using actions',
+               existing_nullable=False)
+
+    with op.batch_alter_table('event_templates_history', schema=None) as batch_op:
+        batch_op.alter_column('visibility',
+               existing_type=postgresql.ENUM('MANDATORY', 'OPTIONAL', 'HIDDEN', name='eventtemplatevisibilityenum'),
+               comment='Indicate whether the event generated with this template should be        autogenerated  or available for optional events or added in the back end using actions',
+               existing_comment='Indicate whether the event generated with this template should be autogenerated  or available for optional events or added in the back end using actions',
+               existing_nullable=False,
+               autoincrement=False)
+
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    with op.batch_alter_table('event_templates_history', schema=None) as batch_op:
+        batch_op.alter_column('visibility',
+               existing_type=postgresql.ENUM('MANDATORY', 'OPTIONAL', 'HIDDEN', name='eventtemplatevisibilityenum'),
+               comment='Indicate whether the event generated with this template should be autogenerated  or available for optional events or added in the back end using actions',
+               existing_comment='Indicate whether the event generated with this template should be        autogenerated  or available for optional events or added in the back end using actions',
+               existing_nullable=False,
+               autoincrement=False)
+
+    with op.batch_alter_table('event_templates', schema=None) as batch_op:
+        batch_op.alter_column('visibility',
+               existing_type=postgresql.ENUM('MANDATORY', 'OPTIONAL', 'HIDDEN', name='eventtemplatevisibilityenum'),
+               comment='Indicate whether the event generated with this template should be autogenerated  or available for optional events or added in the back end using actions',
+               existing_comment='Indicate whether the event generated with this template should be        autogenerated  or available for optional events or added in the back end using actions',
+               existing_nullable=False)
+
+    op.create_table('project_special_fields',
+    sa.Column('id', sa.INTEGER(), autoincrement=True, nullable=False),
+    sa.Column('field_name', sa.VARCHAR(length=100), autoincrement=False, nullable=False),
+    sa.Column('field_value', sa.VARCHAR(), autoincrement=False, nullable=False),
+    sa.Column('time_range', postgresql.TSTZRANGE(), autoincrement=False, nullable=False),
+    sa.Column('project_id', sa.INTEGER(), autoincrement=False, nullable=False),
+    sa.Column('created_by', sa.VARCHAR(length=255), autoincrement=False, nullable=True),
+    sa.Column('created_at', postgresql.TIMESTAMP(timezone=True), server_default=sa.text("timezone('utc'::text, CURRENT_TIMESTAMP)"), autoincrement=False, nullable=True),
+    sa.Column('updated_by', sa.VARCHAR(length=255), autoincrement=False, nullable=True),
+    sa.Column('updated_at', postgresql.TIMESTAMP(timezone=True), autoincrement=False, nullable=True),
+    sa.Column('is_active', sa.BOOLEAN(), server_default=sa.text('true'), autoincrement=False, nullable=False),
+    sa.Column('is_deleted', sa.BOOLEAN(), server_default=sa.text('false'), autoincrement=False, nullable=False),
+    sa.ForeignKeyConstraint(['project_id'], ['projects.id'], name='project_special_fields_project_id_fkey'),
+    sa.PrimaryKeyConstraint('id', name='project_special_fields_pkey')
+    )
+    with op.batch_alter_table('special_fields_history', schema=None) as batch_op:
+        batch_op.drop_index('entity_field_history_index')
+
+    op.drop_table('special_fields_history')
+    with op.batch_alter_table('special_fields', schema=None) as batch_op:
+        batch_op.drop_index('entity_field_index')
+
+    op.drop_table('special_fields')
+    # ### end Alembic commands ###

epictrack-api/src/api/models/__init__.py

@@ -41,8 +41,6 @@
 from .inspection_attachment import InspectionAttachment
 from .inspection_attendee import InspectionAttendee
 from .inspection_detail import InspectionDetail
-from .work_issues import WorkIssues
-from .work_issue_updates import WorkIssueUpdates
 from .milestone_type import MilestoneType
 from .ministry import Ministry
 from .outcome_configuration import OutcomeConfiguration
@@ -56,6 +54,7 @@
 from .reminder_configuration import ReminderConfiguration
 from .responsibility import Responsibility
 from .role import Role
+from .special_field import SpecialField
 from .staff import Staff
 from .staff_work_role import StaffWorkRole
 from .sub_types import SubType
@@ -68,6 +67,8 @@
 from .types import Type
 from .work import Work, WorkStateEnum
 from .work_calendar_event import WorkCalendarEvent
+from .work_issue_updates import WorkIssueUpdates
+from .work_issues import WorkIssues
 from .work_phase import WorkPhase
 from .work_status import WorkStatus
 from .work_type import WorkType

epictrack-api/src/api/models/project.py

@@ -15,10 +15,9 @@
 import enum
 
 from sqlalchemy import Boolean, Column, Enum, Float, ForeignKey, Integer, String, Text, func
-from sqlalchemy.dialects.postgresql import TSTZRANGE
 from sqlalchemy.orm import relationship
 
-from .base_model import BaseModel, BaseModelVersioned
+from .base_model import BaseModelVersioned
 
 
 class ProjectStateEnum(enum.Enum):
@@ -88,17 +87,3 @@ def as_dict(self, recursive=True):
         data = super().as_dict(recursive)
         data["project_state"] = self.project_state.value
         return data
-
-
-class ProjectSpecialFields(BaseModel):
-    """Model class for tracking project special field values."""
-
-    __tablename__ = "project_special_fields"
-
-    id = Column(Integer, primary_key=True, autoincrement=True)
-    field_name = Column(String(100), nullable=False)
-    field_value = Column(String, nullable=False)
-    time_range = Column(TSTZRANGE, nullable=False)
-
-    project_id = Column(ForeignKey("projects.id"), nullable=False)
-    project = relationship("Project", foreign_keys=[project_id], lazy="select")

epictrack-api/src/api/models/special_field.py

@@ -0,0 +1,43 @@
+# Copyright © 2019 Province of British Columbia
+#
+# 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.
+"""Model to manage Special fields."""
+import enum
+
+from sqlalchemy import Column, Enum, Index, Integer, String
+from sqlalchemy.dialects.postgresql import TSTZRANGE
+
+from .base_model import BaseModelVersioned
+
+
+class EntityEnum(enum.Enum):
+    """Enum for enities"""
+
+    PROJECT = "PROJECT"
+    PROPONENT = "PROPONENT"
+    WORK = "WORK"
+
+
+class SpecialField(BaseModelVersioned):
+    """Model class for tracking special field values."""
+
+    __tablename__ = "special_fields"
+
+    id = Column(Integer, primary_key=True, autoincrement=True)
+    entity = Column(Enum(EntityEnum), nullable=False)
+    entity_id = Column(Integer, nullable=False)
+    field_name = Column(String(100), nullable=False)
+    field_value = Column(String, nullable=False)
+    time_range = Column(TSTZRANGE, nullable=False)
+
+    __table_args__ = (Index('entity_field_index', "entity", "entity_id", "field_name", "time_range"), )

epictrack-api/src/api/resources/__init__.py

@@ -42,6 +42,7 @@
 from .reminder_configuration import API as REMINDER_CONFIGURATION_API
 from .reports import API as REPORTS_API
 from .responsibility import API as RESPONSIBILITY_API
+from .special_field import API as SPECIAL_FIELD_API
 from .staff import API as STAFF_API
 from .sub_types import API as SUB_TYPES_API
 from .sync_form_data import API as SYNC_FORM_DATA_API
@@ -52,6 +53,7 @@
 from .work_issues import API as WORK_ISSUES_API
 from .work_status import API as WORK_STATUS_API
 
+
 __all__ = ("API_BLUEPRINT", "OPS_BLUEPRINT")
 
 # This will add the Authorize button to the swagger docs
@@ -107,3 +109,4 @@
 API.add_namespace(ACT_SECTION_API, path="/act-sections")
 API.add_namespace(WORK_STATUS_API, path='/work/<int:work_id>/statuses')
 API.add_namespace(WORK_ISSUES_API, path='/work/<int:work_id>/issues')
+API.add_namespace(SPECIAL_FIELD_API, path='/special-fields')

epictrack-api/src/api/resources/special_field.py

@@ -0,0 +1,107 @@
+# Copyright © 2019 Province of British Columbia
+#
+# 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.
+"""Resource for Special field endpoints."""
+
+from http import HTTPStatus
+
+from flask import jsonify, request
+from flask_restx import Namespace, Resource, cors
+
+from api.exceptions import ResourceNotFoundError
+from api.schemas import request as req
+from api.schemas import response as res
+from api.services.special_field import SpecialFieldService
+from api.utils import auth, constants
+from api.utils.caching import AppCache
+from api.utils.profiler import profiletime
+from api.utils.util import cors_preflight
+
+
+API = Namespace("special-fields", description="Special fields")
+
+
+@cors_preflight("GET, POST")
+@API.route("", methods=["GET", "POST", "OPTIONS"])
+class SpecialFields(Resource):
+    """Endpoint resource to return spcial fields values."""
+
+    @staticmethod
+    @cors.crossdomain(origin="*")
+    @auth.require
+    @profiletime
+    @AppCache.cache.cached(timeout=constants.CACHE_DAY_TIMEOUT, query_string=True)
+    def get():
+        """Return all special field values based on params."""
+        params = req.SpecialFieldQueryParamSchema().load(request.args)
+        values = SpecialFieldService.find_all_by_params(params)
+        return jsonify(res.SpecialFieldResponseSchema(many=True).dump(values)), HTTPStatus.OK
+
+    @staticmethod
+    @cors.crossdomain(origin="*")
+    @auth.require
+    @profiletime
+    def post():
+        """Create new task template"""
+        request_json = req.SpecialFieldBodyParameterSchema().load(API.payload)
+        entry = SpecialFieldService.create_special_field_entry(request_json)
+        return res.SpecialFieldResponseSchema().dump(entry), HTTPStatus.CREATED
+
+
+@cors_preflight('GET, PUT')
+@API.route('/<int:special_field_id>', methods=['GET', 'PUT', 'OPTIONS'])
+class SpecialField(Resource):
+    """Endpoint resource to return special field details."""
+
+    @staticmethod
+    @cors.crossdomain(origin='*')
+    @auth.require
+    @profiletime
+    def get(special_field_id):
+        """Return a special field detail based on id."""
+        req.SpecialFieldIdPathParameterSchema().load(request.view_args)
+        special_field_entry = SpecialFieldService.find_by_id(special_field_id)
+        if special_field_entry:
+            return res.SpecialFieldResponseSchema().dump(special_field_entry), HTTPStatus.OK
+        raise ResourceNotFoundError(f'Special field entry with id "{special_field_id}" not found')
+
+    @staticmethod
+    @cors.crossdomain(origin='*')
+    @auth.require
+    @profiletime
+    def put(special_field_id):
+        """Update and return a special field entry."""
+        req.SpecialFieldIdPathParameterSchema().load(request.view_args)
+        request_json = req.SpecialFieldBodyParameterSchema().load(API.payload)
+        special_field_entry = SpecialFieldService.update_special_field_entry(special_field_id, request_json)
+        return res.SpecialFieldResponseSchema().dump(special_field_entry), HTTPStatus.OK
+
+
+@cors_preflight('GET')
+@API.route('/exists', methods=['GET', 'OPTIONS'])
+class ValidateSpecialFieldEntry(Resource):
+    """Endpoint resource to check for existing special field entry."""
+
+    @staticmethod
+    @cors.crossdomain(origin='*')
+    @auth.require
+    @profiletime
+    def get():
+        """Checks for existing special field entries."""
+        args = req.SpecialFieldExistanceQueryParamSchema().load(request.args)
+        special_field_entry_id = args.pop('spcial_field_id')
+        exists = SpecialFieldService.check_existence(args, special_field_id=special_field_entry_id)
+        return (
+            {'exists': exists},
+            HTTPStatus.OK,
+        )

epictrack-api/src/api/schemas/request/__init__.py

@@ -36,6 +36,9 @@
 from .proponent_request import (
     ProponentBodyParameterSchema, ProponentExistenceQueryParamSchema, ProponentIdPathParameterSchema)
 from .reminder_configuration_request import ReminderConfigurationExistenceQueryParamSchema
+from .special_field_request import (
+    SpecialFieldBodyParameterSchema, SpecialFieldExistanceQueryParamSchema, SpecialFieldIdPathParameterSchema,
+    SpecialFieldQueryParamSchema)
 from .staff_request import (
     StaffBodyParameterSchema, StaffByPositionsQueryParamSchema, StaffEmailPathParameterSchema,
     StaffExistanceQueryParamSchema, StaffIdPathParameterSchema)