Feature/deseng415 (#2334)

* feature/deseng415: Added recording of date with feedback submission and displaying the data on admin side.

* feature/deseng415: Fixed feedback schema, removed yup import, fixed change log date.

CHANGELOG.MD

@@ -2,11 +2,17 @@
 
 All notable changes to this project will be documented in this file. This project adheres to [Semantic Versioning](https://semver.org/).
 
+## v1.1.0 - 2023-11-10
+
+> **Feature**: Started logging source url path with feedback submission. Viewable in dashboard. [🎟️DESENG-415](https://apps.itsm.gov.bc.ca/jira/browse/DESENG-415)
+
 
 ## v1.0.1 - 2023-10-26
 
 > **Bug Fix**: Upgraded BC-Sans font to newest version. [🎟️DESENG-413](https://apps.itsm.gov.bc.ca/jira/browse/DESENG-413)
+
 > **Bug Fix**: Engagements will now open in the same browser window/tab, not a new one. [🎟️DESENG-421](https://apps.itsm.gov.bc.ca/jira/browse/DESENG-421)
+
 > **Bug Fix**: Update sample .env files - [🎟️DESENG-414](https://apps.itsm.gov.bc.ca/jira/browse/DESENG-414)
 >- Sample .env files have been updated to reflect the current state of the project.
 >- *Breaking*: Keycloak URLs and resources now point to the BC Government's SSO service when using `sample.env` as a baseline

docs/MET_database_ERD.md

@@ -286,6 +286,7 @@ erDiagram
         type rating
         type comment_type
         string comment
+        string submission_path
         type source
         timestamp created_date
         timestamp updated_date        

met-api/migrations/versions/02ff8ecc6b91_added_url_path_column_to_feedback_table.py

@@ -0,0 +1,27 @@
+"""Added URL path column to feedback table.
+
+Revision ID: 02ff8ecc6b91
+Revises: 25e6609cb4db
+Create Date: 2023-11-10 10:33:06.780841
+
+"""
+from alembic import op
+import sqlalchemy as sa
+from sqlalchemy.dialects import postgresql
+
+# revision identifiers, used by Alembic.
+revision = '02ff8ecc6b91'
+down_revision = '25e6609cb4db'
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.add_column('feedback', sa.Column('submission_path', sa.String()))
+    # ### end Alembic commands ###
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_column('feedback', 'submission_path')
+    # ### end Alembic commands ###

met-api/src/met_api/models/feedback.py

@@ -24,6 +24,7 @@ class Feedback(BaseModel):
     rating = db.Column(db.Enum(RatingType), nullable=True)
     comment_type = db.Column(db.Enum(CommentType), nullable=True)
     comment = db.Column(db.Text, nullable=True)
+    submission_path = db.Column(db.Text, nullable=True)
     source = db.Column(db.Enum(FeedbackSourceType), nullable=True)
     tenant_id = db.Column(
         db.Integer, db.ForeignKey('tenant.id'), nullable=True)
@@ -65,6 +66,7 @@ def create_feedback(feedback):
         new_feedback = Feedback(
             status=feedback.get('status', None),
             comment=feedback.get('comment', None),
+            submission_path=feedback.get('submission_path', None),
             created_date=datetime.utcnow(),
             rating=feedback.get('rating'),
             comment_type=feedback.get('comment_type', None),

met-api/src/met_api/schemas/feedback.py

@@ -16,6 +16,7 @@ class Meta:  # pylint: disable=too-few-public-methods
 
     id = fields.Int(data_key='id')
     comment = fields.Str(data_key='comment')
+    submission_path = fields.Str(data_key='submission_path')
     created_date = fields.DateTime(data_key='created_date')
     status = EnumField(FeedbackStatusType, by_value=True)
     rating = EnumField(RatingType, by_value=True)

met-api/src/met_api/schemas/schemas/feedback.json

@@ -9,7 +9,8 @@
         {
             "rating": 1,
             "comment_type": "2",
-            "comment": "Custom comment"
+            "comment": "Custom comment",
+            "submission_path": "/gdx/"
         }
     ],
     "required": [
@@ -46,6 +47,15 @@
             "examples": [
                 "A comment example"
             ]
+        },
+        "submission_path": {
+            "$id": "#/properties/submission_path",
+            "type": "string",
+            "title": "Path",
+            "description": "The path that the feedback was submitted from.",
+            "examples": [
+                "/gdx/"
+            ]
         }
     }
 }

met-web/package.json

@@ -1,6 +1,6 @@
 {
     "name": "client",
-    "version": "1.0.1",
+    "version": "1.1.0",
     "private": true,
     "dependencies": {
         "@arcgis/core": "^4.26.5",

met-web/src/components/feedback/FeedbackModal/index.tsx

@@ -15,7 +15,7 @@ import CloseIcon from '@mui/icons-material/Close';
 import { ReactComponent as CheckIcon } from 'assets/images/check.svg';
 import { useState } from 'react';
 import { MetBody, MetHeader3, MetLabel, modalStyle, PrimaryButton, MetDisclaimer } from '../../common';
-import { CommentTypeEnum, createDefaultFeedback, RatingTypeEnum } from 'models/feedback';
+import { CommentTypeEnum, createDefaultFeedback, setFeedbackPath, RatingTypeEnum } from 'models/feedback';
 import { Else, If, Then, When } from 'react-if';
 import { CommentTypeButton, StyledRating } from './styledComponents';
 import { createFeedback } from 'services/feedbackService';
@@ -29,8 +29,8 @@ import SentimentVeryDissatisfiedIcon from '@mui/icons-material/SentimentVeryDiss
 export const FeedbackModal = () => {
     const [isSubmitted, setIsSubmitted] = useState(false);
     const [isOpen, setIsOpen] = useState(false);
-    const [feedbackFormData, setFeedbackFormData] = useState(createDefaultFeedback());
     const [isSaving, setIsSaving] = useState(false);
+    const [feedbackFormData, setFeedbackFormData] = useState(setFeedbackPath(createDefaultFeedback()));
     const { comment, rating, comment_type } = feedbackFormData;
     const dispatch = useAppDispatch();
 

met-web/src/components/feedback/listing.tsx

@@ -98,6 +98,14 @@ const FeedbackListing = () => {
             allowSort: true,
             renderCell: (row: Feedback) => SourceTypeEnum[row.source ?? 0].toString(),
         },
+        {
+            key: 'submission_path',
+            numeric: false,
+            disablePadding: false,
+            label: 'Path',
+            allowSort: true,
+            renderCell: (row: Feedback) => row.submission_path,
+        },
         {
             key: 'comment_type',
             numeric: false,

met-web/src/models/feedback.ts

@@ -6,6 +6,7 @@ export interface Feedback {
     comment_type: CommentTypeEnum;
     source: SourceTypeEnum;
     status: FeedbackStatusEnum;
+    submission_path: string;
 }
 
 export enum FeedbackStatusEnum {
@@ -38,5 +39,13 @@ export const createDefaultFeedback = (): Feedback => {
         created_date: '',
         source: SourceTypeEnum.Public,
         status: FeedbackStatusEnum.NotReviewed,
+        submission_path: '',
+    };
+};
+
+export const setFeedbackPath = (existingFeedback: Feedback): Feedback => {
+    return {
+        ...existingFeedback,
+        submission_path: window.location.pathname,
     };
 };

met-web/src/services/feedbackService/types.ts

@@ -14,11 +14,13 @@ export interface PostFeedbackRequest {
     comment_type: number;
     comment: string;
     status: FeedbackStatusEnum;
+    submission_path: string;
 }
 
 export interface UpdateFeedbackRequest {
     rating?: number;
     comment_type?: number;
     comment?: string;
     status?: FeedbackStatusEnum;
+    submission_path?: string;
 }

met-web/tests/unit/components/feedback/feedbackListing.test.tsx

@@ -13,6 +13,7 @@ const mockFeedbackOne = {
     ...createDefaultFeedback(),
     rating: 2,
     comment: 'Feedback One',
+    submission_path: '/gdx/',
     comment_type: CommentTypeEnum.None,
     created_date: '2022-09-17 10:00:00',
     source: SourceTypeEnum.Public,
@@ -22,6 +23,7 @@ const mockFeedbackTwo = {
     ...createDefaultFeedback(),
     rating: 1,
     comment: 'Feedback Two',
+    submission_path: '/eao/',
     comment_type: CommentTypeEnum.None,
     created_date: '2022-09-19 10:00:00',
     source: SourceTypeEnum.Public,

met-web/tests/unit/components/feedback/feedbackModal.test.tsx

@@ -53,6 +53,7 @@ describe('Feedback modal tests', () => {
                 status: FeedbackStatusEnum.NotReviewed,
                 comment_type: CommentTypeEnum.None,
                 comment: '',
+                submission_path: '',
                 rating: 1,
                 created_date: '',
                 source: SourceTypeEnum.Public,

tools/postman/MET.postman_collection.json

@@ -758,6 +758,7 @@
 									"    var jsonData = pm.response.json().result;\r",
 									"    pm.expect(jsonData.rating).to.exist\r",
 									"    pm.expect(jsonData.comment).to.exist\r",
+									"    pm.expect(jsonData.submission_path).to.exist\r",
 									"    pm.expect(jsonData.comment_type).to.exist\r",
 									"    pm.expect(jsonData.created_date).to.exist\r",
 									"    pm.expect(jsonData.source).to.exist\r",
@@ -813,7 +814,7 @@
 						"header": [],
 						"body": {
 							"mode": "raw",
-							"raw": "{\r\n    \"rating\": {{FEEDBACK_RATING}},\r\n    \"comment\": \"{{FEEDBACK_COMMENT}}\",\r\n    \"comment_type\":{{FEEDBACK_COMMENT_TYPE}},\r\n    \"created_date\": \"{{FEEDBACK_CREATED_DATE}}\",\r\n    \"source\": {{FEEDBACK_SOURCE}}\r\n}",
+							"raw": "{\r\n    \"rating\": {{FEEDBACK_RATING}},\r\n    \"comment\": \"{{FEEDBACK_COMMENT}}\",\r\n    \"submission_path\": \"{{FEEDBACK_SUBMISSION_PATH}}\",\r\n    \"comment_type\":{{FEEDBACK_COMMENT_TYPE}},\r\n    \"created_date\": \"{{FEEDBACK_CREATED_DATE}}\",\r\n    \"source\": {{FEEDBACK_SOURCE}}\r\n}",
 							"options": {
 								"raw": {
 									"language": "json"
@@ -858,6 +859,7 @@
 									"      for (var i=0; i<jsonData.items.length; i++) {\r",
 									"    pm.expect(jsonData.items[i].rating).to.exist\r",
 									"    pm.expect(jsonData.items[i].comment).to.exist\r",
+									"    pm.expect(jsonData.items[i].submission_path).to.exist\r",
 									"    pm.expect(jsonData.items[i].comment_type).to.exist\r",
 									"    pm.expect(jsonData.items[i].created_date).to.exist\r",
 									"    pm.expect(jsonData.items[i].source).to.exist\r",
@@ -1084,6 +1086,11 @@
 			"value": "US",
 			"type": "string"
 		},
+		{
+			"key": "FEEDBACK_SUBMISSION_PATH",
+			"value": "US",
+			"type": "string"
+		},
 		{
 			"key": "FEEDBACK_SOURCE",
 			"value": "",