feature: Reports fields rename (M2-8268) #2002

andrevitalb · 2025-01-03T07:37:25Z

Tests for the changes have been
Delivered the fix or feature branches into develop or release branches via Squash and Merge (to keep clean history)

📝 Description

Renaming & reordering for both report.csv and activity_user_journey.csv fields. Also, renamed report.csv to responses.csv.

All these changes were added behind a workspace-wide feature flag, so won't be directly enabled by default.

Current expected columns & order (for `report.csv`)

id
activity_flow_submission_id
activity_scheduled_time
activity_start_time
activity_end_time
flag
secret_user_id
userId
source_user_subject_id
source_user_secret_id
source_user_nickname
source_user_relation
source_user_tag
target_user_subject_id
target_user_secret_id
target_user_nickname
target_user_tag
input_user_subject_id
input_user_secret_id
input_user_nickname
activity_id
activity_name
activity_flow_id
activity_flow_name
item
response
prompt
options
version
rawScore
reviewing_id
schedule_id
timezone_offset
legacy_user_id

New expected columns & order

target_id
target_secret_id
target_nickname
target_tag
source_id
source_secret_id
source_nickname
source_tag
source_relation
input_id
input_secret_id
input_nickname
userId
secret_user_id
legacy_user_id
applet_version
activity_flow_id
activity_flow_name
activity_flow_submission_id
activity_id
activity_name
activity_submission_id
activity_start_time
activity_end_time
activity_schedule_id
activity_schedule_start_time
utc_timezone_offset
activity_submission_review_id
item_id
item_name
item_prompt
item_response_options
item_response
item_response_status
rawScore

The changes get propagated to activity_user_journey.csv. Additional fields for said report were left unchanged.

🪤 Peer Testing

In order to test functionality, set enableDataExportRenaming feature flag to true.

✏️ Notes

Something to keep in mind is that changes to subscales will come in a separate ticket, under the same feature flag that was used for all the changes added here

…_offset to null

aws-amplify-us-east-1 · 2025-01-03T07:43:09Z

This pull request is automatically being deployed by Amplify Hosting (learn more).

Access this pull request here: https://pr-2002.d19gtpld8yi51u.amplifyapp.com

felipeMetaLab

Disabling eslint and TS

src/shared/utils/exportData/getReportCSVObject.test.ts

src/shared/utils/exportData/getReportAndMediaData.test.ts

src/shared/utils/exportData/getJourneyCSVObject.test.ts

felipeMetaLab

Beside the comment to disable Ts and eslint the code looks good for me.

mbanting

Nice work. Main comment is the flag is temporary. So try and minimize it's proliferation in the code to only where it's necessary. Reduces cleanup and risk later on when flag is archived and code needs to be updated to remove references to it, and where QA might not test to the same level as when the feature is first implemented. I pointed out a couple of places where this can be done.

mbanting · 2025-01-24T17:36:37Z

src/shared/consts.tsx

+const LEGACY_GENERAL_REPORT_NAME = 'report';
+const NEW_GENERAL_REPORT_NAME = 'responses';
+
+export const getGeneralReportName = (enableDataExportRenaming: boolean) =>


Not sure if capturing this condition in a function is needed. It's only called in one place (exportDataSucceed) and the use of a feature flag is temporary. Once the enableDataExportRenaming flag is archived, we'll need to remove all references (or params based on it) to it, so it's good keep this to only where this is needed. Suggest removing this function and simply determine this in exportDataSucceed

mbanting · 2025-01-24T17:39:12Z

