Fix #4879: Add NPS survey models #4914

adhiamboperes · 2023-03-22T16:03:06Z

Explanation

Fix #4879.
This is Part 1 of 7 PRs that the add the new survey feature.

This PR adds the proto model and BUILD definitions required for the feature.

Essential Checklist

The PR title and explanation each start with "Fix #bugnum: " (If this PR fixes part of an issue, prefix the title with "Fix part of #bugnum: ...".)
Any changes to scripts/assets files have their rationale included in the PR explanation.
The PR follows the style guide.
The PR does not contain any unnecessary code changes from Android Studio (reference).
The PR is made from a branch that's not called "develop" and is up-to-date with "develop".
The PR is assigned to the appropriate reviewers (reference).

… develop

…vey-models

BenHenning

Thanks @adhiamboperes! Took a first pass--PTAL.

model/src/main/proto/survey.proto

…CABLE_WONT_USE_OPPIA_ANYMORE 'NA' is a bit ambiguous, and the context is "won't use Oppia anymore". If they aren't using the app, they presumably wouldn't be filling out this survey.

For proto enums, we don't need to prefix-qualify each one since they'll be part of a generated Java enum -- except the first one since the unspecified constant should always repeat the enum name per proto convention.

Refactored to explain the ID format and the uniqueness guaranteed.

To convey that it is a multiple choice answer option.

adhiamboperes

Hey @BenHenning, aside from these two review comments, I have addressed all of your previous comments and I'd like you to take another look. Thanks.

model/src/main/proto/survey.proto

BenHenning

Thanks @adhiamboperes! Took an incremental pass. PTAL.

Once all of these are addressed, I'll take one more full pass just to make sure I didn't miss anything.

model/src/main/proto/survey.proto

…vey-models

Leaving a proto list empty raises the potential ambiguity of an empty proto value, which can make it harder to reason about the model. By using oneof, we can better control the structure of the message and make it clearer what fields are relevant to each question type.

We can use this field to filter open-ended responses in analytics

STARTED_NOT_COMPLETED is already used in topic.

BenHenning

Thanks @adhiamboperes! Took another pass--PTAL.

model/src/main/proto/oppia_logger.proto

model/src/main/proto/survey.proto

…vey-models

Also fixed some spacing issues and updated comments.

BenHenning

Thanks @adhiamboperes! The proto is looking really good, just had one comment about two fields left--PTAL.

model/src/main/proto/survey.proto

…vey-models

Since we localize text in the frontend, these are represented by enums; SurveyQuestionName and oneof answer respectively.

Reorder field numbers after removing some fields.

BenHenning

Thanks @adhiamboperes. This LGTM!

I'll leave it to you to merge since it'll affect your downstream chain PR.

oppiabot · 2023-04-21T05:12:00Z

Hi @adhiamboperes, this PR is ready to be merged. Please address any remaining comments prior to merging, and feel free to merge this PR once the CI checks pass and you're happy with it. Thanks!

adhiamboperes added 4 commits March 13, 2023 09:16

Create survey related models

f5432ef

Merge branch 'develop' of https://github.com/oppia/oppia-android into…

5ceebe0

… develop

Fix protobuf formatting errors

749ca4e

Merge branch 'develop' of github.com:oppia/oppia-android into nps-sur…

896fe91

…vey-models

adhiamboperes requested a review from BenHenning as a code owner March 22, 2023 16:03

adhiamboperes assigned BenHenning Mar 22, 2023

BenHenning requested changes Mar 23, 2023

View reviewed changes

BenHenning assigned adhiamboperes and unassigned BenHenning Mar 23, 2023

adhiamboperes added 5 commits March 30, 2023 00:28

Fix formating nits

8dd5828

Refactor MarketFitAnswer field NA_DONT_USE_OPPIA_ANYMORE to NOT_APPLI…

479b493

…CABLE_WONT_USE_OPPIA_ANYMORE 'NA' is a bit ambiguous, and the context is "won't use Oppia anymore". If they aren't using the app, they presumably wouldn't be filling out this survey.

Refactor enum constants to not include the enum name.

d0ab6d3

For proto enums, we don't need to prefix-qualify each one since they'll be part of a generated Java enum -- except the first one since the unspecified constant should always repeat the enum name per proto convention.

Refactor message ID documentation

f62bb61

