Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
wants to merge 21 commits into
base: develop
Choose a base branch
from

Conversation

andrevitalb
Copy link
Member

@andrevitalb andrevitalb commented Jan 3, 2025

  • 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

🔗 Jira Ticket M2-8268

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

Copy link

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

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

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

@felipeMetaLab felipeMetaLab left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Disabling eslint and TS

expect(
getJourneyCSVObject({
...getPreparedProperties({
//eslint-disable-next-line @typescript-eslint/ban-ts-comment
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there any reason for disabling the eslint and TS here ?
Why is it necessary?
Is there a way to make it work without forcing the bypass?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This replicates pre-existing behavior for tests. The effort required to make the corresponding updates to remove these comments exceeds this ticket's scope. We could explore the option of making the corresponding updates to these tests at a later stage

Copy link
Contributor

@felipeMetaLab felipeMetaLab left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants