Fix #5069: Add a "hint/solution viewed" event to complement the existing "offered"/"unlocked" events. #5298

Vishwajith-Shettigar · 2024-01-13T06:48:16Z

Explanation

Fixes #5069: Added a new event called view existing for hints and solution. This event logs every time user views a hint or solution, except for the first time.

Existing event log access_hint and access_solution renamed to reveal_hint and reveal_solution.

Hints view log

hint.webm

Solution view log

solution.webm

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).

For UI-specific PRs only

If your PR includes UI-related changes, then:

Add screenshots for portrait/landscape for both a tablet & phone of the before & after UI changes
For the screenshots above, include both English and pseudo-localized (RTL) screenshots (see RTL guide)
Add a video showing the full UX flow with a screen reader enabled (see accessibility guide)
For PRs introducing new UI elements or color changes, both light and dark mode screenshots must be included
Add a screenshot demonstrating that you ran affected Espresso tests locally & that they're passing

oppiabot · 2024-01-28T06:30:20Z

Hi @Vishwajith-Shettigar, I'm going to mark this PR as stale because it hasn't had any updates for 7 days. If no further activity occurs within 7 days, it will be automatically closed so that others can take up the issue.
If you are still working on this PR, please make a follow-up commit within 3 days (and submit it for review, if applicable). Please also let us know if you are stuck so we can help you!

oppiabot · 2024-02-09T06:30:47Z

Hi @Vishwajith-Shettigar, I'm going to mark this PR as stale because it hasn't had any updates for 7 days. If no further activity occurs within 7 days, it will be automatically closed so that others can take up the issue.
If you are still working on this PR, please make a follow-up commit within 3 days (and submit it for review, if applicable). Please also let us know if you are stuck so we can help you!

oppiabot · 2024-02-16T12:01:32Z

Hi @Vishwajith-Shettigar, I'm going to mark this PR as stale because it hasn't had any updates for 7 days. If no further activity occurs within 7 days, it will be automatically closed so that others can take up the issue.
If you are still working on this PR, please make a follow-up commit within 3 days (and submit it for review, if applicable). Please also let us know if you are stuck so we can help you!

oppiabot · 2024-04-15T17:10:13Z

Hi @Vishwajith-Shettigar, I'm going to mark this PR as stale because it hasn't had any updates for 7 days. If no further activity occurs within 7 days, it will be automatically closed so that others can take up the issue.
If you are still working on this PR, please make a follow-up commit within 3 days (and submit it for review, if applicable). Please also let us know if you are stuck so we can help you!

oppiabot · 2024-05-02T07:01:47Z

Hi @Vishwajith-Shettigar, I'm going to mark this PR as stale because it hasn't had any updates for 7 days. If no further activity occurs within 7 days, it will be automatically closed so that others can take up the issue.
If you are still working on this PR, please make a follow-up commit within 3 days (and submit it for review, if applicable). Please also let us know if you are stuck so we can help you!

oppiabot · 2024-05-10T05:19:44Z

Hi @Vishwajith-Shettigar, I'm going to mark this PR as stale because it hasn't had any updates for 7 days. If no further activity occurs within 7 days, it will be automatically closed so that others can take up the issue.
If you are still working on this PR, please make a follow-up commit within 3 days (and submit it for review, if applicable). Please also let us know if you are stuck so we can help you!

adhiamboperes

Thanks @Vishwajith-Shettigar! This solution looks good to me, but we need to add tests for the new events that have been added.

adhiamboperes · 2024-05-14T09:56:21Z

domain/src/main/java/org/oppia/android/domain/exploration/ExplorationProgressController.kt

@@ -273,6 +273,19 @@ class ExplorationProgressController @Inject constructor(
    return submitResultFlow.convertToSessionProvider(SUBMIT_HINT_REVEALED_RESULT_PROVIDER_ID)
  }