Refactored to explain the ID format and the uniqueness guaranteed.

Refactor SurveyQuestionAnswer to SurveyAnswerOption

86cd883

To convey that it is a multiple choice answer option.

adhiamboperes commented Mar 29, 2023

View reviewed changes

model/src/main/proto/survey.proto Show resolved Hide resolved

model/src/main/proto/survey.proto Outdated Show resolved Hide resolved

adhiamboperes assigned BenHenning and unassigned adhiamboperes Mar 29, 2023

BenHenning reviewed Mar 31, 2023

View reviewed changes

BenHenning assigned adhiamboperes and unassigned BenHenning Mar 31, 2023

adhiamboperes added 8 commits April 3, 2023 18:44

Merge branch 'develop' of github.com:oppia/oppia-android into nps-sur…

9384a47

…vey-models

Refactor SurveyQuestion to have a language code

cd962ca

We can use this field to filter open-ended responses in analytics

Add BUILD definitions for survey.proto

db2afcf

Refactor SurveyUserAnswer to contain a oneof of the answer enums

1a358c7

Refactored messages for readability and consistency.

f48e9f8

Remove unused import in oppia_logger.proto

8887d9f

Rename enum field causing conflicts

56b6ae1

STARTED_NOT_COMPLETED is already used in topic.

adhiamboperes assigned BenHenning and unassigned adhiamboperes Apr 4, 2023

BenHenning reviewed Apr 6, 2023

View reviewed changes

BenHenning assigned adhiamboperes and unassigned BenHenning Apr 6, 2023

adhiamboperes added 2 commits April 11, 2023 17:04

Merge branch 'develop' of github.com:oppia/oppia-android into nps-sur…

f6d8ce1

…vey-models

Refactor field names

9fe9264

Also fixed some spacing issues and updated comments.

adhiamboperes assigned BenHenning and unassigned adhiamboperes Apr 12, 2023

BenHenning reviewed Apr 15, 2023

View reviewed changes

model/src/main/proto/survey.proto Outdated Show resolved Hide resolved

model/src/main/proto/survey.proto Outdated Show resolved Hide resolved

BenHenning assigned adhiamboperes and unassigned BenHenning Apr 15, 2023

adhiamboperes mentioned this pull request Apr 17, 2023

Fix #4880: Add NPS Survey Gating Logic #4916

Merged

6 tasks

adhiamboperes added 3 commits April 18, 2023 08:38

Merge branch 'develop' of github.com:oppia/oppia-android into nps-sur…

34be078

…vey-models

Remove string fields in SurveyQuestion and SurveyQuestionOption

c89e35e

Since we localize text in the frontend, these are represented by enums; SurveyQuestionName and oneof answer respectively.

Fix skipped field numbers

3fa4ee8

Reorder field numbers after removing some fields.

adhiamboperes assigned BenHenning and unassigned adhiamboperes Apr 18, 2023

BenHenning approved these changes Apr 21, 2023

View reviewed changes

BenHenning assigned adhiamboperes and unassigned BenHenning Apr 21, 2023

oppiabot bot added the PR: LGTM label Apr 21, 2023

Merge branch 'develop' into nps-survey-models

f55f4cd

seanlip merged commit a218247 into develop Apr 21, 2023
41 checks passed

seanlip deleted the nps-survey-models branch April 21, 2023 12:37

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix #4879: Add NPS survey models #4914

Fix #4879: Add NPS survey models #4914

adhiamboperes commented Mar 22, 2023 •

edited

BenHenning left a comment

adhiamboperes left a comment

BenHenning left a comment

BenHenning left a comment

BenHenning left a comment

BenHenning left a comment

oppiabot bot commented Apr 21, 2023

Fix #4879: Add NPS survey models #4914

Fix #4879: Add NPS survey models #4914

Conversation

adhiamboperes commented Mar 22, 2023 • edited

Explanation

Essential Checklist

BenHenning left a comment

Choose a reason for hiding this comment

adhiamboperes left a comment

Choose a reason for hiding this comment

BenHenning left a comment

Choose a reason for hiding this comment

BenHenning left a comment

Choose a reason for hiding this comment

BenHenning left a comment

Choose a reason for hiding this comment

BenHenning left a comment

Choose a reason for hiding this comment

oppiabot bot commented Apr 21, 2023

adhiamboperes commented Mar 22, 2023 •

edited