src/shared/utils/exportData/exportDataSucceed.ts

  await exportTemplate({
    data: reportData,
-    fileName: GENERAL_REPORT_NAME + suffix,
-    defaultData: reportData.length > 0 ? null : reportHeader,
+    fileName: getGeneralReportName(enableDataExportRenaming) + suffix,


I suggest simply determine the report name here

fileName: (enableDataExportRenaming ? NEW_GENERAL_REPORT_NAME : LEGACY_GENERAL_REPORT_NAME) + suffix,

mbanting · 2025-01-24T17:58:02Z

src/shared/consts.tsx

 ];

-export const activityJourneyHeader = [
+export const getReportHeader = (enableDataExportRenaming?: boolean) =>


Same comment as above. I realize this function is also used in the tests (exportDataSucceed.test.ts), but this function itself will likely be deleted once the flag is archived, so minimizing the use of this function in other places like the tests also make sense. Instead can you import legacyReportHeader and newReportHeader in the tests and compare against those values instead of relying on this function.

mbanting · 2025-01-24T17:58:14Z

src/shared/consts.tsx

+  'response_option_selection_time',
+];
+
+export const getActivityJourneyHeader = (enableDataExportRenaming?: boolean) =>


Same comment as above

mbanting · 2025-01-24T17:59:46Z

src/shared/utils/exportData/exportDataSucceed.test.ts

@@ -1,5 +1,7 @@
 /* eslint-disable @typescript-eslint/ban-ts-comment */
 // @ts-nocheck
+import { getActivityJourneyHeader, getReportHeader } from 'shared/consts';


Can this import legacyReportHeader, reportHeader, legacyActivityJourneyHeader, and activityJourneyHeader instead

mbanting · 2025-01-24T18:01:07Z

src/shared/consts.tsx

@@ -387,6 +435,52 @@ export const activityJourneyHeader = [
  'version',
 ];

+export const newActivityJourneyHeader = [


Let's use activityJourneyHeader instead. One less change during flag cleanup.

mbanting · 2025-01-24T18:02:35Z

src/shared/utils/exportData/exportDataSucceed.ts

-    fileName: GENERAL_REPORT_NAME + suffix,
-    defaultData: reportData.length > 0 ? null : reportHeader,
+    fileName: getGeneralReportName(enableDataExportRenaming) + suffix,
+    defaultData: reportData.length > 0 ? null : getReportHeader(enableDataExportRenaming),


Similar comment as above

mbanting · 2025-01-24T18:03:59Z

src/shared/utils/exportData/exportDataSucceed.ts

  });
  await exportTemplate({
    data: activityJourneyData,
    fileName: JOURNEY_REPORT_NAME + suffix,
-    defaultData: activityJourneyData.length > 0 ? null : activityJourneyHeader,
+    defaultData:
+      activityJourneyData.length > 0 ? null : getActivityJourneyHeader(enableDataExportRenaming),


Same comment as above. Determine the headers here instead of relying on an external function that will be removed and unavailable when the flag is archived.

mbanting · 2025-01-24T18:11:06Z

src/shared/utils/exportData/getJourneyCSVObject.test.ts

+  legacy_user_id: null,
+};
+
+const newResult = {


A bit of a nit, but let's just call this result as it is the result when the flag is on and also when it is ultimately archived. Minimizes cleanup when flag is removed.

mbanting · 2025-01-24T18:28:36Z

src/shared/utils/exportData/getReportCSVObject.test.ts

@@ -160,8 +160,63 @@ const result = {
  legacy_user_id: '',
 };

+const newResult = {


A bit of a nit, but let's just call this result as it is the result when the flag is on and also when it is ultimately archived. Minimizes cleanup when flag is removed.

andrevitalb · 2025-01-24T18:34:16Z

On it 🤓

andrevitalb added 17 commits December 12, 2024 17:03

feature: Create data export rename feature flag

cf7be7c

Fast forward branch

b1bd2b8

feature: Add new/legacy variables for data export fields

8864585

feature: Propagate dynamic assignment for data export naming

5e205de

feature: Top level data export renaming feature flag fetching

789d73b

Fast forward branch

0c686f5

Fast forward branch

795f54a

feature: Add conditional props formatting for report

da2cbaf

feature: Add conditional props formatting for journey report

b6583a8

feature: More rename changes for report

aabccbf

feature: Propagate naming changes to activity journey report

4f15638

feature: Apply dynamic functionality for journey report default data

2f5694e

feature: Data export rename feature flag passthrough

cfca9a6

test: Update report tests to check for both legacy & new naming

af0acd9

feature: Data export rename feature flag passthrough for WorkersManager

44b240d

test: Remove unneeded extra fields (duplicated) for mock items

b59a4bb

test: Update expected undefined value for legacy_user_id and timezone…

8f18b06

…_offset to null

Fast forward branch

dc259af

andrevitalb marked this pull request as ready for review January 8, 2025 17:05

andrevitalb added 3 commits January 9, 2025 03:45

test: Update getReportAndMediaData to also test for new naming

0bc44f6

test: Limit new naming test to 2 items

6e82318

test: Prop name & value correction for new name tests

480a4f7

andrevitalb mentioned this pull request Jan 9, 2025

feature: Subscale fields renaming #2010

Draft

2 tasks

andrevitalb requested review from ramirlm and felipeMetaLab January 10, 2025 03:31

felipeMetaLab reviewed Jan 15, 2025

View reviewed changes

src/shared/utils/exportData/getReportCSVObject.test.ts Show resolved Hide resolved

src/shared/utils/exportData/getReportAndMediaData.test.ts Show resolved Hide resolved

src/shared/utils/exportData/getJourneyCSVObject.test.ts Show resolved Hide resolved

felipeMetaLab approved these changes Jan 19, 2025

View reviewed changes

andrevitalb force-pushed the feature/M2-8268-reports-fields-rename branch from ad926a1 to 480a4f7 Compare January 22, 2025 17:54

mbanting requested changes Jan 24, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feature: Reports fields rename (M2-8268) #2002

feature: Reports fields rename (M2-8268) #2002

andrevitalb commented Jan 3, 2025 •

edited

Loading

aws-amplify-us-east-1 bot commented Jan 3, 2025

felipeMetaLab left a comment

felipeMetaLab left a comment

mbanting left a comment

mbanting Jan 24, 2025 •

edited

Loading

mbanting Jan 24, 2025

mbanting Jan 24, 2025

mbanting Jan 24, 2025

mbanting Jan 24, 2025

mbanting Jan 24, 2025

mbanting Jan 24, 2025

mbanting Jan 24, 2025 •

edited

Loading

mbanting Jan 24, 2025

mbanting Jan 24, 2025

andrevitalb commented Jan 24, 2025

feature: Reports fields rename (M2-8268) #2002

Are you sure you want to change the base?

feature: Reports fields rename (M2-8268) #2002

Conversation

andrevitalb commented Jan 3, 2025 • edited Loading

📝 Description

Current expected columns & order (for report.csv)

New expected columns & order

🪤 Peer Testing

✏️ Notes

aws-amplify-us-east-1 bot commented Jan 3, 2025

felipeMetaLab left a comment

Choose a reason for hiding this comment

felipeMetaLab left a comment

Choose a reason for hiding this comment

mbanting left a comment

Choose a reason for hiding this comment

mbanting Jan 24, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mbanting Jan 24, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

andrevitalb commented Jan 24, 2025

andrevitalb commented Jan 3, 2025 •

edited

Loading

Current expected columns & order (for `report.csv`)

mbanting Jan 24, 2025 •

edited

Loading

mbanting Jan 24, 2025 •

edited

Loading