Add survey report settings page (#1810)

* implement client side pagination

* add fetch report settings

* Add checkbox and refine components

* call patch update with the updated settings

* handle navigation on save

* validate survey during update

* fix lint and unit test

* Add service test

* replace double quote with single

* Complete dashboard url copy functionality

* load engagement slug

* remove generate dashboard button setting from report settings

* remove only from unit test

* update docstring and function names

met-api/src/met_api/resources/__init__.py

@@ -80,4 +80,4 @@
 API.add_namespace(WIDGET_EVENTS_API, path='/widgets/<int:widget_id>/events')
 API.add_namespace(WIDGET_MAPS_API, path='/widgets/<int:widget_id>/maps')
 API.add_namespace(ENGAGEMENT_SLUG_API, path='/slugs')
-API.add_namespace(REPORT_SETTING_API)
+API.add_namespace(REPORT_SETTING_API, path='/surveys/<int:survey_id>/reportsettings')

met-api/src/met_api/resources/report_setting.py

@@ -26,41 +26,42 @@
 from met_api.utils.util import allowedorigins, cors_preflight
 
 
-API = Namespace('reportsetting', description='Endpoints for report setting management')
+API = Namespace('reportsettings', description='Endpoints for report setting management')
 """Custom exception messages
 """
 
 
-@cors_preflight('POST, OPTIONS, PATCH')
-@API.route('/')
+@cors_preflight('GET, POST, PATCH, OPTIONS')
+@API.route('')
 class ReportSetting(Resource):
     """Resource for managing report setting."""
 
     @staticmethod
-    # @TRACER.trace()
     @cross_origin(origins=allowedorigins())
-    @_jwt.requires_auth
-    def post():
-        """Refresh the report setting to match the questions on survey."""
+    @auth.optional
+    def get(survey_id):
+        """Fetch report setting for the survey id provided."""
         try:
-            requestjson = request.get_json()
-            report_setting = ReportSettingService().refresh_report_setting(requestjson)
+            report_setting = ReportSettingService().get_report_setting(survey_id)
 
-            return jsonify(report_setting), HTTPStatus.OK
-        except KeyError as err:
-            return str(err), HTTPStatus.INTERNAL_SERVER_ERROR
+            if report_setting:
+                return jsonify(report_setting), HTTPStatus.OK
+
+            return 'Report setting was not found', HTTPStatus.NOT_FOUND
+        except KeyError:
+            return 'Report setting was not found', HTTPStatus.INTERNAL_SERVER_ERROR
         except ValueError as err:
             return str(err), HTTPStatus.INTERNAL_SERVER_ERROR
 
     @staticmethod
     # @TRACER.trace()
     @cross_origin(origins=allowedorigins())
     @_jwt.requires_auth
-    def patch():
+    def patch(survey_id):
         """Update saved report setting partially."""
         try:
-            requestjson = request.get_json()
-            report_setting = ReportSettingService().update_report_setting(requestjson)
+            new_report_settings = request.get_json()
+            report_setting = ReportSettingService().update_report_setting(survey_id, new_report_settings)
 
             return jsonify(report_setting), HTTPStatus.OK
         except KeyError as err:
@@ -69,26 +70,3 @@ def patch():
             return str(err), HTTPStatus.INTERNAL_SERVER_ERROR
         except ValidationError as err:
             return str(err.messages), HTTPStatus.INTERNAL_SERVER_ERROR
-
-
-@cors_preflight('GET, OPTIONS')
-@API.route('/<survey_id>')
-class ReportSettings(Resource):
-    """Resource for managing a report setting."""
-
-    @staticmethod
-    @cross_origin(origins=allowedorigins())
-    @auth.optional
-    def get(survey_id):
-        """Fetch report setting for the survey id provided."""
-        try:
-            report_setting = ReportSettingService().get_report_setting(survey_id)
-
-            if report_setting:
-                return jsonify(report_setting), HTTPStatus.OK
-
-            return 'Report setting was not found', HTTPStatus.NOT_FOUND
-        except KeyError:
-            return 'Report setting was not found', HTTPStatus.INTERNAL_SERVER_ERROR
-        except ValueError as err:
-            return str(err), HTTPStatus.INTERNAL_SERVER_ERROR

met-api/src/met_api/services/report_setting_service.py

@@ -1,6 +1,7 @@
 """Service for report setting management."""
 
 from met_api.models.report_setting import ReportSetting as ReportSettingModel
+from met_api.models.survey import Survey as SurveyModel
 from met_api.schemas.report_setting import ReportSettingSchema
 from met_api.constants.report_setting_type import FormIoComponentType
 
@@ -136,15 +137,20 @@ def _delete_questions_removed_from_form(cls, survey_id, survey_question_keys):
                 ReportSettingModel.delete_report_settings(survey_id, report_setting['question_key'])
 
     @classmethod
-    def update_report_setting(cls, report_setting_data):
+    def update_report_setting(cls, survey_id, new_report_settings):
         """Update report setting."""
-        for data in report_setting_data:
-            report_setting_id = data.get('id', None)
+        survey = SurveyModel.find_by_id(survey_id)
+        if not survey:
+            raise KeyError(f'No survey found for {survey_id}')
+        for setting in new_report_settings:
+            report_setting_id = setting.get('id', None)
             report_setting = ReportSettingModel.find_by_id(report_setting_id)
             if not report_setting:
                 raise ValueError(f'No report setting found for {report_setting_id}')
+            if report_setting.survey_id != survey_id:
+                raise KeyError(f'Report setting {report_setting.id} does not belong to survey {survey_id}')
 
-            report_setting.display = data.get('display', None)
+            report_setting.display = setting.get('display', None)
             report_setting.save()
 
-        return report_setting_data
+        return new_report_settings

met-api/src/met_api/services/survey_service.py

@@ -13,6 +13,7 @@
 from met_api.schemas.survey import SurveySchema
 from met_api.services import authorization
 from met_api.services.membership_service import MembershipService
+from met_api.services.report_setting_service import ReportSettingService
 from met_api.services.object_storage_service import ObjectStorageService
 from met_api.utils.roles import Role
 from met_api.utils.token_info import TokenInfo
@@ -151,7 +152,14 @@ def update(cls, data: SurveySchema):
 
         if engagement and engagement.get('status_id', None) != Status.Draft.value:
             raise ValueError('Engagement already published')
-        return SurveyModel.update_survey(data)
+
+        updated_survey = SurveyModel.update_survey(data)
+        ReportSettingService.refresh_report_setting({
+            'id': updated_survey.id,
+            'form_json': updated_survey.form_json,
+        })
+
+        return updated_survey
 
     @staticmethod
     def validate_update_fields(data):

met-api/tests/unit/api/test_report_setting.py

@@ -16,41 +16,25 @@
 
 Test-Suite to ensure that the Report setting endpoint is working as expected.
 """
-import json
-
 from met_api.utils.enums import ContentType
-from tests.utilities.factory_scenarios import TestJwtClaims, TestSurveyInfo
-from tests.utilities.factory_utils import factory_auth_header, factory_survey_and_eng_model
-
-
-def test_create_report_setting(client, jwt, session):  # pylint:disable=unused-argument
-    """Assert that an report setting can be POSTed."""
-    headers = factory_auth_header(jwt=jwt, claims=TestJwtClaims.staff_admin_role)
-    survey, eng = factory_survey_and_eng_model(TestSurveyInfo.survey3)
-    data = {
-        'id': survey.id,
-        'form_json': survey.form_json,
-    }
-    rv = client.post('/api/reportsetting/', data=json.dumps(data),
-                     headers=headers, content_type=ContentType.JSON.value)
-    assert rv.status_code == 200
+from tests.utilities.factory_scenarios import TestJwtClaims, TestReportSettingInfo, TestSurveyInfo
+from tests.utilities.factory_utils import (
+    factory_auth_header, factory_survey_and_eng_model, factory_survey_report_setting_model)
 
 
 def test_get_report_setting(client, jwt, session):  # pylint:disable=unused-argument
     """Assert that report setting can be fetched."""
     headers = factory_auth_header(jwt=jwt, claims=TestJwtClaims.staff_admin_role)
-    survey, eng = factory_survey_and_eng_model(TestSurveyInfo.survey3)
+    survey, _ = factory_survey_and_eng_model(TestSurveyInfo.survey3)
 
-    data = {
-        'id': survey.id,
-        'form_json': survey.form_json,
+    report_setting_data = {
+        **TestReportSettingInfo.report_setting_1,
+        'survey_id': survey.id,
     }
-    rv = client.post('/api/reportsetting/', data=json.dumps(data),
-                     headers=headers, content_type=ContentType.JSON.value)
-    assert rv.status_code == 200
+    factory_survey_report_setting_model(report_setting_data)
 
     rv = client.get(
-        f'/api/reportsetting/{survey.id}',
+        f'/api/surveys/{survey.id}/reportsettings',
         headers=headers,
         content_type=ContentType.JSON.value
     )

met-api/tests/unit/services/test_report_settings.py

@@ -0,0 +1,35 @@
+# 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.
+"""Tests for the report settings service.
+
+Test suite to ensure that the Survey report settings service routines are working as expected.
+"""
+from met_api.services.report_setting_service import ReportSettingService
+from tests.utilities.factory_scenarios import TestSurveyInfo
+from tests.utilities.factory_utils import factory_survey_and_eng_model
+
+
+def test_refresh_report_setting(session):  # pylint:disable=unused-argument
+    """Assert report settings are refreshed."""
+    survey, _ = factory_survey_and_eng_model(TestSurveyInfo.survey3)
+    survey_data = {
+        'id': survey.id,
+        'form_json': survey.form_json,
+    }
+    result = ReportSettingService.refresh_report_setting(survey_data)
+    assert result == survey_data
+
+    report_settings = ReportSettingService.get_report_setting(survey.id)
+    assert len(report_settings) == 1
+    assert report_settings[0].get('survey_id') == survey.id

met-api/tests/utilities/factory_scenarios.py

@@ -28,6 +28,7 @@
 from met_api.constants.widget import WidgetType
 from met_api.utils.enums import LoginSource
 
+
 fake = Faker()
 
 CONFIG = get_named_config('testing')
@@ -526,3 +527,21 @@ class TestEngagementSlugInfo(dict, Enum):
         'slug': fake.text(max_nb_chars=20),
         'created_date': datetime.now().strftime('%Y-%m-%d'),
     }
+
+
+class TestReportSettingInfo(dict, Enum):
+    """Test scenarios of feedback."""
+
+    report_setting_1 = {
+        'created_by': str(fake.pyint()),
+        'created_date': datetime.now().strftime('%Y-%m-%d'),
+        'display': True,
+        'id': 1,
+        'question': 'What is your opinion about this?',
+        'question_id': str(fake.pyint()),
+        'question_key': 'simpletextarea',
+        'question_type': 'simpletextarea',
+        'survey_id': 1,
+        'updated_by': str(fake.pyint()),
+        'updated_date': datetime.now().strftime('%Y-%m-%d')
+    }

met-api/tests/utilities/factory_utils.py

@@ -29,6 +29,7 @@
 from met_api.models.feedback import Feedback as FeedbackModel
 from met_api.models.membership import Membership as MembershipModel
 from met_api.models.participant import Participant as ParticipantModel
+from met_api.models.report_setting import ReportSetting as ReportSettingModel
 from met_api.models.staff_user import StaffUser as StaffUserModel
 from met_api.models.submission import Submission as SubmissionModel
 from met_api.models.subscription import Subscription as SubscriptionModel
@@ -40,8 +41,8 @@
 from met_api.utils.enums import MembershipStatus
 from tests.utilities.factory_scenarios import (
     TestCommentInfo, TestEngagementInfo, TestEngagementSlugInfo, TestFeedbackInfo, TestParticipantInfo,
-    TestSubmissionInfo, TestSurveyInfo, TestTenantInfo, TestUserInfo, TestWidgetDocumentInfo, TestWidgetInfo,
-    TestWidgetItemInfo)
+    TestReportSettingInfo, TestSubmissionInfo, TestSurveyInfo, TestTenantInfo, TestUserInfo, TestWidgetDocumentInfo,
+    TestWidgetInfo, TestWidgetItemInfo)
 
 
 CONFIG = get_named_config('testing')
@@ -301,3 +302,17 @@ def factory_engagement_slug_model(eng_slug_info: dict = TestEngagementSlugInfo.s
     )
     slug.save()
     return slug
+
+
+def factory_survey_report_setting_model(report_setting_info: dict = TestReportSettingInfo.report_setting_1):
+    """Produce a engagement model."""
+    setting = ReportSettingModel(
+        survey_id=report_setting_info.get('survey_id'),
+        question_id=report_setting_info.get('question_id'),
+        question_key=report_setting_info.get('question_key'),
+        question_type=report_setting_info.get('question_type'),
+        question=report_setting_info.get('question'),
+        display=report_setting_info.get('display'),
+    )
+    setting.save()
+    return setting

met-web/src/apiManager/endpoints/index.ts

@@ -41,6 +41,11 @@ const Endpoints = {
         GET_LIST: `${AppConfig.apiUrl}/submissions/survey/survey_id`,
         GET: `${AppConfig.apiUrl}/submissions/submission_id`,
     },
+    SurveyReportSetting: {
+        GET_LIST: `${AppConfig.apiUrl}/surveys/survey_id/reportsettings`,
+        UPDATE: `${AppConfig.apiUrl}/surveys/survey_id/reportsettings`,
+        CREATE: `${AppConfig.apiUrl}/surveys/survey_id/reportsettings`,
+    },
     Subscription: {
         GET: `${AppConfig.apiUrl}/subscription/participant_id`,
         CREATE: `${AppConfig.apiUrl}/subscription/`,

met-web/src/components/common/Table/ClientSidePagination.tsx

@@ -0,0 +1,65 @@
+import React, { useEffect } from 'react';
+import { MetTableProps } from '.';
+import { PaginationOptions } from './types';
+
+interface ClientSidePaginationProps<T> {
+    rows: T[];
+    searchFilter?: {
+        key: keyof T;
+        value: string;
+    };
+    children: (props: MetTableProps<T>) => React.ReactElement<MetTableProps<T>>;
+}
+
+export function ClientSidePagination<T>({ rows, searchFilter, children }: ClientSidePaginationProps<T>) {
+    const [paginationOptions, setPaginationOptions] = React.useState<PaginationOptions<T>>({
+        page: 1,
+        size: 10, // default page size
+    });
+    const [pageInfo, setPageInfo] = React.useState({ total: rows.length });
+    const [searchFilteredRows, setSearchFilteredRows] = React.useState<T[]>([]);
+    const [paginatedRows, setPaginatedRows] = React.useState<T[]>([]);
+
+    const handleChangePagination = (newPaginationOptions: PaginationOptions<T>) => {
+        const { page, size } = newPaginationOptions;
+        const paginated = searchFilteredRows.slice((page - 1) * size, page * size);
+        setPaginationOptions(newPaginationOptions);
+        setPageInfo({ total: rows.length });
+        setPaginatedRows(paginated);
+    };
+
+    const handleFilter = () => {
+        if (!searchFilter?.value) {
+            setSearchFilteredRows(rows);
+            setPageInfo({ total: rows.length });
+            setPaginationOptions({ ...paginationOptions, page: 1 });
+            return;
+        }
+        const filtered = rows.filter((row) =>
+            String(row[searchFilter.key]).toLowerCase().includes(searchFilter.value.toLowerCase()),
+        );
+        const newTotal = filtered.length;
+        setSearchFilteredRows(filtered);
+        setPageInfo({ total: newTotal });
+        setPaginationOptions({ ...paginationOptions, page: 1 });
+    };
+
+    useEffect(() => {
+        handleFilter();
+    }, [searchFilter, rows]);
+
+    useEffect(() => {
+        handleChangePagination(paginationOptions);
+    }, [searchFilteredRows]);
+
+    const metTableComponent = children({
+        rows: paginatedRows, // Use the filtered rows for rendering
+        loading: false,
+        handleChangePagination,
+        paginationOptions,
+        pageInfo,
+        headCells: [],
+    });
+
+    return <>{metTableComponent}</>;
+}

met-web/src/components/common/Table/index.tsx

@@ -66,7 +66,7 @@ function MetTableHead<T>({ order, orderBy, onRequestSort, headCells, loading, ne
     );
 }
 
-interface MetTableProps<T> {
+export interface MetTableProps<T> {
     headCells: HeadCell<T>[];
     rows: T[];
     hideHeader?: boolean;
@@ -87,7 +87,7 @@ function MetTable<T>({
     noPagination = false,
     commentTable = false,
     // eslint-disable-next-line
-    handleChangePagination = (_pagination: PaginationOptions<T>) => { },
+    handleChangePagination = (_pagination: PaginationOptions<T>) => {},
     loading = false,
     paginationOptions = {
         page: 1,