+  /**
+   * Notifies the controller that the user wishes to view a hint.


Suggested change

* Notifies the controller that the user wishes to view a hint.

* Notifies the controller that the user has viewed a hint.

adhiamboperes · 2024-05-14T09:57:28Z

domain/src/main/java/org/oppia/android/domain/exploration/ExplorationProgressController.kt

@@ -289,6 +302,14 @@ class ExplorationProgressController @Inject constructor(
    return submitResultFlow.convertToSessionProvider(SUBMIT_SOLUTION_REVEALED_RESULT_PROVIDER_ID)
  }

+  /**
+   * Notifies the controller that the user wishes to view the answer.


Suggested change

* Notifies the controller that the user wishes to view the answer.

* Notifies the controller that the user has viewed the answer.

adhiamboperes · 2024-05-14T10:02:07Z

domain/src/main/java/org/oppia/android/domain/exploration/ExplorationProgressController.kt

@@ -1329,6 +1372,30 @@ class ExplorationProgressController @Inject constructor(
      override val callbackFlow: MutableStateFlow<AsyncResult<Any?>>? = null
    ) : ControllerMessage<Any?>()

+    /**
+     * [ControllerMessage] to log cases when user viewed hint for the current session.


Suggested change

* [ControllerMessage] to log cases when user viewed hint for the current session.

* [ControllerMessage] to log cases when the user has viewed a hint for the current session.

adhiamboperes · 2024-05-14T10:03:03Z

domain/src/main/java/org/oppia/android/domain/exploration/ExplorationProgressController.kt

+    ) : ControllerMessage<Any?>()
+
+    /**
+     * [ControllerMessage] to log cases when user viewed solution for the current session.


Suggested change

* [ControllerMessage] to log cases when user viewed solution for the current session.

* [ControllerMessage] to log cases when the user has viewed the solution for the current session.

adhiamboperes · 2024-05-14T10:34:43Z

utility/src/test/java/org/oppia/android/util/logging/EventBundleCreatorTest.kt

This file is missing tests for the two newly created events.

adhiamboperes · 2024-05-14T10:37:18Z

utility/src/test/java/org/oppia/android/util/logging/KenyaAlphaEventBundleCreatorTest.kt

We also need tests for the new events here. Please follow up via the group chat whether sensitive/non-sensitvive values are a concern that we need to address for these new events, since sometimes we collect additional data when a study is on, that we don't collect when the study is off.

adhiamboperes · 2024-05-14T10:38:23Z

model/src/main/proto/oppia_logger.proto

@@ -191,6 +191,12 @@ message EventLog {
      // The event being logged is related to the amount spent by the user with the app in
      // foreground.
      AppInForegroundTimeContext app_in_foreground_time = 48;
+
+      // The event being logged is related to accessing a hint.


Suggested change

// The event being logged is related to accessing a hint.

// The event being logged is related to viewing a hint.

adhiamboperes · 2024-05-14T10:40:54Z

domain/src/test/java/org/oppia/android/domain/exploration/ExplorationProgressControllerTest.kt

We need tests for the new events as well.

oppiabot · 2024-05-21T11:05:16Z

Hi @Vishwajith-Shettigar, I'm going to mark this PR as stale because it hasn't had any updates for 7 days. If no further activity occurs within 7 days, it will be automatically closed so that others can take up the issue.
If you are still working on this PR, please make a follow-up commit within 3 days (and submit it for review, if applicable). Please also let us know if you are stuck so we can help you!

Vishwajith-Shettigar added 3 commits January 13, 2024 12:17

hint viewed event log

453dad4

hint viewed event log

4daa3fc

doc fix

6c1467c

Vishwajith-Shettigar self-assigned this Jan 14, 2024

Vishwajith-Shettigar and others added 5 commits January 14, 2024 16:46

solution view event

26778d7

solution view event

5ee0fef

added kdoc

bd16abc

TEST FILE CHECK issue fixed

eebab9a

Merge branch 'develop' into hint-solution-view-event

a407224

Vishwajith-Shettigar changed the title ~~hint viewed event log~~ [Feature Request] #5069: Add a "hint/solution viewed" event to complement the existing "offered"/"unlocked" events. Jan 20, 2024

Vishwajith-Shettigar marked this pull request as ready for review January 20, 2024 03:41

Vishwajith-Shettigar requested review from a team as code owners January 20, 2024 03:41

Vishwajith-Shettigar requested a review from BenHenning January 20, 2024 03:41

Vishwajith-Shettigar assigned adhiamboperes Jan 20, 2024

Vishwajith-Shettigar changed the title ~~[Feature Request] #5069: Add a "hint/solution viewed" event to complement the existing "offered"/"unlocked" events.~~ Fix #5069: Add a "hint/solution viewed" event to complement the existing "offered"/"unlocked" events. Jan 21, 2024

oppiabot bot added the stale Corresponds to items that haven't seen a recent update and may be automatically closed. label Jan 28, 2024

Vishwajith-Shettigar removed the stale Corresponds to items that haven't seen a recent update and may be automatically closed. label Jan 28, 2024

Merge branch 'develop' into hint-solution-view-event

056b2ed

Vishwajith-Shettigar removed their assignment Jan 29, 2024

Vishwajith-Shettigar added 3 commits February 2, 2024 10:49

refinied code

d7b54b1

test fix

f1cdf9a

test fix

8e29552

oppiabot bot added the stale Corresponds to items that haven't seen a recent update and may be automatically closed. label Feb 9, 2024

Vishwajith-Shettigar removed the stale Corresponds to items that haven't seen a recent update and may be automatically closed. label Feb 9, 2024

oppiabot bot added the stale Corresponds to items that haven't seen a recent update and may be automatically closed. label Feb 16, 2024

Merge branch 'develop' into hint-solution-view-event

0a3f0b0

Vishwajith-Shettigar marked this pull request as ready for review April 8, 2024 16:57

Vishwajith-Shettigar assigned adhiamboperes and unassigned Vishwajith-Shettigar Apr 8, 2024

oppiabot bot added the stale Corresponds to items that haven't seen a recent update and may be automatically closed. label Apr 15, 2024

Vishwajith-Shettigar removed the stale Corresponds to items that haven't seen a recent update and may be automatically closed. label Apr 16, 2024

Vishwajith-Shettigar and others added 11 commits April 16, 2024 15:55

rename accesshint to revealhint

267bb13

klint

56b9cc4

rename accesssolution to revealsolution

a1b556d

rename accesssolution to revealsolution

b6a28a8

resolve conflict

4753d7c

Merge branch 'develop' into hint-solution-view-event

31e8491

resolve conflict

cd6f87f

fix typo

5dbf54e

test fix

641923a

Merge branch 'develop' into hint-solution-view-event

cf8bc5d

Remove extra space

6ef7cdd

oppiabot bot added the stale Corresponds to items that haven't seen a recent update and may be automatically closed. label May 2, 2024

Vishwajith-Shettigar removed the stale Corresponds to items that haven't seen a recent update and may be automatically closed. label May 3, 2024

oppiabot bot added the stale Corresponds to items that haven't seen a recent update and may be automatically closed. label May 10, 2024

Vishwajith-Shettigar removed the stale Corresponds to items that haven't seen a recent update and may be automatically closed. label May 10, 2024

adhiamboperes requested changes May 14, 2024

View reviewed changes

adhiamboperes assigned Vishwajith-Shettigar and unassigned adhiamboperes May 14, 2024

oppiabot bot added the stale Corresponds to items that haven't seen a recent update and may be automatically closed. label May 21, 2024

adhiamboperes removed the stale Corresponds to items that haven't seen a recent update and may be automatically closed. label May 21, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix #5069: Add a "hint/solution viewed" event to complement the existing "offered"/"unlocked" events. #5298

Fix #5069: Add a "hint/solution viewed" event to complement the existing "offered"/"unlocked" events. #5298

Vishwajith-Shettigar commented Jan 13, 2024 •

edited

oppiabot bot commented Jan 28, 2024

oppiabot bot commented Feb 9, 2024

oppiabot bot commented Feb 16, 2024

oppiabot bot commented Apr 15, 2024

oppiabot bot commented May 2, 2024

oppiabot bot commented May 10, 2024

adhiamboperes left a comment

adhiamboperes May 14, 2024

adhiamboperes May 14, 2024

adhiamboperes May 14, 2024

adhiamboperes May 14, 2024

adhiamboperes May 14, 2024

adhiamboperes May 14, 2024

adhiamboperes May 14, 2024

adhiamboperes May 14, 2024

oppiabot bot commented May 21, 2024

	* Notifies the controller that the user wishes to view a hint.
	* Notifies the controller that the user has viewed a hint.

	* [ControllerMessage] to log cases when user viewed hint for the current session.
	* [ControllerMessage] to log cases when the user has viewed a hint for the current session.

	// The event being logged is related to accessing a hint.
	// The event being logged is related to viewing a hint.

Fix #5069: Add a "hint/solution viewed" event to complement the existing "offered"/"unlocked" events. #5298

Are you sure you want to change the base?

Fix #5069: Add a "hint/solution viewed" event to complement the existing "offered"/"unlocked" events. #5298

Conversation

Vishwajith-Shettigar commented Jan 13, 2024 • edited

Explanation

Hints view log

Solution view log

Essential Checklist

For UI-specific PRs only

oppiabot bot commented Jan 28, 2024

oppiabot bot commented Feb 9, 2024

oppiabot bot commented Feb 16, 2024

oppiabot bot commented Apr 15, 2024

oppiabot bot commented May 2, 2024

oppiabot bot commented May 10, 2024

adhiamboperes left a 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

oppiabot bot commented May 21, 2024

Vishwajith-Shettigar commented Jan 13, 2024 •

edited